File: //usr/lib/python3/dist-packages/sphinx/builders/__pycache__/__init__.cpython-310.pyc
o
�$�azc � @ s� d Z ddlZddlZddlmZ ddlmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZ ddlmZ ddlmZ ddlmZ ddlmZmZmZ dd lm Z dd
l m Z dd l m Z dd l!m"Z" dd
l#m$Z$ ddl%m&Z&m'Z'm(Z(m)Z)m*Z* ddl+m,Z, ddl-m.Z. ddl/m0Z0 ddl1m2Z2m3Z3m4Z4 ddl5m6Z6m7Z7m8Z8m9Z9 ddl:m;Z;m<Z<m=Z=m>Z> ddl?m@Z@ ddlAmBZB ddlAmCZC zddlDZDW n eEy� dZDY nw er�ddlFmGZG e'�HeI�ZJG dd� d�ZKdS )z�
sphinx.builders
~~~~~~~~~~~~~~~
Builder superclass for all builders.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�path) �
TYPE_CHECKING�Any�Dict�Iterable�List�Optional�Sequence�Set�Tuple�Type�Union)�nodes)�Node)�Config)�CONFIG_CHANGED_REASON� CONFIG_OK�BuildEnvironment)� ImageAdapter)� SphinxError)� EventManager)�read_doc)�__)�
import_object�logging�progress_message�rst�status_iterator)�
BuildPhase)�bold)�sphinx_domains)� CatalogInfo�CatalogRepository�docname_to_domain)�SEP� ensuredir� relative_uri�relpath)�
ParallelTasks� SerialTasks� make_chunks�parallel_available)�Tags)�
directives)�roles)�Sphinxc @ s� e Zd ZU dZdZdZdZdZee j
e d< dZ dZ
dZdZg Zee e d< dZdZdbd d
�Zded dfdd�Zded ee j
fdd�Zded e j
fdd�Zdcdd�Zdcdd�Z dddeded efd d �Z ddd ed eded efd d!�Z d e ee e f fd"d#�Z!d ee fd$d%�Z"d&e#d dfd'd(�Z$d)e%e& d*ed dfd+d,�Z'dcd-d.�Z(d/ee d dfd0d1�Z)dcd2d3�Z*dcd4d5�Z+d6ee d dfd7d8�Z,dcd9d:�Z-ded<e e d=ed>ed dfd?d@�Z.d ee fdAdB�Z/d<ee d dfdCdD�Z0d<ee dEe1d dfdFdG�Z2ded dfdHdI�Z3ded&e j4d dfdJdK�Z5dfdLe e dMe6e d>ed dfdNdO�Z7d<e6e d dfdPdQ�Z8d<e6e dEe1d dfdRdS�Z9d<e%e d dfdTdU�Z:ded&e j4d dfdVdW�Z;ded&e j4d dfdXdY�Z<dcdZd[�Z=dcd\d]�Z>d^ed_ed efd`da�Z?dS )g�Builderz6
Builds target formats from the reST sources.
� N�default_translator_class�noneFT�supported_image_types�appr/ �returnc C s� |j | _ |j| _|j| _|j| _t| j� || _d | _|j| _|j| _|j | _ | j �
| j � | j �
| j � | j �
d| j � | j �
d| j � i | _
d| _d| _d| _d | _d S )Nz format_%sz
builder_%sr1 F)�srcdir�confdir�outdir�
doctreedirr% r5 �env�events�config�tags�add�format�name�images�imagedir�imgpath� parallel_ok� finish_tasks)�selfr5 � rH �:/usr/lib/python3/dist-packages/sphinx/builders/__init__.py�__init__T s&
zBuilder.__init__r; c C s || _ | j �| j| j� dS )z Store BuildEnvironment object.N)r; �set_versioning_method�versioning_method�versioning_compare)rG r; rH rH rI �set_environmentp s
�zBuilder.set_environment�argsc G s | j j�| �S )z Return a class of translator.)r5 �registry�get_translator_class�rG rO rH rH rI rQ v s z Builder.get_translator_classc G s | j jj| g|�R � S )z�Return an instance of translator.
This method returns an instance of ``default_translator_class`` by default.
Users can replace the translator class with ``app.set_translator()`` API.
)r5 rP �create_translatorrR rH rH rI rS z s zBuilder.create_translatorc C � dS )zoLoad necessary templates and perform initialization. The default
implementation does nothing.
NrH �rG rH rH rI �init� � z Builder.initc C s6 | j jrt| j jd�� | _dS ddlm} |� | _dS )z&Return the template bridge configured.ztemplate_bridge settingr )�BuiltinTemplateLoaderN)r= �template_bridger � templates�sphinx.jinja2gluerX )rG rX rH rH rI �create_template_bridge� s � z Builder.create_template_bridge�docname�typc C � t �)z�Return the target URI for a document name.
*typ* can be used to qualify the link characteristic for individual
builders.
��NotImplementedError)rG r] r^ rH rH rI �get_target_uri� s zBuilder.get_target_uri�from_�toc C s t | �|�| �||��S )z�Return a relative URI between two source filenames.
May raise environment.NoUri if there's no way to return a sensible URI.
)r& rb )rG rc rd r^ rH rH rI �get_relative_uri� s
�zBuilder.get_relative_uric C r_ )aD Return an iterable of output files that are outdated, or a string
describing what an update build will build.
If the builder does not output individual files corresponding to
source files, return a string here. If it does, return an iterable
of those files that need to be written.
r` rU rH rH rI �get_outdated_docs� s zBuilder.get_outdated_docsc C s g S )z;Return list of paths for assets (ex. templates, CSS, etc.).rH rU rH rH rI �get_asset_paths� � zBuilder.get_asset_paths�doctreec C s� t | j�}|�tj�D ]f}d|d v rq d|d vr[| jD ]}|d �|d�}|r+ n+q t|d �}|�|d �}|rIt j
t d�| j |||d� n t j
t d�| j ||d� q ||d< n|d }|| jj
vrfq | jj
| d | j
|< q dS )
z+Pick the best candidate for all image URIs.�?�
candidates�*N�uriz2a suitable image for %s builder not found: %s (%s))�locationz-a suitable image for %s builder not found: %s� )r r; �traverser �imager4 �get�sorted�get_original_image_uri�logger�warningr rA rB )rG ri rB �node�imgtype� candidate� mimetypes� image_urirH rH rI �post_process_images� s4
�
�
�
�zBuilder.post_process_images�catalogs�messagec sv � j jsd S dtdtf� fdd� }t�ttd��| � t|td�dt |�� j
j |d�D ] }|� � j j
� j j� q,d S ) N�catr6 c s t | j� jj��tjt�S �N)r' �mo_pathr; r7 �replacer �sepr$ )r rU rH rI � cat2relpath� s z-Builder.compile_catalogs.<locals>.cat2relpathzbuilding [mo]: �writing output... � darkgreen)�stringify_func)r= �gettext_auto_buildr! �strru �infor r r �lenr5 � verbosity�write_mo�language� gettext_allow_fuzzy_translations)rG r} r~ r� �catalogrH rU rI �compile_catalogs� s
�
��zBuilder.compile_catalogsc C sH t | j| jj| jj| jj�}td�tt|j �� }| �
t |j �|� d S )Nzall of %d po files) r" r7 r= � locale_dirsr� �source_encodingr r� �listr} r� �set)rG �repor~ rH rH rI �compile_all_catalogs� s
�z Builder.compile_all_catalogs�specified_filesc s� dt dtt f� fdd� }t� }tt||��}t� j� jj� jj� jj �}|j
D ]}|j |v r8|� � r8|�
|� q(td�t|� }� �||� d S )N�fpathr6 c s( � j �t�| ��}|rt|� jj�S d S r� )r; �path2docr �abspathr# r= �gettext_compact)r� r] rU rH rI � to_domain� s z4Builder.compile_specific_catalogs.<locals>.to_domainz*targets for %d po files that are specified)r� r r� �mapr" r7 r= r� r� r� r} �domain� is_outdatedr? r r� r� )rG r� r� r} �domainsr� r� r~ rH rU rI �compile_specific_catalogs� s �
�z!Builder.compile_specific_catalogsc C sL t | j| jj| jj| jj�}dd� |jD �}td�t|� }| � ||� d S )Nc S s h | ]}|� � r|�qS rH )r� )�.0�crH rH rI � <setcomp>� s z2Builder.compile_update_catalogs.<locals>.<setcomp>z,targets for %d po files that are out of date)
r" r7 r= r� r� r� r} r r� r� )rG r� r} r~ rH rH rI �compile_update_catalogs� s �z Builder.compile_update_catalogsc C s | j dtd�dd� dS )zBuild all source files.Nzall source files�all)�summary�method)�buildr rU rH rH rI � build_all s zBuilder.build_all� filenamesc C s� t | j�d }g }t| jj�}|D ]N}t�t�|��}|�| j�s*t �
t d�|� qt� |�s8t �
t d�|� q||d� }|D ]}|�
|�rR|dt |� � } nq@|�tjt�}|�|� q| j|dt d�t |� d� dS )z>Only rebuild as much as needed for changes in the *filenames*.ro zIfile %r given on command line is not under the source directory, ignoringz6file %r given on command line does not exist, ignoringN�specificz%%d source files given on command line)r� r� )r� r7 �tupler= �
source_suffixr �normpathr� �
startswithru rv r �isfile�endswithr� r� r$ �appendr� )rG r� �dirlen�to_write�suffixes�filename�suffixrH rH rI �build_specific s4
�
�
�
�zBuilder.build_specificc C sJ | � � }t|t�r| �dg|� dS t|�}| j|td�t|� d� dS )z8Only rebuild what was changed or added since last build.�__all__z0targets for %d source files that are out of date)r� N)rf �
isinstancer� r� r� r r� )rG �to_buildrH rH rI � build_update s
�
�zBuilder.build_update�update�docnamesr� r� c
C s, |rt �ttd�| j �| � t�� � t| �� �}W d � n1 s%w Y t |�}t jttd��dd� | j
� | j |�D ]}|�
|� qAt |�| }|rZt �td�|� nt �td�� |r�dd lm} ttd
���+ tt�| j|�d ��} t�| j
| tj� W d � n1 s�w Y W d � n1 s�w Y tj| j _ttd ���
| j
�� W d � n1 s�w Y n|d
kr�|s�t �ttd��� dS tj | j _|r�|dgkr�t|�| j
j @ }t r�| j j dkr�| j r�| j �!d�| _"nd| _"t#� | _$| �%|t&|�|� | �'� | j$�� dS )zaMain build method.
First updates the environment, and then calls :meth:`write`.
zbuilding [%s]: Nz"looking for now-outdated files... T��nonlz%d foundz
none foundr )�ENV_PICKLE_FILENAMEzpickling environment�wbzchecking consistencyr� zno targets are out of date.r� ro �writeF)(ru r� r r rA r �pending_warningsr� �readr� r; �check_dependentsr5 r? �sphinx.applicationr� r �openr �joinr: �pickle�dump�HIGHEST_PROTOCOLr �CONSISTENCY_CHECK�phase�check_consistency� RESOLVING�
found_docsr+ �parallel�allow_parallel�is_parallel_allowedrE r) rF r� r� �finish)
rG r� r� r� �updated_docnames�doccountr] �outdatedr� �frH rH rI r� * sN
� �� �
��
z
Builder.buildc C s� t jttd��dd� | j�| j| � | jjtk}| j� |�\}}}| j
� d| j|||�D ]
}|� t
|�| jj@ � q-|s?|rJ|� | jj| jj@ � |rbt�| jjd�| jjpXd }t jd|dd� t �td�t|�t|�t|�� |D ]}| j
� d| j|� | j�|� qtt||B �}| j
� d | j|� tr�t|�d
kr�| jjd kr�| j�d �} nd
} | r�| j|| jjd� n| �|� | jj | jj vr�t d| j� | jj � ��| j
� d| j�D ] }
|
dur�|� |
� q�t| j_t|�S )z�(Re-)read all files new or changed since last update.
Store all environment docnames in the canonical format (ie using SEP as
a separator in place of os.path.sep).
zupdating environment: Tr� zenv-get-outdatedr1 z[%s] z %s added, %s changed, %s removed�
env-purge-doczenv-before-read-docs� ro r� F��nproczroot file %s not foundz env-updatedN)!ru r� r r r; �
find_filesr= �
config_statusr �get_outdated_filesr< �emitr� r� r� �
glob_toctreesr rr �config_status_extrar� � clear_docrs r+ r5 r� r� �_read_parallel� _read_serial�root_doc�all_docsr �doc2path�extend) rG �updated�added�changed�removed�docs�reasonr] r� �par_ok�retvalrH rH rI r� n sJ
�
�
�
�z Builder.readc C sN t |td�dt|�| jj�D ]}| j�d| j|� | j�|� | � |� qd S )N�reading sources... �purpler� )
r r r� r5 r� r< r� r; r� r )rG r� r] rH rH rI r� � s � �zBuilder._read_serialr� c s� |D ]}� j �d� j|� � j�|� qdtt dtf� fdd� }dtt dtdd f� fdd� }t|�}t||�}t |t
d �d
t |�� j j
�D ] }|�|||� qGt�tt
d ��� |�� d S ) Nr� r� r6 c s. � j � j_ | D ]}� �|� qt�� jtj�S r� )r5 r; r r� �dumpsr� )r� r] rU rH rI � read_process� s
z,Builder._read_parallel.<locals>.read_process�otherenvc s t �|�}� j�| |� j� d S r� )r� �loadsr; �merge_info_fromr5 )r� r� r; rU rH rI �merge� s
z%Builder._read_parallel.<locals>.merger� r� �waiting for workers...)r< r� r; r� r r� �bytesr( r* r r r� r5 r� �add_taskru r� r r� ) rG r� r� r] r� r� �tasks�chunks�chunkrH rU rI r� � s
� zBuilder._read_parallelc C s� | j �|� t�| jd�}t�|�r| j �|� t| j ��, t� || j
j �� t | j | j | j �
|��}W d � n1 s=w Y W d � n1 sLw Y tt�� t�| j �
|���| j j|< | j j�� | j j�� | �||� dS )z>Parse a file and add/update inventory entries for the doctree.z
docutils.confN)r; �prepare_settingsr r� r8 r� �note_dependencyr r � default_roler= r r5 r� �max�time�getmtimer� � temp_data�clear� ref_context�
write_doctree)rG r] � docutilsconfri rH rH rI r � s
�� � zBuilder.read_docc C s� d|_ d|_d|j_d|j_d|j_t�| j|d �}t t�
|�� t |d��}t �
||t j� W d � dS 1 s;w Y dS )z Write the doctree to a file.Nz.doctreer� )�reporter� transformer�settings�warning_streamr; �record_dependenciesr r� r: r% �dirnamer� r� r� r� )rG r] ri �doctree_filenamer� rH rH rI r � s "�zBuilder.write_doctree�build_docnamesr� c C s |d u s |dgkr
| j j}|dkrt|�t|�B }nt|�}t�td�d�t|��� t|�D ]}| j j �
|t� �D ]
}|| j jv rG|� |� q:q/|� | j j
� ttd���
| �|� W d � n1 sfw Y | jr}| jt|�| jjd d� d S | �t|�� d S )Nr� r� zdocnames to write: %sz, zpreparing documentsro r� )r; r� r� ru �debugr r� rs r� �files_to_rebuildrr r? r= r� r �prepare_writingrE �_write_parallelr5 r� �
_write_serial)rG r r� r� r� r] �
tocdocnamerH rH rI r� � s*
�� �
�z
Builder.writec C s� t �� �7 t|td�dt|�| jj�D ] }tj| j_ | j
� || �}tj | j_ | �
||� | �||� qW d � d S 1 s>w Y d S )Nr� r� )r r� r r r� r5 r� r r� r� r; �get_and_resolve_doctree�WRITING�write_doc_serialized� write_doc)rG r� r] ri rH rH rI r s
�
�"�zBuilder._write_serialc s dt tttjf dd f� fdd� }|d |dd � }}tj� j_� j �
|� �}tj � j_� � ||� � �
||� t|�}t||�}tj� j_t|td�dt|�� jj�D ]'}g } t|�D ]\}
} � j �
| � �}� � | |� | �| |f� q^|�|| � qVt�ttd ��� |�� d S )
Nr� r6 c s( t j� j_| D ]
\}}� �||� qd S r� )r r r5 r� r )r� r] ri rU rH rI �
write_process! s
�z.Builder._write_parallel.<locals>.write_processr ro r� r� r� )r r r� r �documentr r� r5 r� r; r r r r r( r* r r r� r� � enumerater� r� ru r� r r� ) rG r� r� r � firstnameri r r r �arg�ir] rH rU rI r s* $
� zBuilder._write_parallelc C r_ )z?A place where you can add logic before :meth:`write_doc` is runr` )rG r� rH rH rI r ? rh zBuilder.prepare_writingc C r_ )z5Where you actually write something to the filesystem.r` �rG r] ri rH rH rI r C rh zBuilder.write_docc C rT )zoHandle parts of write_doc that must be called in the main process
if parallel build is active.
NrH r& rH rH rI r G rW z Builder.write_doc_serializedc C rT )zWFinish the building process.
The default implementation does nothing.
NrH rU rH rH rI r� M � zBuilder.finishc C rT )zQCleanup any resources.
The default implementation does nothing.
NrH rU rH rH rI �cleanupT r' zBuilder.cleanup�option�defaultc C sH zd| j |f }t| j|�W S ty# d||f }t| j|� Y S w )z�Return a builder specific option.
This method allows customization of common builder settings by
inserting the name of the current builder in the option key.
If the key does not exist, use default as builder name.
z%s_%s)rA �getattrr= �AttributeError)rG r) r* �optnamerH rH rI �get_builder_config[ s �zBuilder.get_builder_config)r5 r/ r6 N)r6 Nr� )Nr� )r� )@�__name__�
__module__� __qualname__�__doc__rA r@ �epilogr2 r r � NodeVisitor�__annotations__rL rM r� �use_message_catalogr4 r r� �supported_remote_images�supported_data_uri_imagesrJ r rN r rQ rS rV r\ rb re r
r rf rg r r| r
r! r� r� r� r� r� r� r� r� r� r� �intr� r r! r r r� r r r r r r� r( r. rH rH rH rI r0 3 s\
!
D@ $
r0 )Lr2 r� r �osr �typingr r r r r r r r
r r r
�docutilsr �docutils.nodesr �
sphinx.configr �sphinx.environmentr r r �!sphinx.environment.adapters.assetr �
sphinx.errorsr �
sphinx.eventsr � sphinx.ior �
sphinx.localer � sphinx.utilr r r r r �sphinx.util.build_phaser �sphinx.util.consoler �sphinx.util.docutilsr �sphinx.util.i18nr! r" r# �sphinx.util.osutilr$ r% r& r' �sphinx.util.parallelr( r) r* r+ �sphinx.util.tagsr, �sphinxr- r. �multiprocessing� ImportErrorr� r/ � getLoggerr/ ru r0 rH rH rH rI �<module> sB
4 �