Dashboard
PHP:
8.2.30
OS:
Linux
User:
dh_nv8b2m
/
/
usr
/
lib
/
python3
/
dist-packages
/
sphinx
/
ext
/
autosummary
/
__pycache__
📤 Upload
📝 New File
📁 New Folder
Close
Editing: generate.cpython-310.pyc
o o�a�` � @ s8 d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z ddlm Z ddl mZmZmZmZmZmZmZmZ ddlmZ ddlmZ ddlZddlm 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- ddlm.Z. ddl/m0Z0m1Z1 ddl2m3Z3 ddl4m5Z5m6Z6m7Z7 ddl8m9Z9 ddl:m;Z; ddl<m=Z= e5�>e?�Z@G dd� d�ZAG dd� de�ZBded dfd d �ZCd eDd dfd d!�ZEd eDd dfd"d#�ZFdXd%eDd&eDd eDfd'd(�ZGG d)d*� d*�ZHG d+d,� d,�ZI dYd-eDd.ed/ed0eHd1eDd2eJded3eJd4ed5eDd6eDd eDfd7d8�ZK <dZd=eeD d>eDd?eDd@eDdAe!dBeDd2eJdedCeJdDeDd dfdEdF�ZLdGeeD d eeB fdHdI�ZMdYd-eDdJeDdKeDd eeB fdLdM�ZNdYdNeeD dJeDdKeDd eeB fdOdP�ZOd ejPfdQdR�ZQejRdSd� fdTeeD d dfdUdV�ZSe?dWk�r�eS� dS dS )[a" 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-2021 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. � N)�NullTranslations)�path)�Any�Dict�List� NamedTuple�Set�Tuple�Type�Union)�TemplateNotFound)�SandboxedEnvironment)�__display_version__� package_dir)�Sphinx)�Builder)�Config)�RemovedInSphinx50Warning)� Documenter)� import_module)�get_documenter�import_by_name�import_ivar_by_name)�__)�ModuleAnalyzer� PycodeError)�SphinxComponentRegistry)�logging�rst�split_full_qualified_name)� safe_getattr)� ensuredir)�SphinxTemplateLoaderc @ s4 e Zd ZdZdeddfdd�Zdeddfdd �ZdS ) �DummyApplicationz3Dummy Application class for sphinx-autogen command.� translator�returnNc C sf t � | _t� | _g | _d| _|| _d| _d| _d| _ | j� di dd � | j� di dd � | j� � d S )N�/r F�autosummary_contextT�autosummary_filename_map) r �configr �registry� messagelog�srcdirr$ � verbosity� _warncount�warningiserror�add� init_values)�selfr$ � r3 �A/usr/lib/python3/dist-packages/sphinx/ext/autosummary/generate.py�__init__; s zDummyApplication.__init__�argsc G s d S �Nr3 )r2 r6 r3 r3 r4 �emit_firstresultI s z!DummyApplication.emit_firstresult)�__name__� __module__� __qualname__�__doc__r r5 r r8 r3 r3 r3 r4 r# 8 s r# c @ s. e Zd ZU eed< eed< eed< eed< dS )�AutosummaryEntry�namer �template� recursiveN)r9 r: r; �str�__annotations__�boolr3 r3 r3 r4 r= M s r= �appr% c C sl ddl m}m}m}m}m}m}m}m}m } m } m } ||||||| | ||| g } | D ] } | j � | j| � q)d S )Nr ) �AttributeDocumenter�ClassDocumenter�DataDocumenter�DecoratorDocumenter�ExceptionDocumenter�FunctionDocumenter�MethodDocumenter�ModuleDocumenter�NewTypeAttributeDocumenter�NewTypeDataDocumenter�PropertyDocumenter)�sphinx.ext.autodocrE rF rG rH rI rJ rK rL rM rN rO r* �add_documenter�objtype)rD rE rF rG rH rI rJ rK rL rM rN rO � documenters� documenterr3 r3 r4 �setup_documentersT s 4��rU �msgc C s t jdtdd� t| � d S )Nz _simple_info() is deprecated.� �� stacklevel)�warnings�warnr �print�rV r3 r3 r4 � _simple_infoc s � r^ c C s& t jdtdd� td| tjd� d S )Nz _simple_warn() is deprecated.rW rX z WARNING: )�file)rZ r[ r r\ �sys�stderrr] r3 r3 r4 � _simple_warni s �rb �=�title�linec C s$ d| v rt d��| d |t| � S )N� z Can only underline single lines)� ValueError�len)rd re r3 r3 r4 � _underlineo s ri c @ sX e Zd ZdZddeeef deddfdd�Zdede fd d �Z ded e defd d �Z dS )�AutosummaryRendererz A helper class for rendering.NrD � template_dirr% c C s� t |t�r tjdtdd� |rtjdtdd� tj�tddd�g}t |j |j j |�}t |d�| _tj| jjd < tj| jjd < t| jjd < t |ttf�r_|jr]| j�d � | j�|j� d S d S t |t�rx|jjrz| j�d � | j�|jj� d S d S d S ) NzLThe first argument for AutosummaryRenderer has been changed to Sphinx objectrW rX z<template_dir argument for AutosummaryRenderer is deprecated.�ext� autosummary� templates)�loader�escape�e� underlinezjinja2.ext.i18n)� isinstancer rZ r[ r �osr �joinr r" r, r) �templates_pathr �envr rp �filtersri r r# r$ � add_extension� install_gettext_translationsrD )r2 rD rk �system_templates_pathro r3 r3 r4 r5 x s6 �� � � �z AutosummaryRenderer.__init__� template_namec C s8 t jdtdd� z | j�|� W dS ty Y dS w )z Check if template file exists.z+AutosummaryRenderer.exists() is deprecated.rW rX TF)rZ r[ r rw � get_templater )r2 r| r3 r3 r4 �exists� s � �zAutosummaryRenderer.exists�contextc C sb z| j �|�}W n# ty+ z | j �d| �}W n ty( | j �d�}Y nw Y nw |�|�S )zRender a template file.zautosummary/%s.rstzautosummary/base.rst)rw r} r �render)r2 r| r r? r3 r3 r4 r� � s ��� zAutosummaryRenderer.renderr7 ) r9 r: r; r< r r r rA r5 rC r~ r r� r3 r3 r3 r4 rj u s rj c @ sh e Zd Zdededdfdd�Zdededefd d �Zdeded edefd d �Zdede e fdd�Z dS )� ModuleScannerrD �objr% Nc C s || _ || _d S r7 )rD �object)r2 rD r� r3 r3 r4 r5 � s zModuleScanner.__init__r> �valuec C s t | j|| j�jS r7 )r rD r� rR )r2 r> r� r3 r3 r4 �get_object_type� s z ModuleScanner.get_object_typerR c C sV z | j �d|||di �W S ty* } ztjtd�||dd� W Y d }~dS d }~ww �Nzautodoc-skip-memberFz\autosummary: failed to determine %r to be documented, the following exception was raised: %srm )�type)rD r8 � Exception�logger�warningr )r2 r> r� rR �excr3 r3 r4 � is_skipped� s � ���zModuleScanner.is_skipped�imported_membersc C s� g }t | j�D ]Y}zt| j|�}W n ty d }Y nw | �||�}| �|||�r+qzt�|�r4d}nt|d�| jjkr@d}nd}W n tyN d}Y nw |rW|� |� q|du r`|� |� q|S )NTr: F) �dirr� r �AttributeErrorr� r� �inspect�ismoduler9 �append)r2 r� �membersr> r� rR �importedr3 r3 r4 �scan� s4 � � � �zModuleScanner.scan) r9 r: r; r r5 rA r� rC r� r r� r3 r3 r3 r4 r� � s r� r> r� �parentr? r| r� r@ r �modname�qualnamec s t � ||��dtdtdtdtf� fdd� �dtdtttf f�fdd� �dtdtttf fd d ��dtdtttf f���fd d � �g d fdtdtt dtt dtdttt tt f f � ��fdd� } dtdttt tt f f�fdd� } dtdttt tt f f�fdd� } i }|�|� �j dkr�t � |�}|� |�|d< | |dh|d�\|d< |d < | |d h|d�\|d < |d < | |d h|d�\|d!< |d"< | |d �\|d#< |d$< t |d%�}|r�|r�| |�\|d&< |d'< n6�j d k�r"t |�|d< tt |��t|j�� � |d(< | |d)hd*g�\|d+< |d,< | |d-d.h�\|d#< |d$< | d u �s,�d u �r2t��\} ��j d/v �rB��d0d1�d2 |d < �j d3v �rK�}n��d0d1�d4 }�|d5< | |d< �|d6< ||d< �j |d< t��d7 |d8< |�ry|�||�S |��j |�S )9Nr� r> rR r% c sT z � � d||| di �W S ty) } ztjtd�||dd� W Y d }~dS d }~ww r� )r8 r� r� r� r )r� r> rR r� )rD r3 r4 � skip_member� s � ���z1generate_autosummary_content.<locals>.skip_memberc s& t jj�| � gt�}dd� |�� D �S )Nc S s i | ]\}}||j �qS r3 )r� )�.0r> �memberr3 r3 r4 � <dictcomp>� s zKgenerate_autosummary_content.<locals>.get_class_members.<locals>.<dictcomp>)�sphinxrl �autodoc�get_class_membersr �items)r� r� )r� r3 r4 r� � s z7generate_autosummary_content.<locals>.get_class_membersc S s: i }t | �D ]}z t| |�||< W q ty Y qw |S r7 )r� r r� )r� r� r> r3 r3 r4 �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� r3 r4 �get_all_members� s z5generate_autosummary_content.<locals>.get_all_membersT�types�include_publicr� c s� g }g }�| �}|� � D ]H\}}t� || �} | j|v rT|s&t|dd �| jkrT�||| j�} | du r2q | du rA|�|� |�|� q |�|� ||v sO|�d�sT|�|� q ||fS )Nr: TF�_)r� r rR �getattrr9 r� � startswith) r� r� r� r� r� �public� all_membersr> r� rT �skipped)rD r� r� r3 r4 � get_members s$ �z1generate_autosummary_content.<locals>.get_membersr� c s| g g }}z,t �� �}|�� }|D ]\}}|dkr,|| v r,|�|� |�d�s,|�|� qW ||fS ty= Y ||fS w )z'Find module attributes with docstrings.� r� )r � for_module�find_attr_docsr� r� r )r� �attrsr� �analyzer� attr_docs� namespace� attr_name�r> r3 r4 �get_module_attrs s �� ��z6generate_autosummary_content.<locals>.get_module_attrsc sz g }t �| j�D ])\}}}� d | }zt|�}|r!t|d�r!W qW n ty+ Y nw |�|� qdd� |D �}||fS )N�.�__sphinx_mock__c S s$ g | ]}|� d �d �d�s|�qS )r� ���r� )�splitr� )r� �xr3 r3 r4 � <listcomp>: s $ zEgenerate_autosummary_content.<locals>.get_modules.<locals>.<listcomp>)�pkgutil� iter_modules�__path__r �hasattr� ImportErrorr� )r� r� r� r� �ispkg�fullnamer� r� r� r3 r4 � get_modules. s � � z1generate_autosummary_content.<locals>.get_modulesr� �function)r� � functions� all_functionsr� �classes� all_classes� exception� exceptions�all_exceptions� attributes�all_attributesr� �modules� all_modules�inherited_members�methodr5 �methods� all_methods� attribute�property)r� r� r� r� � r )r� r� r� �objnamerc rr )r r rA rC r r r r �updaterR r� r� r� r� �set�__dict__�keysr �rsplitrh r� )r> r� r� r? r| r� rD r@ r r� r� r� r� r� �ns�scanner� ispackage� shortnamer3 )rD r� r� r� r� r> r� r� r4 � generate_autosummary_content� sn " ���&& ��� � � �� � r� �.rstFT�utf-8�sources� output_dir�suffix� base_path�builderrk � overwrite�encodingc s |r t jdtdd� |rt jdtdd� tt| ��} t| �dkr/| d d� dg | dd � } t�td �d � | � � |rFt�td �| � � d urS� fd d �| D �} t |�} t | �} g } |rd|j j }ni }tt| �td�D �]}|jd u rwqn|ptj�|j�}t|� zt|j�\}}}}|�|d d�}W n@ ty� } z4zt|j�\}}}}|�|d d�}W n ty� t�td�|j|f � Y W Y d }~qnw W Y d }~nd }~ww i }|r�|�|j j� t |||| |j |||j |||� }tj� ||� ||�| �}tj� |��rNt!|| d�� }|�"� }W d � n 1 �s w Y ||k�r(qn|�rMt!|d| d�� }|�#|� W d � n 1 �sCw Y | �$|� qnt!|d| d�� }|�#|� W d � n 1 �sfw Y | �$|� qn| �r�t%| ||� |||||d� d S d S )Nz?builder argument for generate_autosummary_docs() is deprecated.rW rX 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 r3 )rt r ru )r� �filename�r� r3 r4 r� � s z-generate_autosummary_docs.<locals>.<listcomp>)�keyr� r� z%[autosummary] failed to import %r: %s)r� �w)r� r� r� r� rk r� rD r� )&rZ r[ r �list�sortedrh r� �infor ru rj �find_autosummary_in_filesr) r( r� rA r rt �abspathr! r r> �replacer� r r� r� r' r� r? r@ �get�isfile�open�read�writer� �generate_autosummary_docs) r� r� r� r� r� rk r� rD r� r� �showed_sourcesr? r� � new_files� filename_map�entryr r> r� r� r� r� rq r �contentr� �f� old_contentr3 r� r4 r� p s� �� � � ��� � � � � � ��r� � filenamesc C s^ g }| D ](}t |ddd��}|�� �� }|�t||d�� W d � n1 s'w Y q|S )z^Find out what items are documented in source/*.rst. See `find_autosummary_in_lines`. r� �ignore)r� �errors�r� N)r� r� � splitlines�extend�find_autosummary_in_lines)r � documentedr� r �linesr3 r3 r4 r� � s ��r� r� r� c C s� |r t jdtdd� zt| �\}}}}t�|��� }t|| |d�W S ty+ Y g S t yE } zt d| |f � W Y d}~g S d}~w t yT t d| � Y g S w )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.rW rX )r� r� zFailed to import '%s': %sNz_Failed to import '%s'; the module executes module level statement and it might call sys.exit().) rZ r[ r r �pydoc�getdocr r r� r� r\ � SystemExit) r> r� r� � real_namer� r� r� r rq r3 r3 r4 � find_autosummary_in_docstring� s* � �� ���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 ]�}|r�|�|�}|rAd } q3|�|�}|r[|�d �} |rZtj�tj�|�| �} q3| �|�}|rj|�d ��� } q3|�� � d �rrq3|�|�}|r�|�d ��� }|� d�r�|d d � }|r�|� |d �s�d||f }| � t || | | �� q3|�� r�|� |d �r�q3d}|�|�}|r�d }|�d �}d} d } d } q3|� |�}|r�|�d ��� }| � t||d�� q3|�|�}|r�|�d�}q3q3| 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 rW )�re�compile�match�grouprt r ru �dirname�stripr� r� r= �searchr r )r r� r� �autosummary_re� automodule_re� module_re�autosummary_item_re�recursive_arg_re�toctree_arg_re�template_arg_rer r@ �toctreer? �current_module�in_autosummary� base_indentre �mr> r3 r3 r4 r � s� �� � � � �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� | 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�version� 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)r0 r1 r5 z-sz--suffixr� r z/default suffix for files (default: %(default)s))r0 r1 �defaultr5 z-tz --templatesrn z0custom template directory (default: %(default)s)z-iz--imported-members� store_truer� Fz0document imported members (default: %(default)s))�argparse�ArgumentParserr � add_argumentr )�parserr3 r3 r4 � get_parserS s8 � �� � � � �r= r� �argvc C s� t j�tjd� t j�tj�td�d� t j� g d �\}}t |�}t � |t jt j� t|� t� �| �}|jrB|jj�t�|j�� t|j|jd|j |j |d� d S )Nr� �localer� r� )r� rD ) r� r? � setlocale�LC_ALL� init_consolert r ru r �initr# r �setupr` �stdoutra rU r= � parse_argsrn r) rv r� r� r� r2 r� r� r� )r> r$ r� rD r6 r3 r3 r4 �main} s �rG �__main__)rc )NN) Nr� NNNFNTr� )Tr< r9 r� r? rt r� r r r` rZ �gettextr r �typingr r r r r r r r �jinja2r �jinja2.sandboxr � sphinx.localer� r r �sphinx.applicationr �sphinx.buildersr � sphinx.configr �sphinx.deprecationr rP r �sphinx.ext.autodoc.importerr �sphinx.ext.autosummaryr r r r � sphinx.pycoder r �sphinx.registryr � sphinx.utilr r r �sphinx.util.inspectr �sphinx.util.osutilr! �sphinx.util.templater" � getLoggerr9 r� r# r= rU rA r^ rb ri rj r� rC r� r� r� r r r: r= r> rG r3 r3 r3 r4 �<module> s� ( :6��������� � ��������� �_ � �_$* �
Save
Cancel