Your IP : 216.73.216.196
B
;��Y�X � @ s� d Z ddlZddlZddlZddlZddlmZmZ ddl m
Z ddl m Z yddl
m
Z
W n ek
r| ddlm
Z
Y nX ye W n& ek
r� e� Zefdd �ZY nX d
ZG d d � d e�Zd
d� ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Z G dd� de �Z G dd � d e �Z G d d � d e�Z G d d � d e �Z G d!d"� d"e�Z!d#Z"G d$d%� d%e�Z#G d&d'� d'e�Z$G d(d)� d)e%�Z&G d*d+� d+e�Z'G d,d-� d-e�Z(dS ).zPython code parser.� N)�chain� dropwhile)�compile� )�log)�StringIOc C s2 |t kr| �� S y| �� S tk
r, |S X d S )N)�nothing�next�
StopIteration)�obj�default� r
�B/opt/alt/python37/lib/python3.7/site-packages/pydocstyle/parser.pyr s r ) �Parser�
Definition�Module�Package�Function�NestedFunction�Method�Class� NestedClass�AllErrorr �
ParseErrorc @ s e Zd Zdd� ZdS )r c C s dS )NzCannot parse file.r
)�selfr
r
r �__str__% s zParseError.__str__N)�__name__�
__module__� __qualname__r r
r
r
r r $ s r c C s t d��d| ��� S )Nz (.)([A-Z]+)z\1 \2)�re�sub�lower)�stringr
r
r �humanize) s r# c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �Valuez.A generic object with a list of preset fields.c G sP t | j�t |�kr6td�t |�t | j�| jj| j���t| ��t| j|�� d S )Nz)got {} arguments for {} fields for {}: {}) �len�_fields�
ValueError�format� __class__r �vars�update�zip)r �argsr
r
r �__init__0 s
zValue.__init__c C s t t| ��S )N)�hash�repr)r r
r
r �__hash__7 s zValue.__hash__c C s |ot | �t |�kS )N)r* )r �otherr
r
r �__eq__: s z Value.__eq__c s* d� � fdd�� jD ��}d�� jj|�S )Nz, c 3 s | ]}d � |t� |��V qdS )z{}={!r}N)r( �getattr)�.0Zfield)r r
r � <genexpr>> s z!Value.__repr__.<locals>.<genexpr>z{}({}))�joinr& r( r) r )r �kwargsr
)r r �__repr__= s zValue.__repr__N)r r r �__doc__r. r1 r3 r9 r
r
r
r r$ - s
r$ c @ s| e Zd ZdZdZedd� �Zedd� �Zedd� �Zedd� �Z edd� �Z
d Z d
d � Z ed d
� �Z
edd� �Zdd� ZdS )r z@A Python source code definition (could be class, function, etc).) �name�_source�start�end�
decorators� docstring�children�parent�skipped_error_codesc C s t t| �j�S )N)r# �typer )r r
r
r �<lambda>I � zDefinition.<lambda>c C s | j �� d S )N���)�_human�split)r r
r
r rE J rF c C s | j jS )N)rB �module)r r
r
r rE K rF c C s | j jS )N)rJ �all)r r
r
r rE L rF c C s t | jd | j�S )Nr )�slicer= r> )r r
r
r rE M rF Fc C s t | gf| j�� S )N)r rA )r r
r
r �__iter__P s zDefinition.__iter__c C s ddd�| j S )NZpublicZprivate)TF)� is_public)r r
r
r �
_publicityS s zDefinition._publicityc C s4 | j | j }dd� }t|t|��}d�tt|���S )z*Return the source code for the definition.c S s | � � dkp| � � �d�S )N� �#)�strip�
startswith)�liner
r
r �is_empty_or_comment\ s z.Definition.source.<locals>.is_empty_or_commentrP )r< �_slicer �reversedr7 �list)r Zfull_srcrU Z filtered_srcr
r
r �sourceW s zDefinition.sourcec C s. d� | j| j| j�}| jr*|d� | j�7 }|S )Nz
in {} {} `{}`z (skipping {}))r( rO rH r; rC )r �outr
r
r r b s zDefinition.__str__N)r r r r: r& �propertyrH �kindrJ rK rV �is_classrM rO rY r r
r
r
r r C s r c @ sL e Zd ZdZdZedd� �Zedd� �Zedd� �Z edd� �Z
d d
� Z d S ) r z A Python source code module.) r; r< r= r> r? r@ rA rB �_all�future_importsrC c C s t td�| S )N)�def�class)r r )�sr
r
r rE o rF zModule.<lambda>c C s | S )Nr
)r r
r
r rE p rF c C s | j S )N)r^ )r r
r
r rE q rF c C s | j �d� p| j �d�S )N�_�__)r; rS )r r
r
r rN s s zModule.is_publicc C s dS )Nzat module levelr
)r r
r
r r w s zModule.__str__N) r r r r: r& � staticmethod�_nestr[ rJ rK rN r r
r
r
r r i s r c @ s e Zd ZdZdS )r z"A package is a __init__.py module.N)r r r r: r
r
r
r r { s r c @ s4 e Zd ZdZedd� �Zedd� �Zedd� �ZdS ) r z A Python source code function.c C s t td�| S )N)r` ra )r r )rb r
r
r rE � s zFunction.<lambda>c C s( | j dk r| j| j kS | j�d� S dS )z:Return True iff this function should be considered public.Nrc )rK r; rS )r r
r
r rN � s
zFunction.is_publicc C s | j �d�p| j dkS )a Return True if this function is a test function/method.
We exclude tests from the imperative mood check, because to phrase
their docstring in the imperative mood, they would have to start with
a highly redundant "Test that ...".
ZtestZrunTest)r; rS )r r
r
r �is_test� s zFunction.is_testN) r r r r: re rf r[ rN rg r
r
r
r r s r c @ s e Zd ZdZdZdS )r z%A Python source code nested function.FN)r r r r: rN r
r
r
r r � s r c @ s4 e Zd ZdZedd� �Zedd� �Zedd� �ZdS ) r z A Python source code method.c C s" | j �d�o | j �d�o | j tkS )z@Return True iff this method is a magic method (e.g., `__str__`).rd )r; rS �endswith�VARIADIC_MAGIC_METHODS)r r
r
r �is_magic� s zMethod.is_magicc C s
| j dkS )z*Return True iff this method is `__init__`.r. )r; )r r
r
r �is_init� s zMethod.is_initc C sV x*| j D ] }td�| j���|j�rdS qW | j�d� pH| jtkpH| j}| jj oT|S )z8Return True iff this method should be considered public.z^{}\.Frc )
r? r r( r; �matchrS ri rj rB rN )r Z decoratorZname_is_publicr
r
r rN � s
zMethod.is_publicN)r r r r: r[ rj rk rN r
r
r
r r � s r c @ s& e Zd ZdZedd� �ZejZdZdS )r zA Python source code class.c C s t td�| S )N)r` ra )r r )rb r
r
r rE � rF zClass.<lambda>TN) r r r r: re rf r rN r] r
r
r
r r � s r c @ s e Zd ZdZedd� �ZdS )r z"A Python source code nested class.c C s | j �d� o | jjo | jjS )z7Return True iff this class should be considered public.rc )r; rS rB r] rN )r r
r
r rN � s zNestedClass.is_publicN)r r r r: r[ rN r
r
r
r r � s r c @ s e Zd ZdZd�� ZdS )� Decoratorz*A decorator for function, method or class.zname argumentsN)r r r r: rI r& r
r
r
r rm � s rm )r. �__call__�__new__c @ s e Zd ZdZdd� ZdS )r z9Raised when there is a problem with __all__ when parsing.c C s t �| |t�d� � dS )z2Initialize the error with a more specific message.a]
That means pydocstyle cannot decide which definitions are
public. Variable __all__ should be present at most once in
each file, in form
`__all__ = ('a_public_function', 'APublicClass', ...)`.
More info on __all__: http://stackoverflow.com/q/44834/. ')
N)� Exceptionr. �textwrap�dedent)r �messager
r
r r. � s zAllError.__init__N)r r r r: r. r
r
r
r r � s r c @ s< e Zd ZejejejhZdd� Zdd� Z dd� Z
dd� Z d S )
� TokenStreamc C s> t �|j�| _tt| jd �� | _| jjd | _t | _ d| _
d S )Nr T) �tk�generate_tokens�readline�
_generator�Tokenr �currentr= rT r �got_logical_newline)r �fileliker
r
r r. � s
zTokenStream.__init__c C sP | j }| �� }|d krd nt|� | _ | j r6| j jd n| j| _|j| jk| _|S )Nr )rz �_next_from_generatorry r= rT r\ �LOGICAL_NEWLINESr{ )r Zpreviousrz r
r
r �move� s zTokenStream.movec C s< y t | jd �S ttjfk
r6 | jjddd� d S X d S )Nzerror generating tokensT)�exc_info)r rx � SyntaxErrorru �
TokenErrorr Zwarning)r r
r
r r} � s
z TokenStream._next_from_generatorc c s* x$| j d k r| j V nd S | �� qW d S )N)rz r )r r
r
r rM s
zTokenStream.__iter__N) r r r ru �NEWLINE�INDENT�DEDENTr~ r. r r} rM r
r
r
r rt � s
rt c @ s e Zd Zdd� ZdS )� TokenKindc C s d� tj| �S )Nztk.{})r( ru �tok_name)r r
r
r r9 s zTokenKind.__repr__N)r r r r9 r
r
r
r r� s r� c s$ e Zd Zd�� Z� fdd�Z� ZS )ry zkind value start end sourcec s t t| �j|� t| j�| _d S )N)�superry r. r� r\ )r r- )r) r
r r. s zToken.__init__)r r r rI r& r. �
__classcell__r
r
)r) r ry s ry c @ s� e Zd ZdZdd� Zdd� Zedd� �Zedd� �Zd d
� Z d%d d
�Z
dd� Z dd� Z d&dd�Z
dd� Zdd� Zdd� Zdd � Zd'd d �Zd d � Zd!d"� Zd#d$� Zd S )(r z A Python source code parser.c
C s� t | _ |�� | _d�| j�}yt||d� W n0 tk
r\ } zt�t� |� W dd}~X Y nX t t
|��| _ || _ d| _
t� | _g | _| �� S )z>Parse the given file-like object and return its Module object.rP �execN)r � readlinesrY r7 r r� �sixZ
raise_fromr rt r �stream�filenamerK �setr_ �_accumulated_decorators� parse_module)r r| r� �src�errorr
r
r �parse s
z Parser.parsec O s | j ||�S )zCall the parse method.)r� )r r- r8 r
r
r rn / s zParser.__call__c C s | j jS )N)r� rz )r r
r
r rE 3 rF zParser.<lambda>c C s | j jS )N)r� rT )r r
r
r rE 4 rF c C s | j �� }|j|kst�dS )z8Consume one token and verify it is of the expected kind.N)r� r r\ �AssertionError)r r\ Z
next_tokenr
r
r �consume6 s
zParser.consumeNc C sL xF| j dk rF| j j|kr:|dks,| j j|kr:| �|� dS | j�� qW dS )z�Skip tokens in the stream until a certain token kind is reached.
If `value` is specified, tokens whose values are different will also
be skipped.
N)rz r\ �valuer� r� r )r r\ r� r
r
r �leapfrog; s
zParser.leapfrogc C s� | j �d| jj| jj� x>| jjtjtjtjfkrV| j �
� | j �d| jj| jj� qW | jjtj kr|| jj}| j �
� |S dS )z.Parse a single docstring and return its value.z#parsing docstring, token is %r (%s)N) r �debugrz r\ r� ru �COMMENTr� �NLr� r �STRING)r r@ r
r
r �parse_docstringH s
zParser.parse_docstringc C sF g }g }d}�x| j dk �r"| j�d| j j| j j� | j jtjkrR| j jdkrRP n�| j jtjkr�| j jdkr�| j� t
d� |�d� |��� g }g }d}n~| j jtjkr�| j jdkr�d}n^| j jtjkr�| j jd kr�nB| j jtj ks�| j jtj
kr�n$|�s|� | j j� n|� | j j� | j�� qW | j� t
d� |�d� |��� dS )
z�Called after first @ is found.
Parse decorators into self._accumulated_decorators.
Continue to do so until encountering the 'def' or 'class' start token.
FNz,parsing decorators, current token is %r (%s))r` ra �@rP �(T�))rz r r� r\ r� ru �NAME�OPr� �appendrm r7 r� r� r� r )r r; Z argumentsZ at_argumentsr
r
r �parse_decoratorsV s6 zParser.parse_decoratorsFc c s0 �x(| j dk �r*| j�d| j j| j j� | j�d| jj� |rT| j jdkrT| �� q| j jtj kr�| j jdkr�| jjr�| �
tj � | � � q| j jdkr�| � |�
| j j��V q| j jtjkr�| �
tj� x\| �|�D ]
}|V q�W q| j jtjk�r| �
tj� dS | j jdk�r | �� q| j�� qW dS )z*Parse multiple definitions and yield them.Nz1parsing definition list, current token is %r (%s)zgot_newline: %s�__all__r� )r` ra �from)rz r r� r\ r� r� r{ � parse_allru r� r� r� �parse_definitionrf r� �parse_definitionsr� �parse_from_import_statementr )r �class_rK �
definitionr
r
r r� � s.
zParser.parse_definitionsc
C s> | j jdkst�| �tj� | j jdkr0td��| �tj� | j jdkrPtd��| �tj� g | _d}xx| j j tjks�| j jdkr�| j j tj
tj fkr�n:| j j tj ks�| j jdkr�|| j j7 }ntd�
| j j ���| j�� qhW | �tj� |d 7 }yt|i �| _W n4 tk
�r8 } ztd
�
||���W d d }~X Y nX d S ) z)Parse the __all__ definition in a module.r� �=z(Could not evaluate contents of __all__. z([r� z)]�,z)Unexpected token kind in __all__: {!r}. r� zOCould not evaluate contents of __all__.The value was {}. The exception was:
{}N)rz r� r� r� ru r� r r� rK r\ r� r� r� r( r� r �eval�
BaseException)r Z all_content�er
r
r r� � s4 zParser.parse_allc C s� | j �d� | j}| �� }t| jtdd��}| jdks@t| j��| j}t}| j �
d�rZt }|| j | j ||g ||d| j
dd� }x|jD ]
}||_q�W | j|_| j �d� |S )z=Parse a module (and its children) and return a Module object.zparsing module.T)rK Nz __init__.pyrP zfinished parsing module.)r r� rT r� rX r� r rz r� r� rh r rY rK rA rB r_ )r r= r@ rA r> �clsrJ �childr
r
r r� � s
zParser.parse_modulec
C s� | j }| �tj� | jj}| j�d|j|� | j �
� | jj tj kr�| jjdkr�d}xP| jj tj kr�| jjdkrz|d7 }n | jjdkr�|d8 }|dkr�P | j �
� qVW | jj tj ks�| jjdkr�| j
tj dd� n | �tj � | jj tjtjfk�rr| �� }| �
tj� | jj tjk�s t�| �� }| j}| j�d|� g | _| j�d � t| �|��}| j�d
|� | j d } n&d }| �� }g }g }| j } | �
tj� ||| j|| |||d |� }
x|
jD ] } |
| _�q�W | j�d
|j|| jj | jj� |
S )z=Parse a definition and return its value in a `class_` object.zparsing %s '%s'r� r r r� �:)r� z"current accumulated decorators: %szparsing nested definitions.z,finished parsing nested definitions for '%s'rP Nz/finished parsing %s '%s'. Next token is %r (%s))rT r� ru r� rz r� r r� r r� r r\ r� r� r� r� �parse_skip_commentr� r� r� r� rX r� rY rA rB ) r r� r= r; Zparenthesis_levelrC r@ r? rA r> r� r� r
r
r r� � s^
zParser.parse_definitionc C sR d}| j jtjkrNd| j jkr<d�| j j�d�dd� �}n| j j�d�rNd}|S )z*Parse a definition comment for noqa skips.rP znoqa: r Nz# noqarK )rz r\ ru r� r� r7 rI rS )r rC r
r
r r� s zParser.parse_skip_commentc C sN t �dj| d��}|r"| jj|knd}|r6| jj|knd}|rB|sJt|��dS )z>Verify the current token is of type `kind` and equals `value`.z�
Unexpected token at line {self.line}:
In file: {self.filename}
Got kind {self.current.kind!r}
Got value {self.current.value}
)r TN)rq rr r( rz r\ r� r� )r r\ r� �msgZ
kind_validZ value_validr
r
r �
check_current s
zParser.check_currentc C s" | j �d� | �� }| �|� dS )zeParse a 'from x import y' statement.
The purpose is to find __future__ statements.
z parsing from/import statement.N)r r� �_parse_from_import_source�_parse_from_import_names)r �is_future_importr
r
r r� s z"Parser.parse_from_import_statementc C s� | j jdkst| j j��| j�� | j jdk}| j�� x<| j dk rt| j jtjtjtj fkrt| j jdkrt| j�� q:W | j dks�| j jdkr�dS | j
dd� | j jdks�t| j j��| j�� |S )zuParse the 'from x import' part in a 'from x import y' statement.
Return true iff `x` is __future__.
r� Z
__future__N�importF)r� ) rz r� r� r� r r\ ru �DOTr� r� r� )r r� r
r
r r� ( s
z Parser._parse_from_import_sourcec C sX | j jdkr"| �tj� tjf}n tjtjf}�x"| j j|k�rR| j jtjkr\| j jdk�sR| j jtjkrv| j �
� q2| j � d| j j| j j� |r�| j � d| j j� | j
�| j j� | �tj� | j � d| j j| j j� | j jtjk�r | j jdk�r | �tj� | j jtjk�r | �tj� | j jdk�r8| �tj� | j � d| j j| j j� q2W dS )z4Parse the 'y' part in a 'from x import y' statement.r� �;z parsing import, token is %r (%s)zfound future import: %s�asr� N)rz r� r� ru r� r� � ENDMARKERr\ r� r� r r r� r_ �add)r r� Zexpected_end_kindsr
r
r r� < s2
z Parser._parse_from_import_names)N)F)NN)r r r r: r� rn r[ rz rT r� r� r� r� r� r� r� r� r� r� r� r� r� r
r
r
r r s$
-
4
r ))r: Zloggingr� rq �tokenizeru � itertoolsr r r r Zutilsr r � ImportError�ior � NameError�objectr r� rp r r# r$ r r r r r r r r rm ri r rt �intr� ry r r
r
r
r �<module> sF
& '