Your IP : 216.73.217.111
B
A!p\8 � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddd d
d d d
d�Z
ddddddddhZ d"dd�Z G dd� dej
�Zd d � Zd d � Zd d!� ZdS )#z"checker for use of Python logging
� N)�checkers)�
interfaces)�utils)�check_messages)z>Specify string format arguments as logging function parameterszlogging-not-lazya� Used when a logging statement has a call form of "logging.<logging method>(format_string % (format_args...))". Such calls should leave string interpolation to the logging method itself and be written "logging.<logging method>(format_string, format_args...)" so that the program may avoid incurring the cost of the interpolation in those cases in which no message will be logged. For more, see http://www.python.org/dev/peps/pep-0282/.)zLUse % formatting in logging functions and pass the % parameters as argumentsz logging-format-interpolationz�Used when a logging statement has a call form of "logging.<logging method>(format_string.format(format_args...))". Such calls should use % formatting instead, but leave interpolation to the logging function by passing the parameters as arguments.)zLUse % formatting in logging functions and pass the % parameters as argumentsz logging-fstring-interpolationz�Used when a logging statement has a call form of "logging.method(f"..."))". Such calls should use % formatting instead, but leave interpolation to the logging function by passing the parameters as arguments.)z;Unsupported logging format character %r (%#02x) at index %dzlogging-unsupported-formatzWUsed when an unsupported format character is used in a logging statement format string.)z<Logging format string ends in middle of conversion specifierzlogging-format-truncatedz`Used when a logging statement format string terminates before the end of a conversion specifier.)z,Too many arguments for logging format stringzlogging-too-many-argsz>Used when a logging format string is given too many arguments.)z.Not enough arguments for logging format stringzlogging-too-few-argsz=Used when a logging format string is given too few arguments.)ZW1201ZW1202ZW1203ZE1200ZE1201ZE1205ZE1206Zcritical�debug�error� exception�fatal�info�warn�warning� c C s@ t | tj�o>t | jtj�o>|r*| jj|kndo>|r<| j|kS dS )a� Determines if a BoundMethod node represents a method call.
Args:
func (astroid.BoundMethod): The BoundMethod AST node to check.
types (Optional[String]): Optional sequence of caller type names to restrict check.
methods (Optional[String]): Optional sequence of method names to restrict check.
Returns:
bool: true if the node represents a method call for the given type and
method names, False otherwise.
T)�
isinstance�astroid� BoundMethod�boundZInstance�name)�func�types�methodsr
r
�H/opt/alt/python37/lib/python3.7/site-packages/pylint/checkers/logging.py�is_method_calle s
r c @ s� e Zd ZdZejZdZeZ dddddd�fd d
d d d
d
gdd�ffZ
dd� Z dd� Z dd� Z
ee� dd� �Zdd� Zedd� �Zd d � Zd d � Zd S )!�LoggingCheckerz!Checks use of the logging module.�loggingzlogging-modules)r Zcsvz<comma separated list>zcLogging modules to check that the string format arguments are in logging function parameter format.)�default�type�metavar�helpzlogging-format-style�old�choicez<old (%) or new ({)>�newzuFormat style used to check logging format string. `old` means using % formatting, while `new` is for `{}` formatting.)r r r �choicesr c C sf t � | _| jj}| jj| _t |�| _i | _x6|D ].}|�dd�}t |�dkr0|d | j|d < q0W dS )z?Clears any state left in this checker from last module checked.�.� r N)
�set�_logging_names�configZlogging_modulesZlogging_format_style�
_format_style�_logging_modules�
_from_imports�rsplit�len)�self�nodeZ logging_modsZ logging_mod�partsr
r
r � visit_module� s
zLoggingChecker.visit_modulec C sV y<| j |j }x*|jD ] \}}||kr| j�|p2|� qW W n tk
rP Y nX dS )z;Checks to see if a module uses a non-Python logging module.N)r) �modname�namesr% �add�KeyError)r, r- Z logging_name�module�as_namer
r
r �visit_importfrom� s z LoggingChecker.visit_importfromc C s2 x,|j D ]"\}}|| jkr| j�|p&|� qW dS )z<Checks to see if this module uses Python's built-in logging.N)r1 r( r% r2 )r, r- r4 r5 r
r
r � visit_import� s
zLoggingChecker.visit_importc sL � �fdd�}� fdd�}|� r*� j j}n|� \}}|s<dS ��� |� dS )z Checks calls to logging methods.c s. t � jtj�o,t � jjtj�o,� jjj�jkS )N)r r r � Attribute�expr�Namer r% r
)r- r, r
r �is_logging_name� s z2LoggingChecker.visit_call.<locals>.is_logging_namec s� yfx`� j �� D ]R} t| tj�r| jj}t|tj�r|�� dksTt dd� |�
� D ��rd| jj fS qW W n tj j
k
r~ Y nX dS )Nzlogging.Loggerc s s | ]}|� � d kV qdS )zlogging.LoggerN)�qname)�.0Zancestorr
r
r � <genexpr>� s zELoggingChecker.visit_call.<locals>.is_logger_class.<locals>.<genexpr>T)FN)r Zinferr r r Z_proxied�parentZClassDefr< �anyZ ancestorsr �
exceptionsZInferenceError)�inferredr? )r- r
r �is_logger_class� s z2LoggingChecker.visit_call.<locals>.is_logger_classN)r �attrname�_check_log_method)r, r- r; rC r �resultr
)r- r, r �
visit_call� s
zLoggingChecker.visit_callc s0 |dkr,|j s"|js"t|j�dk r&dS d}n(|tkrP|j sF|jsF|jsJdS d}ndS t|j| tj�r�|j| }|jdk}|jdkr�t � fdd �|j
|j fD ��}|dk}|r�� j d
|d � nnt|j| tj
�r� �|j| � nJt|j| tj��r� �||� n(t|j| tjtjf��r,� j d |d � dS )
z9Checks calls to logging.log(level, format, *format_args).�log� Nr# r �%�+c 3 s" | ]}� � t�|��rd V qdS )r# N)�_is_operand_literal_strr �
safe_infer)r= �operand)r, r
r r> � s z3LoggingChecker._check_log_method.<locals>.<genexpr>zlogging-not-lazy)r- z logging-fstring-interpolation)Zstarargs�kwargsr+ �args� CHECKED_CONVENIENCE_FUNCTIONSr r ZBinOp�op�sum�left�right� add_messageZCall�_check_call_func�Const�_check_format_stringZFormattedValueZ JoinedStr)r, r- r Z
format_posZbinop�emitZtotal_number_of_stringsr
)r, r rE � s4
z LoggingChecker._check_log_methodc C s t | tj�o| jdkS )zL
Return True if the operand in argument is a literal string
�str)r r rX r )rN r
r
r rL s z&LoggingChecker._is_operand_literal_strc C s< t �|j�}d}d}t|||�r8t|j�s8| jd|d� dS )z�Checks that function call is not format_string.format().
Args:
node (astroid.node_classes.Call):
Call AST node to be checked.
)r[ �unicode)�formatz logging-format-interpolation)r- N)r rM r r �is_complex_format_strr rV )r, r- r r r r
r
r rW s z LoggingChecker._check_call_funcc
C sF t |j|d d� �}|s dS |j| j}t|t�s:d}n�yf| jdkrbt�|�\}}}}|r�dS n<| jdkr�t�|�\}} }
t t
dd� |D ���} | | |
}W nn tj k
r� } z*|| j }
| j
d||
t|
�| j fd � dS d} ~ X Y n& tjk
�r | j
d
|d � dS X ||k�r*| j
d |d � n||k �rB| j
d
|d � dS )z�Checks that format string tokens match the supplied arguments.
Args:
node (astroid.node_classes.NodeNG): AST node to be checked.
format_arg (int): Index of the format string in the node arguments.
r# Nr r r c s s | ]\}}t |t�s|V qd S )N)r �int)r= �k�lr
r
r r> 9 s z6LoggingChecker._check_format_string.<locals>.<genexpr>zlogging-unsupported-format)r- rP zlogging-format-truncated)r- zlogging-too-many-argszlogging-too-few-args)�_count_supplied_tokensrP �valuer r[ r' r Zparse_format_stringZparse_format_method_stringr+ r$ ZUnsupportedFormatCharacter�indexrV �ordZIncompleteFormatString)r, r- Z
format_arg�num_args�
format_stringZrequired_num_argsZ keyword_args�_Zkeyword_argumentsZimplicit_pos_argsZexplicit_pos_argsZkeyword_args_cnt�ex�charr
r
r rY s@
z#LoggingChecker._check_format_stringN)�__name__�
__module__� __qualname__�__doc__r ZIAstroidCheckerZ__implements__r �MSGSZmsgs�optionsr/ r6 r7 r rG rE � staticmethodrL rW rY r
r
r
r r y s.
$& r c C sr t �| �}|dks t|jt�s"dS ytt�� �|j��}W n t k
rN dS X x |D ]\}}}}|rVdS qVW dS )z�Checks if node represents a string with complex formatting specs.
Args:
node (astroid.node_classes.NodeNG): AST node to check
Returns:
bool: True if inferred string uses complex formatting, False otherwise
NTF)
r rM r rc r[ �list�string� Formatter�parse�
ValueError)r- rB �parsedrh � format_specr
r
r r^ O s
r^ c C s t dd� | D ��S )a| 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 (list): AST nodes that are arguments for a log format string.
Returns:
int: Number of AST nodes that aren't keywords.
c s s | ]}t |tj�sd V qdS )r# N)r r �Keyword)r= �argr
r
r r> r s z)_count_supplied_tokens.<locals>.<genexpr>)rS )rP r
r
r rb e s
rb c C s | � t| �� dS )z.Required method to auto-register this checker.N)Zregister_checkerr )Zlinterr
r
r �registeru s r{ )r
r
)rn rs r �pylintr r Zpylint.checkersr Zpylint.checkers.utilsr ro rQ r Z BaseCheckerr r^ rb r{ r
r
r
r �<module> s6
W