|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/sphinx/pycode/__pycache__/ |
Upload File : |
o
�$�aR � @ s� d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
mZmZ ddlmZmZ ddlmZmZmZmZmZ ddlmZ dd lmZmZ e� d
�Z e� d �Z e� d �Z d
e de fdd�Z!dej"deej# fdd�Z$d&dej"dej%dee fdd�Z&de de fdd�Z'G dd� d�Z(G d d � d �Z)G d d � d e)�Z*G d d!� d!ej+�Z,G d"d#� d#e)�Z-G d$d%� d%�Z.dS )'z�
sphinx.pycode.parser
~~~~~~~~~~~~~~~~~~~~
Utilities parsing and analyzing Python code.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)� OrderedDict)� Signature)�DEDENT�INDENT�NAME�NEWLINE�NUMBER�OP�STRING)�COMMENT�NL)�Any�Dict�List�Optional�Tuple)�ast)�parse�unparsez^\s*#: ?(.*)
?
?$z^\s*$z ^\s*(#.*)?$�code�returnc C s | � dd�S )N� � )�replace)r � r �6/usr/lib/python3/dist-packages/sphinx/pycode/parser.py�filter_whitespace s r �nodec C s t | tj�r | jS | jgS )z3Get list of targets from Assign and AnnAssign node.)�
isinstancer �Assign�targets�target)r r r r �get_assign_targets s r" �selfc C s |r|j }| jj}|dv rtd| ��|dkr*|du s | j|kr$| jgS td| ��|dv rKg }| jD ]}z
|�t||�� W q3 tyH Y q3w |S |dkro| jjjdkri|ri| jj|kridt| j |�d gS td| ��|d
krv| gS |d kr�t| j|�S t
d | ��)
z�Convert assignment-AST to variable names.
This raises `TypeError` if the assignment does not create new variable::
ary[0] = 'foo'
dic["bar"] = 'baz'
# => TypeError
)�Index�Num�Slice�Str� Subscriptz %r does not create new variable�NameNz*The assignment %r is not instance variable)r r � Attributez%sr �str�StarredzUnexpected node name %r) �arg� __class__�__name__� TypeError�id�elts�extend�get_lvar_names�value�attr�NotImplementedError)r r# �self_id� node_name�members�eltr r r r4 ( s6
� r4 �sc C s2 ddd�}| |_ t�|�}|r|�d��d�S dS )z1Remove common leading indentation from docstring.r Nc S s d S �Nr r r r r �dummyT s z dedent_docstring.<locals>.dummyz
� �r N)�__doc__�inspect�getdoc�lstrip�rstrip)r< r> � docstringr r r �dedent_docstringR s
rG c @ st e Zd ZdZdededeeef deeef deddf d d
�Zd ede fd d
�Z
dede fdd�Z defdd�Z dS )�Tokenz)Better token wrapper for tokenize module.�kindr5 �start�end�sourcer Nc C s" || _ || _|| _|| _|| _d S r= )rI r5 rJ rK rL )r# rI r5 rJ rK rL r r r �__init__c s
zToken.__init__�otherc C sb t |t�r
| j|kS t |t�r| j|kS t |ttf�r%| j| jgt|�kS |d u r+dS td| ��)NFzUnknown value: %r)r �intrI r+ r5 �list�tuple�
ValueError)r# rN r r r �__eq__k s
z Token.__eq__�
conditionsc s t � fdd�|D ��S )Nc 3 s � | ]}� |kV qd S r= r )�.0� candidate�r# r r � <genexpr>x s � z Token.match.<locals>.<genexpr>)�any)r# rT r rW r �matchw s z Token.matchc C s dt j| j | j�� f S )Nz<Token kind=%r value=%r>)�tokenize�tok_namerI r5 �striprW r r r �__repr__z s �zToken.__repr__)
r/ �
__module__� __qualname__rA rO r
r r+ rM �boolrS rZ r^ r r r r rH ` s "�
� rH c @ sX e Zd Zdee ddfdd�Zdedefdd�Zdefd d
�Z d e
dee fd d
�Z dS )�TokenProcessor�buffersr Nc s2 t |�� || _t�� fdd��| _d | _d | _d S )Nc s t � �S r= )�nextr ��linesr r �<lambda>� s z)TokenProcessor.__init__.<locals>.<lambda>)�iterrc r[ �generate_tokens�tokens�current�previous)r# rc r re r rM � s
zTokenProcessor.__init__�linenoc C � | j |d S �zReturns specified line.� �rc �r# rm r r r �get_line� � zTokenProcessor.get_linec C s> z| j | _tt| j�� | _ W | j S ty d| _ Y | j S w )z_Fetch the next token from source code.
Returns ``None`` if sequence finished.
N)rk rl rH rd rj �
StopIterationrW r r r � fetch_token� s ��zTokenProcessor.fetch_token� conditionc C s� g }| � � rJ|�| j� | j|kr |S | jtdgkr%|| �tdg�7 }n!| jtdgkr6|| �tdg�7 }n| jtdgkrF|| �tdg�7 }| � � s|S )zlFetch tokens until specified token appeared.
.. note:: This also handles parenthesis well.
�(�)�{�}�[�])rv �appendrk r � fetch_until)r# rw rj r r r r � s
�� zTokenProcessor.fetch_until) r/ r_ r` r r+ rM rO rs rH rv r
r r r r r rb s
rb c sJ e Zd ZdZdee ddf� fdd� Zdee fdd�Zd d d
�Z � Z
S ) �AfterCommentParserz�Python source code parser to pick up comments after assignments.
This parser takes code which starts with an assignment statement,
and returns the comment for the variable if one exists.
rf r Nc s t � �|� d | _d S r= )�superrM �comment�r# rf �r. r r rM � s
zAfterCommentParser.__init__c C s� g }| � � rg|�| j� | jtdgkr || �tdg�7 }nF| jtdgkr.|| �tdg�7 }n5| jtdgkr?|| �tdg�7 }n$| jtkrL|| �t�7 }n| jtdgkrV |S | jjttt t
fvrc |S | � � s|S )z%Fetch right-hand value of assignment.rx ry rz r{ r| r} �;) rv r~ rk r r r r rI r r r
)r# rj r r r � fetch_rvalue� s&
��z AfterCommentParser.fetch_rvaluec C sh | � � �tdgtt�s| jsJ �| � � �tdgtt�r | jtdgkr&| �� | jtkr2| jj| _dS dS )z3Parse the code and obtain comment after assignment.�=N) rv rZ r r r rk r� r5 r� rW r r r r � s
�
�zAfterCommentParser.parser@ ) r/ r_ r` rA r r+ rM rH r� r �
__classcell__r r r� r r� � s
r� c s� e Zd ZdZdee deddf� fdd� Zdedeee fd d
�Zdeddfd d �Z deddfd
d�Z
de j ddfdd�Z
dededdfdd�Zdede jddfdd�Zdee j defdd�Zdee j defdd �Zdee j fd d �Zd edefd d!�Zd"e jddf� fd#d$� Zd"e jddfd%d&�Zd"e j ddfd'd(�Z d"e j ddfd)d*�Z d"e j ddfd+d,�Z!d"e j"ddfd-d.�Z#d"e j$ddfd/d0�Z%d"e j&ddfd1d2�Z'd"e j ddfd3d4�Z(d"e j)ddfd5d6�Z*� Z+S )7�VariableCommentPickerz7Python source code parser to pick up variable comments.rc �encodingr Nc sn t �� | _|| _|| _g | _g | _d | _t� | _ i | _
d | _ i | _ g | _
i | _d | _d | _d | _t� �� d S r= )� itertools�count�counterrc r� �context�current_classes�current_functionr �comments� annotationsrl � deforders�finals� overloads�typing� typing_final�typing_overloadr� rM )r# rc r� r� r r rM � s
z VariableCommentPicker.__init__�namec C s> | j r| jr| jd dkr| jdd� |g S dS | j|g S )z;Get qualified name for given object as a list of string(s).���rM N)r� r� r� )r# r� r r r �get_qualname_for� s
z&VariableCommentPicker.get_qualname_forc C s, | � |�}|rt| j�| jd�|�< d S d S �N�.)r� rd r� r� �join�r# r� �qualnamer r r � add_entry� s
�z VariableCommentPicker.add_entryc C s( | � |�}|r| j�d�|�� d S d S r� )r� r� r~ r� r� r r r �add_final_entry� s
�z%VariableCommentPicker.add_final_entry�funcc C sF ddl m} | �|j�}|r!| j�d�|�g �}|�||�� d S d S )Nr )�signature_from_astr� )�sphinx.util.inspectr� r� r� r� �
setdefaultr� r~ )r# r� r� r� r� r r r �add_overload_entry s �z(VariableCommentPicker.add_overload_entryr� c C s6 | � |�}|rd�|d d� �}|| j||f< d S d S �Nr� r� )r� r� r� )r# r� r� r� �basenamer r r �add_variable_comment s
�z*VariableCommentPicker.add_variable_comment�
annotationc C s: | � |�}|rd�|d d� �}t|�| j||f< d S d S r� )r� r� r r� )r# r� r� r� r� r r r �add_variable_annotation s
�z-VariableCommentPicker.add_variable_annotation�
decoratorsc C �d g }| j r
|�d| j � | jr|�| j� |D ]}z t|�|v r%W dS W q ty/ Y qw dS )Nz%s.finalTF)r� r~ r� r r7 )r# r� �final� decoratorr r r �is_final � � �z VariableCommentPicker.is_finalc C r� )Nz %s.overloadTF)r� r~ r� r r7 )r# r� �overloadr� r r r � is_overload' r� z!VariableCommentPicker.is_overloadc C s" | j r| j jjr| j jjd S dS )z8Returns the name of the first argument if in a function.r N)r� �argsrW r r r �get_self7 s z VariableCommentPicker.get_selfrm c C rn ro rq rr r r r rs > rt z VariableCommentPicker.get_liner c s t � �|� || _dS )z(Updates self.previous to the given node.N)r� �visitrl �r# r r� r r r� B s
zVariableCommentPicker.visitc C sn |j D ]1}| �|jp |j� |jdkr|jp|j| _q|jdkr(|jp%|j| _q|jdkr4|jp2|j| _qdS )�8Handles Import node and record the order of definitions.r� z typing.finalztyping.overloadN)�namesr� �asnamer� r� r� r� �r# r r� r r r � visit_ImportG s
��z"VariableCommentPicker.visit_Importc C sh |j D ].}| �|jp |j� |jdkr |jdkr |jp |j| _q|jdkr1|jdkr1|jp/|j| _qdS )r� r� r� r� N)r� r� r� r� �moduler� r� r� r r r �visit_ImportFromS s
��z&VariableCommentPicker.visit_ImportFromc s� zt |�}t� fdd�|D �g �}� �|j�}W n
ty" Y dS w t|d�r8|jr8|D ] }� �||j� q-nt|d�rL|jrL|D ] }� �||j� qBt ||j
d� g� j |jd� �}|� � |j
r�t�|j
�r�|D ]}� �|t�d|j
�� � �|� qmdS t�|d|j
� �r�g }t|jd �D ]}� �|jd | �} t�| �r�|�t�d| �� q� |r�td�t|���}
|D ]
}� �||
� � �|� q�dS |D ]}� �|� q�dS ) z3Handles Assign node and pick up a variable comment.c s g | ]
}t |� �� d ��qS )rW )r4 r� )rU �trW r r �
<listcomp>a s z6VariableCommentPicker.visit_Assign.<locals>.<listcomp>Nr� � type_commentz\1rp �
)r" �sumrs rm r0 �hasattrr� r� r� r� �
col_offsetrc r r� �
comment_rerZ r� �subr� � indent_re�ranger~ rG r� �reversed) r# r r �varnames� current_line�varname�parser�
comment_lines�i� before_liner� r rW r � visit_Assign] sN ���
�z"VariableCommentPicker.visit_Assignc C � | � |� dS )z6Handles AnnAssign node and pick up a variable comment.N)r� r� r r r �visit_AnnAssign� rt z%VariableCommentPicker.visit_AnnAssignc C s� t | jtjtjf�rUt |jtj�rWz9t| j�}t|d | � � �}|D ]%}t |jj
t �r0|jj
}n
|jj
� | j
p8d�}| �|t|�� | �|� q"W dS tyT Y dS w dS dS )z2Handles Expr node and pick up a comment if string.r �utf-8N)r rl r r � AnnAssignr5 r' r" r4 r� r< r+ �decoder� r� rG r� r0 )r# r r r� r� rF r r r �
visit_Expr� s" �
� ��z VariableCommentPicker.visit_Exprc C s0 |j D ]}| �|� q|jD ]}| �|� qdS )z�Handles Try node and processes body and else-clause.
.. note:: pycode parser ignores objects definition in except-clause.
N)�bodyr� �orelse)r# r �subnoder r r � visit_Try� s
�z VariableCommentPicker.visit_Tryc C st | j �|j� | �|j� | �|j�r| �|j� | j�|j� || _|j D ]}| �
|� q&| j� � | j � � dS )z&Handles ClassDef node and set context.N) r� r~ r� r� r� �decorator_listr� r� rl r� r� �pop�r# r �childr r r �visit_ClassDef� s
z$VariableCommentPicker.visit_ClassDefc C s� | j du rA| �|j� | �|j�r| �|j� | �|j�r"| �|� | j� |j� || _ |j
D ]}| � |� q/| j� � d| _ dS dS )z)Handles FunctionDef node and set context.N)
r� r� r� r� r� r� r� r� r� r~ r� r� r� r� r r r �visit_FunctionDef� s
�z'VariableCommentPicker.visit_FunctionDefc C r� )z.Handles AsyncFunctionDef node and set context.N)r� r� r r r �visit_AsyncFunctionDef� rt z,VariableCommentPicker.visit_AsyncFunctionDef),r/ r_ r` rA r r+ rM r r� r� r� r � FunctionDefr� r� �ASTr� �exprra r� r� r- r� rO rs r� �Importr� �
ImportFromr� r r� r� r� �Exprr� �Tryr� �ClassDefr� r� �AsyncFunctionDefr� r� r r r� r r� � s.
0
r� c st e Zd ZdZdee ddf� fdd� Zdedeeeef ddfd d
�Z dd d �Z
d
eddfdd�Z ddd�Z � Z
S )�DefinitionFinderzXPython source code parser to detect location of functions,
classes and methods.
rf r Nc s( t � �|� d | _g | _g | _i | _d S r= )r� rM r� r� �indents� definitionsr� r� r r rM � s
zDefinitionFinder.__init__r� �entryc C s6 | j r| j d d dkr|d dkrdS || j|< dS )z Add a location of definition.r� r �defN)r� r� )r# r� r� r r r �add_definition� s $z DefinitionFinder.add_definitionc C s� | � � }|du r dS |tkrnJ|tdgkr-| jdu s$| j�tttt�r-| j du r,|| _ n-|�t
dg�r:| � d� n |�t
dg�rG| � d� n|tkrR| j �
d� n|tkrZ| �� q)z1Parse the code to obtain location of definitions.TN�@�classr� )rN NN)rv r r rl rZ r r r r r� r �parse_definitionr� r~ �finalize_block)r# �tokenr r r r � s* �
� �zDefinitionFinder.parse�typc C s� | � � }| j�|j� d�| j�}| jr | jjd }d| _n|jd }| �tdg� | � � � t
t �rB| �t � | j
�|||f� dS | �||||jd f� | j�� dS )zParse AST of definition.r� r N�:)rv r� r~ r5 r� r� rJ r r rZ r r r r� r� rK r� )r# r� r� �funcname� start_posr r r r� � s
z!DefinitionFinder.parse_definitionc C s| | j �� }|d dkr<|\}}}| jjd d }t�| �|��r,|d8 }t�| �|��s | �||||f� | j�� dS dS )zFinalize definition block.r rN rp N) r� r� rk rK � emptyline_rerZ rs r� r� )r# �
definitionr� r� r� �end_posr r r r� s
��z DefinitionFinder.finalize_blockr@ )r/ r_ r` rA r r+ rM r rO r� r r� r� r� r r r� r r� � s
r� c @ sF e Zd ZdZddededdfdd�Zdd d
�Zdd d �Zdd
d�ZdS )�ParserzyPython source code parser to pick up variable comments.
This is a better wrapper for ``VariableCommentPicker``.
r� r r� r Nc C s8 t |�| _|| _i | _i | _i | _i | _g | _i | _d S r= ) r r r� r� r� r� r� r� r� )r# r r� r r r rM s
zParser.__init__c C s | � � | �� dS )zParse the source code.N)�parse_commentsr� rW r r r r ) s z Parser.parsec C sT t | j�}t| j�d�| j�}|�|� |j| _|j| _|j| _|j | _ |j
| _
dS )z$Parse the code and pick up comments.TN) r r r� �
splitlinesr� r� r� r� r� r� r� )r# �tree�pickerr r r r . s
zParser.parse_commentsc C s$ t | j�d��}|�� |j| _dS )z0Parse the location of definitions from the code.TN)r� r r r r� )r# r� r r r r� 9 s zParser.parse_definition)r� r@ ) r/ r_ r` rA r+ rM r r r� r r r r r s
r r= )/rA rB r� �rer[ � collectionsr r r� r r r r r r r
r r r� r
r r r r �sphinx.pycode.astr r r �compiler� r� r� r+ r r� r� r" r- r4 rG rH rb r� � NodeVisitorr� r� r r r r r �<module> s4 $
* -- vK