| 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/ext/autosummary/__pycache__/ |
Upload File : |
a
�abxg � @ s d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
m Z ddlm Z ddl
mZmZmZmZmZmZmZmZmZ ddlmZ ddlmZ ddlZ ddl m Z m Z dd l m Z dd
l!m"Z" dd l#m$Z$ dd l%m&Z& dd
l'm(Z( ddl)m*Z* ddl+m,Z,m-Z-m.Z.m/Z/ ddlm0Z0 ddl1m2Z2m3Z3 ddl4m5Z5 ddl6m7Z7m8Z8m9Z9 ddl:m;Z;m<Z< ddl=m>Z> ddl?m@Z@ e7�AeB�ZCG dd� d�ZDG dd� de�ZEedd�d d �ZFeGdd �d d �ZHeGdd �d!d"�ZIdIeGeGeGd$�d%d&�ZJG d'd(� d(�ZKG d)d*� d*�ZLee$eeG d+�d,d-�ZMdJeGeeeKeGeNeeNeeGeGeGd.� d/d0�ZOdKeeG eGeGeGe"eGeNeeNeGdd5� d6d7�ZPeeG eeE d8�d9d:�ZQdLeGeGeGeeE d;�d<d=�ZRdMeeG eGeGeeE d>�d?d@�ZSejTdA�dBdC�ZUejVdDd� feeG ddE�dFdG�ZWeBdHk�reW� dS )Na"
sphinx.ext.autosummary.generate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Usable as a library or script to generate automatic RST source files for
items referred to in autosummary:: directives.
Each generated RST file contains a single auto*:: directive which
extracts the docstring of the referred item.
Example Makefile rule::
generate:
sphinx-autogen -o source/generated source/*.rst
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�NullTranslations)�path) �Any�Dict�List�
NamedTuple�Sequence�Set�Tuple�Type�Union)�TemplateNotFound)�SandboxedEnvironment)�__display_version__� package_dir)�Sphinx)�Builder)�Config)�RemovedInSphinx50Warning)�
Documenter)�
import_module)�ImportExceptionGroup�get_documenter�import_by_name�import_ivar_by_name)�__)�ModuleAnalyzer� PycodeError)�SphinxComponentRegistry)�logging�rst�split_full_qualified_name)�getall� safe_getattr)� ensuredir)�SphinxTemplateLoaderc @ s0 e Zd ZdZedd�dd�Zedd�dd�ZdS ) �DummyApplicationz3Dummy Application class for sphinx-autogen command.N)�
translator�returnc C sx t � | _t� | _g | _d| _|| _d| _d| _d| _ | j�
di dd � | j�
di dd � | j�
dddt � | j� � d S ) N�/r F�autosummary_contextT�autosummary_filename_map� autosummary_ignore_module_all�env)
r �configr �registryZ
messagelog�srcdirr' � verbosityZ
_warncountZwarningiserror�add�boolZ init_values)�selfr' � r5 �C/usr/lib/python3.9/site-packages/sphinx/ext/autosummary/generate.py�__init__< s zDummyApplication.__init__)�argsr( c G s d S �Nr5 )r4 r8 r5 r5 r6 �emit_firstresultK s z!DummyApplication.emit_firstresult)�__name__�
__module__� __qualname__�__doc__r r7 r r: r5 r5 r5 r6 r& 9 s r& c @ s. e Zd ZU eed< eed< eed< eed< dS )�AutosummaryEntry�namer �template� recursiveN)r; r< r= �str�__annotations__r3 r5 r5 r5 r6 r? O s
r? )�appr( c C sl ddl m}m}m}m}m}m}m}m}m } m
}
m } ||||||| |
||| g } | D ]}
| j �
|
j|
� qRd S )Nr ) �AttributeDocumenter�ClassDocumenter�DataDocumenter�DecoratorDocumenter�ExceptionDocumenter�FunctionDocumenter�MethodDocumenter�ModuleDocumenter�NewTypeAttributeDocumenter�NewTypeDataDocumenter�PropertyDocumenter)�sphinx.ext.autodocrF rG rH rI rJ rK rL rM rN rO rP r/ Zadd_documenter�objtype)rE rF rG rH rI rJ rK rL rM rN rO rP Z documenters�
documenterr5 r5 r6 �setup_documentersV s 4�rT )�msgr( c C s t jdtdd� t| � d S )Nz _simple_info() is deprecated.� ��
stacklevel)�warnings�warnr �print�rU r5 r5 r6 � _simple_infoe s �r] c C s& t jdtdd� td| tjd� d S )Nz _simple_warn() is deprecated.rV rW z WARNING: )�file)rY rZ r r[ �sys�stderrr\ r5 r5 r6 � _simple_warnk s �ra �=)�title�liner( c C s$ d| v rt d��| d |t| � S )N�
z Can only underline single lines)�
ValueError�len)rc rd r5 r5 r6 �
_underlineq s rh c @ sN e Zd ZdZd eeef edd�dd�Zee d�dd�Z
ee ed �d
d �Z dS )
�AutosummaryRendererz A helper class for rendering.N)rE � template_dirr( c C s� t |t�rtjdtdd� |r.tjdtdd� tj�tddd�g}t |j
|j j |�}t
|d�| _tj| jjd < tj| jjd
< t| jjd < t |ttf�r�|jr�| j�d � | j�|j� n.t |t�r�|jjr�| j�d � | j�|jj� d S )
NzLThe first argument for AutosummaryRenderer has been changed to Sphinx objectrV rW z<template_dir argument for AutosummaryRenderer is deprecated.�ext� autosummary� templates)�loader�escape�e� underlinezjinja2.ext.i18n)�
isinstancer rY rZ r �osr �joinr r% r0 r. �templates_pathr r- r ro �filtersrh r r& r' �
add_extensionZ install_gettext_translationsrE )r4 rE rj Zsystem_templates_pathrn r5 r5 r6 r7 z s0
�� �
z AutosummaryRenderer.__init__)�
template_namer( c C s< t jdtdd� z| j�|� W dS ty6 Y dS 0 dS )z Check if template file exists.z+AutosummaryRenderer.exists() is deprecated.rV rW TFN)rY rZ r r- � get_templater
)r4 rx r5 r5 r6 �exists� s � zAutosummaryRenderer.exists)rx �contextr( c C sb z| j �|�}W nF tyV z| j �d| �}W n tyP | j �d�}Y n0 Y n0 |�|�S )zRender a template file.zautosummary/%s.rstzautosummary/base.rst)r- ry r
�render)r4 rx r{ rA r5 r5 r6 r| � s zAutosummaryRenderer.render)N)
r; r< r= r> r r r rC r7 r3 rz r r| r5 r5 r5 r6 ri w s
ri c @ sX e Zd Zeedd�dd�Zeeed�dd�Zeeeed�d d
�Zee e d �d d
�Z
dS )�
ModuleScannerN)rE �objr( c C s || _ || _d S r9 )rE �object)r4 rE r~ r5 r5 r6 r7 � s zModuleScanner.__init__)r@ �valuer( c C s t | j|| j�jS r9 )r rE r rR )r4 r@ r� r5 r5 r6 �get_object_type� s z ModuleScanner.get_object_type)r@ r� rR r( c
C sZ z| j �d|||di �W S tyT } z$tjtd�||dd� W Y d }~dS d }~0 0 d S �Nzautodoc-skip-memberFz\autosummary: failed to determine %r to be documented, the following exception was raised:
%srl )�type)rE r: � Exception�logger�warningr )r4 r@ r� rR �excr5 r5 r6 �
is_skipped� s
�
�zModuleScanner.is_skipped)�imported_membersr( c C s� g }t | j| jj�D ]�}zt| j|�}W n ty> d }Y n0 | �||�}| �|||�r\qz0t� |�rnd}n t|d�| jj
kr�d}nd}W n ty� d}Y n0 | jjj }|r�|� |� q|du r�|� |� qdt
| j�v r|r|� |� q|S )NTr< F�__all__)�
members_ofr rE r. r# �AttributeErrorr� r� �inspectZismoduler; r, �append�dir)r4 r� �membersr@ r� rR �imported�respect_module_allr5 r5 r6 �scan� s2
zModuleScanner.scan) r; r< r= r r7 rC r� r3 r� r r� r5 r5 r5 r6 r} � s
r} )r~ �confr( c C s" |j rt| �S t| �p t| �S dS )z�Get the members of ``obj``, possibly ignoring the ``__all__`` module attribute
Follows the ``conf.autosummary_ignore_module_all`` setting.N)r, r� r" )r~ r� r5 r5 r6 r� � s r� ) r@ r~ �parentrA rx r� rE rB r{ �modname�qualnamer( c s� t � ||��ttttd�� fdd� �ttttf d��fdd� �ttttf d�� fdd� �ttttf d����fd d
� �g d fttt tt tttt tt f d �� ��fd
d�
} tttt tt f d��fdd� } tttt tt f d��fdd� }
i }|�|� �j dk�r�t
� |�}|� |�|d< | |dh|d�\|d< |d< | |dh|d�\|d< |d < | |d h|d�\|d < |d < | |d �\|d < |d!< t |d"�}|�r6|�r6|
|�\|d#< |d$< nl�j dk�r6t
|�|d< tt
|��t|j�� � |d%< | |d&hd'g�\|d(< |d)< | |d*d+h�\|d < |d!< | d u �sJ�d u �rVt��\} ��j d,v �rv��d-d.�d/ |d< �j d0v �r��}n��d-d.�d1 }�|d2< | |d< �|d3< ||d4< �j |d5< t��d6 |d7< |�r�|�||�S |��j |�S d S )8N)r~ r@ rR r( c
sX z� � d||| di �W S tyR } z$tjtd�||dd� W Y d }~dS d }~0 0 d S r� )r: r� r� r� r )r~ r@ rR r� �rE r5 r6 � skip_member� s
�
�z1generate_autosummary_content.<locals>.skip_member)r~ r( c s& t jj�| � gt�}dd� |�� D �S )Nc S s i | ]\}}||j �qS r5 )r )�.0r@ �memberr5 r5 r6 �
<dictcomp> � zKgenerate_autosummary_content.<locals>.get_class_members.<locals>.<dictcomp>)�sphinxrk Zautodoc�get_class_membersr# �items)r~ r� )r� r5 r6 r� s z7generate_autosummary_content.<locals>.get_class_membersc sD i }t | � j�D ].}zt| |�||< W q ty< Y qY q0 q|S r9 )r� r. r# r� )r~ r� r@ r� r5 r6 �get_module_members s z8generate_autosummary_content.<locals>.get_module_membersc s( � j dkr�| �S � j dkr$�| �S i S )N�module�class)rR )r~ )�docr� r� r5 r6 �get_all_members s
z5generate_autosummary_content.<locals>.get_all_membersT)r~ �types�include_publicr� r( c s� g }g }�| �}|� � D ]�\}}t� || �} | j|v r|sLt|dd �| jkr�||| j�}
|
du rdq|
du r�|�|� |�|� q|�|� ||v s�|�d�s|�|� q||fS )Nr< TF�_)r� r rR �getattrr; r� �
startswith) r~ r� r� r� r� �publicZ all_membersr@ r� rS Zskipped)rE r� r� r5 r6 � get_members s"
z1generate_autosummary_content.<locals>.get_members)r� r( c sx g g }}zRt �� �}|�� }|D ]6\}}|dkr"|| v r"|�|� |�d�s"|�|� q"W n tyn Y n0 ||fS )z'Find module attributes with docstrings.� r� )r Z
for_moduleZfind_attr_docsr� r� r )r� �attrsr� ZanalyzerZ attr_docs� namespaceZ attr_name�r@ r5 r6 �get_module_attrs0 s
z6generate_autosummary_content.<locals>.get_module_attrsc sz g }t �| j�D ]R\}}}� d | }z t|�}|rBt|d�rBW qW n tyV Y n0 |�|� qdd� |D �}||fS )N�.Z__sphinx_mock__c S s$ g | ] }|� d �d �d�s|�qS )r� ���r� )�splitr� )r� �xr5 r5 r6 �
<listcomp>K r� zEgenerate_autosummary_content.<locals>.get_modules.<locals>.<listcomp>)�pkgutilZ iter_modules�__path__r �hasattr� ImportErrorr� )r~ r� r� r� Z_ispkg�fullnamer� r� r� r5 r6 � get_modules? s z1generate_autosummary_content.<locals>.get_modulesr� r� �function)r� Z functionsZ
all_functionsr� �classesZ all_classes� exception�
exceptionsZall_exceptionsZ
attributesZall_attributesr� �modulesZ all_modulesZinherited_members�methodr7 �methodsZ all_methods� attribute�property)r� r� r� r� � r )r� r� r� Zobjnamer@ rR rb rq )r r rC r3 r r r r
�updaterR r} r� r� r� �set�__dict__�keysr! �rsplitrg r| )r@ r~ r� rA rx r� rE rB r{ r� r� r� r� r� �ns�scanner� ispackageZ shortnamer5 )rE r� r� r� r� r@ r� r� r6 � generate_autosummary_content� sh
��$$
���
�
�� �
r� �.rstFT�utf-8) �sources�
output_dir�suffix� base_path�builderrj r� rE � overwrite�encodingr( c
sl |rt jdtdd� |r(t jdtdd� tt| ��}
t|
�dkr^|
d d� dg |
dd � }
t�td �d
� |
� � |r�t�td �| � � d ur�� fd d
�| D �} t
|�} t | �} g }
|r�|j j
}ni }tt| �td�D �]h}|jd u r�q�|p�tj�|j�}t|� z*t|jdd�\}}}}|�|d d�}W n� t�y } z�z&t|j�\}}}}|�|d d�}W n� t�y� } zv|j�r�|j|jg }n |j|g }ttdd� |D ���}t� td�|jd� |�� W Y d }~W Y d }~q�W Y d }~n
d }~0 0 W Y d }~n
d }~0 0 i }|�r*|� |j j � t |||| |j |||j!|||� }tj� ||�"||�| �} tj�#| ��rt$| | d��} | �%� } W d � n1 �s�0 Y || k�r�q�nJ|�rFt$| d| d��} | �&|� W d � n1 �s�0 Y |
�'| � q�t$| d| d��} | �&|� W d � n1 �s20 Y |
�'| � q�|
�rht(|
||� |||||d� d S )Nz?builder argument for generate_autosummary_docs() is deprecated.rV rW zDtemplate_dir argument for generate_autosummary_docs() is deprecated.� �
z...i����z,[autosummary] generating autosummary for: %sz, z[autosummary] writing to %sc s g | ]}t j�� |��qS r5 )rs r rt )r� �filename�r� r5 r6 r� � r� z-generate_autosummary_docs.<locals>.<listcomp>)�keyT�Zgrouped_exceptionr� r� c s s | ]}d t |�j|f V qdS �z* %s: %sN�r� r; �r� rp r5 r5 r6 � <genexpr>� r� z,generate_autosummary_docs.<locals>.<genexpr>z5[autosummary] failed to import %s.
Possible hints:
%sre )r� �w)r� r� r� r� rj r� rE r� ))rY rZ r �list�sortedrg r� �infor rt ri �find_autosummary_in_filesr. r+ r� rC r rs �abspathr$ r r@ �replacer r r� � __cause__r� r� r� r* r� rA rB �get�isfile�open�read�writer� �generate_autosummary_docs) r� r� r� r� r� rj r� rE r� r� Zshowed_sourcesrA r� Z new_filesZ filename_map�entryr r@ r~ r� r� r� r� Zexc2r� �errorsr{ Zcontentr� �fZ old_contentr5 r� r6 r� � s� ��
�
�B
�(
* * �r� )� filenamesr( c C s^ g }| D ]P}t |ddd��.}|�� �� }|�t||d�� W d � q1 sN0 Y q|S )z^Find out what items are documented in source/*.rst.
See `find_autosummary_in_lines`.
r� �ignore)r� r� �r� N)r� r� �
splitlines�extend�find_autosummary_in_lines)r� �
documentedr� r� �linesr5 r5 r6 r� � s 2r� )r@ r� r� r( c
C s� |rt jdtdd� z2t| dd�\}}}}t�|��� }t|| |d�W S tyX Y nn t y� } z:t
t dd� |j D ���} t
d | d
�| �f � W Y d }~n&d }~0 ty� t
d | � Y n0 g S )
znFind out what items are documented in the given object's docstring.
See `find_autosummary_in_lines`.
zBmodule argument for find_autosummary_in_docstring() is deprecated.rV rW Tr� )r� r� c s s | ]}d t |�j|f V qdS r� r� r� r5 r5 r6 r� r� z0find_autosummary_in_docstring.<locals>.<genexpr>z'Failed to import %s.
Possible hints:
%sre Nz_Failed to import '%s'; the module executes module level statement and it might call sys.exit().)rY rZ r r �pydocZgetdocr� r� r� r r� r� r� r[ rt �
SystemExit)
r@ r� r� Z real_namer~ r� r� r� r� r� r5 r5 r6 � find_autosummary_in_docstring� s$ � * � r� )r� r� r� r( c C s� t �d�}t �d�}t �d�}t �d�}t �d�}t �d�}t �d�} g }
d} d } d }
|}d}d
}| D �]�}|�rt|�|�}|r�d } qf|�|�}|r�|�d �} |rftj�tj�|�| �} qf| �|�}|r�|�d ��� }
qf|�� � d
�r�qf|�|�}|�rV|�d ��� }|� d��r |d d � }|�r@|� |d ��s@d||f }|
�
t || |
| �� qf|�� rf|� |d ��rpqfd}|�|�}|�r�d }|�d �}d} d } d }
qf|� |�}|�r�|�d ��� }|
�
t||d�� qf|�|�}|rf|�d�}qfqf|
S )a� Find out what items appear in autosummary:: directives in the
given lines.
Returns a list of (name, toctree, template) where *name* is a name
of an object and *toctree* the :toctree: path of the corresponding
autosummary directive (relative to the root of the file name), and
*template* the value of the :template: option. *toctree* and
*template* ``None`` if the directive does not have the
corresponding options set.
z ^(\s*)\.\.\s+autosummary::\s*z.^\s*\.\.\s+automodule::\s*([A-Za-z0-9_.]+)\s*$z4^\s*\.\.\s+(current)?module::\s*([a-zA-Z0-9_.]+)\s*$z%^\s+(~?[_a-zA-Z][a-zA-Z0-9_.]*)\s*.*?z^\s+:recursive:\s*$z^\s+:toctree:\s*(.*?)\s*$z^\s+:template:\s*(.*?)\s*$FNr� Tr� �:�~r� z%s.%s� r� rV )�re�compile�match�grouprs r rt �dirname�stripr� r� r? �searchr� r� )r� r� r� Zautosummary_reZ
automodule_reZ module_reZautosummary_item_reZrecursive_arg_reZtoctree_arg_reZtemplate_arg_rer� rB ZtoctreerA Zcurrent_moduleZin_autosummaryZ base_indentrd �mr@ r5 r5 r6 r�
s�
��
�
�
�
r� )r( c C s� t jdtd�td�d�} | jddddt d � | jd
d td �d
� | jddddtd�d� | jdddddtd�d� | jdddd d td �d� | jd d d d!d"td#�d� | jd$d%d d&d"td'�d� | S )(Nz#%(prog)s [OPTIONS] <SOURCE_FILE>...z:For more information, visit <https://www.sphinx-doc.org/>.a�
Generate ReStructuredText using autosummary directives.
sphinx-autogen is a frontend to sphinx.ext.autosummary.generate. It generates
the reStructuredText files from the autosummary directives contained in the
given input files.
The format of the autosummary directive is documented in the
``sphinx.ext.autosummary`` Python module and can be read using::
pydoc sphinx.ext.autosummary
)�usage�epilog� descriptionz --version�versionZ show_versionz %%(prog)s %s)�action�destr
� source_file�+z&source files to generate rST files for)�nargs�helpz-oz --output-dir�storer� z directory to place all output in)r r r z-sz--suffixr� r z/default suffix for files (default: %(default)s))r r �defaultr z-tz --templatesrm z0custom template directory (default: %(default)s)z-iz--imported-members�
store_truer� Fz0document imported members (default: %(default)s)z-az--respect-module-allr� zPdocument exactly the members in module __all__ attribute. (default: %(default)s))�argparse�ArgumentParserr � add_argumentr )�parserr5 r5 r6 �
get_parserl s@ �
��
� � �
�
�r r� )�argvr( c C s� t j�tjd� t j�tj�td�d� t j� g d �\}}t
|�}t � |t
jt
j� t|� t� �| �}|jr�|jj�t�|j�� |j |j_t|j|j d|j |j |d� d S )Nr� �localer� r� )r� rE ) r� r � setlocale�LC_ALLZ init_consolers r rt r �initr& r Zsetupr_ �stdoutr` rT r �
parse_argsrm r. ru r� r� r� r, r� r r� r� r� )r r' r� rE r8 r5 r5 r6 �main� s
�r# �__main__)rb )NN) Nr� NNNFNTr� )NN)NN)Xr> r r� r rs r� r� r r_ rY �gettextr r �typingr r r r r r r
r r Zjinja2r
Zjinja2.sandboxr Z
sphinx.localer� r r Zsphinx.applicationr Zsphinx.buildersr Z
sphinx.configr Zsphinx.deprecationr rQ r Zsphinx.ext.autodoc.importerr Zsphinx.ext.autosummaryr r r r r Z
sphinx.pycoder r Zsphinx.registryr Z sphinx.utilr r r! Zsphinx.util.inspectr" r# Zsphinx.util.osutilr$ Zsphinx.util.templater% Z getLoggerr; r� r& r? rT rC r] ra rh ri r} r� r3 r� r� r� r� r� r r r r# r5 r5 r5 r6 �<module> s� ,
:6 �� �
� f
� � _."