File: //lib/python3/dist-packages/sphinx/util/__pycache__/docutils.cpython-310.pyc
o
�$�a"J � @ s� U d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZmZ ddlZddlmZ dd lmZ dd
lmZm Z m Z dd l m Z m Z m!Z! dd l"m#Z# dd
l$m%Z%m&Z&m'Z' ddl(m)Z)m*Z* ddl+m,Z, ddl-m.Z. ddl/m0Z0 ddl1m2Z2 ddl3m4Z4 e2�5e6�Z7e�8d�Z9e r�ddl:m;Z; ddl<m=Z= ddl>m?Z? e,�@ejA�jBZCeD� ZEeee eFd< eded fdd ��ZGd eHdeIfd d �ZJd eHd ee ddfd!d"�ZKd eHdeIfd#d$�ZLd eHd%e4ddfd&d'�ZMd eHddfd(d)�ZNd*ee deIfd+d,�ZOd*ee ddfd-d.�ZPd*ee ddfd/d0�ZQeded fd1d2��ZRed3eeH ded fd4d5��ZSedWd3eeH ded fd6d7��ZTG d8d9� d9eU�ZVG d:d;� d;�ZWG d<d=� d=�ZXG d>d?� d?e)�ZYG d@dA� dAe)�ZZdeIfdBdC�Z[edDe%dEe'ded fdFdG��Z\G dHdI� dIe�Z]G dJdK� dKe �Z^G dLdM� dM�Z_G dNdO� dOe_�Z`G dPdQ� dQeja�Zbdaceejd eFdR< dWdSeHdTe dejdfdUdV�ZedS )Xz�
sphinx.util.docutils
~~~~~~~~~~~~~~~~~~~~
Utility functions for docutils.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�contextmanager)�copy)�path)�
ModuleType) �IO�
TYPE_CHECKING�Any�Callable�Dict� Generator�List�Optional�Set�Tuple�Type�cast)�nodes)�
FileOutput)�Element�Node�system_message)� Directive�
directives�roles)�Inliner)�State� StateMachine�
StringList)�Reporter�unescape)�version)� SphinxError)�_)�logging)� RoleFunctionz>^(.+?:(?:\d+)?): \((DEBUG|INFO|WARNING|ERROR|SEVERE)/(\d+)?\) )�Builder)�Config)�BuildEnvironment�additional_nodes�return)NNNc
c s~ � z&t tj�} t tj�}dV W | t_|t_tt�D ] }t|� t�|� qdS | t_|t_tt�D ] }t|� t�|� q2w )z"Create namespace for reST parsers.N) r r � _directivesr �_roles�listr( �unregister_node�discard)r* r+ �node� r0 �6/usr/lib/python3/dist-packages/sphinx/util/docutils.py�docutils_namespace0 s" �
�� �r2 �namec C �
| t jv S )z1Check the *name* directive is already registered.)r r* �r3 r0 r0 r1 �is_directive_registeredA �
r6 � directivec C � t �| |� dS )z�Register a directive to docutils.
This modifies global state of docutils. So it is better to use this
inside ``docutils_namespace()`` to prevent side-effects.
N)r �register_directive)r3 r8 r0 r0 r1 r: F � r: c C r4 )z,Check the *name* role is already registered.)r r+ r5 r0 r0 r1 �is_role_registeredO r7 r< �rolec C r9 )z�Register a role to docutils.
This modifies global state of docutils. So it is better to use this
inside ``docutils_namespace()`` to prevent side-effects.
N)r �register_local_role)r3 r= r0 r0 r1 �
register_roleT r; r? c C s t j�| d� dS )z Unregister a role from docutils.N)r r+ �popr5 r0 r0 r1 �unregister_role] � rA r/ c C s t tjd| j �S )z'Check the *node* is already registered.�visit_)�hasattrr �GenericNodeVisitor�__name__�r/ r0 r0 r1 �is_node_registeredb rB rH c C s2 t tjd| j �st�| jg� t�| � dS dS )z�Register a node to docutils.
This modifies global state of some visitors. So it is better to use this
inside ``docutils_namespace()`` to prevent side-effects.
rC N)rD r rE rF �_add_node_class_namesr( �addrG r0 r0 r1 �
register_nodeg s �rK c C sb t tjd| j �r/ttjd| j � ttjd| j � ttjd| j � ttjd| j � dS dS )zaUnregister a node from docutils.
This is inverse of ``nodes._add_nodes_class_names()``.
rC �depart_N)rD r rE rF �delattr�SparseNodeVisitorrG r0 r0 r1 r- r s �r- c # sR � ddl m� d dtdtdtf� fdd�
} z| tj_dV W � tj_dS � tj_w )
z�Patch docutils.languages.get_language() temporarily.
This ignores the second argument ``reporter`` to suppress warnings.
refs: https://github.com/sphinx-doc/sphinx/issues/3788
r �� get_languageN�
language_code�reporterr) c s � | �S �Nr0 )rQ rR rO r0 r1 �patched_get_language� � z2patched_get_language.<locals>.patched_get_languagerS )�docutils.languagesrP �strr r �docutils� languages)rT r0 rO r1 rT ~ s � rT �confdirc
c s� � z-t j�dd�}| rt�t�| �d�t jd< dV W |du r(t j�dd� dS |t jd< dS |du r;t j�dd� w |t jd< w )z?Let docutils know the location of ``docutils.conf`` for Sphinx.�DOCUTILSCONFIGNz
docutils.conf)�os�environ�getr �join�abspathr@ )rZ �docutilsconfigr0 r0 r1 �using_user_docutils_conf� s ��rb c c sl � t � �( t| �� dV W d � n1 sw Y W d � dS W d � dS 1 s/w Y dS )z Patch to docutils temporarily.N)rT rb )rZ r0 r0 r1 �patch_docutils� s �P�rc c @ s e Zd ZdS )�ElementLookupErrorN)rF �
__module__� __qualname__r0 r0 r0 r1 rd � s rd c
@ s� e Zd ZdZd!dd�Zd"dd �Zd
ee d ed eddfd
d�Z d"dd�Z
d"dd�Z de de defdd�Z
de dedejdeeee ee f fdd�Zd e ded ed edeeee f f
d d �ZdS )#�sphinx_domainszcMonkey-patch directive and role dispatch, so that domain-specific
markup takes precedence.
�envr' r) Nc C s || _ dd� | _dd� | _d S )Nc W � d g fS rS r0 ��argsr0 r0 r1 �<lambda>� � z)sphinx_domains.__init__.<locals>.<lambda>c W ri rS r0 rj r0 r0 r1 rl � rm )rh �directive_func�
roles_func)�selfrh r0 r0 r1 �__init__� s
zsphinx_domains.__init__c C � | � � d S rS )�enable�rp r0 r0 r1 � __enter__� � zsphinx_domains.__enter__�exc_type� exc_value� tracebackc C rr rS )�disable)rp rw rx ry r0 r0 r1 �__exit__� rv zsphinx_domains.__exit__c C s$ t j| _tj| _| jt _| jt_d S rS )r r8 rn r r= � role_func�lookup_directive� lookup_rolert r0 r0 r1 rs � s zsphinx_domains.enablec C s | j t_| jt_d S rS )rn r r8 r| r r= rt r0 r0 r1 rz � s zsphinx_domains.disable�typer3 c C s� |� � }d|v r6|�dd�\}}|| jjv r,| j�|�}t||�|�}|dur+|g fS n$t�td�||� n| jj �
d�}|durPt||�|�}|durP|g fS t| j�d�|�|�}|durc|g fS t �)ztLookup a markup element (directive or role), given its name which can
be a full name (with domain).
�:� Nz%unknown directive or role name: %s:%s�default_domain�std) �lower�splitrh �domains�
get_domain�getattr�logger�warningr" � temp_datar^ rd )rp r r3 � domain_name�domain�element�
def_domainr0 r0 r1 �lookup_domain_element� s& �z$sphinx_domains.lookup_domain_element�directive_name�language_module�documentc C s0 z| � d|�W S ty | �|||� Y S w )Nr8 )r� rd rn )rp r� r� r� r0 r0 r1 r} � s
�z sphinx_domains.lookup_directive� role_name�linenorR c C s2 z| � d|�W S ty | �||||� Y S w )Nr= )r� rd r| )rp r� r� r� rR r0 r0 r1 r~ � s
�zsphinx_domains.lookup_role)rh r' r) N�r) N)rF re rf �__doc__rq ru r � Exceptionr r{ rs rz rW r� r r r� r r
r r r r} �intr r$ r~ r0 r0 r0 r1 rg � s
0 .rg c @ s e Zd Zdeddfdd�ZdS )�
WarningStream�textr) Nc C sT t �|�}|st�|�d�� d S |�� \}}}t �d|��� }tj|||d� d S )Nz
� )�location)� report_re�searchr� r� �rstrip�groups�sub�log)rp r� �matchedr� r �level�messager0 r0 r1 �write� s
zWarningStream.write)rF re rf rW r� r0 r0 r0 r1 r� � s r� c
sZ e Zd Zededd fdd��Zejejddfdede d e d
e
d edd f � fd
d�
Z � Z S )�LoggingReporterrR r) c C s | |j |j|j|j|j�S )zACreate an instance of LoggingReporter from other reporter object.)�source� report_level�
halt_level�
debug_flag�
error_handler)�clsrR r0 r0 r1 �
from_reporter� s �z LoggingReporter.from_reporterF�backslashreplacer� r� r� �debugr� Nc s( t tt� �}t� j||||||d� d S )N)r� )r r r� �superrq )rp r� r� r� r� r� �stream�� __class__r0 r1 rq s
�zLoggingReporter.__init__)
rF re rf � classmethodr r� �
WARNING_LEVEL� SEVERE_LEVELrW r� �boolrq �
__classcell__r0 r0 r� r1 r� � s �����r� c s" e Zd ZdZd� fdd� Z� ZS )� NullReporterz A dummy reporter; write nothing.r) Nc s t � �ddd� d S )Nr� i� � )r� rq rt r� r0 r1 rq s zNullReporter.__init__r� )rF re rf r� rq r� r0 r0 r� r1 r� s r� c C s t dkS )N)r �
r )�__version_info__r0 r0 r0 r1 �is_html5_writer_available rU r� �state�contentc c sL � z | j jj}tg d�}||_|j| j j_dV W || j j_dS || j j_w )z1Switch current source input of state temporarily.N)�memorR �get_source_and_liner � input_lines)r� r� r� �
state_machiner0 r0 r1 �switch_source_input s �
r� c s@ e Zd ZdZdeddf� fdd� Zdedef� fdd � Z� ZS )
�SphinxFileOutputz#Better FileOutput class for Sphinx.�kwargsr) Nc s$ |� dd�| _t� jdi |�� d S )N�overwrite_if_changedFr0 )r@ r� r� rq )rp r� r� r0 r1 rq , s zSphinxFileOutput.__init__�datac s� | j r<| jr<d| jvr<| jr<tj�| j �r<t| j | jd��}|� � |kr-|W d � S W d � n1 s7w Y t
� � |�S )N�b)�encoding) �destination_path� autoclose�moder� r\ r �exists�openr� �readr� r� )rp r� �fr� r0 r1 r� 0 s � � � � zSphinxFileOutput.write) rF re rf r� r rq rW r� r� r0 r0 r� r1 r� ) s r� c @ sb e Zd ZdZeddd��Zeddd��Zdeee f fd d
�Z
d e dd fd
d�Z defdd�Z
d S )�SphinxDirectivez�A base class for Sphinx directives.
This class provides helper methods for Sphinx directives.
.. note:: The subclasses of this class might not work with docutils.
This class is strongly coupled with Sphinx.
r) r' c C � | j jjjS �z3Reference to the :class:`.BuildEnvironment` object.)r� r� �settingsrh rt r0 r0 r1 rh D � zSphinxDirective.envr& c C � | j jS �z)Reference to the :class:`.Config` object.�rh �configrt r0 r0 r1 r� I � zSphinxDirective.configc C s | j �| j�S )zGet source and line number.)r� r� r� rt r0 r0 r1 �get_source_infoN s z SphinxDirective.get_source_infor/ Nc C s | � � \|_|_dS )z'Set source and line number to the node.N�r� r� �line)rp r/ r0 r0 r1 �set_source_infoR s z SphinxDirective.set_source_infoc C � d� dd� | �� D ��S )�&Get current location info for logging.r� c s � � | ]}t |�V qd S rS �rW ��.0�sr0 r0 r1 � <genexpr>X � � z/SphinxDirective.get_location.<locals>.<genexpr>�r_ r� rt r0 r0 r1 � get_locationV � z SphinxDirective.get_location�r) r' �r) r& )rF re rf r� �propertyrh r� r rW r� r� r r� r� r0 r0 r0 r1 r� ; s r� c @ s e Zd ZU dZeed< eed< eed< eed< eed< eed< e e ed< i g fdedededededede e d e
e e e e f fd
d �Z
d e
e e e e f fd d
�Zed dd��Zed dd��Zd ded e
eef fdd�Zd de ded dfdd�Zd efdd�ZdS ) �
SphinxRolez�A base class for Sphinx roles.
This class provides helper methods for Sphinx roles.
.. note:: The subclasses of this class might not work with docutils.
This class is strongly coupled with Sphinx.
r3 �rawtextr� r� �inliner�optionsr� r) c C sx || _ t|�| _|| _|| _|| _|| _|r |�� | _| �� S | j j
� dd�| _| js1| j j j
| _| js8td��| �� S )N� default_roler� z cannot determine default role!)r� r r� r� r� r� r� r� r3 rh r� r^ r� r� r! �run)rp r3 r� r� r� r� r� r� r0 r0 r1 �__call__m s
� zSphinxRole.__call__c C s t �rS )�NotImplementedErrorrt r0 r0 r1 r� � s zSphinxRole.runr' c C r� r� )r� r� r� rh rt r0 r0 r1 rh � r� zSphinxRole.envr& c C r� r� r� rt r0 r0 r1 r� � r� zSphinxRole.configNc C s |d u r| j }| jj�|�S rS )r� r� rR r� )rp r� r0 r0 r1 r� � s zSphinxRole.get_source_infor/ c C s | � |�\|_|_d S rS r� )rp r/ r� r0 r0 r1 r� � s zSphinxRole.set_source_infoc C r� )r� r� c s r� rS r� r� r0 r0 r1 r� � r� z*SphinxRole.get_location.<locals>.<genexpr>r� rt r0 r0 r1 r� � r� zSphinxRole.get_locationr� r� rS )rF re rf r� rW �__annotations__r� r r
r r r r r� r� r� rh r� r� r� r� r0 r0 r0 r1 r� [ s6
����
� r� c s� e Zd ZU dZeed< eed< eed< eed< e�dej �Z
i g fdeded ed
e d e d e
d
ee deee ee f f� fdd�
Z� ZS )�
ReferenceRolez�A base class for reference roles.
The reference roles can accept ``link title <target>`` style as a text for
the role. The parsed result; link title and target will be stored to
``self.title`` and ``self.target``.
�has_explicit_title�disabled�title�targetz^(.+?)\s*(?<!\x00)<(.*?)>$r3 r� r� r� r� r� r� r) c sv |� d�| _| j�|�}|r"d| _t|�d��| _t|�d��| _n
d| _t|�| _t|�| _t � �
|||||||�S )N�!Tr� � F) �
startswithr� �explicit_title_re�matchr� r �groupr� r� r� r� ) rp r3 r� r� r� r� r� r� r� r� r0 r1 r� � s
zReferenceRole.__call__)rF re rf r� r� r� rW �re�compile�DOTALLr r� r r
r r r r r� r� r0 r0 r� r1 r� � s"
�����r� c s\ e Zd ZdZdejddddf� fdd� Zd eddf� fd
d � Zd eddf� fd d
� Z � Z
S )�SphinxTranslatorax A base class for Sphinx translators.
This class adds a support for visitor/departure method for super node class
if visitor/departure method for node class is not found.
It also provides helper methods for Sphinx translators.
.. note:: The subclasses of this class might not work with docutils.
This class is strongly coupled with Sphinx.
r� �builderr% r) Nc s& t � �|� || _|j| _|j| _d S rS )r� rq r r� r� )rp r� r r� r0 r1 rq � s zSphinxTranslator.__init__r/ c �B |j jD ]}t| d|j d�}|r||� dS qt� �|� dS )z�
Dispatch node to appropriate visitor method.
The priority of visitor method is:
1. ``self.visit_{node_class}()``
2. ``self.visit_{super_node_class}()``
3. ``self.unknown_visit()``
zvisit_%sN)r� �__mro__r� rF r� �dispatch_visit�rp r/ �
node_class�methodr� r0 r1 r � � �z SphinxTranslator.dispatch_visitc r
)z�
Dispatch node to appropriate departure method.
The priority of departure method is:
1. ``self.depart_{node_class}()``
2. ``self.depart_{super_node_class}()``
3. ``self.unknown_departure()``
z depart_%sN)r� r r� rF r� �dispatch_departurer
r� r0 r1 r � r z#SphinxTranslator.dispatch_departure) rF re rf r� r r� rq r r r r� r0 r0 r� r1 r � s
r �__document_cache__� source_pathr� c C sT t du r
tj�| �a |du rtt j�}ddlm} |j|t j | d�}|�
| d� |S )a& Return a new empty document object. This is an alternative of docutils'.
This is a simple wrapper for ``docutils.utils.new_document()``. It
caches the result of docutils' and use it on second call for instantiation.
This makes an instantiation of document nodes much faster.
Nr )�addnodes)r� ���) r rX �utils� new_documentr r� �sphinxr r� rR � note_source)r r� r r� r0 r0 r1 r � s
r rS )fr� r\ r �
contextlibr r r �typesr �typingr r r r r
r r r
r r r r rX r � docutils.ior �docutils.nodesr r r �docutils.parsers.rstr r r �docutils.parsers.rst.statesr �docutils.statemachiner r r �docutils.utilsr r � packagingr �
sphinx.errorsr! �
sphinx.localer" � sphinx.utilr# �sphinx.util.typingr$ � getLoggerrF r� r r� �sphinx.buildersr% �
sphinx.configr& �sphinx.environmentr' �parse� __version__�releaser� �setr( r� r2 rW r� r6 r: r< r? rA rH rK r- rT rb rc r� rd rg r� r� r� r� r� r� r� r� r� � NodeVisitorr r r� r r0 r0 r0 r1 �<module> sx
8
E B"7