| Server IP : 127.0.0.1 / Your IP : 216.73.216.109 Web Server : Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10 System : Windows NT DESKTOP-E5T4RUN 10.0 build 19045 (Windows 10) AMD64 User : SERVERWEB ( 0) PHP Version : 8.1.10 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/cygwin64/lib/python3.9/site-packages/sphinx/environment/__pycache__/ |
Upload File : |
a
�abKe � @ s* U d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZ ddlmZ dd lmZ dd
lmZ dd lm Z dd l m Z dd
l m Z ddl!m"Z" ddl#m$Z$m%Z%m&Z&m'Z' ddl(m)Z) ddl*m+Z+ ddl,m-Z- ddl.m/Z/ ddl0m1Z1m2Z2m3Z3 ddl4m5Z5 ddl6m7Z7m8Z8 ddl9m:Z: ddl;m<Z<m=Z= e
�r�ddl>m?Z? ddl@mAZA e3�BeC�ZDdd d d d dd dd d d d d!d g d"�ZEe
eFe f eGd#< d$ZHd%ZId&ZJd'ZKd(ZLeJe+d)�eKe+d*�eLe+d+�iZMd e:d,�ZNe
eFeeOe f f eGd-< G d.d/� d/�ZPdS )0z�
sphinx.environment
~~~~~~~~~~~~~~~~~~
Global creation environment.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)� defaultdict)�copy)�datetime)�path) �
TYPE_CHECKING�Any�Callable�Dict� Generator�Iterator�List�Optional�Set�Tuple�Union)�nodes)�Node)�addnodes)�Config)�RemovedInSphinx60Warning)�Domain)�TocTree)�BuildEnvironmentError�
DocumentError�ExtensionError� SphinxError)� EventManager)�__)�Project)�SphinxTransformer)�
DownloadFiles�FilenameUniqDict�logging)�LoggingReporter)�CatalogRepository�docname_to_domain)�is_translatable)�
canon_path�os_path)�Sphinx)�Builder�idFTz https://www.python.org/dev/peps/z&https://datatracker.ietf.org/doc/html/z utf-8-sig� )Zauto_id_prefixZ embed_imagesZembed_stylesheetZcloak_email_addressesZ pep_base_urlZpep_referencesZ rfc_base_urlZrfc_references�input_encodingZdoctitle_xformZsectsubtitle_xformZsection_self_linkZ
halt_levelZfile_insertion_enabledZsmartquotes_locales�default_settings�8 � � � � z
new configzconfig changedzextensions changed)Znone�text�versioning_conditionsc @ s� e Zd ZU dZeeef ed< dZdd�dd�Zed�d d
�Z edd �d d
�Z
ddd�dd�Z e dd�dd�Z
e dd�dd�Zeeef edd�dd�Zedd�dd�Zee d ddd �d d �Zeee d �d d!�Zd[eeed#�d$d%�Zd\eeeeef d&�d'd(�Zee e d�d)d*��Z e d+dd,�d-d.�Z eee e e e e e f d/�d0d1�Z de e e eddf d2�d3d4�Z!edd�d5d6�Z"eed�d7d8��Z#d]ee$d:�d;d<�Z%edd �d=d>�Z&edd �d?d@�Z'dd�dAdB�Z(eedC�dDdE�Z)ee*j+d�dFdG�Z,d^ed+e*j+eee*j+dI�dJdK�Z-d_ed+e.j/ee$eeee0dM� dNdO�Z1e*j+ed+ddP�dQdR�Z2e*j+eddS�dTdU�Z3eeeee f d�dVdW�Z4dd�dXdY�Z5dS )`�BuildEnvironmentz�
The environment in which the ReST files are translated.
Stores an inventory of cross-file targets and provides doctree
transformations to resolve links to them.
�domainsNr) )�appc C s d | _ d | _d | _d | _d | _d | _d | _d | _d | _d | _ d | _
i | _ t �
� | _| | jd< i | _tt�| _tt�| _t� | _tt�| _i | _i | _i | _i | _i | _i | _ i | _ i | _ t� | _ t� | _ i | _!t"� | _#t$� | _%i | _&i | _'i | _(|�r| �)|� nt*j+dt,dd� d S )N�envz?The 'app' argument for BuildEnvironment() becomes required now.r1 )�
stacklevel)-r8 �
doctreedir�srcdir�config�
config_status�config_status_extra�events�project�version�versioning_condition�versioning_comparer7 r. r �settings�all_docsr �set� dependencies�included�
reread_always�dict�metadataZtitlesZ
longtitlesZtocsZtoc_num_entriesZtoc_secnumbersZtoc_fignumbers�toctree_includes�files_to_rebuildZ
glob_toctreesZnumbered_toctrees�
domaindatar! Zimagesr ZdlfilesZoriginal_image_uri� temp_dataZ ref_context�setup�warnings�warnr )�selfr8 � rU �?/usr/lib/python3.9/site-packages/sphinx/environment/__init__.py�__init__c sP
�zBuildEnvironment.__init__)�returnc C s | j �� }|jdi dd� |S )z'Obtains serializable data for pickling.N)r8 r7 r@ )�__dict__r �update)rT rY rU rU rV � __getstate__� s
z BuildEnvironment.__getstate__)�staterX c C s | j �|� d S �N)rY rZ )rT r\ rU rU rV � __setstate__� s z BuildEnvironment.__setstate__)r8 rX c C s� | j r&| j |j�|�kr&ttd���n | jrD| j|jkrDttd���| jrX|j�| j� || _|j | _ |j
| _
|j| _|j| _|j�|�| _ i | _ |j� | �D ]}|| j |j
< q�| j �� D ] }|�� q�| �|j� | �|j� dS )z Set up BuildEnvironment object.z%build environment version not currentz source directory has changedN)rB �registryZget_envversionr r r< rA Zrestorer8 r; r@ r7 Zcreate_domains�name�valuesrQ �_update_configr= �_update_settings)rT r8 �domainrU rU rV rQ � s&
zBuildEnvironment.setup)r= rX c C s� t | _d| _| jdu r t| _n�| jj|jkr~t| _tt| jj�t|j�A �}t |�dkrb|d }ndt |�f }d|f | _n:|�
d�D ].}| j|j |j kr�t
| _d|j f | _ q�q�|| _dS )z!Update configurations by new one.� Nr0 r z%dz (%r)r9 )� CONFIG_OKr> r? r= �
CONFIG_NEW�
extensions�CONFIG_EXTENSIONS_CHANGED�sortedrG �len�filterr` �value�CONFIG_CHANGED)rT r= rh � extension�itemrU rU rV rb � s&
�
z BuildEnvironment._update_configc C s: |j | jd< |j| jd< |jp d| jd< | j�dd� dS )z Update settings by new config.r- � trim_footnote_reference_space�enZ
language_codeZ smart_quotesTN)�source_encodingrE rq �language�
setdefault)rT r= rU rU rV rc s z!BuildEnvironment._update_settings)�method�comparerX c C sT t |�r|}n |tvr"td| ��t| }| jd|fvrDttd���|| _|| _dS )aX This sets the doctree versioning method for this environment.
Versioning methods are a builder property; only builders with the same
versioning method can share the same doctree directory. Therefore, we
raise an exception if the user tries to use an environment with an
incompatible versioning method.
z invalid versioning method: %rNzdThis environment is incompatible with the selected builder, please choose another doctree directory.)�callabler5 �
ValueErrorrC r r rD )rT rv rw Z conditionrU rU rV �set_versioning_method
s z&BuildEnvironment.set_versioning_method)�docnamerX c C sP || j v r2| j �|d� | j�|d� | j�|� | j�� D ]}|�|� q<dS )z4Remove all traces of a source file in the inventory.N)rF �poprI rJ �discardr7 ra � clear_doc)rT r{ rd rU rU rV r~ $ s
zBuildEnvironment.clear_doc)�docnames�otherr8 rX c C s� t |�}|D ]:}|j| | j|< |j| | j|< ||jv r | j�|� q | j�� D ]\}}|�||j| � qR| j �
d| ||� dS )z�Merge global information gathered about *docnames* while reading them
from the *other* environment.
This possibly comes from a parallel build process.
zenv-merge-infoN) rG rF rI rJ �addr7 �itemsZmerge_domaindatarO r@ �emit)rT r r� r8 r{ �
domainnamerd rU rU rV �merge_info_from. s
z BuildEnvironment.merge_info_from)�filenamerX c C s | j �|�S )z�Return the docname for the filename if the file is document.
*filename* should be absolute or relative to the source directory.
)rA �path2doc�rT r� rU rU rV r� @ s zBuildEnvironment.path2docT)r{ �baserX c C s | j �||�S )z�Return the filename for the document name.
If *base* is True, return absolute path under self.srcdir.
If *base* is False, return relative path to self.srcdir.
)rA �doc2path)rT r{ r� rU rU rV r� G s zBuildEnvironment.doc2path)r� r{ rX c C st t |�}|�d�s |�tj�r,|dd� }n&t�| j|p<| jdd��}t�||�}t t�
|��t�
t�| j |��fS )a+ Return paths to a file referenced from a document, relative to
documentation root and absolute.
In the input "filename", absolute filenames are taken as relative to the
source dir, while relative filenames are relative to the dir of the
containing document.
�/r0 N)r� ) r( �
startswith�os�sepr �dirnamer� r{ �joinr' �normpathr< )rT r� r{ Zrel_fnZdocdirrU rU rV �
relfn2pathO s � �zBuildEnvironment.relfn2pathc C s | j jS )z contains all existing docnames.)rA r �rT rU rU rV �
found_docsb s zBuildEnvironment.found_docsr* )r= �builderrX c
C s� z�| j j| j j |�� }| j�|� |jr�t| j| j j | j j
| j j �}dd� |j D �}| j
D ].}t|| j j�}||v r^| j| �|| � q^W n< ty� } z$ttd�| j|f �|�W Y d}~n
d}~0 0 dS )zYFind all source files in the source dir and put them in
self.found_docs.
c S s i | ]}|j |j�qS rU )rd Zmo_path)�.0�crU rU rV �
<dictcomp>{ � z/BuildEnvironment.find_files.<locals>.<dictcomp>z"Failed to scan documents in %s: %rN)r= Zexclude_patternsZtemplates_pathZget_asset_pathsrA ZdiscoverZuse_message_catalogr$ r< Z locale_dirsrt rs Zcatalogsr� r% Zgettext_compactrH r� �OSErrorr r ) rT r= r� Z
exclude_pathsZrepoZmo_pathsr{ rd �excrU rU rV �
find_filesg s, �� �
��zBuildEnvironment.find_files)�config_changedrX c
C s� t | j�| j }t � }t � }|r*| j}�nZ| jD �]P}|| jvrXt�d|� |�|� q0t�| j|d �}t� |�s�t�d|� |�|� q0|| j
v r�t�d|� |�|� q0| j| }t� | � |��}||kr�t�d|t
�|�t
�|�� |�|� q0| j| D ]~} zRt�| j| �}
t� |
��s2|�|� W q0t� |
�} | |k�rV|�|� W q0W n$ t�y| |�|� Y q0Y n0 �qq0|||fS )z&Return (added, changed, removed) sets.z[build target] added %r�.doctreez[build target] changed %rz$[build target] outdated %r: %s -> %s)rG rF r� �logger�debugr� r r� r; �isfilerJ �getmtimer� r ZutcfromtimestamprH r< r� ) rT r� ZremovedZaddedZchangedr{ r� �mtimeZnewmtimeZdepZdeppathZdepmtimerU rU rV �get_outdated_files� sV
�
z#BuildEnvironment.get_outdated_files)r8 �alreadyrX c c sB g }| j �d| �D ]}|�|� qt|�D ]}||vr*|V q*d S )Nzenv-get-updated)r@ r� �extendrG )rT r8 r� Z
to_rewriter r{ rU rU rV �check_dependents� s z!BuildEnvironment.check_dependentsc C s2 || j d< | jj| j d< | j�| jj�| j d< dS )z*Prepare to set up environment for reading.r{ � default_roleZdefault_domainN)rP r= r� r7 �getZprimary_domain)rT r{ rU rU rV �prepare_settings� s
�z!BuildEnvironment.prepare_settingsc C s
| j d S )z;Returns the docname of the document currently being parsed.r{ )rP r� rU rU rV r{ � s zBuildEnvironment.docnamere )�categoryrX c C s( |d }| j �|d�}|d | j |< |S )z�Return a serial number, e.g. for index entry targets.
The number is guaranteed to be unique in the current document.
Zserialnor r0 )rP r� )rT r� �keyZcurrU rU rV � new_serialno� s z BuildEnvironment.new_serialnoc C s | j | j �|� dS )z�Add *filename* as a dependency of the current document.
This means that the document will be rebuilt if this file changes.
*filename* should be absolute or relative to the source directory.
N)rH r{ r� r� rU rU rV �note_dependency� s z BuildEnvironment.note_dependencyc C s | j | j �| �|�� dS )z�Add *filename* as a included from other document.
This means the document is not orphaned.
*filename* should be absolute or relative to the source directory.
N)rI r{ r� r� r� rU rU rV �
note_included� s z BuildEnvironment.note_includedc C s | j �| j� dS )zxAdd the current document to the list of documents that will
automatically be re-read at the next build.
N)rJ r� r{ r� rU rU rV � note_reread� s z BuildEnvironment.note_reread)r� rX c
C sH z | j | W S tyB } z ttd�| �|�W Y d}~n
d}~0 0 dS )zReturn the domain instance with the specified name.
Raises an ExtensionError if the domain is not registered.
zDomain %r is not registeredN)r7 �KeyErrorr r )rT r� r� rU rU rV �
get_domain� s zBuildEnvironment.get_domainc C sb t �| j|d �}t|d��}t�|�}W d � n1 s<0 Y | |j_t| � |��|_
|S )z:Read the doctree for a file from the pickle and return it.r� �rbN) r r� r; �open�pickle�loadrE r9 r# r� Zreporter)rT r{ r� �f�doctreerU rU rV � get_doctree s (z BuildEnvironment.get_doctreeF)r{ r� r� �prune_toctrees�
includehiddenrX c C sj |du r| � |�}| �||� |�tj�D ]:}t| �j|||||d�}|du rZ|�g � q*|�|� q*|S )zgRead the doctree from the pickle, resolve cross-references and
toctrees and return it.
N)�pruner� )r� �apply_post_transforms�findallr �toctreer �resolveZ replace_self)rT r{ r� r� r� r� Z toctreenode�resultrU rU rV �get_and_resolve_doctree
s
� z(BuildEnvironment.get_and_resolve_doctreer ) r{ r� r� r� �maxdepth� titles_only�collapser� rX c
C s t | ��||||||||�S )a Resolve a *toctree* node into individual bullet lists with titles
as items, returning None (if no containing titles are found) or
a new node.
If *prune* is True, the tree is pruned to *maxdepth*, or if that is 0,
to the value of the *maxdepth* option on the *toctree* node.
If *titles_only* is True, only toplevel document titles will be in the
resulting tree.
If *collapse* is True, all branches not containing docname will
be collapsed.
)r r� ) rT r{ r� r� r� r� r� r� r� rU rU rV �resolve_toctree% s �z BuildEnvironment.resolve_toctree)r� � fromdocnamer� rX c C s | � ||� d S r] )r� )rT r� r� r� rU rU rV �resolve_references7 s z#BuildEnvironment.resolve_references)r� r{ rX c C sh zJt | j�}|| jd< t|�}|�| � |�| jj�� � |�� W || _n|| _0 | j �
d||� dS )zApply all post-transforms.r{ zdoctree-resolvedN) r rP r Zset_environmentZadd_transformsr8 r_ Zget_post_transformsZapply_transformsr@ r� )rT r� r{ ZbackupZ transformerrU rU rV r� ; s
z&BuildEnvironment.apply_post_transformsc s� t � �ttttttf d�� ��fdd� �i }�d � jj�}d }t|�\}}|D ]"\}}|||g||< |}|}|}qR||d g||< |S )N)�parentr{ rX c 3 s� | |kr"t jtd�|ddd� d S | |fV ��|� � j�|�pDg D ]4}�||�D ]$\}}|�vrT||fV ��|� qTqFd S )Nz'self referenced toctree found. Ignored.ZtocZcircular)�location�typeZsubtype)r� �warningr r� rM r� )r� r{ �childZ subparentZ
subdocname�rT �traverse_toctreeZ traversedrU rV r� O s
�
z<BuildEnvironment.collect_relations.<locals>.traverse_toctree)rG �strr r r= �root_doc�next)rT Z relationsr Zprevdocr� r{ Z
nextparentZnextdocrU r� rV �collect_relationsL s & z"BuildEnvironment.collect_relationsc C s� t � j| j�� � }t| j�D ]H}|| jvr || jjkr8q ||v rBq d| j | v rRq t
j t d�|d� q | j
�� D ] }|�� qp| j�d| � dS )zDo consistency checks.Zorphanz&document isn't included in any toctree)r� zenv-check-consistencyN)rG �unionrI ra rj rF rN r= r� rL r� r� r r7 �check_consistencyr@ r� )rT rI r{ rd rU rU rV r� n s
�
z"BuildEnvironment.check_consistency)N)T)N)re )NTF)Tr FFF)6�__name__�
__module__� __qualname__�__doc__r r� r �__annotations__rW r[ r^ rQ r rb rc r r �boolrz r~ r r� r
r� r� r r� �propertyr r� r� r� r
r� r� r{ �intr� r� r� r� r� r Zdocumentr� r� r r� r r� r� r� r� r� rU rU rU rV r6 X s`
^
� &9
�� �
� � "r6 )Qr� r� r� rR � collectionsr r r r �typingr r r r r
r r r
r r r Zdocutilsr Zdocutils.nodesr Zsphinxr Z
sphinx.configr Zsphinx.deprecationr Zsphinx.domainsr Z#sphinx.environment.adapters.toctreer Z
sphinx.errorsr r r r Z
sphinx.eventsr Z
sphinx.localer Zsphinx.projectr Zsphinx.transformsr Z sphinx.utilr r! r" Zsphinx.util.docutilsr# Zsphinx.util.i18nr$ r% Zsphinx.util.nodesr& Zsphinx.util.osutilr' r( Zsphinx.applicationr) Zsphinx.buildersr* Z getLoggerr� r� r. r� r� Z ENV_VERSIONrf rg rn ri ZCONFIG_CHANGED_REASONr5 r� r6 rU rU rU rV �<module> st
4
���