ڭv Z U d Z ddlmZ ddlZddlZddlmZ ddlZddlmZm Z ddl
m Z ddl m
Z
ddlmZ dd lmZ dd
lmZ ej d k rdd lmZ ndd lmZ erdd
lmZ ddddddddZded< h dZ e g d Z d2d3d"Z G d# d$e
j Z d4d'Z!d5d+Z"d6d-Z#d7d1Z$dS )8z"Checker for use of Python logging. ) annotationsN)
TYPE_CHECKING)basesnodes)InferenceResult)checkers)utils) infer_all)MessageDefinitionTuple) )Literal)PyLinter)&Use %s formatting in logging functionslogging-not-lazya Used when a logging statement has a call form of "logging.(format_string % (format_args...))". Use another type of string formatting instead. You can use % formatting but leave interpolation to the logging function by passing the parameters as arguments. If logging-fstring-interpolation is disabled then you can use fstring formatting. If logging-format-interpolation is disabled then you can use str.format.)r logging-format-interpolationa Used when a logging statement has a call form of "logging.(format_string.format(format_args...))". Use another type of string formatting instead. You can use % formatting but leave interpolation to the logging function by passing the parameters as arguments. If logging-fstring-interpolation is disabled then you can use fstring formatting. If logging-not-lazy is disabled then you can use % formatting as normal.)r logging-fstring-interpolationa Used when a logging statement has a call form of "logging.(f"...")".Use another type of string formatting instead. You can use % formatting but leave interpolation to the logging function by passing the parameters as arguments. If logging-format-interpolation is disabled then you can use str.format. If logging-not-lazy is disabled then you can use % formatting as normal.)z;Unsupported logging format character %r (%#02x) at index %dlogging-unsupported-formatzWUsed when an unsupported format character is used in a logging statement format string.)zUsed when a logging format string is given too many arguments.)z.Not enough arguments for logging format stringlogging-too-few-argsz=Used when a logging format string is given too few arguments.)W1201W1202W1203E1200E1201E1205E1206z!dict[str, MessageDefinitionTuple]MSGS> infowarndebugerrorfatalwarningcritical exception)z%sz%dz%fz%r funcbases.BoundMethodtypestuple[str, ...]methodsreturnboolc t | t j o=t | j t j o |r| j j |v ndo |r | j |v ndS )a~ Determines if a BoundMethod node represents a method call.
Args:
func: The BoundMethod AST node to check.
types: Optional sequence of caller type names to restrict check.
methods: Optional sequence of method names to restrict check.
Returns:
true if the node represents a method call for the given type and
method names, False otherwise.
T)
isinstanceastroid BoundMethodboundInstancename)r) r+ r- s i/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/pylint/checkers/logging.pyis_method_callr8 o sf 4,-- 8 tz7#3 4 4 8).
8TZ_
%
%D 8 &-
6TY'
!
!$ c e Zd ZdZdZeZddddddfd d
d d d
d
gddffZd+dZd,dZ d-dZ
d.dZ d/d Z d0d Z
ed1d# Zed2d% Zd.d&Zd3d)Zd*S )4LoggingCheckerz!Checks use of the logging module.loggingzlogging-modules)r< csvzzcLogging modules to check that the string format arguments are in logging function parameter format.)defaulttypemetavarhelpzlogging-format-styleoldchoiceznewztThe type of string formatting that logging methods do. `old` means using % formatting, `new` is for `{}` formatting.)r> r? r@ choicesrA _ nodes.Moduler. Nonec 8 t | _ | j j j }| j j j | _ t | | _ i | _ |D ]A}| dd }t | dk r|d | j |d < BdS )z?Clears any state left in this checker from last module checked.. r N) set_logging_nameslinterconfiglogging_moduleslogging_format_style
_format_style_logging_modules
_from_importsrsplitlen)selfrF logging_mods logging_modpartss r7 visit_modulezLoggingChecker.visit_module s
),{)9 ![ / D #L 1 1 ' 8 8K &&sA..E5zzA~~/4Qx"58, 8 8r9 nodenodes.ImportFromc | j |j }|j D ]'\ }}||k r | j |p| (dS # t
$ r Y dS w xY w)z;Checks to see if a module uses a non-Python logging module.N)rT modnamenamesrM addKeyError)rW r\ logging_namemoduleas_names r7 visit_importfromz LoggingChecker.visit_importfrom s -dl;L#':
?
?\))'++G,=v>>>
?
? DD s AA
AA nodes.Importc j |j D ]*\ }}|| j v r | j |p| +dS )z.is_logging_name sH 49eo66 ? ty~uz::?IN'4+>>
r9 tuple[bool, str | None]c \ t j D ]} t | t j ry| j j }t |t j rS| dk s+t d | D rd| j j fc S dS )Nlogging.Loggerc 3 F K | ] }| d k V dS )rt N)qname).0ancestors r7 zELoggingChecker.visit_call..is_logger_class.. sF ( %NN , ,0@ @ r9 T)FN)
r
r) r1 r2 r3 _proxiedparentr ClassDefrv any ancestorsr6 )inferredr{ r\ s r7 is_logger_classz2LoggingChecker.visit_call..is_logger_class s %di 0 0
<
< h(;<< < % . 5F!&%.99 < *::: ,2,<,<,>,> ; $X%6%; ;;;; ;r9 N)r. r/ )r. rr )r) attrname_check_log_method)rW r\ rq r r6 results `` r7
visit_callzLoggingChecker.visit_call s ? 9%DD*?,,LFD
tT*****r9 r6 strc |dk r+|j s |j st |j dk rdS d}n%|t v r|j s|j s|j sdS d}ndS |j | }t |t j r|}|j dk }|j dk rB | s-t fd|j |j fD }|dk }|r.
d | | f
dS dS t |t j r | dS t |t j r || dS t |t j r?t) | rdS
d | | f
dS dS ) z9Checks calls to logging.log(level, format, *format_args).log NrK r %+c 3 j K | ]-} t j | )d V .dS rK N)_is_operand_literal_strr
safe_infer)rw operandrW s r7 ry z3LoggingChecker._check_log_method.. sV . . 33E4DW4M4MNN.. . . . . .r9 r r\ argsr )starargskwargsrV r CHECKED_CONVENIENCE_FUNCTIONSr1 r BinOpop#_is_node_explicit_str_concatenationsumleftright add_message_helper_stringCall_check_call_funcConst_check_format_string JoinedStrstr_formatting_in_f_string)rW r\ r6
format_pos
format_argbinopemittotal_number_of_stringss ` r7 r z LoggingChecker._check_log_method s: 5==}
s49~~/A/A ()JJ
2
2
2}
49
JJ FYz*
j%+ . . E8s?Dx3t'O'OPU'V'V*- . . . .$)J #<. . . + +'
/2
& --d335 !
EJ
/
/ ! !* - - - - -
EK
0
0 % %dJ 7 7 7 7 7
EO
4
4 )*55
/))$//1
r9 c p dg}| j d|j s| d | j d|j s| d | j d|j s| d d | S ) zGCreate a string that lists the valid types of formatting for this node.zlazy %zlogging-fstring-formattingfstringr z .format()r r z or )rN is_message_enabled
fromlinenoappendjoin)rW r\ valid_typess r7 r z LoggingChecker._helper_string s j {-- ($/
*
y ) ) ){-- *DO
,
{ + + +{--.@$/RR $ s # # #{{;'''r9 r InferenceResult | Noner/ c L t | t j o
| j dk S )z;Return True if the operand in argument is a literal string.r )r1 r r r6 )r s r7 r z&LoggingChecker._is_operand_literal_str$ s" '5;//IGLE4IIr9 nodes.NodeNGc 2 t | t j sdS t | j p t | j o=t | j p t | j S )zEReturn True if the node represents an explicitly concatenated string.F)r1 r r r; r r r r r\ s r7 r z2LoggingChecker._is_node_explicit_str_concatenation) s $ ,, 5 2 249 = =
M AA$)LL
2 24: > >
N AA$*MM
r9 c " t j |j }d}d}t |t j rSt
||| rDt |j s2| d||
| f dS dS dS dS )z8Checks that function call is not format_string.format().)r unicode)formatr r N) r r r) r1 r2 r3 r8 is_complex_format_strr4 r r )rW r\ r) r+ r- s r7 r z LoggingChecker._check_call_func6 s **" tW 0 1 1 tUG44 *$*55
.))$//1
r9 r
Literal[0, 1]c H t |j |dz d }|sdS |j | j }d}t |t r| }t |t r | j dk r t j | \ }}}}|rdS nD| j dk r9t j
| \ }} }
t d |D } | | z |
z }n# t j $ rE} || j
}
| d||
t |
| j
f Y d} ~ dS d} ~ wt j $ r | d |
Y dS w xY w||k r| d |
dS ||k r| d |
dS dS )
zChecks that format string tokens match the supplied arguments.
Args:
node: AST node to be checked.
format_arg: Index of the format string in the node arguments.
rK Nr rB rD c B h | ] \ }}t |t | S r( )r1 int)rw krF s r7 z6LoggingChecker._check_format_string..i s+ SSStq!
1c@R@RSSSSr9 r r r r r r )_count_supplied_tokensr valuer1 bytesdecoder rR r parse_format_stringparse_format_method_stringrV UnsupportedFormatCharacterindexr ordIncompleteFormatString)rW r\ r num_args
format_stringrequired_num_args keyword_argsrF keyword_argumentsimplicit_pos_argsexplicit_pos_argskeyword_args_cntexchars r7 r z#LoggingChecker._check_format_stringF s8 *$)JN4D4D*EFF
F *-3
mU + + 3 ) 0 0 2 2M mS ) ) !
%..P
G08 8 8 8" ; ; ; ; + + + +@- - - -^( ( ( (" J J J \J
\
6@ 6@ 6@ 6@ 6@ 6@r9 r; r\ r c b t j | }|4t |t j rt |j t sdS t t j
|j }n# t $ r Y dS w xY wt d |D S )zJReturn whether the node represents a string with complex formatting specs.NTFc 3 $ K | ] \ }}}}|V d S rm r( )rw rF format_specs r7 ry z(is_complex_format_str.. s+ @@ 51k1{@@@@@@r9 )
r r r1 r r r r liststring Formatterparse
ValueErrorr} )r\ r parseds r7 r r s %%H8U[)) .8 .M.M tf&((..x~>>?? uu @@@@@ @ @@s 8B
BBr list[nodes.NodeNG]r c 4 t d | D S )ap Counts the number of tokens in an args list.
The Python log functions allow for special keyword arguments: func,
exc_info and extra. To handle these cases correctly, we only count
arguments that aren't keywords.
Args:
args: AST nodes that are arguments for a log format string.
Returns:
Number of AST nodes that aren't keywords.
c 3 N K | ] }t |t j d V !dS r )r1 r Keyword)rw args r7 ry z)_count_supplied_tokens.. s3 GGS
3
(F(FGqGGGGGGr9 )r )r s r7 r r s! GGDGGG G GGr9 nodes.JoinedStrc > t d | j D S )znDetermine whether the node represents an f-string with string formatting.
For example: `f'Hello %s'`
c 3 K | ]Gt t j d j v o t fdt
D V HdS )r c 3 * K | ]
}|j v V d S rm )r )rw xvals r7 ry z7str_formatting_in_f_string... s) P PAci P P P P P Pr9 N)r1 r r r r} MOST_COMMON_FORMATTING)rw r s @r7 ry z-str_formatting_in_f_string.. ss c5; ' ' syPS P P P P9O P P P P P r9 )r} valuesr s r7 r r s4 ; r9 rN r rH c J | t | d S rm )register_checkerr; )rN s r7 registerr s$
N6 2 233333r9 )r( r( )r) r* r+ r, r- r, r. r/ r )r r r. r )r\ r r. r/ )rN r r. rH )%r
__future__r r systypingr r2 r r astroid.typingr pylintr pylint.checkersr pylint.checkers.utilsr
pylint.typingr version_infor typing_extensions pylint.lintr r __annotations__r frozensetr r8 BaseCheckerr; r r r r r( r9 r7 r sG
) ( ( " " " " " "
* * * * * * ! ! ! ! ! ! + + + + + + 0 0 0 0 0 0v )))))) %$$$$$$
s> > @ @ @ @F ! ! ! ##;#;#;<< VX ,w@ w@ w@ w@ w@X) w@ w@ w@t A A A A
H
H
H
H
4 4 4 4 4 4r9