e>0UdZddlmZddlZddlmZmZddlZddlmZm Z ddl m Z ddl m Z ddlmZdd lmZdd lmZerdd lmZd d ddddddZded<hdZegdZ d d dZGdde j8Zd!dZd"dZd#dZ d$dZ!y)%z"Checker for use of Python logging.) annotationsN) TYPE_CHECKINGLiteral)basesnodes)InferenceResult)checkers)utils) infer_all)MessageDefinitionTuple)PyLinter)&Use %s formatting in logging functionslogging-not-lazyaUsed 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.)rlogging-format-interpolationaUsed 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.)rlogging-fstring-interpolationaUsed 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%rct|tjxrVt|jtjxr0|r|jj |vndxr|r|j |vSdS)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)functypesmethodss 9/usr/lib/python3/dist-packages/pylint/checkers/logging.pyis_method_callr1isj 4,,- 8 tzz7#3#3 4 8).TZZ__ %D 8&-TYY' ! 37 ceZdZdZdZeZddddddfd d d d d d gddffZddZddZ ddZ ddZ ddZ d dZ ed!dZed"dZddZd#dZy)$LoggingCheckerz!Checks use of the logging module.loggingzlogging-modules)r5csvzzcLogging 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.)r7r8r9choicesr:cTt|_|jjj}|jjj |_t||_i|_|D]8}|jdd}t|dkDs$|d|j|d<:y)z?Clears any state left in this checker from last module checked..rN) set_logging_nameslinterconfiglogging_moduleslogging_format_style _format_style_logging_modules _from_importsrsplitlen)self_ logging_mods logging_modpartss r0 visit_modulezLoggingChecker.visit_modules ),{{))99 ![[//DD #L 1' 8K&&sA.E5zA~/4Qx""58, 8r2c |j|j}|jD]*\}}||k(s |jj |xs|,y#t $rYywxYw)z;Checks to see if a module uses a non-Python logging module.N)rJmodnamenamesrCaddKeyError)rMnode logging_namemoduleas_names r0visit_importfromzLoggingChecker.visit_importfromsg --dll;L#':: ?\)''++G,=v> ?   s0A!A A! A!c|jD]3\}}||jvs|jj|xs|5y)z.is_logging_namesV499eoo6?tyy~~uzz:?IINN''4+>+>> r2cltjD]}t|tjs|j j }t|tjsO|jdk(s!td|jDsd|j jfcSy)Nlogging.Loggerc3BK|]}|jdk(yw)rgN)qname).0ancestors r0 zELoggingChecker.visit_call..is_logger_class..s% (%NN,0@@sT)FN) r r-r'r(r)_proxiedparentrClassDefriany ancestorsr,)inferredrnrXs r0is_logger_classz2LoggingChecker.visit_call..is_logger_classs%dii0 <h(;(;<%..55F!&%..9 *::,2,<,<,> $X%6%6%;%;;; <r2N)returnbool)rtztuple[bool, str | None])r-attrname_check_log_method)rMrXrersr,results`` r0 visit_callzLoggingChecker.visit_callsF    99%%D*,LFD tT*r2c|dk(r4|js$|jst|jdkryd}n1|tvr(|js|js |jsyd}ny|j|}t |t jr|}|jdk(}|jdk(r@j|s/tfd|j|jfD}|dkD}|r%jd |j|f yyt |t jrj!|yt |t j"rj%||yt |t j&r1t)|ryjd |j|f yy) z9Checks calls to logging.log(level, format, *format_args).logNrAr%+c3jK|]*}jtj|rd,ywrAN)_is_operand_literal_strr safe_infer)rjoperandrMs r0rlz3LoggingChecker._check_log_method..s2.33E4D4DW4MN.s03rrXargsr)starargskwargsrLrCHECKED_CONVENIENCE_FUNCTIONSr'rBinOpop#_is_node_explicit_str_concatenationsumleftright add_message_helper_stringCall_check_call_funcConst_check_format_string JoinedStrstr_formatting_in_f_string)rMrXr, format_pos format_argbinopemittotal_number_of_stringss` r0rwz LoggingChecker._check_log_methods 5=}} s499~/A()J 2 2}} 499J YYz* j%++ .E88s?Dxx3t'O'OPU'V*-.$)JJ #<.+' /2  &--d35!  EJJ /  ! !* -  EKK 0  % %dJ 7  EOO 4)*5   /))$/1  5r2ctdg}|jjd|js|jd|jjd|js|jd|jjd|js|jddj |S) zGCreate a string that lists the valid types of formatting for this node.zlazy %zlogging-fstring-formattingfstringrz .format()rr}z or )rDis_message_enabled fromlinenoappendjoin)rMrX valid_typess r0rzLoggingChecker._helper_string sj {{-- ($//    y ){{-- *DOO    { +{{--.@$//R   s #{{;''r2cXt|tjxr|jdk(S)z;Return True if the operand in argument is a literal string.str)r'rrr,)rs r0rz&LoggingChecker._is_operand_literal_strs#'5;;/IGLLE4IIr2c<t|tjsytj |j xstj |j xr@tj |jxstj |jS)zEReturn True if the node represents an explicitly concatenated string.F)r'rrr4rrrrrXs r0rz2LoggingChecker._is_node_explicit_str_concatenation#su$ ,  2 2499 = MAA$))L   2 24:: > NAA$**M  r2ctj|j}d}d}t|tj rIt |||r;t|js%|jd||j|fyyyy)z8Checks that function call is not format_string.format().)runicode)formatrrN) r rr-r'r(r)r1is_complex_format_strr*rr)rMrXr-r.r/s r0rzLoggingChecker._check_call_func0s *" tW00 1tUG4)$**5   .))$/1  65 2r2c ^t|j|dzd}|sy|j|j}d}t|tr|j }t|t r |jdk(rtj|\}}}}|r`y|jdk(rPtj|\}} } t|D chc]\} }t| tr| c}} } | | z| z}||kDr|jd | y||kr|jd | yycc}} w#tj$rC} || j}|jd||t!|| jfYd} ~ yd} ~ wtj"$r|jd| YywxYw) 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. rANrr;r=rrrrrr)_count_supplied_tokensrvaluer'bytesdecoderrHr parse_format_stringparse_format_method_stringrLintUnsupportedFormatCharacterindexrordIncompleteFormatString)rMrXrnum_args format_stringrequired_num_args keyword_argsrNkeyword_argumentsimplicit_pos_argsexplicit_pos_argskkeyword_args_cntexchars r0rz#LoggingChecker._check_format_string@s*$))JN4D*EF  *-33  mU +)002M mS ) %%.P   G08"; +@-^("JJ     6@r2r4cJtj|}|4t|tjrt|j t sy ttjj|j }td|DS#t$rYywxYw)zJReturn whether the node represents a string with complex formatting specs.TFc3*K|] \}}}}| ywrar)rjrN format_specs r0rlz(is_complex_format_str..s@51k1{@s) r rr'rrrrliststring Formatterparse ValueErrorrp)rXrrparseds r0rrys%H8U[[)j.Mf&&(..x~~>? @@ @@ s6B B"!B"c&td|DS)apCounts 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. c3VK|]!}t|tjrd#ywr)r'rKeyword)rjargs r0rlz)_count_supplied_tokens..sGS 3 (FqGs)))r)rs r0rrs GDG GGr2c:td|jDS)znDetermine whether the node represents an f-string with string formatting. For example: `f'Hello %s'` c3K|]Fttjr*djvxrt fdt DHyw)r}c3:K|]}|jvywra)r)rjxvals r0rlz7str_formatting_in_f_string...s PAcii PsN)r'rrrrpMOST_COMMON_FORMATTING)rjrs @r0rlz-str_formatting_in_f_string..sD  c5;; ' syyPS P9O PPPsA A)rpvaluesrs r0rrs" ;; r2c8|jt|yra)register_checkerr4)rDs r0registerrs N623r2)rr)r-zbases.BoundMethodr.tuple[str, ...]r/rrtrur)rzlist[nodes.NodeNG]rtr)rXznodes.JoinedStrrtru)rDr rtr)"r __future__rrtypingrrr(rrastroid.typingrpylintr pylint.checkersr pylint.checkers.utilsr pylint.typingr pylint.lintr r__annotations__r frozensetrr1 BaseCheckerr4rrrrrr2r0rs )" ) *!+0$      s>@F !##;<VX $3CR ,w@X))w@t A H 4r2