to S M n d Z ddlZddlZddlZddlmZ ddlmZm Z ddl
m Z ddl m
Z ddlmZ dd lmZ d
Z G d d e Z G d
de Zd Z G d d Z G d de Z G d de Z G d de Z G d de Z G d de Z G d d e Z G d d e Z G d d!e Z G d" d#e Z G d$ d%e! Z"d&Z# G d' d(e Z$ G d) d* Z% G d+ d,e& Z' G d- d.e Z( G d/ d0 Z)dS )1zPython code parser. N)StringIO)chain dropwhilePath)compile)Tuple )log) Parser
DefinitionModulePackageFunctionNestedFunctionMethodClass NestedClassAllErrorr
ParseErrorc e Zd ZdZd ZdS )r z+An error parsing contents of a Python file.c dS )NzCannot parse file. selfs c/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/pydocstyle/parser.py__str__zParseError.__str__! s ## N)__name__
__module__ __qualname____doc__r r r r r r s) 55$ $ $ $ $r r c e Zd Zd Zd ZdS )UnexpectedTokenErrorc " || _ || _ d S Ntoken
expected_kind)r r( r) s r __init__z UnexpectedTokenError.__init__& s
*r c B d | j | j S )Nz Unexpected token {}, expected {})formatr( r) r s r r z UnexpectedTokenError.__str__* s$ 188 J*
r N)r r r! r* r r r r r$ r$ % s2 + + +
r r$ c l t d d| S )Nz (.)([A-Z]+)z\1 \2)resublower)strings r humanizer2 0 s,
n ! !(F 3 3 9 9 ; ;;r c * e Zd ZdZd Zd Zd Zd ZdS )Valuez.A generic object with a list of preset fields.c ` t | j t | k rSt d t | t | j | j j | j t
| t | j | d S )Nz)got {} arguments for {} fields for {}: {}) len_fields
ValueErrorr, __class__r varsupdatezip)r argss r r* zValue.__init__7 s t| D ) ) ;BBII %%N+L
T
#dlD1122222r c : t t | S r& )hashreprr s r __hash__zValue.__hash__C s DJJ r c F |o t | t | k S r& )r: )r others r __eq__z Value.__eq__F s 2dtE{{22r c t d fd j D } j j d| dS )Nz, c 3 ` K | ](}d |t | V )dS )z{}={!r}N)r, getattr).0fieldr s r z!Value.__repr__..J sQ
UGD%$8$8 9 9
r ())joinr7 r9 r )r kwargss ` r __repr__zValue.__repr__I s\
.)55F5555r N)r r r! r" r* rA rD rO r r r r4 r4 4 sV 88
3
3
3 3 3 36 6 6 6 6r r4 c e Zd ZdZdZ ed Z ed Z ed Z ed Z ed Z
dZ d Z ed
Z
ed Zed Zd
ZdS )r
z@A Python source code definition (could be class, function, etc).)
name_sourcestartend
decorators docstringchildren
callable_argsparentskipped_error_codesc D t t | j S r& )r2 typer r s r zDefinition.a s 8DJJ,?#@#@ r c @ | j d S )N)_humansplitr s r r] zDefinition.b s !2!2!4!4R!8 r c | j j S r& )rY moduler s r r] zDefinition.c s 4;#5 r c | j j S r& )rc
dunder_allr s r r] zDefinition.d s t{'= r c < t | j dz
| j S )Nr
)slicerS rT r s r r] zDefinition.e s 5a #B#B r Fc ( t | gg| j R S r& )r rW r s r __iter__zDefinition.__iter__h s dV,dm,,,,r c \ t | j t r | j j S | j S )z4Get the line number with which to report violations.)
isinstancerV DocstringrS r s r error_linenozDefinition.error_linenok s+ dni 0 0 (>' 'zr c " ddd| j S )Npublicprivate)TF) is_publicr s r
_publicityzDefinition._publicityr s y11$.AAr c | j | j }d }t |t | }d t t | S )z*Return the source code for the definition.c | dk p&| d S )N #)strip
startswith)lines r is_empty_or_commentz.Definition.source..is_empty_or_comment{ s0 ::<<2%E )@)@)E)E Er ru )rR _slicer reversedrM list)r full_srcrz filtered_srcs r sourcezDefinition.sourcev s` < , F F F !!4hx6H6HII wwx\ 2 233444r c f d| j d| j d| j d}| j r|d| j dz
}|S )Nzin z ``z (skipping rL )rr r` rQ rZ )r outs r r zDefinition.__str__ sQ ADOAAdkAATYAAA # = <!9<<< >J
XBB
C
CFH- - - X B B XB 5 5 X5 r r
c e Zd ZdZdZ ed Z ed Z ed Z ed Z
d Z d Z d Z
d
Zd S ) r z A Python source code module.) rQ rR rS rT rU rV rW rY _dunder_alldunder_all_errorfuture_importsrZ c , t t d| S Ndefclass)r r ss r r] zModule. s 8e#D#DQ#G r c | S r& r r s r r] zModule. s 4 r c | j S r& )r r s r r] zModule. s t'7 r c t | j j }| o| | S )zsReturn True iff the module is considered public.
This helps determine if it requires a docstring.
)r rQ stem_is_inside_private_package_is_public_namer module_names r rq zModule.is_public sE 49oo* 22444
9M9M :
:
r c t | j j }d t j D }||j k r6||vr2| |j rdS |j }||j k r||v2dS )z6Return True if the module is inside a private package.c , g | ]}t | S r r )rH ps r
z5Module._is_inside_private_package.. s ---q477---r TF)r rQ rY syspath_is_private_name)r r syspaths r r z!Module._is_inside_private_package s DI%--CH--- dk!!d'&9&9$$TY//
t;D dk!!d'&9&9
ur c | d p)| d o| d S )zJDetermine whether a "module name" (i.e. module or package name) is public.___)rx endswithr s r r zModule._is_public_name sD ))#...
" "4 ( ( G[-A-A$-G-G
r c . | | S )zKDetermine whether a "module name" (i.e. module or package name) is private.)r r s r r zModule._is_private_name s '' 4444r c dS )Nzat module levelr r s r r zModule.__str__ s r N)r r r! r" r7 staticmethod_nestr rc re rq r r r r r r r r r s &&
G
LGG H HE
X''
(
(F7788J
X
5 5 5! ! ! ! !r r c e Zd ZdZdS )r z"A package is a __init__.py module.N)r r r! r" r r r r r s ,,,,r r c e Zd ZdZ ed Zed Zed Zd Z ed Z
ed Z dS ) r z A Python source code function.c , t t d| S r )r r r s r r] zFunction. s .;??B r c b | j | j | j v S | j d S )z:Return True iff this function should be considered public.Nr )re rQ rx r s r rq zFunction.is_public s4 ? &9/ /y++C000 0r c > t d | j D S )z3Return True iff the method decorated with overload.c 3 , K | ]}|j d k V dS )overloadNrQ )rH decorators r rJ z'Function.is_overload.. s:
-6INj (
r anyrU r s r is_overloadzFunction.is_overload s4
:>/
r c D t fd| j D S )zCReturn True if the method is decorated with any property decorator.c 3 * K | ]
}|j v V d S r& r )rH r property_decorator_namess r rJ z'Function.is_property.. s?
N 6 6
r r )r r s `r is_propertyzFunction.is_property s=
!_
r c L | j d p
| j dk S )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 ...".
testrunTest)rQ rx r s r is_testzFunction.is_test s& y##F++EtyI/EEr c | j S )zReturn the parameter names.)rX r s r param_nameszFunction.param_names s
!!r N) r r r! r" r r r rq r r r r r r r r r s (( LBB
E 1 1 X1
X
F F XF " " X" " "r r c e Zd ZdZdZdS )r z%A Python source code nested function.FN)r r r! r" rq r r r r r s //IIIr r c j e Zd ZdZed Zed Zed Zed ZdS )r z A Python source code method.c | j d o'| j d o
| j t vS )z@Return True iff this method is a magic method (e.g., `__str__`).r )rQ rx r VARIADIC_MAGIC_METHODSr s r is_magiczMethod.is_magic sD
I & &
8 ""4((
8 !77
r c | j dk S )z*Return True iff this method is `__init__`.r* r r s r is_initzMethod.is_init s yJ&&r c | j D ]5}t d| j d |j r dS 6| j d p| j t
v p| j }| j j o|S )z8Return True iff this method should be considered public.^z\.Fr ) rU r. rQ matchrx r r rY rq )r r name_is_publics r rq zMethod.is_public s I$ty$$$%%++IN;;
uu
$$S)) )
y 22
}
{$7 7r c 6 | j D ]}|j dk r dS dS )z%Return True iff the method is static.r TF)rU rQ )r r s r is_staticzMethod.is_static s3 I~ //tt 0ur N) r r r! r" r r r rq r r r r r r s &&
X
' ' X' 8 8 X 8 X r r c < e Zd ZdZ ed Zej ZdZdS )r zA Python source code class.c , t t d| S r )r r r s r r] zClass.' s 6K#H#H#K r TN) r r r! r" r r r rq r r r r r r $ s4 %% LKK L LE"IHHHr r c ( e Zd ZdZed ZdS )r z"A Python source code nested class.c h | j d o| j j o | j j S )z7Return True iff this class should be considered public.r )rQ rx rY r rq r s r rq zNestedClass.is_public/ s9 $$S)) )
& $
& %
r N)r r r! r" r rq r r r r r , s3 ,,
X
r r c : e Zd ZdZd ZdS ) Decoratorz*A decorator for function, method or class.zname argumentsN)r r r! r" ra r7 r r r r r 9 s% 44 $$&&GGGr r c e Zd ZdZd Zd ZdS )rl zRepresent a docstring.
This is a string, but has additional start/end attributes representing
the start and end of the token.
c 8 t | | S r& )str__new__)clsvrS rT s r r zDocstring.__new__G s {{3"""r c " || _ || _ d S r& )rS rT )r r rS rT s r r* zDocstring.__init__J s
r N)r r r! r" r r* r r r rl rl ? s< # # # r rl )r* __call__r c e Zd ZdZd ZdS )r z9Raised when there is a problem with __all__ when parsing.c f t | |t j d z 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* textwrapdedent)r messages r r* zAllError.__init__U sC o
r N)r r r! r" r* r r r r r R s) CC
r r c N e Zd Zej ej ej hZd Zd Z d Z
d Z dS ) TokenStreamc t j |j | _ t t | j d | _ | j j d | _ t | _ d| _
d S )Nr T) tkgenerate_tokensreadline
_generatorTokennextcurrentrS ry r got_logical_newline)r filelikes r r* zTokenStream.__init__n sU ,X->?? d4?D 9 9: L&q) #' r c | j }| }|d nt | | _ | j r| j j d n| j | _ |j t j t j fv }|j | j v p| j
o|| _
|S )Nr ) r _next_from_generatorr rS ry r r NLCOMMENTLOGICAL_NEWLINESr )r previousr is_logical_blanks r movezTokenStream.moveu s <++-- &ttE7O -1\HDL&q))ty #=RUBJ,?? MT 2 2
?(=-=
r c t | j d S # t t j f$ r | j dd Y d S w xY w)Nzerror generating tokensT)exc_info)r r SyntaxErrorr
TokenErrorr warningr s r r z TokenStream._next_from_generator s^ .. .R]+ H 6 F F F44 s 2A
A
c # X K | j
| j V nd S | (r& )r r r s r ri zTokenStream.__iter__ s; |'l"""" IIKKK r N) r r r! r NEWLINEINDENTDEDENTr r* r r ri r r r r r f se
BIry9( ( ( r r c e Zd Zd ZdS ) TokenKindc L d t j | S )Nztk.{})r, r tok_namer s r rO zTokenKind.__repr__ s ~~bk$ /000r N)r r r! rO r r r r r s# 1 1 1 1 1r r c L e Zd Zd Z fdZd Z xZS )r zkind value start end sourcec f t j | t | j | _ d S r& )superr* r r )r r= r9 s r r* zToken.__init__ s, $ di(( r c & | j d| j dS )Nz (rL )r valuer s r r z
Token.__str__ s )......r )r r r! ra r7 r* r
__classcell__)r9 s @r r r sX +1133G) ) ) ) )/ / / / / / /r r c e Zd ZdZd Zd Z ed Z ed Zd Z ddZ
d Z d
Z dd Z
d
Zd Zd Zd ZddZd Zd Zd ZdS )r z A Python source code parser.c t | _ | | _ d | j } t ||d n!# t
$ r}t
|d}~ww xY wt t | | _ || _
d| _ d| _ t | _ g | _ | S )z>Parse the given file-like object and return its Module object.ru execN)r readlinesr rM r r r r r streamfilenamere r setr _accumulated_decorators parse_module)r r r srcerrors r parsez Parser.parse s ((** ggdk"" * C6 * * * * * * * ,,E ) *!(3--00
$ !ee')$ """s A
A1 A,,A1c | j |i |S )zCall the parse method.)r )r r= rN s r r zParser.__call__ s tz4*6***r c | j j S r& )r
r r s r r] zParser. s DK$7 r c | j j S r& )r
ry r s r r] zParser. s !1 r c p | j }|j |k rt || dS )z8Consume one token and verify it is of the expected kind.r' N)r
r r r$ )r r
next_tokens r consumezParser.consume s= [%%''
?d " "&ZtLLL L # "r Nc | j [| j j |k r)|| j j |k r| | dS | j | j YdS dS )zSkip 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)r r r r r
r )r r r s r leapfrogzParser.leapfrog sq l&| D((
!3u! ! "
| BG++ 0B G 1 1 "be++ 0Bc0I0I,33 bggdmmRWWY-?-?@@ $ "be++ 0Bc0I0I # "be++ 0Bc0I0I "bj00DL4E4N4N $ 9KK 23333 $$T\%7888 K I l&N
$++ bggdmmRWWY%7%7 8 8
r Fc # K | j | j d| j j | j j | j d| j j |r&| j j dk r| n|| j j t j k rQ| j j dk rA| j j r5|
t j | n| j j dv r5| |
| j j V n| j j t j k r;|
t j | | E d{V ny| j j t j k r!|
t j dS | j j dk r| n| j | j dS dS )z*Parse multiple definitions and yield them.Nz1parsing definition list, current token is %r (%s)zgot_newline: %s__all__r# r from)r r r r r r
r parse_dunder_allr r% r r) parse_definitionr r parse_definitionsr parse_from_import_statementr )r class_re s r r/ zParser.parse_definitions s l& HNNC ! "
HNN,dk.M N N N
#dl 0I = =%%'''' !RU**L&#--K3 . RU###%%'''' #'777++FLL 9K,L,LMMMMMM "bi// RY''' 11&9999999999 "bi// RY''' #v--002222 """7 l&&&&&r c | | j j dk sJ | t j | j | j d| _ d| _ dS | j j dk r d| _ dS | t j d}| j j dv r!d}| t j d} |r| j j d v rn| j j t j t j
fv rn| j j t j t j fv rnC| j j t j
k s| j j d
k r|| j j z
}n d | _ dS | j |r | t j |s*d
|vr&d | j j | _ dS |d
z
} t# |i | _ n2# t$ $ r%}d || | _ Y d}~nd}~ww xY w| j j | j j vr| j j t j
k ry| j j t j k rd| _ d| _ dS | j | j j | j j vr | j j t j
k udS dS dS dS )z)Parse the __all__ definition in a module.r+ Nz(Could not evaluate contents of __all__. =Fz([TrK z)],z'Could not evaluate contents of __all__.z(Unexpected token kind in __all__: {!r}. rL zOCould not evaluate contents of __all__.The value was {}. The exception was:
{})r r r r r$ re r r% r r ENDMARKERr r r r
r r, eval
BaseExceptionr )r
is_surroundeddunder_all_contentes r r- zParser.parse_dunder_all8 s |!Y.... RW ? &$*?*K "DO$ND ! F < $ $$ND ! F RU
< % % M LL
!3t!;!;| RZ $>>>| RUBJ$777 "bi//4<3E3L3L"dl&88"" > % K LL ,>!>!>:AAL%
!
Fc! "#5r : :DOO ==CV&> >
! ! ! ! ! !
L T[%A A A !R\11| BJ.."&> % K
L T[%A A A !R\1111
B A11
B As G
H 'HH c 6 | j d | j }| }| }t | t d }| j J | j | j }t }| j
d rt } || j | j ||g ||d| j
| j d| }|j D ] }||_
| j |_ | j d |S )z=Parse a module (and its children) and return a Module object.zparsing module.T)re Nz __init__.pyzfinished parsing module.)r r ry parse_skip_commentr r} r/ r r r r r r re r rW rY r ) r rS rZ rV rW rT r rc childs r r zParser.parse_module| s! ())) " 5 5 7 7((** ..v$.GGHH|##T\###i = ! !- 0 0 C M K O !
_ " "E!ELL $ 3 1222
r c $ | j }| t j | j j }| j d|j | | j
g }| j j t j k r| j j dk rd}d} | j j t j k rF| j j dk r|dz
}ns| j j dk r
|dz }|dk rnqnV| j j dk rd}nC|dk r=| j j t j k r#|s!|
| j j d}| j
| j j t j k s| j j d k r"| t j d
n | t j | j j t j t j fv r| }| t j | j j t j k sJ | }| j } | j d | g | _ | j d t+ | | }
| j d
| | j dz
} ngd}| }| j } | j d | g | _ g }
| j } | t j ||| j || | ||
|d|
} | j D ] }
| |
_
| j d|j || j | S )z=Parse a definition and return its value in a `class_` object.zparsing %s '%s'rK r FTr
rL r4 :r z"current accumulated decorators: %szparsing nested definitions.z,finished parsing nested definitions for '%s'ru Nz*finished parsing %s '%s'. Next token is %r)ry r r r$ r r r r r r
r r r% r& r r r r< r r r r} r/ r rW rY )r r1 rS rQ rX parenthesis_levelin_default_argrZ rV rU rW rT
definitionr= s r r. zParser.parse_definition sw RW |! (&/4@@@
< % %$,*<*C*C ! "N
#<$--|)S00)Q.)) +s22)Q.),11 ! 2 +s22).%** )RW44 * 5 "(( );<<<%)N """#
#$ < % % );s)B)B MM"%sM + + + + LL < RZ 8 8 8"&"9"9";"; MM") $ $ $<$ 1111 ,,..I 5J HNN? L L L+-D ( HNN8 9 9 9D 2 26 : :;;H HNN>
)a-CC"$ ,,..I 5J HNN? L L L+-D (H)C MM"* % % %V K
( & &E%ELL 8 O L
r c f d}| j j t j t j t j fv r| j j t j k rjd| j j v r;d | j j d dd }n!| j j d rd}| j
| j
d| j j | j j |rn/| j j t j t j t j fv |S )z*Parse a definition comment for noqa skips.ru znoqa: r
Nz# noqaallz3parsing comments before docstring, token is %r (%s))r r r r r r r rM ra rx r
r r r )r rZ s r r< zParser.parse_skip_comment s l BJ
BE#BBB| BJ..t| 111*,'' *00::122>+ +'' \'228<< 0*/' K HNNE ! "
#
! l BJ
BE#BBB$ #"r c t j d | }|r| j j |k nd}|r| j j |k nd}|r|s
J | 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)r r r, r r r )r r r msg
kind_valid value_valids r
check_currentzParser.check_current s o
F
37@T\&$..D
5:Ddl(E11 .k..3..)..r c | 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_namesr is_future_imports r r0 z"Parser.parse_from_import_statement sF
7888 99;; %%&677777r c | j j dk sJ | j j | j | j j dk }| j | j | j j t
j t
j t
j fv ro| j j dk r_| j | j ?| j j t
j t
j t
j fv r| j j dk _| j | j j dk rdS | d | j j dk sJ | j j | j |S )zuParse the 'from x import' part in a 'from x import y' statement.
Return true iff `x` is __future__.
r,
__future__NimportFr@ )
r r r
r r r DOTr$ r% rJ rN s r rL z Parser._parse_from_import_source sQ
|!V+++T\-?+++ <- = L $ !bfbgru%=== "h.. K
L $ !bfbgru%=== "h.. < 4<#5#A#A5 ***|!X---t|/A--- r c b | j j dk r-| t j t j f}nt j t j f}| j j |vrF| j j t j k r| j j dk s | j j t j k r| j
n| j d| j j | j j |rI| j d| j j | j
| j j | t j | j d| j j | j j | j j t j k rh| j j dk rX| t j | j j t j k r | t j | j j dk r | t j | j d| j j | j j | j j |vr2| j j t j k | j j dk dS dS dS dS )z4Parse the 'y' part in a 'from x import y' statement.rK ;z parsing import, token is %r (%s)zfound future import: %sasr4 N)r r r r r% r r5 r r$ r
r r r r add)r rO expected_end_kindss r rM z Parser._parse_from_import_names3 sE < $ $ LL "$% "$*bl!; l '999 L & &4<+=+D+D| BG++ """ HNN2 ! "
< 8$,:LMMM#'' (:;;; LL ! ! ! HNN2 ! "
| BG++ 0Bd0J0J RW%%%<$//LL)))|!S(( RU### HNN2 ! "
5 l '999 L & &4<+=+D+D+D+D :9+D+D :9r r& )F)NN)r r r! r" r r r r ry r r r r) r/ r- r r. r< rJ r0 rL rM r r r r r s? &&# # #$+ + + h7788G 811 2 2DM M M $3
3
3
j # # # #>B B B H @L L L\# # #./ / / /$8 8 8 ,% % % % %r r )*r" r r tokenizer ior itertoolsr r pathlibr r. r typingr utilsr r+ r r r$ r2 r4 r
r r r r r r r r r rl r r r intr r r r r r r` s
& & & & & & & &
$ $ $ $ $ $ $ $
:
< < <6 6 6 6 6 6 6 6:4 4 4 4 4 4 4 4n8! 8! 8! 8! 8!Z 8! 8! 8!v- - - - -f - - -+" +" +" +" +"z +" +" +"\ X & & & & &X & & &R J
%
' ' ' ' ' ' ' '
=
y
() ) ) ) ) ) ) )X1 1 1 1 1 1 1 1
/ / / / /E / / /v v v v v v v v v vr