File: //usr/lib/python3/dist-packages/sphinx/ext/autodoc/__pycache__/directive.cpython-310.pyc
o
�$�aI � @ sX d Z ddlZddlmZmZmZmZmZmZ ddl m
Z
ddl m Z m
Z
ddlmZ ddlmZ ddlmZmZ dd lmZ dd
lmZmZ dd lmZ dd l m Z m Z dd
l m Z ddl!m"Z"m#Z# ddl$m%Z% e �&e'�Z(g d�Z)g d�Z*G dd� de+�Z,G dd� d�Z-dee dedede fdd�Z.d ed ede dee
fd d �Z/G d d!� d!e"�Z0dS )"z�
sphinx.ext.autodoc.directive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�Any�Callable�Dict�List�Set�Type)�nodes)�Element�Node)�RSTState)�
StringList)�Reporter�assemble_option_dict)�Config)�RemovedInSphinx50Warning�RemovedInSphinx60Warning)�BuildEnvironment)�
Documenter�Options)�logging)�SphinxDirective�switch_source_input)�nested_parse_with_titles) �membersz
undoc-memberszinherited-memberszshow-inheritance�private-members�special-memberszignore-module-all�exclude-membersz member-orderzimported-memberszclass-doc-from)r r r r c @ s: e Zd ZdZdefdd�Zdedeegef fdd�ZdS ) �DummyOptionSpecz"An option_spec allows any options.�returnc C s dS )z&Behaves like some options are defined.T� ��selfr r �>/usr/lib/python3/dist-packages/sphinx/ext/autodoc/directive.py�__bool__* s zDummyOptionSpec.__bool__�keyc C s dd� S )Nc S s | S �Nr )�xr r r" �<lambda>/ s z-DummyOptionSpec.__getitem__.<locals>.<lambda>r )r! r$ r r r" � __getitem__. s zDummyOptionSpec.__getitem__N) �__name__�
__module__� __qualname__�__doc__�boolr# �strr r( r r r r" r ' s r c @ sh e Zd ZdZdedededededdf d d
�Z d e
ddfd d
�Z e de
fdd��Ze defdd��ZdS )�DocumenterBridgez'A parameters container for Documenters.�env�reporter�options�lineno�stater Nc C s2 || _ || _|| _|| _t� | _t� | _|| _d S r% ) r0 � _reporter�genoptr3 �set�record_dependenciesr �resultr4 )r! r0 r1 r2 r3 r4 r r r" �__init__5 s
zDocumenterBridge.__init__�msgc C s, t jdtdd� tj|| jj| jfd� d S )NzTDocumenterBridge.warn is deprecated. Please use sphinx.util.logging module instead.� ��
stacklevel��location)�warnings�warnr �logger�warningr0 �docnamer3 )r! r; r r r" rB ? s � zDocumenterBridge.warnc C � t jdtdd� | jS )Nz,DocumenterBridge.filename_set is deprecated.r< r= )rA rB r r8 r r r r" � filename_setE � �z DocumenterBridge.filename_setc C rF )Nz(DocumenterBridge.reporter is deprecated.r< r= )rA rB r r5 r r r r" r1 K rH zDocumenterBridge.reporter)r) r* r+ r, r r
r �intr r: r. rB �propertyr rG r1 r r r r" r/ 2 s ��
�
r/ �
documenter�configr2 r c C s� t D ]a}|| jvr
q|�d| d�du }||jv rS|sS||v rKt|j| t�rK|tv rJ|| durJ|| �d�rJd�|j| || dd� g�||< q|j| ||< q|� |�durc|| �
d�||< qt t |�
� | j��S )z0Recognize options of Documenter from user input.zno-TN�+�,� )�AUTODOC_DEFAULT_OPTIONS� option_spec�pop�autodoc_default_options�
isinstancer. �AUTODOC_EXTENDABLE_OPTIONS�
startswith�join�get�lstripr r �items)rK rL r2 �name�negatedr r r" �process_documenter_optionsR s"
���r] r4 �contentc C sv t | |��, |jrt�� }| j|_t| ||� nt�� }| j|_| �|d|� |jW d � S 1 s4w Y dS )z1Parse an item of content generated by Documenter.r N) r �titles_allowedr �section�documentr � paragraph� nested_parse�children)r4 r^ rK �noder r r" �parse_generated_contentl s $�rf c @ s8 e Zd ZdZe� ZdZdZdZdZ de
e fdd�Z dS ) �AutodocDirectivez�A directive class for all autodoc directives. It works as a dispatcher of Documenters.
It invokes a Documenter upon running. After the processing, it parses and returns
the content generated by Documenter.
TrO r r c
C sP | j jj}z
|�| j�\}}W n
ty d\}}Y nw t�d||| j� | j dd � }| j
j j j
| }z
t|| j| j�}W n' tttfyf } ztjd| j |f | j
j|fd� g W Y d }~S d }~ww t| j
|||| j �}||| jd �} | j| jd� |js�g S t�dd �|j�� |j D ] }
| j jj j � |
� q�t | j |j| �} | S )
N)NNz[autodoc] %s:%s: input:
%s� z=An option to %s is either unknown or has an invalid value: %sr? r )� more_contentz[autodoc] output:
%s�
) r4 ra r1 �get_source_and_liner3 �AttributeErrorrC �debug�
block_textr[ r0 �app�registry� documentersr] rL r2 �KeyError�
ValueError� TypeError�errorrE r/ � arguments�generater^ r9 rW r8 �settings�addrf ) r! r1 �sourcer3 �objtype�doccls�documenter_options�exc�paramsrK �fnr9 r r r" �run� s<
��
���
zAutodocDirective.runN)
r) r* r+ r, r rQ � has_content�required_arguments�optional_arguments�final_argument_whitespacer r
r� r r r r" rg } s rg )1r, rA �typingr r r r r r �docutilsr �docutils.nodesr r
�docutils.parsers.rst.statesr �docutils.statemachiner �docutils.utilsr
r �
sphinx.configr �sphinx.deprecationr r �sphinx.environmentr �sphinx.ext.autodocr r � sphinx.utilr �sphinx.util.docutilsr r �sphinx.util.nodesr � getLoggerr) rC rP rU �dictr r/ r] rf rg r r r r" �<module> s6
�
�