File: //lib/python3/dist-packages/sphinx/util/__pycache__/nodes.cpython-310.pyc
o
�$�a?Y � @ s d Z ddlZddlZddlmZmZmZmZmZm Z m
Z
m Z m Z m
Z
mZ ddlmZ ddlmZmZ ddlmZ ddlmZ ddlmZ dd lmZ dd
l m Z dd l m Z erpdd l m!Z! dd
l"m#Z# ddl$m%Z% ddl&m'Z' e �(e)�Z*e�+dej,�Z-e-Z.G dd� d�Z/dede0fdd�Z1d�dede2de0fdd�Z3deddfdd �Z4ej5ej6ej7ej8fZ9dede:fd d �Z;dede:fd d �Z<ej6ej7ej=ej>fZ?ej@fZAejBfZCd!edee ee0f fd"d#�ZDdede e0 fd$d%�ZEdede e2 fd&d'�ZFd�ded(edee fd)d*�ZGdede e fd+d,�ZHd!edee eed- f fd.d/�ZId0ed1edede0fd2d3�ZJdede0fd4d5�ZKd6e0de e:e0e0f fd7d8�ZLg d9�ZMd:e0d;e0dee e0e0e0e0e e0 f fd<d=�ZNd>d?d@e
e0 dAe0dBejOdCedDee0 dejOfdEdF�ZPdGe0de0fdHdI�ZQe�+dJ�ZRe�+dK�ZSi dLdM�dNdO�dPdQ�dRdS�dTdU�dVdW�dXdY�dZdY�d[d\�d]dO�d^d_�d`da�dbdU�dcdd�dedf�dgdW�dhdW�i didj�dkdl�dmdn�dodl�dpdU�dqdd�drdW�dsdt�dud\�dvdw�dxdl�dydz�d{dt�d|d}�d~d�d�dj��ZTd�d�d�d�d�d��ZU d�d�d�d�ejOd�e0d�e0de0f
d�d��ZVdejWd�e0de e fd�d��ZX d�d>d?d�e0d�e0d;e0d�e
eee f d�e0dejYfd�d��ZZd�ededdfd�d��Z[d�ed�e2deddfd�d��Z\d�ed�eddfd�d��Z]ej^ej_ej`ej@ej>ejaejbfZcdede:fd�d��Zdd�ed�d�ddfd�d��Zed�edefd�d��Zfefej_gdS )�z�
sphinx.util.nodes
~~~~~~~~~~~~~~~~~
Docutils node-related utility functions for Sphinx.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N) �
TYPE_CHECKING�Any�Callable�Iterable�List�Optional�Set�Tuple�Type�Union�cast)�nodes)�Element�Node)� Directive)�Inliner)�
StringList)�addnodes)�__)�logging)�Builder)�
IndexEntry)�BuildEnvironment)�Tagsz ^(.+?)\s*(?<!\x00)<([^<]*?)>$c @ sN e Zd ZdZdee deddfdd�Zdedefd d
�Z dedefd d �Z
dS )
� NodeMatchera% A helper class for Node.traverse().
It checks that the given node is an instance of the specified node-classes and
has the specified node-attributes.
For example, following example searches ``reference`` node having ``refdomain``
and ``reftype`` attributes::
matcher = NodeMatcher(nodes.reference, refdomain='std', reftype='citation')
doctree.traverse(matcher)
# => [<reference ...>, <reference ...>, ...]
A special value ``typing.Any`` matches any kind of node-attributes. For example,
following example searches ``reference`` node having ``refdomain`` attributes::
from typing import Any
matcher = NodeMatcher(nodes.reference, refdomain=Any)
doctree.traverse(matcher)
# => [<reference ...>, <reference ...>, ...]
� node_classes�attrs�returnNc O s || _ || _d S �N)�classesr )�selfr r � r! �3/usr/lib/python3/dist-packages/sphinx/util/nodes.py�__init__> s
zNodeMatcher.__init__�nodec C s� z=| j r
t|| j �s
W dS | jr;t|tj�sW dS | j�� D ] \}}||vr* W dS |tu r/q |�|�|kr: W dS q W dS tyG Y dS w )NFT) r �
isinstancer r
r �itemsr �get� Exception)r r$ �key�valuer! r! r" �matchB s$ � �zNodeMatcher.matchc C s
| � |�S r )r+ )r r$ r! r! r" �__call__X s
zNodeMatcher.__call__) �__name__�
__module__� __qualname__�__doc__r
r r r# �boolr+ r, r! r! r! r" r ( s
r r$ r c C s d� | j| jj�S )z�
Return full module dotted path like: 'docutils.nodes.paragraph'
:param nodes.Node node: target node
:return: full module dotted path
z{}.{})�formatr. � __class__r- �r$ r! r! r" �get_full_module_name\ s r5 �P �lengthc C sP z| � � �� }W n
ty t| �}Y nw |r&t|�|kr&|d|� d }|S )a�
return DOM XML representation of the specified node like:
'<paragraph translatable="False"><inline classes="versionmodified">New in version...'
:param nodes.Node node: target node
:param int length:
length of return value to be striped. if false-value is specified, repr_domxml
returns full of DOM XML representation.
:return: DOM XML representation
Nz...)�asdom�toxmlr( �str�len)r$ r7 �textr! r! r" � repr_domxmlf s �r= c C s� t | tj�r'| js't�dt| �t| �� | j}|j | _ |j
d | _
| � � | _nt | tj�r5| j s5| jj | _ t | tj �rV| j d u rVt�dt| �t| �� | jj | jj
| _ | _
t | tj
�rw| j d u rwt�dt| �t| �� | jj | jj
| _ | _
t | tj�r�t�dt| �t| �� tt| j�tj���D ]}t�dt�|� � � d| j�| _q�t | tj�r�| j d u r�t| �| _ | js�| � � | _| j r�| jr�d S t | tjtj
tj tjf�r�t�dt| �t| �� t| �p�d| _ d | _
d S d S )
Nz7[i18n] PATCH: %r to have source, line and rawsource: %s� z)[i18n] PATCH: %r to have source, line: %sz#[i18n] PATCH: %r to have source: %sz&[i18n] PATCH: %r to have rawsource: %sz \s*:\s*%s� z,[i18n] PATCH: %r to have source and line: %sr )r% r
�
classifier� rawsource�logger�debugr5 r= �parent�source�line�astext�image�title�term�reversed�list�traverse�re�sub�escape�
literal_block�get_node_source�rubric�
field_name)r$ �definition_list_itemr@ r! r! r" �apply_source_workaroundz s^ �
� � ��
� ��rV c C s0 t | tj�rt | j�dd g�d tj�rdS dS )Nr
r TF)r% r
�pending�detailsr' r �metar4 r! r! r" �is_pending_meta� s
�rZ c C s" t | tj�rdS t | tj�r| �d�s| �d�rdS t | tj�r&d| vr&dS t | tj�r�| js<t �
dt | �t | �� dS t | t
�rRd| vrRt �
dt | �t | �� dS | �dd�set �
dt | �t | �� dS t | tj�r| jd d krt �
d
t | �t | �� dS dS t | tj�r�dS t| �r�dS dS ) NT� translatable�altFz)[i18n] SKIP %r because no node.source: %szO[i18n] SKIP %r because node is in IGNORED_NODES and no node['translatable']: %sz3[i18n] SKIP %r because not node['translatable']: %sr �orphanz&[i18n] SKIP %r because orphan node: %s)r% r r[ r
rH r' �Inline� TextElementrE rB rC r5 r= �
IGNORED_NODESrT �childrenrY rZ r4 r! r! r" �is_translatable� sB � � � � rb �doctreec c s� � | � t�D ]q}t|tj�r|�� D ]}||fV qqt|t�r*|j}|s)|�� }nFt|t j
�rK|� d�r<||d fV |� d�rHd|d }n(d}n%t|t �rT|j
}n t|t j�rgt|�rg|jd d j
}n |j�dd ��� }|rw||fV qd
S ) z3Extract translatable messages from a document tree.r\ r[ z
.. image:: %s�urir? r
r �
� N)rM rb r% r r[ �extract_original_messages�LITERAL_TYPE_NODESrA rG r
rH r' �META_TYPE_NODES�
rawcontentrW rZ rX �replace�strip)rc r$ �msgr! r! r" �extract_messages� s4 �
�
��rn c C �" t | �D ]
}|jr|j S qd S r )�traverse_parentrE �r$ �pnoder! r! r" rR �
�rR c C ro r )rp rF rq r! r! r" �
get_node_line" rs rt �clsc c s0 � | r|d u s t | |�r| V | j} | sd S d S r )r% rD )r$ ru r! r! r" rp ) s � �rp c C s& | j �| �}|dkr| j |d S d S )Nr r> )rD �index)r$ �posr! r! r" �
get_prev_node0 s rx r c c sD � | � ttjdd��D ]}d|v r|d }n|d }||fV q dS )z6Traverse translatable index node from a document tree.F)�inline� raw_entries�entriesN)rM r r rv )rc r$ r{ r! r! r" �traverse_translatable_index8 s �
�r| �state�contentc C sX | j j}| j j}g | j _d| j _z| j|d|dd�W || j _|| j _S || j _|| j _w )z�Version of state.nested_parse() that allows titles and does not require
titles to have the same decoration as the calling document.
This is useful when the parsed content comes from a completely different
context, such as docstrings.
r r> )� match_titles)�memo� title_styles�
section_level� nested_parse)r} r~ r$ �surrounding_title_styles�surrounding_section_levelr! r! r" �nested_parse_with_titlesB s
�
r� c C sL | � � } | �tj�D ]}d|d< q
t| �tj��D ]}|j�|� q| �� S )z&Like node.astext(), but ignore images.r? r\ ) �deepcopyrM r
rH rL �rawrD �removerG )r$ �imgr� r! r! r" � clean_astextU s
r� r< c C s. t �| �}|rd|�d�|�d�fS d| | fS )z3Split role content into title and target, if given.Tr> � F)�explicit_title_rer+ �group)r< r+ r! r! r" �split_explicit_title_ s
r� )�single�pair�double�triple�see�seealso�entry�targetidc C sF ddl m} g }| �� } | }d}| �d�r d}| dd � �� } |D ]*}| �|d �rK| t|�d d � �� }|| d | }|�d |||d f� |S q!tD ](}| �|d �rv| t|�d d � �� }|d
krid }|�||||d f� |S qN|�d �D ]$}|�� }d}|�d�r�d}|dd � �� }|s�q||�d |||d f� q||S )
Nr )�pairindextypesr? �!�mainr> �:z; r� r� �,r� ) �sphinx.domains.pythonr� rl �
startswith�lstripr; �append�
indextypes�split)r� r� r� � indexentries�oentryr� �typer* r! r! r" �process_index_entryl sF
� �
r� �builderr �
docnameset�docname�tree� colorfunc� traversedc
C s t tj|�� �}t|�tj��D ]s}g }tt |d �}|D ]^} | |vr{z$|�
| � t j || �d dd� t
| || | j�| �||�}
|�| � W n tyZ t jtd�| |d� Y q w tj| d�} |
j| _| �tj�D ]
} d| vru| | d< qk|�
| � q |j�||� q|S ) zwInline all toctrees in the *tree*.
Record all docnames in *docnameset*, and output docnames with *colorfunc*.
� includefilesrf T)�nonlz+toctree contains ref to nonexisting file %r��location)r� r� )r r
�documentr� rL rM r �toctree�mapr: r� rB �info�inline_all_toctrees�env� get_doctree�addr( �warningr �
start_of_filera �sectionrD rk )
r� r� r� r� r� r� � toctreenode�newnodesr� � includefile�subtree�sof� sectionnoder! r! r" r� � s:
�
�� �
�r� �stringc C sX | � t�}|� t�}t�d|��dd��d�}t�dd� |�
� ��}t �d|�}t |�S )a� Convert `string` into an identifier and return it.
This function is a modified version of ``docutils.nodes.make_id()`` of
docutils-0.16.
Changes:
* Allow to use capital alphabet characters
* Allow to use dots (".") and underscores ("_") for an identifier
without a leading character.
# Author: David Goodger <goodger@python.org>
# Maintainer: docutils-develop@lists.sourceforge.net
# Copyright: This module has been placed in the public domain.
�NFKD�ascii�ignore�-rf r? )
� translate�_non_id_translate_digraphs�_non_id_translate� unicodedata� normalize�encode�decode�
_non_id_charsrO �joinr� �_non_id_at_endsr: )r� �idr! r! r" �_make_id� s
r� z[^a-zA-Z0-9._]+z^[-0-9._]+|-+$� �oi �di' �hi1 �iiB �lig �ti� �bi� i� �ci� i� �fi� �ki� i� �ni� �pi� i� i� �yi� �zi� �gi% i4 i5 i6 i7 �ji< i? �si@ iG �eiI iK �qiM �riO �sz�ae�oe�db�qp)�� �� iS i8 i9 r? r� r r� �prefixrJ c C s� d}|r |d }n|j jpdd }|r"|r"t|| �}||kr!d}n |r.t|�}|dkr.d}|du s7||jv rG|| �|� }|du s7||jv s7|S )z>Generate an appropriate node_id for given *prefix* and *term*.Nz-%sr� z%sr? )�settings� id_prefixr� �ids� new_serialno)r� r� r� rJ �node_id�idformatr! r! r" �make_id� s"
��r� � conditionc C s0 | D ]}t |tj�r|�d�|kr| S qdS )zBPick matched pending_xref_condition node up from the pending_xref.r� N)r% r �pending_xref_conditionr' )r$ r� �subnoder! r! r" �find_pending_xref_condition s �r� � fromdocname� todocname�childrI c C sl t jdddd�}||kr|r||d< n|r"| �||�d | |d< n| �||�|d< |r0||d< ||7 }|S )z$Shortcut to create a reference node.r? T)�internal�refid�#�refuri�reftitle)r
� reference�get_relative_uri)r� r� r� r� r� rI r$ r! r! r" � make_refnode# s
�
�r � directivec C s | j �| j�\|_|_d S r )�
state_machine�get_source_and_line�linenorE rF )r r$ r! r! r" �set_source_info5 s �r
�inlinerr c C s | j �|�\|_|_d S r )�reporterr rE rF )r r r$ r! r! r" �set_role_source_info: s r
�src�dstc C s t | �|_t| �|_d S r )rR rE rt rF )r r r! r! r" �copy_source_info> s
r c C sN t | j�D ]}t|t�r dS |�dd�du r dS qt| dd�du r%dS dS )z0Check whether the node is smart-quotable or not.F�support_smartquotesNT)rp rD r% � NON_SMARTQUOTABLE_PARENT_NODESr' �getattrrq r! r! r" �is_smartquotableN s
�r �tagsr c C s� | � tj�D ]F}z |�|d �}W n& ty7 } ztjtd�||d� |�|j p+t
� � � W Y d}~qd}~ww |rE|�|j pBt
� � � q|�t
� � � qdS )z0Filter ``only`` nodes which do not match *tags*.�exprz8exception while evaluating only directive expression: %sr� N) rM r �only�eval_conditionr( rB r� r � replace_selfra r
�comment)r� r r$ �ret�errr! r! r" �process_only_nodes\ s � ���r r c C s6 | j | jfi | j��}t| tj�r| j|_| j|_|S )z�monkey-patch Element.copy to copy the rawsource and line
for docutils-0.16 or older versions.
refs: https://sourceforge.net/p/docutils/patches/165/
)r3 rA �
attributesr% r
r rE rF )r �newnoder! r! r" � _new_copyp s
r )r6 r )r? N)hr0 rN r� �typingr r r r r r r r r
r r �docutilsr
�docutils.nodesr r �docutils.parsers.rstr �docutils.parsers.rst.statesr �docutils.statemachiner �sphinxr �
sphinx.localer � sphinx.utilr �sphinx.buildersr �
sphinx.domainr �sphinx.environmentr �sphinx.util.tagsr � getLoggerr- rB �compile�DOTALLr� �caption_ref_rer r: r5 �intr= rV � InvisiblerQ �
doctest_block�versionmodifiedr` r1 rZ rb �
math_blockr� rh rH �IMAGE_TYPE_NODESrY ri rn rR rt rp rx r| r� r� r� r� r� r� r� r� r� r� r� r� r� � pending_xrefr� r r r
r
r �FixedTextElement�literal�math� problematic�not_smartquotabler r r r �copyr! r! r! r" �<module> sX
4
4
:� ,��� "
�'���
�"
�������� �
� � �
��������������� � � � � �!�$�
���
�
� ���
��