File: //usr/lib/python3/dist-packages/sphinx/directives/__pycache__/__init__.cpython-310.pyc
o
�$�a�) � @ sd d Z ddlZddlmZmZmZmZmZmZm Z m
Z
ddl m Z ddl
mZ ddlmZmZ ddlmZ ddlmZ dd lmZmZ dd
lm Z dd lmZm Z m Z dd l m Z dd
l m!Z! erfddl"m#Z# e�$d�Z%e�$d�Z&e d�Z'de(de)fdd�Z*G dd� de ee' �Z+G dd� de �Z,G dd� de �Z-ed d e+ied d i� d d dee(ef fd!d"�Z.dS )#z�
sphinx.directives
~~~~~~~~~~~~~~~~~
Handlers for additional ReST directives.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�
TYPE_CHECKING�Any�Dict�Generic�List�Tuple�TypeVar�cast)�nodes)�Node)�
directives�roles)�addnodes)�desc_signature)�RemovedInSphinx50Warning�deprecated_alias)�docutils)�DocFieldTransformer�Field�
TypedField)�SphinxDirective)�
OptionSpec)�Sphinxz\\\nz\\(.)�T�argument�returnc C s( | du rdS t | �}|dk rtd��|S )zS
Check for an integer argument or None value; raise ``ValueError`` if not.
Nr z(negative value; must be positive or zero)�int�
ValueError)r �value� r �</usr/lib/python3/dist-packages/sphinx/directives/__init__.py� optional_int% s r! c @ s e Zd ZU dZdZdZdZdZdej iZ
e e d< g Z
ee e d< dZee d < dZee d
< dZeje d < i Zeeeeef f e d < d
eeeeef f fdd�Zd
ee fdd�Zdede d
e fdd�Z de dede d
dfdd�Z d"dd�Z dej!d
dfd d �Z"d"d d �Z#d
ee$ fd d!�Z%dS )#�ObjectDescriptionz�
Directive to describe a class, function or similar object. Not used
directly, but subclassed (in domain-specific directives) to add custom
behavior.
T� r �noindex� option_spec�doc_field_typesN�domain�objtype� indexnode�_doc_field_type_mapr c C sf | j i kr0i | _ | jD ]$}|jD ] }|df| j |< q|jr/tt|�}|jD ] }|df| j |< q%q | j S )NFT)r* r& �names�is_typedr r � typenames)�self�field�name� typed_fieldr r r �get_field_type_mapJ s
�z$ObjectDescription.get_field_type_mapc C s< t �d| jd ��d�}| jjrdd� |D �S dd� |D �S )z�
Retrieve the signatures to document from the directive arguments. By
default, signatures are given as arguments, one per line.
� r �
c S s g | ]
}t �d |�� ��qS )z\1)�strip_backslash_re�sub�strip��.0�liner r r �
<listcomp>` s z4ObjectDescription.get_signatures.<locals>.<listcomp>c S s g | ]}|� � �qS r )r7 r8 r r r r; b s )� nl_escape_rer6 � arguments�split�config�strip_signature_backslash)r. �linesr r r �get_signaturesX s z ObjectDescription.get_signatures�sig�signodec C s t �)a�
Parse the signature *sig* into individual nodes and append them to
*signode*. If ValueError is raised, parsing is aborted and the whole
*sig* is put into a single desc_name node.
The return value should be a value that identifies the object. It is
passed to :meth:`add_target_and_index()` unchanged, and otherwise only
used to skip duplicates.
)r )r. rC rD r r r �handle_signatured s
z"ObjectDescription.handle_signaturer0 c C � dS )z�
Add cross-reference IDs and entries to self.indexnode, if applicable.
*name* is whatever :meth:`handle_signature()` returned.
Nr )r. r0 rC rD r r r �add_target_and_indexp s z&ObjectDescription.add_target_and_indexc C rF )z�
Called before parsing content. Used to set information about the current
directive context on the build environment.
Nr �r. r r r �before_contentx � z ObjectDescription.before_content� contentnodec C rF )z�
Called after creating the content through nested parsing,
but before the ``object-description-transform`` event is emitted,
and before the info-fields are transformed.
Can be used to manipulate the content.
Nr )r. rK r r r �transform_content s z#ObjectDescription.transform_contentc C rF )z�
Called after parsing content. Used to reset information about the
current directive context on the build environment.
Nr rH r r r �
after_content� rJ z ObjectDescription.after_contentc C s� d| j v r| j �dd�\| _| _nd| j | _| _tjg d�| _t�� }| jj |_ | j|d< | j |d< |d< d| j
v |d< }| jrK|d � | j� |d � |d � g | _ | �
� }t|�D ]F\}}t�|d�}| �|� |� |� z| �||�}W n ty� |�� |t�||�7 }Y q_w || j vr�| j � |� |s�| �|||� q_t�� }|� |� | j r�| j d
| jjd < | �� | j�| j| j |� | � |� | jj � d | j| j|� t | ��!|� d
| jjd < | �"� | j|gS )a
Main directive entry function, called by docutils upon encountering the
directive.
This directive is meant to be quite easily subclassable, so it delegates
to several additional methods. What it does:
* find out if called as a domain-specific directive, set self.domain
* create a `desc` node to fit all description inside
* parse standard options, currently `noindex`
* create an index node if needed as self.indexnode
* parse all given signatures (as returned by self.get_signatures())
using self.handle_signature(), which should either return a name
or raise ValueError
* add index entries using self.add_target_and_index()
* parse the content and handle doc fields in it
�:r# r3 )�entriesr' r( �desctyper$ �classesr �object� object-description-transformN)#r0 r> r' r( r �indexr) �desc�state�document�options�appendr+ rB � enumerater �set_source_inforE r �clear� desc_namerG � desc_content�env� temp_datarI � nested_parse�content�content_offsetrL �app�emitr �
transform_allrM ) r. �noder$ �
signatures�irC rD r0 rK r r r �run� sX
�
�
�
zObjectDescription.run)r N)&�__name__�
__module__� __qualname__�__doc__� has_content�required_arguments�optional_arguments�final_argument_whitespacer �flagr% r �__annotations__r& r r r' �strr( r) r rT r* r r �boolr2 rB r r rE rG rI r^ rL rM r rj r r r r r" 2 s*
�
r" c @ s* e Zd ZdZdZdZdee fdd�ZdS )� DefaultRolezK
Set the default interpreted text role. Overridden from docutils.
r# Fr c C s� | j s
t�d� g S | j d }t�|| jj| j| jj �\}}|r-t�
d|� || j j d< n t
�| j| j�}| jj }|jd| || jd�}||g7 }ttt
j |�S )Nr3 r � default_rolez#Unknown interpreted text role "%s".)r: )r= r �unregister_roler
�role�
state_machine�language�linenorV �reporter�
register_roler_ r` r
�
literal_block�
block_text�errorr r r )r. � role_namerz �messagesr� r~ r� r r r rj � s"
�
�
zDefaultRole.runN) rk rl rm rn rq rr r r rj r r r r rw � s
rw c @ s@ e Zd ZU dZdZdZdZdZi Ze e
d< de e fdd�Z
d S )
�
DefaultDomainzH
Directive to (re-)set the default domain for this source file.
Fr# r r% r c C s( | j d �� }| jj�|�| jjd< g S )Nr �default_domain)r= �lowerr_ �domains�getr` )r. � domain_namer r r rj s zDefaultDomain.runN)rk rl rm rn ro rp rq rr r% r rt r r rj r r r r r� � s
r� zsphinx.directives�
DescDirectivez#sphinx.directives.ObjectDescriptionrd r c C sT | � ddd� t�dt� t�dt� t�dt� t�dt� | �d� d d
d
d �S ) Nr@ Fr_ z default-rolezdefault-domain�describerR rS �builtinT)�version�parallel_read_safe�parallel_write_safe)�add_config_valuer �register_directiverw r� r" � add_event)rd r r r �setup s
�r� )/rn �re�typingr r r r r r r r r r
�docutils.nodesr �docutils.parsers.rstr r
�sphinxr �sphinx.addnodesr �sphinx.deprecationr r � sphinx.util�sphinx.util.docfieldsr r r �sphinx.util.docutilsr �sphinx.util.typingr �sphinx.applicationr �compiler< r5 r ru r r! r" rw r� r� r r r r �<module> s>
(
) ���