| 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/__pycache__/ |
Upload File : |
a
�ab�K � @ s� d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddlm
Z
ddl m Z m
Z
mZmZ ddlZddlmZmZ dd lmZ dd
lmZ dd lmZmZ dd lmZ d
ej v r�ej d
� d�Z ng d�Z de e � Z e
�!edd�Z"e#e$d�dd�Z%e#e#d�dd�Z&dBe#ee# e$d�dd�Z'e#e#e dd �d d �Z(dCe#e#e e#dd �d d!�Z)g dfe#e#e#ee# e ee# e$ee# e#dd"�
d#d$�Z*dDee# e e#e#dd&�d'd(�Z+g fe#e ee# e$d)�d*d+�Z,e#e ee# e$d,�d-d.�Z-e#ee# e e
ee#ee# ee# f ddf d/�d0d1�Z.e#ee# e e$d/�d2d3�Z/dEe#ee# e e#ee# d4�d5d6�Z0e#ee# e$d7�d8d9�Z1ej2d:�d;d<�Z3ej4d=d� fee# e5d>�d?d@�Z6e7dAk�r�e6� dS )Fu
sphinx.ext.apidoc
~~~~~~~~~~~~~~~~~
Parses a directory tree looking for Python modules and packages and creates
ReST files appropriately to create code documentation with Sphinx. It also
creates a modules index (named modules.<suffix>).
This is derived from the "sphinx-autopackage" script, which is:
Copyright 2008 Société des arts technologiques (SAT),
https://sat.qc.ca/
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�copy��fnmatch)�EXTENSION_SUFFIXES)�path)�Any� Generator�List�Tuple)�__display_version__� package_dir)�
EXTENSIONS)�__)�FileAvoidWrite� ensuredir)� ReSTRendererZSPHINX_APIDOC_OPTIONS�,)�membersz
undoc-memberszshow-inheritance)z.pyz.pyxZ templatesZapidoc)�filename�returnc C s4 t �| �}tttdd�D ]}|d| kr dS qdS )z)Check *filename* is __init__ file or not.T)�key�reverse�__init__FN)r �basename�sorted� PY_SUFFIXES�len)r r �suffix� r �5/usr/lib/python3.9/site-packages/sphinx/ext/apidoc.py� is_initpy3 s
r )�modnamesr c G s d� td| ��S )z Join module names with dots.�.N)�join�filter)r! r r r � module_join= s r% )�dirname�filesr c C s8 |du r| du rdS |du r&t �| �}tdd� |D ��S )z+Check given *files* contains __init__ file.NFc s s | ]}t |�r|V qd S �N�r ��.0�fr r r � <genexpr>I � z is_packagedir.<locals>.<genexpr>)�os�listdir�any)r& r' r r r �
is_packagedirB s
r2 )�name�text�optsr c C s� t |dd�}t�|jd| |jf �}|jrB|s>ttd�| � dS |jsht� |�rh|s�ttd�| � nF|s|ttd�| � t
|��}|� |� W d � n1 s�0 Y dS )z0Write the output file for module/package <name>.�quietNz%s.%szWould create file %s.z!File %s already exists, skipping.zCreating file %s.) �getattrr r# �destdirr �dryrun�printr �force�isfiler �write)r3 r4 r5 r6 Zfnamer, r r r �
write_fileL s
r> )�packager r5 �user_template_dirr c C s` t t�}|jr d|vr |�d� t| |�}|j |||d�}t|tg��d|�}t |||� dS )�.Build the text of the file and write the file.�private-members)�
show_headingsr �qualname�automodule_optionsz module.rst_tN)
r �OPTIONS�includeprivate�appendr% �
noheadingsr � template_dir�renderr> )r? r r5 r@ �optionsrD �contextr4 r r r �create_module_file_ s
�rN )
�root�master_package�subroot�py_filesr5 �subs� is_namespace�excludesr@ r c
s� � ����fdd�|D �} � ��fdd�|D �}
��fdd�|
D �}
t t�} �jrdd| vrd| �d� t���} | | |
|�j�j| �j �jd� }
t |t
g�� d|
�}t | |�� |
r҈jr�|
D ]}t
d|�|� q�dS ) rA c s, g | ]$}t t��|��� �st��|��qS r )�is_skipped_packager r# r% )r+ �pkgname�rU rP r5 rO rQ r r �
<listcomp>v s �z'create_package_file.<locals>.<listcomp>c s6 g | ].}t t��|��� �st|�s|�d �d �qS )r" r )�is_skipped_moduler r# r �split�r+ �sub)rU r5 rO r r rY z s �c s g | ]}t � �|��qS r )r% )r+ �modname)rP rQ r r rY } s �rB ) rW � subpackages�
submodulesrT � modulefirst�separatemodulesrE rC �maxdepthz
package.rst_tN)r rF rG rH r% ra rb rI rc r rJ rK r> rN )rO rP rQ rR r5 rS rT rU r@ r_ r` rL rW rM r4 Z submoduler rX r �create_package_fileq s4 � �
�
rd �modules)re r5 r3 r@ r c C sp | � � d}| dd� D ]"}|�|d �r6| �|� q|}q|j|j| d�}t|tg��d|�}t|||� dS )zCreate the module's index.� Nr" )�headerrc Zdocnamesz toc.rst_t) �sort�
startswith�removerg rc r rJ rK r> )re r5 r3 r@ � prev_module�modulerM r4 r r r �create_modules_toc_file� s �rm )r& r5 rU r c sd t �� �sdS t�t �� d��}tdd� |D ��}|s@|js@dS t� �fdd�|D ��r\dS dS dS )�%Check if we want to skip this module.Fz*.pyc s s | ]}t |�r|V qd S r( r) r* r r r r- � r. z%is_skipped_package.<locals>.<genexpr>Tc 3 s | ]}t t�� |���V qd S r( )� is_excludedr r# r* �r& rU r r r- � r. N)r �isdir�globr# r1 �implicit_namespaces�all)r& r5 rU r' Zregular_packager rp r rV � s
rV )r r5 rU r c C s0 t �| �sdS t �| ��d�r(|js(dS dS dS )rn T�_FN)r �existsr ri rG )r r5 rU r r r rZ � s
rZ )�rootpathrU r5 r c # s� t |dd�}t |dd�}tj| |d�D ]^\�}}t��fdd�|D ��}|rRd� nd� t� ��fd d�|D ��|d
d
�< �||fV q&d
S ) z@Walk through the directory and list files and subdirectories up.� followlinksFrG )rx c 3 s. | ]&}|� t�rtt��|�� �s|V qd S r( )�endswithr ro r r# r* )rU rO r r r- � s
�zwalk.<locals>.<genexpr>)r" )r" ru c 3 s. | ]&}|� � �stt��|���s|V qd S r( )ri ro r r# r\ �Zexclude_prefixesrU rO r r r- � s �N)r7 r/ �walkr )rw rU r5 rx rG rS r' r rz r r{ � s "r{ c C s& t | ||�D ]\}}}|r dS q dS )zACheck the given directory contains child module/s (at least one).TF)r{ )rw rU r5 �_rootZ_subsr' r r r �has_child_module� s r} )rw rU r5 r@ r c C s� t |dd�}t| �s|r*| �tj�d }nd}g }t| ||�D �]:\}}} td| �}
|
o\|} |
r�| dd� D ]"} t| �rn| �| � | �d| � qnn|| kr�|s�|dd�= q>|
s�| �r2|s�t | �dks�t
||��sz|t | �d� � tj�� tjd�}
| �rt
|||��rzt|||
| ||| ||� |�t||
�� q>| D ]B}tt�| |�||��s6|�d�d }t||||� |�|� �q6q>|S )z`
Look for every file in the directory tree and create the corresponding
ReST files.
rs F���Nr � r" )r7 r2 r[ r �sepr{ r rj �insertr rV �lstrip�replacer} rd rH r% rZ r# rN )rw rU r5 r@ rs Z root_packageZ toplevelsrO rS r' Zis_pkgrT r, Z
subpackageZpy_filerl r r r � recurse_tree� sD
�
�r� )rO rU r c C s |D ]}t | |�r dS qdS )z�Check if the directory is in the exclude list.
Note: by having trailing slashes, we avoid common prefix issues, like
e.g. an exclude "foo" also accidentally excluding "foobar".
TFr )rO rU �excluder r r ro # s
ro )r c C s� t jdtd�td�d�} | jddddt d � | jd
td �d � | jd
dtd�d� | jdddddtd�d� | jdddtd�d � | jd d dd td td!�d"� | jd#d$dd%td&�d � | jd'd(dd)d*td+�d,� | jd-d.dd/td0�d � | jd1d2dd3td4�d � | jd5d6dd7td8�d � | jd9dd:d;td<�d,� | jd=d>d?d:td@�d � | jdAdBddCtdD�d � | jdEdFddGtdH�d � | jdIddJtdK�d � | jdLdMddNdOtdP�d,� | jdQdRddStdT�d � | jdUdVddWtdX�d � | jdYdZdd[td\�d � | jd]d^dd_td`�d � | jdadbddtdc�d � | jdddeddftdg�d � | �tdh��}|jdidjdkdltdm�dn� tD ]*}|jdo| dpdq| dktdr�| ds� �qd| �tdt��}|jdudvdwdxtdy�dz� | S ){NzH%(prog)s [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, ...]z:For more information, visit <https://www.sphinx-doc.org/>.aE
Look recursively in <MODULE_PATH> for Python modules and packages and create
one reST file with automodule directives per package in the <OUTPUT_PATH>.
The <EXCLUDE_PATTERN>s can be file and/or directory patterns that will be
excluded from generation.
Note: By default this script will not overwrite already created files.)�usage�epilog� descriptionz --version�versionZ show_versionz %%(prog)s %s)�action�destr� � module_pathzpath to module to document)�help�exclude_pattern�*zGfnmatch-style file and/or directory patterns to exclude from generation)�nargsr� z-oz --output-dir�storer8 Tz directory to place all output)r� r� �requiredr� z-q�
store_truer6 z,no output on stdout, just warnings on stderr)r� r� r� z-dz
--maxdepthrc � z;maximum depth of submodules to show in the TOC (default: 4))r� r� �type�defaultr� z-fz--forcer; zoverwrite existing filesz-lz--follow-linksrx FzNfollow symbolic links. Powerful when combined with collective.recipe.omelette.)r� r� r� r� z-nz --dry-runr9 z%run the script without creating filesz-ez
--separaterb z1put documentation for each module on its own pagez-Pz --privaterG zinclude "_private" modulesz --tocfile�tocfilere z0filename of table of contents (default: modules)z-Tz--no-toc� store_falsez%don't create a table of contents filez-Ez
--no-headingsrI zedon't create headings for the module/package packages (e.g. when the docstrings already contain them)z-Mz--module-firstra z7put module documentation before submodule documentationz--implicit-namespacesrs zNinterpret module paths according to PEP-0420 implicit namespaces specificationz-sz--suffixr Zrstzfile suffix (default: rst)z-Fz--full�fullz.generate a full project with sphinx-quickstartz-az--append-syspath�append_syspathz9append module_path to sys.path, used when --full is givenz-Hz
--doc-projectrg z(project name (default: root module name)z-Az --doc-author�authorz,project author(s), used when --full is givenz-Vz
--doc-versionz*project version, used when --full is givenz-Rz
--doc-release�releasezEproject release, used when --full is given, defaults to --doc-versionzextension optionsz --extensionsr
�
extensionsrH zenable arbitrary extensions)�metavarr� r� r� z--ext-%s� append_constz
sphinx.ext.%szenable %s extension)r� �constr� r� zProject templatingz-tz
--templatedirZ TEMPLATEDIR� templatedirz%template directory for template files)r� r� r� )�argparse�ArgumentParserr � add_argumentr �int�add_argument_groupr
)�parser�group�extr r r �
get_parser/ s� �
��� �
� � �
� �
�
� � �
�
�� � �
� � � � �
�
�
�r� r )�argvr c C s. t j�tjd� t j�tj�td�d� t � }|�
| �}t� |j �}|j
du r`|�tj�d |_
|j�d�r||jdd� |_t�|�s�ttd�| tjd � t�d� |js�t|j� d
d � |jD �}t ||||j �}|j �rd d
l m } |�!� d}d}|D ]&} | �|d ��rq�| }|d| 7 }q�|jdd|j
|j"�p<d|j#�pFd|j$�pX|j#�pXdd|j ddg d�ddd|j%|d||j&d�}
|j'�r�|
d �(|j'� |j)�r�d|
d< |
d dd� D ]2} d| v �r�|
d �*| � |
d �(| �d�� �q�|j�s*|j+|
d|j,|j d� n|j-�r*t.|||j-|j � d S )z+Parse and check the command line arguments.rf �locale�sphinxNr~ r" r z%s is not a directory.)�filec S s g | ]}t �|��qS r )r �abspath)r+ r� r r r rY � r. zmain.<locals>.<listcomp>r )�
quickstartz %s
Fru ZAuthor�indexT)zsphinx.ext.autodoczsphinx.ext.viewcodezsphinx.ext.todo�en)r r� �dotZprojectr� r� r� r ZmasterZepubr� ZmakefileZ batchfileZ make_modeZmastertocmaxdepthZ
mastertoctree�languager� r� r� r6 r )ZsilentZ overwriter� )/r� r� � setlocale�LC_ALLZ init_consoler/ r r# r r� �
parse_argsr� r� rg r[ r� r ri rq r: r �sys�stderr�exitr9 r r8 r� r� r� r� Z
sphinx.cmdr� rh r� r� r� rc r� r� �extendr6 rj Zgenerater; r� rm ) r� r� �argsrw rU re �qsrk r4 rl �dr� r r r �main� sz
�
�r� �__main__)NN)N)re N)N)8�__doc__r� rr r� r/ r� r r Zimportlib.machineryr r �typingr r r r
Z
sphinx.localer� r r Zsphinx.cmd.quickstartr
r Zsphinx.util.osutilr r Zsphinx.util.templater �environr[ rF �tupler r# rJ �str�boolr r% r2 r> rN rd rm rV rZ r{ r} r� ro r� r� r� r� r� �__name__r r r r �<module> sl
�� �
� & � �
�
� � 6 a"L