| Server IP : 127.0.0.1 / Your IP : 216.73.216.109 Web Server : Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10 System : Windows NT DESKTOP-E5T4RUN 10.0 build 19045 (Windows 10) AMD64 User : SERVERWEB ( 0) PHP Version : 8.1.10 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/cygwin64/lib/python3.9/site-packages/sphinx/directives/__pycache__/ |
Upload File : |
a
�ab�) � @ s` 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! er�ddl"m#Z# e�$d�Z%e�$d�Z&e d�Z'e(e)d�dd�Z*G dd� de ee' �Z+G dd� de �Z,G dd� de �Z-edd e+ied d i� d ee(ef d �d d!�Z.dS )"z�
sphinx.directives
~~~~~~~~~~~~~~~~~
Handlers for additional ReST directives.
:copyright: Copyright 2007-2022 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 r dS t | �}|dk r$td��|S dS )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.9/site-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 < eeeeef f d
�dd�Zee d
�dd�Zee e d�dd�Z e ee dd�dd�Z dd
�dd�Z ej!dd�dd �Z"dd
�d d �Z#ee$ d
�d 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_map�r c C sf | j i kr`i | _ | jD ]H}|jD ]}|df| j |< q |jrtt|�}|jD ]}|df| j |< qJq| j S )NFT)r* r& �namesZis_typedr r Z typenames)�selfZfield�nameZ typed_fieldr r r �get_field_type_mapJ s
z$ObjectDescription.get_field_type_mapc C s@ t �d| jd ��d�}| jjr.dd� |D �S dd� |D �S dS )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>` � z4ObjectDescription.get_signatures.<locals>.<listcomp>c S s g | ] }|� � �qS r )r4 r5 r r r r8 b r9 N)� nl_escape_rer3 � arguments�splitZconfig�strip_signature_backslash)r- �linesr r r �get_signaturesX s z ObjectDescription.get_signatures)�sig�signoder c C s t �dS )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.
N)r )r- r@ rA r r r �handle_signatured s
z"ObjectDescription.handle_signature)r. r@ rA r c C s dS )z�
Add cross-reference IDs and entries to self.indexnode, if applicable.
*name* is whatever :meth:`handle_signature()` returned.
Nr )r- r. r@ rA r r r �add_target_and_indexp s z&ObjectDescription.add_target_and_indexc C s dS )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 s z ObjectDescription.before_content)� contentnoder c C s dS )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- rF r r r �transform_content s z#ObjectDescription.transform_contentc C s dS )z�
Called after parsing content. Used to reset information about the
current directive context on the build environment.
Nr rD r r r �
after_content� s 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< }| jr�|d � | j� |d � |d � g | _ | �
� }|D ]�}t�|d�}| �|� |� |� z| �||�}W n0 t�y |�� |t�||�7 }Y q�Y n0 || j vr�| j � |� |s�| �|||� q�t�� }|� |� | j �rv| 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# r0 )�entriesr' r( Zdesctyper$ �classesr �object� object-description-transformN)"r. r< r' r( r �indexr) Zdesc�stateZdocument�options�appendr, r? r Zset_source_inforB r �clearZ desc_namerC � desc_content�env� temp_datarE Z nested_parseZcontentZcontent_offsetrG �app�emitr Z
transform_allrH )r- Znoder$ Z
signaturesr@ rA r. rF r r r �run� sT
� zObjectDescription.run)&�__name__�
__module__� __qualname__�__doc__� has_content�required_arguments�optional_arguments�final_argument_whitespacer �flagr% r �__annotations__r& r r r' �strr( r) r rN r* r r �boolr/ r? r r rB rC rE rS rG rH r rX r r r r r" 2 s(
� r" c @ s* e Zd ZdZdZdZee d�dd�ZdS )� DefaultRolezK
Set the default interpreted text role. Overridden from docutils.
r# Fr+ c C s� | j st�d� g S | j d }t�|| jj| j| jj �\}}|rZt�
d|� || j j d< n8t
�| j| j�}| jj }|jd| || jd�}||g7 }ttt
j |�S )Nr0 r Z default_rolez#Unknown interpreted text role "%s".)r7 )r; r Zunregister_roler
�roleZ
state_machine�language�linenorO �reporterZ
register_rolerT rU r
�
literal_blockZ
block_text�errorr r r )r- Z role_namerf �messagesrj ri rk r r r rX � s"
�
�
zDefaultRole.runN) rY rZ r[ r\ r_ r` r r rX r r r r re � s re c @ s@ e Zd ZU dZdZdZdZdZi Ze e
d< e e d�dd�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 Zdefault_domain)r; �lowerrT Zdomains�getrU )r- Z domain_namer r r rX s zDefaultDomain.runN)rY rZ r[ r\ r] r^ r_ r` r% r rb r r rX r r r r rm � s
rm zsphinx.directivesZ
DescDirectivez#sphinx.directives.ObjectDescriptionr )rV r c C sT | � ddd� t�dt� t�dt� t�dt� t�dt� | �d� d d
d
d �S ) Nr= FrT z default-rolezdefault-domainZdescriberL rM ZbuiltinT)�versionZparallel_read_safeZparallel_write_safe)Zadd_config_valuer Zregister_directivere rm r" Z add_event)rV r r r �setup s
�rq )/r\ �re�typingr r r r r r r r r r
Zdocutils.nodesr Zdocutils.parsers.rstr r
Zsphinxr Zsphinx.addnodesr Zsphinx.deprecationr r Z sphinx.utilZsphinx.util.docfieldsr r r Zsphinx.util.docutilsr Zsphinx.util.typingr Zsphinx.applicationr �compiler: r2 r rc r r! r" re rm rq r r r r �<module> s<
(
) ���