File: //usr/lib/python3/dist-packages/sphinx/util/__pycache__/__init__.cpython-310.pyc
o
u�a�L � @ s� U d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl m Z ddl m
Z
ddlmZ ddlmZmZ ddlmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z ddl m!Z!m"Z"m#Z#m$Z$m%Z% dd l&m'Z' dd
l(m)Z)m*Z*m+Z+ dd l,m-Z- dd l.m/Z/ dd
l0m1Z1m2Z2m3Z3m4Z4 ddl5m6Z6 ddl7m8Z8m9Z9m:Z:m;Z; ddl<m=Z=m>Z>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZE ddlFmGZG er�ddlHmIZI e/�JeK�ZLe�Md�ZNe eOd< e�Md�ZPe eOd< deQdeQdeQfdd�ZRd eQdeQfd d �ZS d~d eQd!e eGd"f deeQ fd#d$�ZTd%eeQeQf d&eQdeQfd'd(�ZUG d)d*� d*eV�ZWdd,d-�ZXdd.d/�ZYG d0d1� d1eV�ZZd2Z[d3d4deQfd5d6�Z\d7eQd8eQdeQfd9d:�Z]e�Md;�Z^G d<d=� d=�Z_G d>d?� d?�Z`d@eQdAeadeea fdBdC�ZbdDeQdEeQdeQfdFdG�ZcdHeQdIeQde eQeQf fdJdK�ZddLeadMeQdNeQdeeQ fdOdP�ZedMeQdNeQdeeQ fdQdR�Zfd�dTeadeQfdUdV�Zgd�dWeQdXeQdefdYdZ�Zhd[eQde eeQ eQf fd\d]�Zid^eQdeQfd_d`�ZjdaeQdekfdbdc�ZlddedeQfdedf�ZmdgemfdhedieQdjeQdkeegeQf def
dldm�ZndgddemfdhedieQdjeQdneadoeadkeegeQf defdpdq�ZoG drds� dsep�ZqG dtdu� du�ZrdvesdeQfdwdx�ZtdyeQdesfdzd{�Zude fd|d}�ZvdS )�z�
sphinx.util
~~~~~~~~~~~
Utility functions for Sphinx.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�datetime)�
import_module)�path��mktime�strptime)
�IO�
TYPE_CHECKING�Any�Callable�Dict�Iterable�Iterator�List�Optional�Pattern�Set�Tuple�Type)� parse_qsl�
quote_plus� urlencode�urlsplit�
urlunsplit)�RemovedInSphinx50Warning)�ExtensionError�FiletypeNotFoundError�SphinxParallelError)�__)�logging)�bold�colorize� strip_colors�term_width_line)� patfilter)�caption_ref_re�explicit_title_re�nested_parse_with_titles�split_explicit_title) �SEP�copyfile� copytimes� ensuredir�
make_filename�movefile�mtimes_of_files�os_path� relative_uri)� PathMatcher)�Sphinxz\s+�ws_rez(?P<schema>.+)://.*�url_re� basedocname�docname�returnc C s t �t �d| d|��dd � S )N�/z..� )� posixpath�normpath�join)r6 r7 � r> �6/usr/lib/python3/dist-packages/sphinx/util/__init__.py� docname_join8 s
��r@ �filepathc C s | � tjjt�}t�d|�S )z+Normalize path separator and unicode string�NFC)�replace�osr �sepr) � unicodedata� normalize)rA �newpathr> r> r? �path_stabilize= s rI r> �dirname�exclude_matchers.c # s� � t �t �| ��} t| �d }tj| dd�D ]S\}� }||d� �t�fdd�� D ��}t�fdd�|D ��}|D ]��fdd �|D �}�fd
d �|D �}q9t� fd d�|D ��� dd�< t|�D ]\}}|V qaqdS ) z}Get all file names in a directory, recursively.
Exclude files and dirs matching some matcher in *exclude_matchers*.
r: T)� followlinksNc 3 � � | ] }t t�� |��V qd S �N�rI r r= )�.0�dn�� relativerootr> r? � <genexpr>P � � �z%get_matching_files.<locals>.<genexpr>c 3 rM rN rO )rP �fnrR r> r? rT R rU c � g | ]
}� |d �s|�qS �r: r> �rP �entry��matcherr> r? �
<listcomp>U � z&get_matching_files.<locals>.<listcomp>c rW rX r> rY r[ r> r? r] V r^ c 3 s � | ] \}}� | V qd S rN r> )rP �i�_)�dirsr> r? rT X s � )r r< �abspath�lenrD �walk� enumerate�sorted) rJ rK �dirlen�root�files�qdirs�qfilesr_ �filenamer> )ra r\ rS r? �get_matching_filesC s& � � � ��rm �
source_suffixrl c C s, | � � D ]\}}|�|�r|pd S qt�)N�restructuredtext)�items�endswithr )rn rl �suffix�filetyper> r> r? � get_filetype^ s
�rt c @ s� e Zd ZdZddd�Zdededefdd �Zdeddfd
d �Zd ee d
e ee
ee e f f ddfdd�Z dee fdd�Z
dee ddfdd�ZdS )�FilenameUniqDictz�
A dictionary that automatically generates unique names for its keys,
interpreted as filenames, and keeps track of a set of docnames they
appear in. Used for images and downloadable files in the environment.
r8 Nc C s t � | _d S rN )�set� _existing��selfr> r> r? �__init__m s zFilenameUniqDict.__init__r7 �newfilec C s� || v r| | d � |� | | d S t�|�}t�|�\}}d}|| jv r6|d7 }d|||f }|| jv s&|h|f| |< | j� |� |S )Nr r: z%s%s%s)�addr �basename�splitextrw )ry r7 r{ �
uniquename�base�extr_ r> r> r? �add_filep s
� zFilenameUniqDict.add_filec C s> t | �� �D ]\}\}}|�|� |s | |= | j�|� qd S rN )�listrp �discardrw )ry r7 rl �docs�uniquer> r> r? � purge_doc~ s
��zFilenameUniqDict.purge_doc�docnames�otherc C �8 |� � D ]\}\}}|t|�@ D ]}| �||� qqd S rN �rp rv r� )ry r� r� rl r� r� �docr> r> r? � merge_other� �
��z FilenameUniqDict.merge_otherc C s | j S rN �rw rx r> r> r? � __getstate__� s z FilenameUniqDict.__getstate__�statec C �
|| _ d S rN r� )ry r� r> r> r? � __setstate__� �
z FilenameUniqDict.__setstate__�r8 N)�__name__�
__module__� __qualname__�__doc__rz �strr� r� r r r r
r� r� r� r> r> r> r? ru g s
.ru � c K �B z
t j| fi |��W S ty t j| fi |�ddi�� Y S w )a3 Wrapper around hashlib.md5
Attempt call with 'usedforsecurity=False' if we get a ValueError, which happens when
OpenSSL FIPS mode is enabled:
ValueError: error:060800A3:digital envelope routines:EVP_DigestInit_ex:disabled for fips
See: https://github.com/sphinx-doc/sphinx/issues/7611
�usedforsecurityF)�hashlib�md5�
ValueError��data�kwargsr> r> r? r� � s
�r� c K r� )z�Wrapper around hashlib.sha1
Attempt call with 'usedforsecurity=False' if we get a ValueError
See: https://github.com/sphinx-doc/sphinx/issues/7611
r� F)r� �sha1r� r� r> r> r? r� � s
�r� c @ sf e Zd ZdZdededefdd�Zdeddfdd �Zd
ee d eee ee e
f f ddfd d
�Z dS )�
DownloadFilesz�A special dictionary for download files.
.. important:: This class would be refactored in nearly future.
Hence don't hack this directly.
r7 rl r8 c C sX || vr t |�� ��� }d|tj�|�f }t� |f| |< | | d �|� | | d S )Nz%s/%sr r: )r� �encode� hexdigestrD r r} rv r| )ry r7 rl �digest�destr> r> r? r� � s zDownloadFiles.add_fileNc C s2 t | �� �D ]\}\}}|�|� |s| |= qd S rN )r� rp r� )ry r7 rl r� r� r> r> r? r� � s
��zDownloadFiles.purge_docr� r� c C r� rN r� )ry r� r� rl r� r� r7 r> r> r? r� � r� zDownloadFiles.merge_other) r� r� r� r� r� r� r� r r r r
r� r> r> r> r? r� � s
2r� z�# Sphinx version: %s
# Python version: %s (%s)
# Docutils version: %s %s
# Jinja2 version: %s
# Last messages:
%s
# Loaded extensions:
�appr3 c C s ddl }ddl}ddl}ddl}t�� d }t|t�r!d|j }nt� � }t
� dd�\}}d} | dur>d� d d
� | j
D ��} t�|t|j|�� |�� |j|j|j| f �� � | dur~| j�� D ] }
t|
jd d �} |
jd
kr}t�|d|
j |
j| f �� � q`t�||�� � t� |� |S )z;Save the current exception's traceback in a temporary file.r Nr: z (Error in parallel process)
z.logz sphinx-err-� �
c s s � | ] }d t |��� V qdS )z# %sN)r" �strip)rP �sr> r> r? rT � s
� �
�z!save_traceback.<locals>.<genexpr>�__file__�unknown�builtinz# %s (%s) from %s
) �platform�docutils�jinja2�sphinx�sys�exc_info�
isinstancer � traceback�
format_exc�tempfile�mkstempr= �
messagelogrD �write�
_DEBUG_HEADER�__display_version__�python_version�python_implementation� __version__�__version_details__r� �
extensions�values�getattr�module�version�name�close) r� r� r� r� r� �exc�
exc_format�fdr � last_msgsr� �modfiler> r> r? �save_traceback� sL
����
���
r� �modname� attributec C sB | d u rd S t | �}|}|�d�D ] }|rt||�}qt|dd �S )N�.r� )r �splitr� )r� r� r� �value�attrr> r> r? �get_full_modname� s
� r� zcoding[:=]\s*([-\w.]+)c @ s< e Zd ZdZdeddfdd�Zdedeeef fdd �Z dS )
�UnicodeDecodeErrorHandlerz8Custom error handler for open() that warns and replaces.r7 r8 Nc C r� rN )r7 )ry r7 r> r> r? rz r� z"UnicodeDecodeErrorHandler.__init__�errorc C s� |j �dd|j�}|j �d|j�}|dkrt|j �}|j �dd|j�d }tjtd�|j |d |j� d |j |j|j � d |j |j |� | j
|fd� d |j fS )
N�
r ���r: z5undecodable source characters, replacing with "?": %rs >>>s <<<)�location�?) �object�rfind�start�findrc �count�logger�warningr �endr7 )ry r� � linestart�lineend�linenor> r> r? �__call__ s
����
z"UnicodeDecodeErrorHandler.__call__)
r� r� r� r� r� rz �UnicodeDecodeErrorr �intr� r> r> r> r? r� s r� c @ sB e Zd ZdZdededdfdd�Zdeddfd d
�Zd
d d �ZdS )�Teez2
File-like object writing to two streams.
�stream1�stream2r8 Nc C s || _ || _d S rN )r� r� )ry r� r� r> r> r? rz * s
z Tee.__init__�textc C s | j �|� | j�|� d S rN )r� r� r� )ry r� r> r> r? r� . s z Tee.writec C s4 t | jd�r | j�� t | jd�r| j�� d S d S )N�flush)�hasattrr� r� r� rx r> r> r? r� 2 s
�z Tee.flushr� ) r� r� r� r� r rz r� r� r� r> r> r> r? r� & s
r� �spec�totalc C s� t � }| �d�}|D ]d}zO|�� �d�}ddg|kr t�t|�dkr.|�t|d �d � n,t|�dkrXt|d p:d�}t|d pEt||��}||krMt�|�t |d |�� nt�W q
t
yn } ztd| �|�d}~ww |S ) z_Parse a line number spec (such as "1,2,4-6") and return a list of
wanted line numbers.
�,�-r� r: r � z invalid line number spec: %rN) r� r� r� r� rc �appendr� �max�extend�range� Exception) r� r� rp �parts�part�begendr� r� r� r> r> r? � parselinenos9 s,
���r �string�encodingc C s` t jdtdd� t| t�r.z|r| �|�} W | S | �� } W | S ty- | �d�} Y | S w | S )z2Forcibly get a unicode string out of a bytestring.z force_decode() is deprecated.r� ��
stacklevel�latin1)�warnings�warnr r� �bytes�decode� UnicodeError)r r r> r> r? � force_decodeT s �
� � �r r� �tc C sJ t jdtdd� | �|�}|dkr!| d|� | |t|� d� fS d| fS )zESimilar to str.rpartition from 2.5, but doesn't return the separator.z rpartition() is now deprecated.r� r r� Nr� )r r r r� rc )r� r r_ r> r> r? �
rpartitione s
r
�n�typer� c C sD dd� |� d| d �D �}tdd� |D ��| k r td||f ��|S )z@Split an index entry into a given number of parts at semicolons.c S s g | ]}|� � �qS r> )r� )rP �xr> r> r? r] p s z split_into.<locals>.<listcomp>�;r: c s s � | ]}|rd V qdS )r: Nr> )rP r� r> r> r? rT q s � z split_into.<locals>.<genexpr>�invalid %s index entry %r)r� �sumr� )r r r� r� r> r> r? �
split_inton s r c C s� | dkr z t dd|�}W |S ty t dd|�}Y |S w | dkr*t dd|�}|S | dkr6t dd|�}|S | dkrBt dd|�}|S | dkrNt dd|�}|S td | |f ��)
N�singler� r: �pair�triple� �see�seealsor )r r� )r r� �resultr> r> r? �split_index_msgv s* � �
� � � �r r: r c C sH t �� \}}}g }t�|�}||| d� 7 }|t�||�7 }d�|�S )z?Format an exception with traceback, but only the last x frames.Nr� )r� r� r� � format_tb�format_exception_onlyr= )r �typ�val�tb�res�tbresr> r> r? �format_exception_cut_frames� s
r$ �objname�sourcec
C s� z0| � d�}|�d�}t|�}|D ] }|d| 7 }zt||�}W q ty- t|�}Y qw |W S ttfyR } z|rFtd| |f |�|�td| |�|�d}~ww )z!Import python object by qualname.r� r z#Could not import %s (needed for %s)zCould not import %sN)r� �popr r� �AttributeError� ImportErrorr )r% r& �objpathr� �objr� r� r> r> r? �
import_object� s0
������r, r� c
C s� | � d�}t|d�D ]O\}}zd�|d|� �}t|� W q
tyQ |d|d � rFd�|d|d � �d�||d d� �f Y S dd�|�f Y S tyY Y q
w | dfS )a Split full qualified name to a pair of modname and qualname.
A qualname is an abbreviation for "Qualified name" introduced at PEP-3155
(https://www.python.org/dev/peps/pep-3155/). It is a dotted path name
from the module top-level.
A "full" qualified name means a string containing both module name and
qualified name.
.. note:: This function actually imports the module to check its existence.
Therefore you need to mock 3rd party modules if needed before
calling this function.
r� r: Nr� )r� re r= r r) �
IndexError)r� r� r_ r� r� r> r> r? �split_full_qualified_name� s
4 �r. �uric C sh t t| ��}|d �d��d�|d< t|d �� d�|d< t dd� t|d �D ��}t|�|d< t|�S ) Nr: �idna�asciir� r9 c s s � | ] \}}||� � fV qd S rN )r� )rP �q�vr> r> r? rT � s � z encode_uri.<locals>.<genexpr>r )r� r r� r r r r r )r/ r� �queryr> r> r? �
encode_uri� s r5 �urlc C s | rd| v rdS dS )zCheck *url* is URL or not.z://TFr> )r6 r> r> r? �isurl� s r7 �chunkc C sB t | ttf�r t| �dkrt| d �S d| d | d f S t| �S )Nr: r z%s .. %sr� )r� r� �tuplerc r� )r8 r> r> r? �
display_chunk� s
r: � darkgreen�iterable�summary�color�stringify_funcc c sp � d}| D ]%}|dkrt jt|�dd� d}t j||�|dd� t jddd� |V q|dkr6t �d� d S d S )Nr T��nonlr: )r> rA � r� )r� �infor )r< r= r> r? �l�itemr> r> r? �old_status_iterator� s ��rF �length� verbosityc c s� � |dkrt | |||�E d H d S d}t|�}| D ]+}|d7 }d|d| | t|||��f }|r6|d7 }nt|�}tj|dd� |V q|dkrPt�d� d S d S ) Nr r: z %s[%3d%%] %s�d r� Tr@ r� )rF r r! r# r� rC ) r< r= r> rG rH r? rD rE r� r> r> r? �status_iterator� s" �
�rJ c @ s e Zd ZdS )�SkipProgressMessageN)r� r� r� r> r> r> r? rK s rK c @ sX e Zd Zdeddfdd�Zddd�Zdee d ed
ede fd d �Z
d
e de fdd�Z dS )�progress_message�messager8 Nc C r� rN )rM )ry rM r> r> r? rz r� zprogress_message.__init__c C s t jt| jd �dd� d S )Nz... Tr@ )r� rC r rM rx r> r> r? � __enter__ s zprogress_message.__enter__�exc_type� exc_valuer� c C sV t |t�rt�td�� |jrtj|j� dS |r"t�td�� dS t�td�� dS )N�skippedT�failed�doneF)r� rK r� rC r �args)ry rO rP r� r> r> r? �__exit__ s
�zprogress_message.__exit__�fc s* t �� �dtdtdtf� �fdd� �}|S )NrT r� r8 c s6 �� � | i |��W d � S 1 sw Y d S rN r> )rT r� �rV ry r> r? �wrapper s $�z*progress_message.__call__.<locals>.wrapper)� functools�wrapsr
)ry rV rX r> rW r? r� s zprogress_message.__call__r� )
r� r� r� r� rz rN r r� r
�boolrU r r� r> r> r> r? rL s
rL �epochc C s, ddl m} t�| �}d}|||dd�d S )z)Convert datetime format epoch to RFC1123.r )�format_datetimezEEE, dd LLL yyyy hh:mm:ss�en)�localez GMT)� babel.datesr] r �
fromtimestamp)r\ r] �dt�fmtr> r> r? �epoch_to_rfc1123( s
rd �rfc1123c C s t t| d��S )Nz%a, %d %b %Y %H:%M:%S %Zr )re r> r> r? �rfc1123_to_epoch1 s rf c s� dddgdddgddgd d
gd d gd
dgddgddgddgddgddgddgdd gd d gg} d d d!d"gd#d$d%gd&d'gg}d/d)t d*td+tf� fd,d-�
� � | �}� |�}t�d.|||f �S )0N�:�A�Zr` �a�z� À� Ö� Ø� ö� øu ˿u Ͱu ͽu Ϳu u u u ⁰u u Ⰰu u 、u u 豈u ﷏u ﷰu �u 𐀀u z\-z\.�0�9� ·u ̀u ͯu ‿u ⁀�|�entries�splitterr8 c sB g }| D ]}t |t�r|�d� |d� � q|�|� q|�|�S )Nz[%s]r� )r� r� r� r= )ru rv �resultsrZ ��convertr> r? ry C s
z xmlname_checker.<locals>.convertz (%s)(%s|%s)*)rt )r
r� �re�compile)�name_start_chars�
name_chars�start_chars_regex�name_chars_regexr> rx r? �xmlname_checker5 s �� �r� )r> )r� rX rN )wr� rY r� rD r; rz r� r� r� rF r r � importlibr r �timer r �typingr r r
r r r
r r r r r r r � urllib.parser r r r r �sphinx.deprecationr �
sphinx.errorsr r r �
sphinx.localer � sphinx.utilr �sphinx.util.consoler r! r" r# �sphinx.util.matchingr$ �sphinx.util.nodesr% r& r' r( �sphinx.util.osutilr) r* r+ r, r- r. r/ r0 r1 �sphinx.util.typingr2 �sphinx.applicationr3 � getLoggerr� r� r{ r4 �__annotations__r5 r� r@ rI rm rt �dictru r� r� r� r� r� r� �
_coding_rer� r� r� r r r
r r r$ r, r. r5 r[ r7 r: rF rJ r� rK rL �floatrd rf r� r> r> r> r? �<module> s�
< ,
�
�
�
*
%
� �
���� �
�