File: //usr/lib/python3/dist-packages/sphinx/__pycache__/addnodes.cpython-310.pyc
o
�$�axE � @ s� d Z ddlmZmZmZmZmZ ddlmZ ddl m
Z
er$ddl m Z G dd� dej
�Z
G dd � d ej�ZG d
d � d �ZG d d
� d
ejej
e�ZG dd� dej
e�ZG dd� dejej
�ZG dd� deejejej�ZG dd� dejejej�ZG dd� dejej
�Z G dd� deejej�Z G dd� deejejej�Z G d d � d eejejej�Z e Z G d d � d ejejej�Z!G d d!� d!e!�Z"G d"d#� d#ejejej�Z#G d$d%� d%ejejej�Z$G d&d'� d'ejejej�Z%G d(d)� d)ejejej�Z&G d*d+� d+ej'e�Z(G d,d-� d-e(�Z)G d.d/� d/e(�Z*G d0d1� d1e(�Z+G d2d3� d3e(�Z,G d4d5� d5e(�Z-G d6d7� d7e(�Z.G d8d9� d9e(�Z/G d:d;� d;e(�Z0G d<d=� d=e(�Z1e)e*e+e,e-e.e/e0e1g Z2G d>d?� d?ejej�Z3G d@dA� dAejej
�Z4G dBdC� dCejej
�Z5G dDdE� dEejejej�Z6G dFdG� dGej7ejej�Z8G dHdI� dIejej�Z9G dJdK� dKej
�Z:G dLdM� dMej
�Z;G dNdO� dOej
�Z<G dPdQ� dQej=�Z>G dRdS� dSej
�Z?G dTdU� dUej
�Z@G dVdW� dWej
�ZAG dXdY� dYej
�ZBG dZd[� d[ej
�ZCG d\d]� d]ejDejEej
�ZFG d^d_� d_ejej
�ZGG d`da� daejej�ZHG dbdc� dcejI�ZJG ddde� deejI�ZKG dfdg� dgejLe�ZMG dhdi� diejNe�ZOG djdk� dkejej�ZPdldmdneeQef fdodp�ZRdqS )rz�
sphinx.addnodes
~~~~~~~~~~~~~~~
Additional docutils nodes.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�
TYPE_CHECKING�Any�Dict�List�Sequence)�nodes)�Element)�Sphinxc s8 e Zd ZdZ d
dedededef� fdd �
Z� ZS ) �documentaj The document root element patched by Sphinx.
This fixes that document.set_id() does not support a node having multiple node Ids.
see https://sourceforge.net/p/docutils/patches/167/
.. important:: This is only for Sphinx internal use. Please don't use this
in your extensions. It will be removed without deprecation period.
N� �node�msgnode�suggested_prefix�returnc sf ddl m} |jdkrt� �|||�}nt� �||�}|jdk r1|d D ] }|| jvr0|| j|< q$|S )Nr ��docutils)r � )r � �ids)� sphinx.utilr �__version_info__�super�set_idr )�selfr r
r r �ret�node_id�� __class__� �1/usr/lib/python3/dist-packages/sphinx/addnodes.pyr s
�zdocument.set_id)Nr )�__name__�
__module__� __qualname__�__doc__r �strr �
__classcell__r r r r r
s ���r
c @ �B e Zd ZdZd dd�Zdededdfdd �Zdee fd
d �ZdS )
� translatablea� Node which supports translation.
The translation goes forward with following steps:
1. Preserve original translatable messages
2. Apply translated messages from message catalog
3. Extract preserved messages (for gettext builder)
The translatable nodes MUST preserve original messages.
And these messages should not be overridden at applying step.
Because they are used at final step; extraction.
r Nc C � t �)z(Preserve original translatable messages.��NotImplementedError�r r r r �preserve_original_messages= � z'translatable.preserve_original_messages�original_message�translated_messagec C r( )zApply translated message.r) )r r. r/ r r r �apply_translated_messageA r- z%translatable.apply_translated_messagec C r( )zjExtract translation messages.
:returns: list of extracted messages or messages generator
r) r+ r r r �extract_original_messagesE s z&translatable.extract_original_messages�r N) r r! r" r# r, r$ r0 r r1 r r r r r' / s
r' c @ � e Zd ZdZdZdS )�not_smartquotablez+A node which does not support smart-quotes.FN)r r! r" r# �support_smartquotesr r r r r4 M s r4 c @ r& )
�toctreez Node for inserting a "TOC tree".r Nc C sJ | � dg �}| d D ] \}}|r|�|� q
| �d�r#| d | d< d S d S )N�
rawentries�entries�caption�
rawcaption)�
setdefault�append�get)r r7 �title�docnamer r r r, U s
�
�z"toctree.preserve_original_messagesr. r/ c C sP t | d �D ]\}\}}||kr||f| d |< q| �d�|kr&|| d< d S d S )Nr8 r: r9 )� enumerater= )r r. r/ �ir> r? r r r r0 ` s � �z toctree.apply_translated_messagec C s0 g }|� | �dg �� d| v r|�| d � |S )Nr7 r: )�extendr= r< )r �messagesr r r r1 j s
z!toctree.extract_original_messagesr2 ) r r! r" r# r, r$ r0 r r1 r r r r r6 R s
r6 c s@ e Zd ZU dZg Zee ed< dededdf� fdd� Z � Z
S ) �_desc_classes_injectorz_Helper base class for injecting a fixes list of classes.
Use as the first base class.
�classes�args�kwargsr Nc s& t � j|i |�� | d �| j� d S �NrE �r �__init__rB rE )r rF rG r r r rJ � s z _desc_classes_injector.__init__) r r! r" r# rE r r$ �__annotations__r rJ r% r r r r rD z s
"rD c @ � e Zd ZdZdS )�descam Node for a list of object signatures and a common description of them.
Contains one or more :py:class:`desc_signature` nodes
and then a single :py:class:`desc_content` node.
This node always has two classes:
- The name of the domain it belongs to, e.g., ``py`` or ``cpp``.
- The name of the object type in the domain, e.g., ``function``.
N�r r! r" r# r r r r rM � � rM c s, e Zd ZdZddgZe� fdd��Z� ZS )�desc_signatureaS Node for a single object signature.
As default the signature is a single-line signature.
Set ``is_multiline = True`` to describe a multi-line signature.
In that case all child nodes must be :py:class:`desc_signature_line` nodes.
This node always has the classes ``sig``, ``sig-object``, and the domain it belongs to.
�sigz
sig-objectc s | � d�rdS t� jS )N� is_multiline� )r= r �child_text_separatorr+ r r r rT � s
z#desc_signature.child_text_separator)r r! r" r# rE �propertyrT r% r r r r rP � s
rP c @ r3 )�desc_signature_linez�Node for a line in a multi-line object signature.
It should only be used as a child of a :py:class:`desc_signature`
with ``is_multiline`` set to ``True``.
Set ``add_permalink = True`` for the line that should get the permalink.
r N)r r! r" r# �sphinx_line_typer r r r rV � � rV c @ rL )� desc_contentzfNode for object description content.
Must be the last child node in a :py:class:`desc` node.
NrN r r r r rY � rO rY c s: e Zd ZdZddgZdedededdf� fd d
� Z� ZS ) � desc_inlinez�Node for a signature fragment in inline text.
This is for example used for roles like :rst:role:`cpp:expr`.
This node always has the classes ``sig``, ``sig-inline``,
and the name of the domain it belongs to.
rQ z
sig-inline�domainrF rG r Nc s$ t � j|i |�� | d �|� d S rH )r rJ r< )r r[ rF rG r r r rJ � s zdesc_inline.__init__) r r! r" r# rE r$ r rJ r% r r r r rZ � s &rZ c @ � e Zd ZdZddgZdS )� desc_namez�Node for the main object name.
For example, in the declaration of a Python class ``MyModule.MyClass``,
the main name is ``MyClass``.
This node always has the class ``sig-name``.
zsig-name�descnameN�r r! r" r# rE r r r r r] � s r] c @ r\ )� desc_addnamez�Node for additional name parts for an object.
For example, in the declaration of a Python class ``MyModule.MyClass``,
the additional name part is ``MyModule.``.
This node always has the class ``sig-prename``.
z sig-prename�
descclassnameNr_ r r r r r` � s r` c @ rL )� desc_typez+Node for return types or object type names.NrN r r r r rb � rO rb c s& e Zd ZdZdef� fdd� Z� ZS )� desc_returnsz4Node for a "returns" annotation (a la -> in Python).r c s dt � �� S )Nz -> �r �astextr+ r r r re � s zdesc_returns.astext)r r! r" r# r$ re r% r r r r rc � s rc c s$ e Zd ZdZdZ� fdd�Z� ZS )�desc_parameterlistz"Node for a general parameter list.�, c s d� t� �� �S )Nz({}))�formatr re r+ r r r re � s zdesc_parameterlist.astext)r r! r" r# rT re r% r r r r rf � s rf c @ rL )�desc_parameterz Node for a single parameter.NrN r r r r ri rO ri c s* e Zd ZdZdZdef� fdd� Z� ZS )�
desc_optionalz6Node for marking optional parts of the parameter list.rg r c s dt � �� d S )N�[�]rd r+ r r r re s zdesc_optional.astext)r r! r" r# rT r$ re r% r r r r rj s rj c @ rL )�desc_annotationz@Node for signature annotations (not Python 3-style annotations).NrN r r r r rm
rO rm c sJ e Zd ZU dZg Zee ed< d dededede dd f
� fd
d �
Z
� Z S )
�desc_sig_elementz<Common parent class of nodes for inline text of a signature.rE r � rawsource�text�children�
attributesr Nc s0 t � j||g|�R i |�� | d �| j� d S rH rI �r ro rp rq rr r r r rJ s zdesc_sig_element.__init__)r r ) r r! r" r# rE r r$ rK r r rJ r% r r r r rn s
���rn c s> e Zd ZdZdgZd
dedededed d
f
� fd d �
Z� Z S )�desc_sig_spacez Node for a space in a signature.�wr rS ro rp rq rr r Nc s t � j||g|�R i |�� d S )N)r rJ rs r r r rJ ) s zdesc_sig_space.__init__)r rS )
r r! r" r# rE r$ r r rJ r% r r r r rt % s ���rt c @ � e Zd ZdZdgZdS )�
desc_sig_namez&Node for an identifier in a signature.�nNr_ r r r r rw . �
rw c @ rv )�desc_sig_operatorz$Node for an operator in a signature.�oNr_ r r r r rz 3 ry rz c @ rv )�desc_sig_punctuationz$Node for punctuation in a signature.�pNr_ r r r r r| 8 ry r| c @ rv )�desc_sig_keywordz*Node for a general keyword in a signature.�kNr_ r r r r r~ = ry r~ c @ rv )�desc_sig_keyword_typez;Node for a keyword which is a built-in type in a signature.�ktNr_ r r r r r� B ry r� c @ rv )�desc_sig_literal_numberz*Node for a numeric literal in a signature.�mNr_ r r r r r� G ry r� c @ rv )�desc_sig_literal_stringz)Node for a string literal in a signature.�sNr_ r r r r r� L ry r� c @ rv )�desc_sig_literal_charz,Node for a character literal in a signature.�scNr_ r r r r r� Q ry r� c @ rL )�versionmodifiedzNode for version change entries.
Currently used for "versionadded", "versionchanged" and "deprecated"
directives.
NrN r r r r r� a rO r� c @ rL )�seealsoz Custom "see also" admonition.NrN r r r r r� i rO r� c @ rL )�productionlistzKNode for grammar production lists.
Contains ``production`` nodes.
NrN r r r r r� m rO r� c @ rL )�
productionz*Node for a single grammar production rule.NrN r r r r r� t rO r� c @ rL )�indexa� Node for index entries.
This node is created by the ``index`` directive and has one attribute,
``entries``. Its value is a list of 5-tuples of ``(entrytype, entryname,
target, ignored, key)``.
*entrytype* is one of "single", "pair", "double", "triple".
*key* is categorization characters (usually a single character) for
general index page. For the details of this, please see also:
:rst:dir:`glossary` and issue #2320.
NrN r r r r r� z rO r� c @ rL )�centeredz Deprecated.NrN r r r r r� � rO r� c @ rL )�acksz Special node for "acks" lists.NrN r r r r r� � rO r� c @ rL )�hlistzjNode for "horizontal lists", i.e. lists that should be compressed to
take up less vertical space.
NrN r r r r r� � rO r� c @ rL )�hlistcolz)Node for one column in a horizontal list.NrN r r r r r� � rO r� c @ rL )�compact_paragraphz<Node for a compact paragraph (which never makes a <p> node).NrN r r r r r� � rO r� c @ rL )�glossaryzNode to insert a glossary.NrN r r r r r� � rO r� c @ rL )�onlyzANode for "only" directives (conditional inclusion based on tags).NrN r r r r r� � rO r� c @ rL )�
start_of_filezANode to mark start of a new file, used in the LaTeX builder only.NrN r r r r r� � rO r� c @ rL )�
highlightlangzcInserted to set the highlight language and line number options for
subsequent code blocks.
NrN r r r r r� � rO r� c @ rL )�tabular_col_specz;Node for specifying tabular columns, used for LaTeX output.NrN r r r r r� � rO r� c @ s e Zd ZdZdZdS )�metazYNode for meta directive -- same as docutils' standard meta node,
but pickleable.
N)r r! r" r# �
rawcontentr r r r r� � s r� c @ r3 )� pending_xrefz�Node for cross-references that cannot be resolved without complete
information about all documents.
These nodes are resolved before writing output, in
BuildEnvironment.resolve_references.
r N)r r! r" r# rT r r r r r� � rX r� c @ rL )�pending_xref_conditiona} Node for cross-references that are used to choose appropriate
content of the reference by conditions on the resolving phase.
When the :py:class:`pending_xref` node contains one or more
**pending_xref_condition** nodes, the cross-reference resolver
should choose the content of the reference using defined conditions
in ``condition`` attribute of each pending_xref_condition nodes::
<pending_xref refdomain="py" reftarget="io.StringIO ...>
<pending_xref_condition condition="resolved">
<literal>
StringIO
<pending_xref_condition condition="*">
<literal>
io.StringIO
After the processing of cross-reference resolver, one of the content node
under pending_xref_condition node is chosen by its condition and to be
removed all of pending_xref_condition nodes::
# When resolved the cross-reference successfully
<reference>
<literal>
StringIO
# When resolution is failed
<reference>
<literal>
io.StringIO
.. note:: This node is only allowed to be placed under pending_xref node.
It is not allows to place it under other nodes. In addition,
pending_xref node must contain only pending_xref_condition
nodes if it contains one or more pending_xref_condition nodes.
The pending_xref_condition node should have **condition** attribute.
Domains can be store their individual conditions into the attribute to
filter contents on resolving phase. As a reserved condition name,
``condition="*"`` is used for the fallback of resolution failure.
Additionally, as a recommended condition name, ``condition="resolved"``
is used for the representation of resolstion success in the intersphinx
module.
.. versionadded:: 4.0
NrN r r r r r� � rO r� c @ rL )�number_referencez4Node for number references, similar to pending_xref.NrN r r r r r� � rO r� c @ rL )�download_referencez6Node for download references, similar to pending_xref.NrN r r r r r� � rO r� c @ rL )�literal_emphasisz{Node that behaves like `emphasis`, but further text processors are not
applied (e.g. smartypants for HTML output).
NrN r r r r r� rO r� c @ rL )�literal_strongzyNode that behaves like `strong`, but further text processors are not
applied (e.g. smartypants for HTML output).
NrN r r r r r� rO r� c @ rL )�manpagez Node for references to manpages.NrN r r r r r� rO r� �appr r c C s� ddl m} | �t� | �t� | �t� | �t� | �t� | �t� | �t � | �t
� | �t � | �t � | �t
� | �t� | �t� | �t� tD ]}| �|� qN| �t� | �t� | �t� | �t� | �t� | �t� | �t� | �t� | �t� | �t� | �t � | �t � | �t � | �t � | �t � | �t!� | �t"� | �t#� | �t$� | �t%� | �t&� |j'dk r�| �t(� dddd�S )Nr r )r � �builtinT)�version�parallel_read_safe�parallel_write_safe))r r �add_noder6 rM rP rV rY rZ r] r` rb rc rf ri rj rm � SIG_ELEMENTSr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r� )r� r rx r r r �setup sX
�r� N)Sr# �typingr r r r r r r �docutils.nodesr �sphinx.applicationr r
�Noder' r4 �Generalr6 rD �
AdmonitionrM �Part�Inline� TextElementrP �FixedTextElementrV rY rZ r] r` �desc_classnamerb rc rf ri rj rm �inlinern rt rw rz r| r~ r� r� r� r� r� r� r� r� r� � Invisibler� r� r� r� r� � paragraphr� r� r� r� r� r� �Special�PreBibliographicr� r� r� � referencer� r� �emphasisr� �strongr� r� r$ r� r r r r �<module> s�
(
�
0