| 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/util/__pycache__/ |
Upload File : |
a
�abP@ � @ s� d Z ddlmZmZmZmZmZmZmZm Z ddl
m Z ddl m
Z
ddlmZ ddlmZ ddlmZ ddlmZ dd lmZ dd
lmZ er�dd lmZ e� e �Z e j e d �d
d�Z!G dd� d�Z"G dd� de"�Z#G dd� de#�Z$G dd� d�Z%dS )a8
sphinx.util.docfields
~~~~~~~~~~~~~~~~~~~~~
"Doc fields" are reST field lists in object descriptions that will
be domain-specifically transformed to a more appealing presentation.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�
TYPE_CHECKING�Any�Dict�List�Tuple�Type�Union�cast)�nodes)�Node)�Inliner)�addnodes)�BuildEnvironment)�__)�logging)� TextlikeNode)�ObjectDescription��node�returnc C sX t | �dkrdS t | �dkr@| dd� D ]}t|tj�s( dS q(t| d tj�rTdS dS )zCTrue if the node only contains one paragraph (and system messages).r F� NT)�len�
isinstancer
Zsystem_message� paragraph)r Zsubnode� r �9/usr/lib/python3.9/site-packages/sphinx/util/docfields.py�_is_single_paragraph s r c @ s� e Zd ZdZdZdZdeeedf eeeedd�dd �Z e
j ddddfeeee e
eeeeed
� d d �Ze
j ddddfeeee e
eeeeee d
� d
d�Zeee eeee f d�dd�Zdeeee f eeeeeejd�dd�ZdS )�Fielda� A doc field that is never grouped. It can have an argument or not, the
argument can be linked using a specified *rolename*. Field should be used
for doc fields that usually don't occur more than once.
The body can be linked using a specified *bodyrolename* if the content is
just a single inline or text node.
Example::
:returns: description of the return value
:rtype: description of the return type
Fr NT.)�name�names�label�has_arg�rolename� bodyrolenamer c C s( || _ || _|| _|| _|| _|| _d S �N)r r r r! r" r# )�selfr r r r! r" r# r r r �__init__: s zField.__init__) r" �domain�target� innernode�contnode�env�inliner�locationr c C s� |s|p|||�S |� |��|�} | d u s2|d u r�| d u r`|d ur`td�}
tjt|
�|||d� tjd|d||d�} | |p�|||�7 } |� |��| � | S t� |�d } | |||| |i g �\}
}t
j |dg|
�R � S )Nz]Problem in %s domain: field is supposed to use role '%s', but that role is not in the domain.)r- � F)Z refdomainZ refexplicitZreftypeZ reftargetr ) Z
get_domain�roler �loggerZwarningr
Z pending_xrefZprocess_field_xrefr Zget_source_liner
�inline)r% r" r' r( r) r* r+ r, r- r/ �msgZrefnode�lineno�ns�messagesr r r � make_xrefC s
�zField.make_xrefc
C s | � ||||||||�gS r$ )r6 ) r% r" r' r( r) r* r+ r, r- r r r �
make_xrefs] s �zField.make_xrefs��fieldarg�contentr c C s ||fS r$ r )r% r9 r: r r r �
make_entryd s zField.make_entry)�typesr' �itemr+ r, r- r c C s� |\}}t �d| j�} |rJ| t �d�7 } | �| j| j||t j|||d�� t|�dkr�t|d t j�s�t|d t j �r�t|d �dkr�t|d d t j�r�| j| j
||d � � |d |||d�}t � dt j
ddg|�R � �}
t �d| |
�S )Nr. � �r+ r, r- r r )r* r+ r, r- )r
�
field_namer �Text�extendr7 r" r r r1 r# �astext�
field_bodyr �field) r% r< r' r= r+ r, r- r9 r: � fieldname� fieldbodyr r r �
make_fieldg s. � ����
� zField.make_field)r NTNN)NNN)�__name__�
__module__� __qualname__�__doc__�
is_grouped�is_typed�strr �boolr& r
�literal_emphasisr r r r r r6 r r7 r; r r
rE rH r r r r r * s> ��
�� �
� " ��r c sn e Zd ZdZdZejZd
ee edf eee
dd�� fdd �
Z de ee
e f ee eeeejd
�d d �Z� ZS )� GroupedFielda�
A doc field that is grouped; i.e., all fields of that type will be
transformed into one field with its body being a bulleted list. It always
has an argument. The argument can be linked using the given *rolename*.
GroupedField should be used for doc fields that can occur more than once.
If *can_collapse* is true, this field will revert to a Field if only used
once.
Example::
:raises ErrorClass: description when it is raised
Tr NF.)r r r r" � can_collapser c s t � �|||d|� || _d S )NT)�superr& rS )r% r r r r" rS �� __class__r r r& � s zGroupedField.__init__�r< r' �itemsr+ r, r- r c C s� t �d| j�}| �� }|D ]X\} }
t �� } | �| j| j|| tj |||d�� | t �
d�7 } | |
7 } |t � d| �7 }qt |�dkr�| j
r�tt j |d �} t �d| d �}
t �d||
�S t �d|�}
t �d||
�S )Nr. r? � -- r r )r
r@ r � list_typer rB r7 r" r
�literal_strongrA � list_itemr rS r rD rE )r% r< r' rX r+ r, r- rF Zlistnoder9 r: �parr\ rG r r r rH � s" � zGroupedField.make_field)r NNF)NNN)rI rJ rK rL rM r
Z bullet_listrZ rO r rP r& r r r r r rE rH �
__classcell__r r rU r rR } s �� ��rR c
st e Zd ZdZdZd
eeedf eedf eeeedd�� fdd �
Zde ee
e f eee e
e ejd
�d d �Z� ZS )�
TypedFieldaa
A doc field that is grouped and has type information for the arguments. It
always has an argument. The argument can be linked using the given
*rolename*, the type using the given *typerolename*.
Two uses are possible: either parameter and type description are given
separately, using a field from *names* and one from *typenames*,
respectively, or both are given using a field from *names*, see the example.
Example::
:param foo: description of parameter foo
:type foo: SomeClass
-- or --
:param SomeClass foo: description of parameter foo
Tr NF.)r r � typenamesr r" � typerolenamerS r c s$ t � �|||||� || _|| _d S r$ )rT r& r` ra )r% r r r` r r" ra rS rU r r r& � s zTypedField.__init__rW c
s� t t tjd�� �����fdd� }t�d�j�}t|�dkrZ�jrZ|d \} }
|| |
�} n,��� } |D ] \} }
| t�d|| |
��7 } qft� d| �} t�
d|| �S )Nr8 c s� t �� }|��j�j� | tj�d�� | �v r�|t �d�7 }��| �}t |�dkr�t
|d t j�r�|d � � }|��j�j � |tj
���d�� n||7 }|t �d�7 }|t �d�7 }||7 }|S )N)r+ z (r r r? �)rY )r
r rB r7 r" r
r[ rA �popr r rC ra rQ )r9 r: r] � fieldtype�typename�r' r+ r, r- r% r< r r � handle_item� s$ �
�
z*TypedField.make_field.<locals>.handle_itemr. r r ) rO r
r r@ r r rS rZ r\ rD rE )
r% r< r' rX r+ r, r- rg rF r9 r: ZbodynoderG r rf r rH � s " zTypedField.make_field)r r NNNF)NNN)rI rJ rK rL rN rO r rP r& r r r r r r
rE rH r^ r r rU r r_ � s �� ��r_ c @ s^ e Zd ZU dZeeeeef f e d< ddd�dd�Z
e j dd�d d
�Z
ejdd�d d �ZdS )
�DocFieldTransformerz�
Transforms field lists in "doc field" syntax into better-looking
equivalents, using the field type definitions given on a domain.
�typemapr N)� directiver c C s || _ |�� | _d S r$ )rj Zget_field_type_mapri )r% rj r r r r& � s z DocFieldTransformer.__init__r c C s$ |D ]}t |tj�r| �|� qdS )z,Transform all field list children of a node.N)r r
�
field_list� transform)r% r �childr r r �
transform_all� s z!DocFieldTransformer.transform_allc !
C s� | j }g }i }i }tttj |�D �]�}ttj|d �}ttj|d �}z|�� �dd�\} }
W n t y� |�� d } }
Y n0 |�
| d�\} } t |�r�ttj |d �}
|
j
}n|j
}| du s�| jt|
�k�r�| dd� �� | dd� }|
r�|d|
7 }t�|�|d< |�|� | r"| r"|r"t|�dkr"t|d tj�r"tt| �}|d �� }|j|j| jj||d | jjjj j d�}t |��r�ttj |d �}
|
� � |
� |� q"|� � |tj ddg|�R � 7 }q"| j }| �r�dd � |D �}|r"||�!|i �|
< q"| j"�rHz|
�#dd�\}}W n t �y* Y n 0 t�|�g|�!|i �|< |}
tj$|j%d
d �}|j&j|_|j&j'|_'|j&j(|_(||7 }| j)�r�||v �r�tt*t+tt,f ||| �}n t|�||< | g |f}|�|� | �-|
|g�}|d �|� q"| �-|
|g�}|�| ||f� q"t�.� }|D ]l}t|tj��r4||7 }nN|\}} } |�
|j i �} | jjjj j } | jjj/} ||j0| | jj| | | | d �7 }�q|�1|� dS )
z%Transform a single field list *node*.r r Nr. )NNr> )r* r+ c S s" g | ]}t |tjtjf�r|�qS r )r r
ZInlinerA )�.0�nr r r �
<listcomp>? � z1DocFieldTransformer.transform.<locals>.<listcomp>T)Z translatabler? )2ri r r r
rE r@ rD rC �split�
ValueError�getr r Zchildrenr! rP �upperrA �appendr r r_ r7 ra rj r' �stateZdocumentZsettingsr+ �clearrB r �
setdefaultrN �rsplitr1 Z rawsource�parent�source�linerM r r r r; rk r, rH Z replace_self)!r% r ri �entriesZ groupindicesr< rE r@ rD Zfieldtype_namer9 ZtypedescZ is_typefieldr r: Z
new_fieldnameZ typed_fieldr( Zxrefsre Zargtype�argnameZtranslatable_content�groupZ new_entryZnew_list�entryrd rX r- Z
fieldtypesr+ r, r r r rl � s�
��
�
��
� z DocFieldTransformer.transform)rI rJ rK rL r rO r r rP �__annotations__r& r
Z desc_contentrn r
rk rl r r r r rh � s
rh N)&rL �typingr r r r r r r r Zdocutilsr
Zdocutils.nodesr Zdocutils.parsers.rst.statesr Zsphinxr
Zsphinx.environmentr Z
sphinx.localer Z sphinx.utilr Zsphinx.util.typingr Zsphinx.directivesr Z getLoggerrI r0 rD rP r r rR r_ rh r r r r �<module> s"
(
S,A