1jT B d Z ddlZddlZddlZddlmZ ddlmZm Z ddl
m Z
ddl m
Z
ddlmZ dd lmZ dd
lmZmZmZmZmZmZmZmZmZm Z m Z m Z dd l m Z m!Z!m"Z"m#Z#m$Z$ dd l%m&Z&m'Z'm(Z( d
Z)ddZ* G d d Z+ e Z, ddZ-d Z.d Z/d Z0d Z1d Z2dS )z5Parsed source code checkers for docstring violations. N)
namedtuple)chain takewhile)compile)dedent )
violations)IllegalConfiguration) AllErrorClass
DefinitionFunctionMethodModule NestedClassNestedFunctionPackage
ParseErrorParserStringIO)common_prefix_lengthis_blanklogpairwisestrip_non_alphanumeric)IMPERATIVE_BLACKLISTIMPERATIVE_VERBSstem)checkFc fd}|S )Nc $ | _ | _ | S N)
_check_for _terminal)fkindterminals d/builddir/build/BUILD/cloudlinux-venv-1.0.11/venv/lib/python3.11/site-packages/pydocstyle/checker.py decoratorz check_for..decorator( s )r& r' r) s `` r( check_forr, ' s*
r* c | e Zd ZdZdZdZ ed Z d,dZe d Z
e e d
d Z
e e d
d Z e e d
Z e e d Z e e d Z e e d Zed Z e e d Z e e d Z e e d Z e e d Z e e d Z e e d Z ed Z e e d Z e e d Z e e d Z e e d Z! e e d Z" e e d Z# e e d Z$ed Z%e&d! Z'e&d" Z(e&d# Z)ed$ Z*ed% Z+ed& Z,e&d' Z-ed( Z.d) Z/d* Z0 e e d+ Z1dS )-ConventionCheckerzChecker for PEP 257, NumPy and Google conventions.
D10x: Missing docstrings
D20x: Whitespace issues
D30x: Docstring formatting
D40x: Docstring content issues
)
z
Short SummaryzExtended Summary
ParametersReturnsYieldszOther ParametersRaisesSee AlsoNotes
ReferencesExamples
AttributesMethods) Args Arguments Attentionr7 CautionDangerErrorExampler6 Hint Importantz Keyword ArgszKeyword Argumentsr8 Noter4 Returnr0 r2 r5 r3 TipTodoWarningWarningsWarnsYieldr1 z"^\s*(\w+)\s*(\(.*?\))?\s*:\n?\s*.+NFc # 6 K |i n|| _ || _ t t | | }|D ]}| j D ]} d}
t || j r|j dk } d uo t fd|j D } |s| s| s | | ||j
}
nd }
t |
d r|
n|
g}|D ]Z}
|
V|s|
j |j vrF| j
d }|\ }}}|
|| |
V | j rd}
n[|
r nڌd S )NFallc 3 n K | ]/}t |j d k V 0dS )r N)lenfindallname).0decignore_decoratorss r( z1ConventionChecker.check_source.. s] K K - 5 5ch ? ?@@1DK K K K K Kr* __iter__z.
) explanation
definitionT)property_decoratorsignore_self_only_initparser checks
isinstancer# skipped_error_codesany
decorators docstringhasattrcode__doc__ partition set_contextr$ )selfsourcefilenamerR rW ignore_inline_noqarX modulerV
this_check terminate skipping_alldecorator_skiperrorerrorsrc message_rU s ` r( check_sourcez ConventionChecker.check_source s &-BB3F
&;"x''22 ! ! J "k
! j**?@@ &#-#AU#JL%6d%B &s K K K K#-#8K K K H HN
+%2>% ,% !+
*j.B! ! !%&-eZ&@&@ MUUugF!'
&
& , . - $z1O O O(2(:(D(DU(K(KI6? 3GQ ! - -,7J . #(KKK ) 3 &,0 % EA! ! r* c d t t | D }t |d S )Nc 2 g | ]}t |d |S )r# )r` )rP rj s r(
z,ConventionChecker.checks.. s8
z<00
r* c | j S r" )r$ )rj s r( z*ConventionChecker.checks.. s j6J2J r* key)varstypevaluessorted)re rK s r( rZ zConventionChecker.checks sS
"4:: . . 5 5 7 7
c J JKKKKr* T)r' c 6 fd}|sj rt t j t t j t t j t |t t j
t fdt t j
i} |t S dS dS )a D10{0,1,2,3}: Public definitions should have docstrings.
All modules should normally have docstrings. [...] all functions and
classes exported by a module should also have docstrings. Public
methods (including the __init__ constructor) should also have
docstrings.
Note: Public (exported) definitions are either those with names listed
in __all__ variable (if present), or those that do not start
with a single underscore.
c j rt j S j r4j rt j dk rd S t j S j st j S d S )Nr )
is_magicr D105is_initrX rM param_namesD107 is_overloadD102)rV re s r( method_violationzCConventionChecker.check_docstring_missing..method_violation sy "
)!(((!
). J 233q88 4!((( )
)!(((4r* c < j st j nd S r" )r r D103)rV s r( rw z;ConventionChecker.check_docstring_missing.. s# %1 JO - - - r* N) is_publicr r D100r D101r D106r r r r r D104r{ )re rV r_ r codess `` r( check_docstring_missingz)ConventionChecker.check_docstring_missing s -Z 1 -
zZ_(
E +5j))*,, , - - - -r* c v |r4t t j | rt j S dS dS )zD419: Docstring is empty.
If the user provided a docstring but it was empty, it is like they never provided one.
NOTE: This used to report as D10X errors.
N)r ast literal_evalr D419re rV r_ s r( check_docstring_emptyz'ConventionChecker.check_docstring_empty sH %#"29"="=>> % ?$$ $ % % % %r* c |rzt j | d }t | dk rBt d |D }|dk r%t j t | S dS dS dS )zD200: One-liner docstrings should fit on one line with quotes.
The closing quotes are on the same line as the opening quotes.
This looks better for one-liners.
r c 3 8 K | ]}t | d V dS )r Nr rP ls r( rS z5ConventionChecker.check_one_liners.. s- %J%JAhqkk%Ja%J%J%J%J%J%Jr* N)r r splitrM sumr D200)re rV r_ linesnon_empty_liness r( check_one_linersz"ConventionChecker.check_one_liners s 7$Y//55d;;E5zzA~~"%%J%J%J%J%J"J"J"a''%?3u::666 7 7 ~''r* c # K |rZ|j | \ }}}t t t | d dd }t t t | d dd }t
t t t | }t
t t | } |dk rt j | V t | sH| dk rD| dk r"t d | s t j | V dS dS dS dS dS )zD20{1,2}: No blank lines allowed around function/method docstring.
There's no blank line either before or after the docstring unless directly
followed by an inner function or class.
r Nr r z"\s+(?:(?:class|def|async def)\s|@))rf rc listmapr r r r boolreversedr D201rK rematchD202)
re functionr_ beforerq after
blanks_before blanks_afterblanks_before_countblanks_after_counts
r( check_no_blank_beforez'ConventionChecker.check_no_blank_before sf > ' 8 8 C C FAu Xv||D/A/A#2#/F!G!G H HM Hekk$.?.?.C D DEEL"%ih}6M6M&N&N"O"O !$Yt\%B%B!C!C "a'' o&9:::::|$$
>);q)@)@
'!++@AAGGNN , %/*<=======! > >
>
>)@)@
,+r* c # K |rN|j | \ }}}t t t | d dd }t t t | d dd }t
t t t | }t
t t | } |dk rt j | V |dk rt j | V t | s | dk r t j | V dS dS dS dS )a D20{3,4}: Class docstring should have 1 blank line around them.
Insert a blank line before and after all docstrings (one-line or
multi-line) that document a class -- generally speaking, the class's
methods are separated from each other by a single blank line, and the
docstring needs to be offset from the first method by a blank line;
for symmetry, put a blank line between the class header and the
docstring.
r Nr r r )rf rc r r r r r r r r r D211D203rK D204)
re class_r_ r rq r r r r r s
r( check_blank_before_after_classz0ConventionChecker.check_blank_before_after_class sR ( : %} 6 6y A A FAu Xv||D/A/A#2#/F!G!G H HM Hekk$.?.?.C D DEEL"%ih}6M6M&N&N"O"O !$Yt\%B%B!C!C "a'' o&9:::::"a'' o&9:::::|$$
:);q)@)@ o&89999999 : :
:
:)@)@r* c v |rt j | d }t | dk rht t
t |dd }t t t | }|dk rt j | S dS dS dS )a D205: Put one blank line between summary line and description.
Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate
description. The summary line may be used by automatic indexing tools;
it is important that it fits on one line and is separated from the
rest of the docstring by a blank line.
r r N)
r r stripr rM r r r r r r r D205)re rV r_ r post_summary_blanks blanks_counts r( check_blank_after_summaryz+ConventionChecker.check_blank_after_summary@ s 9$Y//5577==dCCE5zzA~~&*3xqrr+C+C&D&D# "9T3F#G#G H H 1$$%?<888
9 9 ~ %$r* c t | j | \ }}}| d \ }}}|S )z9Return the indentation of the docstring's opening quotes.r )rf rc
rpartition)rV r_ before_docstringrq indents r( _get_docstring_indentz'ConventionChecker._get_docstring_indentS s@ ",!2!.g sS 4 "'q1u !6!6t!.l s+ NNN(1++N=++NNNr* z Nr r ) r r rM enumeratesetjoinr D206minD208D207)re rV r_ r indentsr s @r( check_indentz ConventionChecker.check_indentZ s ,//
IFFF OOD))E5zzA~~ #,U#3#3
ONUNNNu::RWWW%5%5%>!?!???$/+++++LL1$$WSbS\):):V)C)CLL1$$v)=)=$/+++++w<. s4 {{ r* r r r )"""'''N)r r r rM r r D209re rV r_ r s r( "check_newline_after_last_paragraphz4ConventionChecker.check_newline_after_last_paragraphv s - ))44::4@@ E
5zzA~~ ??4((,2244NJJ%?,,, - - ~JJr* c |rt j | d }|d d s.t | dk r0|d d rt
j S dS dS dS )z8D210: No whitespaces allowed surrounding docstring text.r r r N)r r r
startswithrM r r D210r s r( check_surrounding_whitespacesz/ConventionChecker.check_surrounding_whitespaces s )$Y//55d;;Ea##C((
)u::??!H%%c** # "((( ) ) #???r* c \ |rg d}t j | d }t | dk rk| d d }||v rt
j S t
j S dS dS )zD21{2,3}: Multi-line docstring summary style check.
A multi-line docstring summary should start either at the first,
or separately at the second line of a docstring.
)r r zu"""zu'''zr"""zr'''zur"""zur'''r r r N) r r r rM r lowerr D212D213)re rV r_ start_tripler firsts r( check_multi_line_summary_startz0ConventionChecker.check_multi_line_summary_start s - L $Y//55d;;E5zzA~~!--a06688>>@@L((%?,,,%?,,,% - - ~r* c 8 |rdt j | v rt d }nt d }| | sMt d }| | d }t j | S dS dS )a D300: Use """triple double quotes""".
For consistency, always use """triple double quotes""" around
docstrings. Use r"""raw triple double quotes""" if you use any
backslashes in your docstrings. For Unicode docstrings, use
u"""Unicode triple-quoted strings""".
Note: Exception to this is made if the docstring contains
""" quotes in its body.
r z[uU]?[rR]?'''[^'].*z[uU]?[rR]?"""[^"].*z[uU]?[rR]?("+|'+).*r N)r r r r groupr D300)re rV r_ regexillegal_matcherillegal_quotess r( check_triple_double_quotesz,ConventionChecker.check_triple_double_quotes s 7(3333 122122;;y))
7"$%?"@"@!0!6!6y!A!A!G!G!J!J!~666 7 7
7
7r* c |rJt d | r*| d st j S dS dS dS )aX D301: Use r""" if any backslashes in a docstring.
Use r"""raw triple double quotes""" if you use any backslashes
(\) in your docstrings.
Exceptions are backslashes for line-continuation and unicode escape
sequences \N... and \u... These are considered intended unescaped
content in docstrings.
z \\[^\nuN])rurN)r searchr r D301r s r( check_backslashesz#ConventionChecker.check_backslashes sp
%< '' 22 % ((55 %
?$$ $ % % % % % %r* c | ret j | d d }| | s ||d S dS dS )a First line ends with one of `chars`.
First line of the docstring should end with one of the characters in `chars`.
`chars` supports either a `str` or an `Iterable[str]`. If the condition is
evaluated to be false, it raises `violation`.
r r r N)r r r r r )r_ chars violation summary_lines r( _check_ends_withz"ConventionChecker._check_ends_with sz 3 +I66<<>>DDTJJ1ML ((//
3 y b!1222 3 3
3
3r* c D | |dt j S )z}D400: First line should end with a period.
The [first line of a] docstring is a phrase ending in a period.
.)r r D400r s r( check_ends_with_periodz(ConventionChecker.check_ends_with_period s $$YZ_EEEr* c D | |dt j S )zD415: should end with proper punctuation.
The [first line of a] docstring is a phrase ending in a period,
question mark, or exclamation point
)r !?)r r D415r s r( check_ends_with_punctuationz-ConventionChecker.check_ends_with_punctuation s% $$
r* c ( |r|j s| | j st j | }|rt
| d }| t v rt j | S t j
t }|rG|vrEt |fd }t j | | S dS dS dS dS dS dS )a D401: First line should be in imperative mood: 'Do', not 'Does'.
[Docstring] prescribes the function or method's effect as a command:
("Do this", "Return that"), not as a description; e.g. don't write
"Returns the pathname ...".
r c $ t | S r" )r )r%
check_words r( rw z9ConventionChecker.check_imperative_mood.. s &::q&I&I r* rx N)is_test is_propertyrW r r r r r r r r D401br getr maxD401
capitalize)re r r_ stripped
first_word
correct_formsbestr s @r( check_imperative_moodz'ConventionChecker.check_imperative_mood sU
J $ J (()ABB J
' 2288::H
J 3HNN4D4DQ4G H H
' - - / /
!555%+J777 0 4T*5E5E F F
JZ}%D%D % I I I I D &?4??+<+'>
KKK L L 54r* c B |r|j rt j S dS dS )a" D418: Function decorated with @overload shouldn't contain a docstring.
Functions that are decorated with @overload are definitions,
and are for the benefit of the type checker only,
since they will be overwritten by the non-@overload-decorated definition.
N)r r D418)re r r_ s r( check_if_neededz!ConventionChecker.check_if_needed@ s8 %- % ?$$ $ % % % %r* c |sdS t j | }|sdS t | d }| dk rt
j S dS )zD404: First word of the docstring should not be `This`.
Docstrings should use short, simple language. They should not begin
with "This class is [..]" or "This module contains [..]".
Nr this)r r r r r r r D404)re r r_ r r s r( check_starts_with_thisz(ConventionChecker.check_starts_with_thisL s F#I..4466 F+HNN,<,. sQ .
.
:;G ! ' ' ) ) 2 21 5 5.
.
.
.
.
.
r* )r r lstrip section_namer] r r4 )r6 section_name_suffix section_suffix_is_only_colon punctuation prev_line_ends_with_punctuation#this_line_looks_like_a_section_name%prev_line_looks_like_end_of_paragraphs ` r( _is_docstring_sectionz'ConventionChecker._is_docstring_section_ s J
L ' '(<(B(B(D(D E E K K M M (;c'A$DDD *- .
.
.
.
?J.
.
.
+
+
'
( ) ) I-I ,
, Nx8M/N/N .
0
65
r* c # j K d}|j D ]}t | s n4|dz
}t j | V t j | V dS |j | }d t
| dk }|s6t j | V |dk rt j | V dS dS |dk rt j | V | dt | z k rDt j t | |t | V t | |k rt j
| V |dz }|t |j k r|j | } t | ra|j |d }
t d |
st j | V dS t j | V dS dS t j | V dS )a_ D4{07,08,09,12,14}, D215: Section underline checks.
Check for correct formatting for docstring sections. Checks that:
* The line that follows the section name contains
dashes (D40{7,8}).
* The amount of dashes is equal to the length of the section
name (D409).
* The section's content does not begin in the line that follows
the section header (D412).
* The section has no content (D414).
* The indentation of the dashed line is equal to the docstring's
indentation (D215).
r r Nr r. )following_linesr r D407D414r r r D412D408rM D409r D215) clsr8 r6 indentationblank_lines_after_headerr non_empty_linedash_line_foundline_after_dashes_indexline_after_dashes
rest_of_liness r( #_check_blanks_and_section_underlinez5ConventionChecker._check_blanks_and_section_underline s " $% + DD>>
$ ) $ $ /,// / / / /,// / / / F 01IJ ''#n&:&:&<&<"="=>>#E " 4 /,// / / /'!++ ol3333333 ,+ (!++ ol33333 ##%%s&B # 'W-D)E)EEE$+$;+%! -.. <$+$;/00%M $BGGM$:$:;; < (ol ; ;;;;;; (ol ; ;;;;;;< < !ol3333333r* c # N K | || }|j }|j |vr ||v r t j ||j V t |j |k rt j | V |j rt |j d s4|j
rt j | V nt j | V t |j
st j | V | ||| E d{V dS )a D4{05,10,11,13}, D214: Section name checks.
Check for valid section names. Checks that:
* The section name is properly capitalized (D405).
* The section is not over-indented (D214).
* There's a blank line after the section (D410, D413).
* There's a blank line before the section (D411).
Also yields all the errors from `_check_blanks_and_section_underline`.
r N)r r8 titler D405r r D214rA r is_last_sectionD413D410r4 D411rP )rH r_ rV r6 valid_section_namesrI capitalized_sections r( _check_common_sectionz'ConventionChecker._check_common_section sm //
IFF % 2 8 8 : :
(; ; ;#'::: /"5w7KLL L L L & & 4 4 /"566 6 6 6& ;h #B '/
/
; &
; o&9:::::: o&9:::::-.. 7 /"566 6 6 6:: +
r* c # K | || }|j }| |||| j E d{V |j |j }|r.t j ||j V |dk r |
||| E d{V dS dS )a* D406: NumPy-style section name checks.
Check for valid section names. Checks that:
* The section name has no superfluous suffix to it (D406).
Additionally, also yield all violations from `_check_common_section`
which are style-agnostic section checks.
Nr/ ) r r8 rR r[ NUMPY_SECTION_NAMESr r r7 r D406_check_parameters_section)rH r_ rV r6 rI rZ suffixs r( _check_numpy_sectionz&ConventionChecker._check_numpy_section s$ //
IFF % 2 8 8 : :,, z7C,C
##%%,,W-ABB M /"5w|7I7I7K7KLL L L L , . .44:w
/ .r* c # K t }t |j }d |j dd d }t ||dd D ]\ }}t | |k rt t | t t | k r| rsd|v r| dd \ }} n| }| d }
|
D ])} |
| *t || E d{V dS )zD417: `Parameters` section check for numpy style.
Check for a valid `Parameters` section. Checks that:
* The section documents all function arguments (D417)
except `self` or `cls` if it is a method.
r z\
r r Nr+ r, )
r r r r rA r r ziprM r addr. _check_missing_args) r_ rV r6 docstring_argssection_level_indentcontent current_line next_line
parametersparameter_typeparameter_list parameters r( r_ z+ConventionChecker._check_parameters_section s ,W\ : :
IIg- . . 6 6vr B B H H N N (+7GABBK'@'@ : : #L) |,,0DDD
i0011- 55667 7 OO%%7 ,&&1=1C1CC1K1K.J ".!3!3!5!5J ",!1!1#!6!6!/ : :I"&&y'8'89999$88 J
r* c #
K t }|j r7|j d }|dt |
t d
fd|j D }g }| d D ]D}|dd s| | 4|dxx |z
cc< E|D ]K}t j | } | r(|
| d Lt || E d{V dS ) a D417: `Args` section checks.
Check for a valid `Args` or `Argument` section. Checks that:
* The section documents all function arguments (D417)
except `self` or `cls` if it is a method.
Documentation for each arg should start at the same indentation
level. For example, in this case x and y are distinguishable::
Args:
x: Lorem ipsum dolor sit amet
y: Ut enim ad minim veniam
In the case below, we only recognize x as a documented parameter
because the rest of the content is indented as if it belongs
to the description for x::
Args:
x: Lorem ipsum dolor sit amet
y: Ut enim ad minim veniam
r Nr c J g | ] }| s|d k | S )r r )rP r leading_whitespacess r( ru z9ConventionChecker._check_args_section..q sC ':;; @Drzz ?Izzr* T)keependsr r )r rA rM r7 r r r
splitlinesisspaceappendr. GOOGLE_ARGS_REGEXr rd r re ) r_ rV r6 rf r args_content
args_sectionsr sectionr rr s @r( _check_args_sectionz%ConventionChecker._check_args_sectionP s . " J 03J",-HJ4E4E4G4G0H0H/H-H"I II ' 7
%''
++T+:: * *D8##%%
* $$T**** b!!!T)!!!!$ 3 3G%7==gFFE
3 ""5;;q>>222$88 J
r* c # T K t |t rt |j }|j dk r|j s
|dd }d |D }t
| | z
}|r@t j d t | |j V dS dS dS )a3 D417: Yield error for missing arguments in docstring.
Given a list of arguments found in the docstring and the
callable definition, it checks if all the arguments of the
callable are present in the docstring, else it yields a
D417 with a list of missing arguments.
methodr Nc 0 g | ]}t | |S r+ )is_def_arg_private)rP arg_names r( ru z9ConventionChecker._check_missing_args.. s6 )(33 r* z, ) r[ r get_function_argsrf r& is_staticr r D417r r} rO )rf rV
function_args missing_argss r( re z%ConventionChecker._check_missing_args s j( + + -j.? @ @M (**:3G* -abb 1
- M
}-->L
oIIf\ 2 233Z_
r* c # K |j }| |||| j E d{V |j |j }|dk r1t j |dz |j V |dv r | ||| E d{V dS dS )a D416: Google-style section name checks.
Check for valid section names. Checks that:
* The section does not contain any blank line between its name
and content (D412).
* The section is not empty (D414).
* The section name has colon as a suffix (D416).
Additionally, also yield all violations from `_check_common_section`
which are style-agnostic section checks.
Nr+ )r9 r: )
r8 rR r[ GOOGLE_SECTION_NAMESr r r7 r D416r{ )rH r_ rV r6 rZ r` s r( _check_google_sectionz'ConventionChecker._check_google_section s
& 2 8 8 : :,, z7C,D
##%%,,W-ABB S== /#c)7<+=+=+?+?
"7 7 7..y*gNN N N N N N N N N N 8 7r* c
# r K d |D fdfdt D }t dd fd|D }d |D }t |d D ]H\ }}|d n|j } |j |j |j |j d
z | |j |du V IdS ) a Generate `SectionContext` objects for valid sections.
Given a list of `valid_section_names`, generate an
`Iterable[SectionContext]` which provides:
* Section Name
* String value of the previous line
* The section line
* Following lines till the next section
* Line index of the beginning of the section in the docstring
* Boolean indicating whether the section is the last section.
for each valid section.
c 6 g | ]}| S r+ )r )rP ss r( ru z;ConventionChecker._get_section_contexts.. s F F FQqwwyy F F Fr* c N t | }|v S r" )get_leading_wordsr )_lineresultlower_section_namess r( _suspected_as_sectionzFConventionChecker._get_section_contexts.._suspected_as_section s$ &u{{}}55F 00 0r* c 0 g | ]\ }} | |S r+ r+ )rP r r r s r( ru z;ConventionChecker._get_section_contexts.. s> %
%
%
!T1F1Ft1L1L%
%
%
%
r* SectionContext)r8 r4 r rA original_indexrU c 3 K | ]S} t | |d z
| |d z d |d V TdS )r NF)r r )rP r r r s r( rS z:ConventionChecker._get_section_contexts.. s
N!%(.."2"233a!e aa!egg
r* c 3 N K | ] }t | |V !d S r" )r. r? )rP cs r( rS z:ConventionChecker._get_section_contexts.. sJ
#4#J#J1#M#M
r* Nr r )r r r r r8 r4 r )
r rY suspected_section_indicescontextsabendr r r s
` @@@r( _get_section_contextsz'ConventionChecker._get_section_contexts s_ G F2E F F F 1 1 1 1 1
%
%
%
%
&u - -%
%
%
! $
/
Xt,, DAq ""q'7C .a&*S01 T
r* c # K d}| || j D ]!}d}| ||| E d{V "|S )a NumPy-style docstring sections checks.
Check the general format of a sectioned docstring:
'''This is my one-liner.
Short Summary
-------------
This is my summary.
Returns
-------
None.
'''
Section names appear in `NUMPY_SECTION_NAMES`.
Yields all violation from `_check_numpy_section` for each valid
Numpy-style section.
FTN)r r] ra )re r rV r_ found_any_numpy_sectionctxs r( _check_numpy_sectionsz'ConventionChecker._check_numpy_sections sk ( #( --eT5MNN M MC&* #00JLL L L L L L L L L&&r* c # K | || j D ] }| ||| E d{V dS )a Google-style docstring section checks.
Check the general format of a sectioned docstring:
'''This is my one-liner.
Note:
This is my summary.
Returns:
None.
'''
Section names appear in `GOOGLE_SECTION_NAMES`.
Yields all violation from `_check_google_section` for each valid
Google-style section.
N)r r r )re r rV r_ r s r( _check_google_sectionsz(ConventionChecker._check_google_sections$ sl $ -- 4,
N NC 11)ZMM M M M M M M M M N Nr* c # K |sdS | d }t | dk rdS | ||| E d{V }|s | ||| E d{V dS dS )z Check for docstring sections.Nr )r rM r r )re rV r_ r found_numpys r( check_docstring_sectionsz*ConventionChecker.check_docstring_sections; s F%% u::>> F!%!;!; :y"
"
22z9
r* )NNFF)2__name__
__module__ __qualname__rb r] r r rw rr propertyrZ r, r
r r r r r r r r staticmethodr r r r r r r r r r r r r" r% r) r? classmethodrP r[ ra r_ r{ re r r r r r r+ r* r( r. r. 0 s H
4 #/ / / /b L L XL YzD)))*- *- *)*-X YzD))) % % *) % Yz 7 7 7 Yx> > >0 Yu : : :@ Yz9 9 9$ \ Yz, , ,6 Yz- - -" Yz ) ) ) Yz- - -6 Yz7 7 74 Yz% % %( 3 3 \ 3 YzF F F Yz
Yx J J J< Yx
)
)
) YxL L L Yx % % % Yz% % %$ 9
9
\9
v A4 A4 [A4F &
&
[&
P [. -
-
\-
^ 9
9
\9
v \8 O O [O2 C C \CJ' ' '6N N N. Yz r* r. c # K ||t d ||}n\|It t t j t | z
}nt j j }| D ]}t j d| t j | 5 } | }
ddd n # 1 swxY w Y t |
||||| D ]} t | dd } | |v r| V # t t" t$ f$ r$} t j d|| | V Y d} ~ d} ~ wt j $ r t+ d|z V Y w xY wdS )a Generate docstring errors that exist in `filenames` iterable.
By default, the PEP-257 convention is checked. To specifically define the
set of error codes to check for, supply either `select` or `ignore` (but
not both). In either case, the parameter should be a collection of error
code strings, e.g., {'D100', 'D404'}.
When supplying `select`, only specified error codes will be reported.
When supplying `ignore`, all error codes which were not specified will be
reported.
Note that ignored error code refer to the entire set of possible
error codes, which is larger than just the PEP-257 convention. To your
convenience, you may use `pydocstyle.violations.conventions.pep257` as
a base set to add or remove errors from.
`ignore_inline_noqa` controls if `# noqa` comments are respected or not.
`ignore_self_only_init` controls if D107 is reported on __init__ only containing `self`.
Examples
---------
>>> check(['pydocstyle.py'])
>>> check(['pydocstyle.py'], select=['D100'])
>>> check(['pydocstyle.py'], ignore=conventions.pep257 - {'D100'})
Nz@Cannot pass both select and ignore. They are mutually exclusive.zChecking file %s.ra zError in file %s: %szinvalid syntax in file %s)r
r r r
ErrorRegistryget_error_codes conventionspep257r infotkopenreadr. rr getattrOSErrorr r warning
TokenError SyntaxError)
filenamesselectignorerR rW rh rX
checked_codesrg filerf rn ra s
r( r r Q s R f 0"
+
(88:: ; ;c&kk I
#.5
F F $h/// F""
%d
%
%
%
%
%
%
%
%
%
%
%
%
%
%
%*,,99!#"%
ufd33=(( KKK
:. K.% @ @ @KKKKKKKK} F F F 9H DEE E E E E E F'F FsC D%C: DC
D
C
ADE3+E
&E32E3c 4 t d | D S )zBReturn a boolean indicating if `string` only has ascii characters.c 3 < K | ]}t | d k V dS ) N)ord)rP r! s r( rS zis_ascii.. s, 224s4yy3222222r* )rK r s r( is_asciir s 226222 2 22r* c j t d | S )z'Return any leading space from `string`.z\s*)r r r r s r( r r s(
f:: F # # ) ) + ++r* c t d | }|| S dS )z{Return any leading set of words from `line`.
For example, if `line` is " Hello world!!!", returns "Hello world".
z[\w ]+N)r r r r )r r s r( r r sA
]]
.
.F
||~~ r* c , | d S )z. s L L LXHL L L Lr* )r rY r7 bodyargsr
kwonlyargsr )function_sourcefunction_arg_node arg_nodeskwonly_arg_nodess r( r r s Io&<&<&>&> ? ? DQ G L "&I(3 L Ly:J)K)K L L LLs 69 AA)F)NNNNFF)3rb r r tokenizer collectionsr itertoolsr r r r textwrapr r r configr
parserr r r
r r r r r r r r r utilsr r r r r wordlistsr r r __all__r, r. rY r r r r r r r+ r* r( r sp ; ;
" " " " " " & & & & & & & & ( ( ( ( ( (
D C C C C C C C C C
[ [ [ [ [ [ [ [|
KF KF KF KF\3 3 3
, , ,
$ $ $
M M M M Mr*