Dashboard
PHP:
8.2.30
OS:
Linux
User:
dh_nv8b2m
/
/
usr
/
lib
/
python3
/
dist-packages
/
sphinx
/
util
/
__pycache__
📤 Upload
📝 New File
📁 New Folder
Close
Editing: docfields.cpython-310.pyc
o �$�as@ � @ s� d Z ddlmZmZmZmZmZmZmZm Z ddl m Z ddl m Z ddlmZ ddlmZ ddlmZ ddlmZ dd lmZ dd lmZ erNdd lmZ e� e �Z d e j d e fdd�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-2021 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 qt| d tj�r*dS dS )zCTrue if the node only contains one paragraph (and system messages).r F� NT)�len� isinstancer �system_message� paragraph)r �subnode� r �7/usr/lib/python3/dist-packages/sphinx/util/docfields.py�_is_single_paragraph s �r c @ s0 e Zd ZdZdZdZ d#dedeedf d ed ed ed ed dfdd�Z e j ddddfd ededede e dedededed efdd�Ze j ddddfd ededede e dedededed ee fdd�Zded ee d eeee f fd d �Z d$d eeee f ded edededed ejfd!d"�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__�domain�target� innernode�contnode�env�inliner�locationc C s |d usJ �|d u |d u ksJ ||f��|s |p |||�S |� |��|�} | d u s-|d u rc| d u rF|d urFd} | d7 } tjt| �|||d� tjd|d||d�} | |pW|||�7 } |� |��| � | S t� |�d } | |||| |i g �\} }t j |dg| �R � S )Nz(Problem in %s domain: field is supposed z5to use role '%s', but that role is not in the domain.)r. � F)� refdomain� refexplicit�reftype� reftargetr ) � get_domain�role�logger�warningr r � pending_xref�process_field_xrefr �get_source_liner �inline)r& r# r( r) r* r+ r, r- r. r5 �msg�refnode�lineno�ns�messagesr r r � make_xrefC s& �zField.make_xrefc C s | � ||||||||�gS r% )rA ) r& r# r( r) r* r+ r, r- r. r r r � make_xrefs] s �zField.make_xrefs�fieldarg�contentc C s ||fS r% r )r& rC rD r r r � make_entryd s zField.make_entry�types�itemc C s� |\}}t �d| j�} |r%| t �d�7 } | �| j| j||t j|||d�� t|�dkr`t|d t j�sMt|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�extendrB r# r r r; r$ �astext� field_bodyr �field) r& rF r( rG r, r- r. rC rD � 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 rA r rB rE r r rO rR r r r r r * sz ���� � ������ ������� �&������r c s� e Zd ZdZdZejZ ddede edf d ed ed e d df � fd d� Z dde ee e f dede dededed ejfdd�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 NFr r .r! r# � can_collapser c s t � �|||d|� || _d S )NT)�superr' r^ )r& r r r! r# r^ �� __class__r r r' � s zGroupedField.__init__rF r( �itemsr, r- r. c C s� t �d| j�}| �� }|D ],\} } t �� } | �| j| j|| tj |||d�� | t � d�7 } | | 7 } |t � d| �7 }q t |�dkrZ| j rZtt j |d �} t �d| d �} t �d|| �S t �d|�} t �d|| �S )Nr/ rI � -- r r )r rJ r! � list_typer rL rB r# r �literal_strongrK � list_itemr r^ r rN rO )r& rF r( rb r, r- r. rP �listnoderC rD �parrf rQ r r r rR � s" � zGroupedField.make_field)r NNFrS )rT rU rV rW rX r � bullet_listrd rZ r r[ r' r r r r r rO rR � __classcell__r r r` r r] } s4 ����������r] c s� e Zd ZdZdZ ddedeedf d eedf d ed ed ed eddf� fdd� Z dde ee e f dedede de de dejfdd�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 NFr r .� typenamesr! r# � typerolenamer^ r c s$ t � �|||||� || _|| _d S r% )r_ r' rl rm )r& r r rl r! r# rm r^ r` r r r' � s zTypedField.__init__rF r( rb r, r- r. c s� dt dt dtjf� �����fdd� }t�d�j�}t|�dkr/�jr/|d \} } || | �} n��� } |D ]\} } | t�d|| | ��7 } q5t� d| �} t� d|| �S ) NrC rD r c s� t �� }|��j�j� | tj�d�� | �v rT|t �d�7 }��| �}t |�dkrIt |d t j�rI|d � � }|��j�j � |tj ���d�� n||7 }|t �d�7 }|t �d�7 }||7 }|S )N)r, z (r r rI �)rc )r r rL rB r# r re rK �popr r rM rm r\ )rC rD rh � fieldtype�typename�r( r, r- r. r& rF r r � handle_item� s$ � �z*TypedField.make_field.<locals>.handle_itemr/ r r ) rZ r r rJ r! r r^ rd rf rN rO ) r& rF r( rb r, r- r. rs rP rC rD �bodynoderQ r rr r rR � s & zTypedField.make_field)r r NNNFrS )rT rU rV rW rY rZ r r[ r' r r r r r r rO rR rj r r r` r rk � s< ������������rk c @ s\ e Zd ZU dZeeeeef f e d< ddd�Z d e j ddfd d �Z d ejddfd d �ZdS )�DocFieldTransformerz� Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain. �typemap� directiver r Nc C s || _ |�� | _d S r% )rw �get_field_type_maprv )r& rw 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 �]z}t|�dks J �ttj|d �}ttj|d �}z |�� � dd�\} } W n t yH |�� d} } Y nw |� | d�\} } t |�rattj |d �} | j}n|j}| du so| jt| �kr�| 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 �} | � � | � |� n|� � |tj ddg|�R � 7 }q| j }| �rd d � |D �}|�r||�!|i �| < q| j"�r+z | �#dd�\}}W n t �y Y nw t�|�g|�!|i �|< |} tj$|j%d d �}|j&j|_|j&j'|_'|j&j(|_(||7 }| j)�r}||v �r^tt*t+tt,f ||| �}nt|�||< | g |f}|�|� | �-| |g�}|d �|� q| �-| |g�}|�| ||f� qt�.� }|D ]7}t|tj��r�||7 }�q�|\}} } |� |j i �} | jjjj j } | jjj/} ||j0| | jj| | | | d �7 }�q�|�1|� dS )z%Transform a single field list *node*.� r r Nr/ )NNrH )r+ r, c S s( g | ]}t |tj�st |tj�r|�qS r )r r �InlinerK )�.0�nr r r � <listcomp>? s �z1DocFieldTransformer.transform.<locals>.<listcomp>T)� translatablerI )2rv r r r rO r rJ rN rM �split� ValueError�getr r �childrenr" r[ �upperrK �appendr rk rB rm rw r( �state�document�settingsr, �clearrL r � setdefaultrY �rsplitr; � rawsource�parent�source�linerX r r r rE ry r- rR � replace_self)!r& r rv �entries� groupindicesrF rO rJ rN �fieldtype_namerC �typedesc� is_typefieldr rD � new_fieldname� typed_fieldr) �xrefsrq �argtype�argname�translatable_content�group� new_entry�new_list�entryrp rb r. � fieldtypesr, r- r r r rz � s� � � � �� �z DocFieldTransformer.transform)rw r r N)rT rU rV rW r rZ r r r[ �__annotations__r' r � desc_contentr| r ry rz r r r r ru � s ru N)&rW �typingr r r r r r r r �docutilsr �docutils.nodesr �docutils.parsers.rst.statesr �sphinxr �sphinx.environmentr � sphinx.localer � sphinx.utilr �sphinx.util.typingr �sphinx.directiver � getLoggerrT r6 rN r[ r r r] rk ru r r r r �<module> s$ ( S,A
Save
Cancel