2
2n U d Z ddlmZ ddlZddlZddlmZ ddlmZ ddl m
Z
ddl m Z ddl
mZmZ dd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZmZmZ e
rddl m Z ej dk rddl m Z nddl m Z h dZ!ej" ej# hZ$ddddddddddd ej% ifd d d d Z&d!e'd"< d3d+Z( G d, d$ Z) G d- d.ee Z*d4d2Z+dS )5zPython code format's checker.
By default, try to follow Guido's style guide :
https://www.python.org/doc/essays/styleguide/
Some parts of the process_token method is based from The Tab Nanny std module.
) annotationsN)reduce)Match)
TYPE_CHECKING)nodes)BaseRawFileCheckerBaseTokenChecker)only_required_for_messages) WarningScope)HIGH)MessageDefinitionTuple) OPTION_POPragmaParserError parse_pragma)PyLinter) )Literal> ifindelfornotelifwithraisewhileyieldassertexceptreturn=:=)zLine too long (%s/%s)
line-too-longz=Used when a line is longer than a given number of characters.)z Too many lines in module (%s/%s)too-many-linesz@Used when a module has too many lines, reducing its readability.)zTrailing whitespacetrailing-whitespacezHUsed when there is whitespace between the end of a line and the newline.)zFinal newline missingmissing-final-newlinez7Used when the last line in a file is missing a newline.)zTrailing newlinestrailing-newlinesz3Used when there are trailing blank lines in a file.)z)Bad indentation. Found %s %s, expected %sbad-indentationzUUsed when an unexpected number of indentation's tabulations or spaces has been found.)zUnnecessary semicolonunnecessary-semicolonzeUsed when a statement is ended by a semi-colon (";"), which isn't necessary (that's python, not C ;).z(More than one statement on a single linemultiple-statementsz r@ s h/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/pylint/checkers/format.py_last_token_on_line_isrJ z st 1 0 LLA & &% / : a< : LLA & &% / : KK1 % %)9 9 c B e Zd ZdZddZdd
Zdd Zdd Zdd
ZddZ dS )r= z3A wrapper for readable access to token information.r< list[tokenize.TokenInfo]r! Nonec || _ d S N_tokens)selfr< s rI __init__zTokenWrapper.__init__ s
rK idxr? rA c ( | j | d S )NrD rQ rS rU s rI r@ zTokenWrapper.token |C ##rK c ( | j | d S )Nr rQ rW s rI rF zTokenWrapper.type rX rK c 4 | j | d d S )NrE r rQ rW s rI
start_linezTokenWrapper.start_line |C #A&&rK c 4 | j | d d S )NrE rD rQ rW s rI start_colzTokenWrapper.start_col r\ rK c ( | j | d S )N rQ rW s rI linezTokenWrapper.line rX rK Nr< rM r! rN )rU r? r! rA )rU r? r! r? )
__name__
__module__ __qualname____doc__rT r@ rF r[ r^ ra rK rI r= r= s == $ $ $ $$ $ $ $' ' ' '' ' ' '$ $ $ $ $ $rK c x e Zd ZdZdZeZddddddfd d
d d d
dfddddddfddddddfddddddfdddd d dfd ddd d dfd!d"d#d$g d%d&d'ffZdT fd, ZdUd1Z dVd4Z
dWd7Z dXd8Z dYd<Z
ed= dZd? Zd[dAZd\dCZd]dFZed^dI Zed_dK Zed`dN ZdadPZdbdSZ xZS )c
FormatCheckerzvFormatting checker.
Checks for :
* unauthorized constructions
* strict indentation
* line length
formatzmax-line-lengthd r? zz.Maximum number of characters on a single line.)defaultrF metavarhelpzignore-long-linesregexpzz^\s*(# )??$z>Regexp for a line that is allowed to be longer than the limit.)rF rm rl rn zsingle-line-if-stmtFynzzOAllow the body of an if to be on the same line as the test if there is no else.zsingle-line-class-stmtzfAllow the body of a class to be on the same line as the declaration if body contains single statement.zmax-module-linesi z$Maximum number of lines in a module.z
indent-stringz non_empty_stringzzSString used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).zindent-after-parenr` zGNumber of spaces of indent required inside a hanging or continued line.zexpected-line-ending-formatchoicez )rs LFCRLFzIExpected format of line ending, e.g. empty (any line ending), LF or CRLF.)rF rm rl choicesrn linterr r! rN c f t | i | _ i | _ d S rP )superrT _lines_visited_lines)rS rw __class__s rI rT zFormatChecker.__init__ s0
&( 8:rK r< r= r>
line_startc ~ t ||d r*| d| | | | }| | }| | t
vr#| d d | j |< | |||| dS )z9A new line has been encountered, process it if necessary.;r* ra
r N) rJ add_messager[ ra rF _JUNK_TOKENSsplitrz check_lines)rS r< r> r} line_numra s rI new_linezFormatChecker.new_line s !&(C 8 8 X 46;L;LX;V;V W W W$$Z00{{:&& ;;z " ", 6 6$(JJt$4$4Q$7DK ! T8<<<< r r r > }r r :]rE r r- ra args,> orandr r elsec 3 $ K | ] }|j V d S rP )string).0is rI z;FormatChecker._check_keyword_parentheses..z s$ < >+/((-%|s""
!a%='3..-.* $$
- &Q-2F#2M2M(,??? $ *a/* !a%='+EEEEJ8+X-?AQRJS JS 0 4IA4MQV4V4V EAI~~ # $,, $$,8- % !8s??FF 8},,#'LL 1X((FF
1X&&FF 1X'' < < < < <<< 77qrr
AFFFFFOG G rK c dg}d}d}i _ i _ d _ d}t | D ]\ }\ }}} }
} | d |k rj| d }|t j k r+ t | |dz
|dz n' t | |dz
| |t j k rd} || n|t j k rAd}
||d dz | | |d dz n|t j k rd}t | dk r|d= nc|t j k r| d s|}n;|t j t j fvr!|r d}
| |d | |t j k r,| d r d |
|t* v r || |dz }| j j j k r j j d d } | j d f}
t; t= d fd |
D d } d | j j j f|
||k r |dk r d|
dS dS dS )zProcess tokens and search for:
- too long lines (i.e. longer than )
- optionally bad construct (if given, bad_construct must be a compiled
regular expression).
r FNrD T
lzlowercase-l-suffixr r% c 3 V K | ]#}j j | V $d S rP )rw _pragma_linenoget)r namerS s rI r z/FormatChecker.process_tokens.. s6 U Utdk 8 < t d |d }|dk rdnd}||k r | d||f| d S d S d S )
Nr. r c | |k r| |z n| S rP rg )xys rI z2FormatChecker._check_line_ending.. s qAvva!ee1 rK rs r rt ru r/ r )r r rw r expected_line_ending_formatr )rS r r expecteds rI r z FormatChecker._check_line_ending s ! -
F{d.D D D !5H EEE!, ;%A !D!DkSUVVK"-"5"5$$6Kh&& 3%x0! ! '&rK r+ nodes.NodeNGc |j sdS | j sdS | }||j }nt |j t j r)||j j v r|j j
d j dz }nBt |j t j rd}n |j
d j }|j }|s
J | ||k r6| j | dk r| || dS || j v rdS |j }n# t$ $ r
|j }Y nw xY w|s
J | g }t' ||dz D ]d}d| j |< | | j | @# t. $ r | d Y aw xY wdS )z8Check the node line number and check it if not yet done.Nr rD T)futurerE rs ) is_statementroot pure_pythonprevious_sibling
fromlineno
isinstanceparentr
TryFinally finalbodybodytolinenoModule statementr{ r _check_multi_statement_lineblockstart_tolinenoAttributeErrorr r rz rstripKeyError)rS r prev_sibl prev_linera r liness rI
visit_defaultzFormatChecker.visit_default s Fyy{{& F))++ !,II
t{E$4 5 5 F:>$+BW:W:W (+4q8II
U\
2
2 FII --T-::EITt !4!8!8!>!>!!C!C , ,T4 8 8 8 F 4& & & F %/HH % % %}HHH % x $1 -- ! !D()D %
! T[ . 5 5 7 78888
!
!
! R
! ! !s$ (D0 0EE52F(( G
G
ra c t |t j rdS t |t j r!t |j t j rdS t |j t j r |j j s| j j j
rdS t |j t j r0t |j j
dk r| j j j rdS t |j t j rNt |t j r4t |j t j r|j j t& u rdS | d| d| j |< dS )z/Check for lines containing multiple statements.NrD r+ )r rE )r r With TryExceptr r Iforelserw r single_line_if_stmtClassDefr r single_line_class_stmt FunctionDefExprvalueConstEllipsisr r{ )rS r ra s rI r z)FormatChecker._check_multi_statement_line s_ dEJ ' ' F dEO , , K)2
2
F t{EH - - K& "6
F t{EN 3 3 DK$%%** "9 +
F
t{E$5 6 6 4,, 4:u{33
H,, F .T:::$%D!!!rK r c | d }|t | d dvr-| d|t | t dS dS )z,Check that there is no trailing white-space.z
N)r r r& )ra
col_offset
confidence)r r r r )rS ra r
stripped_lines rI check_trailing_whitespace_endingz.FormatChecker.check_trailing_whitespace_ending= sv K00
M""$$ %^ ; ; % }--
< ;rK checker_offrB c V | j j j }| j j j }| }t | |k r]| | sJ|r | j d| dS | d|t | |f dS dS dS )z=Check that the line length is less than the authorized value.r$ r N) rw r max_line_lengthignore_long_linesr r searchadd_ignored_messager )rS ra r r max_charsignore_long_lines rI check_line_lengthz FormatChecker.check_line_lengthI s K&6 ;-?{{}} t99y )9)@)@)F)F
W //CCCCC qD 9?U VVVVV ! rK options_pattern_obj
Match[str]c | j }|d| d || d d z }|S )z-Remove the `# pylint ...` pattern from lines.NrD )r r r end)r r purged_liness rI remove_pylint_option_from_linesz-FormatChecker.remove_pylint_option_from_linesT sd $* 0'--a000 1 8 8 : :'++A..001
2 rK pylint_pattern_match_objectc t | d D ]}|j dk r d|j v r dS n# t $ r Y nw xY wdS )z2Return True if the line length check is activated.rE disabler$ FT)r groupactionmessagesr )r pragmas rI is_line_length_check_activatedz,FormatChecker.is_line_length_check_activated^ s| &'B'H'H'K'KLL
!
!=I--/V_2T2T 55
! ! D ts 9? ?
A A r list[str]c h d}g }d}| d D ],}|d |vr| ||z d}'||z
}-|S )z]Split lines according to universal newlines except those in a specific
sets.
>
rs Tr )
splitlinesr )r unsplit_endsresbuffer atomic_lines rI specific_splitlinesz!FormatChecker.specific_splitlinesj sz
++D11 & &K2l22
6K/000+%
rK r c | j j j | | }t | D ]q\ }}| d s| d||z 5| | t j k r|
|||z rt fd|D }|sdS t j
| } d}
| r,| | sd}
| | }t | | D ] \ }}| |||z |
dS )zCheck given lines for potential messages.
Check if lines have:
- a final newline
- no trailing white-space
- less than a maximum number of characters
r r' r c 3 > K | ]}t | k V d S rP )r )r ra r s rI r z,FormatChecker.check_lines.. s? ,
,
&*CII !,
,
,
,
,
,
rK NFT)rw r r r) r r r rF rG STRINGr anyr r r r r ) rS r< r} r r split_linesoffsetra potential_line_length_warningmobjr r s @rI r zFormatChecker.check_lines s $ K&6 ..u55 %k 2 2 M MLFD==&&
!8v OOO {{:&&(/9955dFVOLLL ), ,
,
,
,
.9,
,
,
)
)
% - F && ?66t<<
# " 88>>E &d&>&>u&E&E F F G GLFD " "4& + F F F F G GrK r r c | j j j }|dk rd}d}t | }|d| |k r ||d }|dz
}|d| |k d}|r+|d dv r!||d z
}|dd }|r
|d dv !||k s|rCd}|d dk rd }| d
|||z t | z |||z f dS dS ) z&Return the indent level of the string.z\t r NrD rs z spacestabsr) r )rw r
indent_stringr r ) rS r r r indentlevel unit_sizesuppli_types rI r z FormatChecker.check_indent_level s= #1 U??FKK ZiZ F**IJJ'F QJE ZiZ F** e++ VAY EABBZF e++ H FayD ! i'#e**4fh>RS
rK rw r r! rN )r< r= r> r? r} r? r! rN )r r r! rN )r< rM r r? r! rN rb )r rA r r? r! rN )r r r! rN )r r ra r? r! rN )ra rA r r? r! rN )ra rA r r? r rB r! rN )r r
r! rA )r r
r! rB )r rA r! r )
r< r= r} r? r rA r r? r! rN )r rA r r? r r? r! rN )rc rd re rf r r; msgsoptionsrT r r r r r r
r r r r staticmethodr r r) r r
__classcell__)r| s @rI ri ri s D D
"H
%8T
" %<
% %(
">
!*%6
! " %
* 2 ---@
WXGt; ; ; ; ; ;
= = = =
e e e eNVA VA VA VAp 0 566'! '! '! 76'!R#& #& #& #&J
W W W W \ \ \06G 6G 6G 6Gp rK ri rw r rN c J | t | d S rP )register_checkerri )rw s rI registerrC s$
M& 1 122222rK )r< r= r> r? r@ rA r! rB r< ),rf
__future__r sysrG functoolsr rer typingr astroidr pylint.checkersr r pylint.checkers.utilsr
pylint.constantsr pylint.interfacesr
pylint.typingr
pylint.utils.pragma_parserr r r pylint.lintr version_infor typing_extensionsr rH r r NODEr; __annotations__rJ r= ri rC rg rK rI rU sq
# " " " " "
@ @ @ @ @ @ @ @ < < < < < < ) ) ) ) ) ) " " " " " " 0 0 0 0 0 0 Q Q Q Q Q Q Q Q Q Q %$$$$$$v )))))) " (+.
3 F ,#$
o<+ <+ < < < <~ $ $ $ $ $ $ $ $,w w w w w$&8 w w wt3 3 3 3 3 3rK