3
tûœ]Xy  ã               @   s,  d Z ddlZddlZddlZddlmZ ddlZddlmZ ddl	m
Z
 ddlmZmZmZ ddlmZ ddlmZmZmZ dRZdSdTdUdVdWdXdYdZd[d\d]d^d_d`dadbdcdddBœZej
ejejejejejejfZejdC ZejdD Z ejdE Z!dFdG„ Z"dHdI„ Z#G dJdK„ dKeƒZ$G dLdM„ dMeƒZ%dNdO„ Z&dPdQ„ Z'dS )ez*Checker for string formatting operations.
é    N)ÚCounter)ÚCallSite)ÚConst)ÚBaseCheckerÚBaseTokenCheckerÚutils)Úcheck_messages)ÚIAstroidCheckerÚIRawCheckerÚITokenCheckerú__builtin__.unicodeú__builtin__.strúbuiltins.strú3Unsupported format character %r (%#02x) at index %dúbad-format-characterúEUsed when an unsupported format character is used in a format string.ú4Format string ends in middle of conversion specifierútruncated-format-stringúNUsed when a format string terminates before the end of a conversion specifier.ú?Mixing named and unnamed conversion specifiers in format stringúmixed-format-stringúÛUsed when a format string contains both named (e.g. '%(foo)d') and unnamed (e.g. '%d') conversion specifiers.  This is also used when a named conversion specifier contains * for the minimum field width and/or precision.ú*Expected mapping for format string, not %súformat-needs-mappingúoUsed when a format string that uses named conversion specifiers is used with an argument that is not a mapping.ú7Format string dictionary key should be a string, not %súbad-format-string-keyúyUsed when a format string that uses named conversion specifiers is used with a dictionary whose keys are not all strings.ú)Unused key %r in format string dictionaryúunused-format-string-keyú�Used when a format string that uses named conversion specifiers is used with a dictionary that contains keys not required by the format string.ú*Missing key %r in format string dictionaryúmissing-format-string-keyúšUsed when a format string that uses named conversion specifiers is used with a dictionary that doesn't contain all the keys required by the format string.ú$Too many arguments for format stringútoo-many-format-argsú^Used when a format string that uses unnamed conversion specifiers is given too many arguments.ú&Not enough arguments for format stringútoo-few-format-argsú\Used when a format string that uses unnamed conversion specifiers is given too few argumentsú)Argument %r does not match format type %rúbad-string-format-typeúSUsed when a type required by format string is not suitable for actual argument typeú!Suspicious argument in %s.%s callúbad-str-strip-callúGThe argument to a str.{l,r,}strip call contains a duplicate character, úInvalid format stringúbad-format-stringú.Used when a PEP 3101 format string is invalid.ú-Missing keyword argument %r for format stringúmissing-format-argument-keyúhUsed when a PEP 3101 format string that uses named fields doesn't receive one or more required keywords.úUnused format argument %rúunused-format-string-argumentú}Used when a PEP 3101 format string that uses named fields is used with an argument that is not required by the format string.úTFormat string contains both automatic field numbering and manual field specificationúformat-combined-specificationúƒUsed when a PEP 3101 format string contains both automatic field numbering (e.g. '{}') and manual field specification (e.g. '{0}').ú2Missing format attribute %r in format specifier %rúmissing-format-attributeú�Used when a PEP 3101 format string uses an attribute specifier ({0.length}), but the argument passed for formatting doesn't have that attribute.ú2Using invalid lookup key %r in format specifier %rúinvalid-format-indexú¥Used when a PEP 3101 format string uses a lookup specifier ({a[1]}), but the argument passed for formatting doesn't contain or doesn't have that key as an attribute.úKDuplicate string formatting argument %r, consider passing as named argumentú$duplicate-string-formatting-argumentúmUsed when we detect that a string formatting is repeating an argument instead of using named string arguments)ZE1300ZE1301ZE1302ZE1303ZW1300ZW1301ZE1304ZE1305ZE1306ZE1307ZE1310ZW1302ZW1303ZW1304ZW1305ZW1306ZW1307ZW1308z.strz.floatz.intc             C   sN   g }x6|D ].\}}|r(|j dj|ƒƒ q
|j dj|ƒƒ q
W t| ƒdj|ƒ S )z^ Given a list of format specifiers, returns
    the final access path (e.g. a.b.c[0][1]).
    z.{}z[{!r}]Ú )ÚappendÚformatÚstrÚjoin)ÚkeyÚpartsÚpathÚis_attributeÚ	specifier© rO   ú9/tmp/pip-build-fn42xldr/pylint/pylint/checkers/strings.pyÚget_access_path¬   s    rQ   c             C   sT   |dkrdS t | tjƒrP| jƒ } | tkr0|dkS | tkr@|dkS | tkrLdS dS dS )NÚsrTÚcz	deEfFgGn%F)Ú
isinstanceÚastroidÚInstanceÚpytypeÚBUILTINS_STRÚBUILTINS_FLOATÚBUILTINS_INT)Úarg_typeÚformat_typerO   rO   rP   Úarg_matches_format_type¹   s    r]   c               @   sV   e Zd ZdZefZdZeZe	eŽ dd„ ƒZ
e	eŽ dd„ ƒZdd„ Zd	d
„ Zdd„ ZdS )ÚStringFormatCheckerz�Checks string formatting operations to ensure that the format string
    is valid and the arguments match the format string.
    Ústringc             C   sb  |j dkrd S |j}|j}t|tjƒo0t|jtƒs6d S |j}ytj	|ƒ\}}}}W nj tj
k
rš }	 z*||	j }
| jd||
t|
ƒ|	jfd� d S d }	~	X n$ tjk
r¼   | jd|d� d S X |rØ|rØ| jd|d� �n†|�rZt|tjƒ�r*tƒ }d}xV|jD ]L\}}t|tjƒ�rD|j}t|tƒ�r2|j|ƒ n| jd||d� nd	}� qþW |�s~x(|D ] }||k�rZ| jd
||d� �qZW x(|D ] }||k�r„| jd||d� �q„W x¬|jD ]t\}}t|tjƒ�sÊ�q°|j|jd ƒ}tj|ƒ}|d k	�r°|d tjfk�r°t||ƒ �r°| jd||jƒ |fd� �q°W n,t|ttjfƒ�r^t|ƒj}| jd||d� �nf }t|tjƒ�r–tj|ƒ}d }t|dƒ�r¾|j}t|ƒ}n(t|ttjtjffƒ�rº|g}d}nd }|d k	�r^||k�râ| jd|d� n||k �rú| jd|d� xbt ||ƒD ]T\}}|�s�qtj|ƒ}|d tjfk�rt||ƒ �r| jd||jƒ |fd� �qW d S )Nú%zbad-format-character)ÚnodeÚargsztruncated-format-string)ra   zmixed-format-stringFzbad-format-string-keyTzmissing-format-string-keyzunused-format-string-keyzbad-string-format-typezformat-needs-mappingÚeltsé   ztoo-many-format-argsztoo-few-format-args)!ÚopÚleftÚrightrT   rU   r   ÚvaluerH   r   Zparse_format_stringZUnsupportedFormatCharacterÚindexÚadd_messageÚordÚIncompleteFormatStringÚDictÚsetÚitemsÚaddÚgetÚ
safe_inferÚUninferabler]   rW   ÚOTHER_NODESÚTupleÚtypeÚ__name__Úhasattrrc   ÚlenÚDictCompÚzip)Úselfra   rf   rb   Úformat_stringZrequired_keysZrequired_num_argsZrequired_key_typesZrequired_arg_typesÚexcÚ	formattedÚkeysZunknown_keysÚkÚ_rJ   Úargr\   r[   Ú	type_nameZ	args_eltsZ	rhs_tupleÚnum_argsrO   rO   rP   Úvisit_binopÔ   s¬    
















zStringFormatChecker.visit_binopc             C   sÀ   t j|jƒ}t|tjƒr¼t|jtjƒr¼|jjdkr¼|jdkr¦|j	r¦t j|j	d ƒ}t|tj
ƒ snt|jtƒ rrd S t|jƒtt|jƒƒkr¼| jd||jj|jfd	� n|jd
kr¼| j||ƒ d S )NrH   ÚunicodeÚbytesÚstripÚlstripÚrstripr   zbad-str-strip-call)ra   rb   rG   )rH   r‡   rˆ   )r‰   rŠ   r‹   )r   rr   ÚfuncrT   rU   ZBoundMethodÚboundrV   Únamerb   r   rh   rH   ry   rn   rj   Ú_check_new_format)r|   ra   rŒ   rƒ   rO   rO   rP   Ú
visit_callP  s    
zStringFormatChecker.visit_callc             C   sH   t dd„ |D ƒƒ}x0|jƒ D ]$\}}|dkr.q| jd||fd� qW d S )Nc             s   s    | ]}t |tjƒr|jV  qd S )N)rT   rU   ÚNamerŽ   )Ú.0rƒ   rO   rO   rP   ú	<genexpr>g  s    zAStringFormatChecker._detect_vacuous_formatting.<locals>.<genexpr>rd   z$duplicate-string-formatting-argument)ra   rb   )r   ro   rj   )r|   ra   Úpositional_argumentsÚcounterrŽ   ÚcountrO   rO   rP   Ú_detect_vacuous_formattinge  s    z.StringFormatChecker._detect_vacuous_formattingc             C   s8  t |jtjƒr$t |jjtjƒ r$dS |js0|jr4dS yt|j	j
ƒ ƒ}W n tjk
r\   dS X t |tjƒott |jtƒszdS ytj|ƒ}W n tjk
rž   dS X ytj|jƒ\}}}W n$ tjk
rÚ   | jd|d� dS X |j}|j}	dd„ |D ƒ}
|�r|�r| jd|d� dS d}|tdd	„ |
D ƒƒ7 }|
�rÌx0|
D ](}|�r:||	k�r:| jd
||fd� �q:W x*|	D ]"}||
k�rl| jd||fd� �qlW |�pš|}|�s¨|�rÐtdd	„ |
D ƒƒ}|	�sÆ|�rÐd}nd}|�r|�pÞ|}t|ƒ|k�rþ| jd|d� nt|ƒ|k �r| jd|d� | j||ƒ | j|||	ƒ dS )z!Check the new string formatting. Nzbad-format-string)ra   c             S   s"   h | ]}t |d  tƒr|d  ’qS )r   )rT   rH   )r’   ÚfieldrO   rO   rP   ú	<setcomp>–  s    z8StringFormatChecker._check_new_format.<locals>.<setcomp>zformat-combined-specificationFc             s   s   | ]}|d krdV  qdS )rE   rd   NrO   )r’   r˜   rO   rO   rP   r“   �  s    z8StringFormatChecker._check_new_format.<locals>.<genexpr>zmissing-format-argument-key)ra   rb   zunused-format-string-argumentc             s   s   | ]}|d krdV  qdS )rE   TNrO   )r’   r˜   rO   rO   rP   r“   ¬  s    Tztoo-many-format-argsztoo-few-format-args)rT   rŒ   rU   Ú	AttributeÚexprr   ZstarargsÚkwargsÚnextr�   ÚinferÚInferenceErrorrh   rH   r   Z	from_callr   Zparse_format_method_stringrl   rj   r”   Zkeyword_argumentsÚsumÚanyry   r—   Ú_check_new_format_specifiers)r|   ra   rŒ   ZstrnodeZ	call_siteÚfieldsr…   Z
manual_posr”   Znamed_argumentsZnamed_fieldsZ
check_argsr˜   ÚemptyrO   rO   rP   r�   p  sh    




z%StringFormatChecker._check_new_formatc          %   C   sd  �x\|D �]R\}}|dkrd}t |tjƒrVytj||ƒ}W qh tjk
rR   wY qhX n||kr`q|| }|tjdfkrxqytj|ƒ}W n tj	k
rž   wY nX | s| r®q|j
rÄt |j
tjƒrÄq|}g }	�xŒ|D �]‚\}
}|tjkrêP |	j|
|fƒ |
�rdy|j|ƒd }W nP tjk
�r`   t|dƒ�r<|jƒ �r<P t||	ƒ}| jd||f|d� P Y nX nÈd}t|dƒ�rØy|jtj|ƒƒ}W n> tjtjtjfk
�r®   d	}Y n tj	k
�rÆ   P Y nX |tjk�rP n.y|jd
ƒ P W n tjk
�r   d	}Y nX |�r,t||	ƒ}| jd||f|d� P yt|jƒ ƒ}W qÔ tj	k
�rV   P Y qÔX qÔW qW dS )zg
        Check attribute and index access in the format
        string ("{0.a}" and "{0[a]}").
        rE   r   NÚhas_dynamic_getattrzmissing-format-attribute)rb   ra   FÚgetitemTÚ__getitem__zinvalid-format-index)rT   ÚnumbersÚNumberr   Zget_argument_from_callZNoSuchArgumentErrorrU   rs   rr   rŸ   ÚparentÚ	ArgumentsrF   ÚgetattrZNotFoundErrorrx   r¥   rQ   rj   r¦   r   ZAstroidIndexErrorZAstroidTypeErrorZAttributeInferenceErrorr�   rž   )r|   ra   r£   ÚnamedrJ   Ú
specifiersZargnameÚargumentÚpreviousÚparsedrM   rN   rL   Z
warn_errorrO   rO   rP   r¢   Á  s†    







z0StringFormatChecker._check_new_format_specifiersN)rw   Ú
__module__Ú__qualname__Ú__doc__r	   Ú__implements__rŽ   ÚMSGSÚmsgsr   r†   r�   r—   r�   r¢   rO   rO   rO   rP   r^   Ê   s   |Qr^   c                   sº   e Zd ZdZeeefZdZd'd(d)dœZ	ddddddœffZ
dZdZ‡ fdd„Zdd„ Zdd„ Zee	jƒ Ž dd„ ƒZee	jƒ Ž dd„ ƒZee	jƒ Ž dd „ ƒZd!d"„ Zd#d$„ Zd%d&„ Z‡  ZS )*ÚStringConstantCheckerzCheck string literalsr_   úRAnomalous backslash in string: '%s'. String constant might be missing an r prefix.úanomalous-backslash-in-stringúBUsed when a backslash is in a literal string but not as an escape.úaAnomalous Unicode escape in byte string: '%s'. String constant might be missing an r or u prefix.ú"anomalous-unicode-escape-in-stringúSUsed when an escape like \u is encountered in a byte string where it has no effect.ú)Implicit string concatenation found in %súimplicit-str-concat-in-sequenceúiString literals are implicitly concatenated in a literal iterable definition : maybe a comma is missing ?)ZW1401ZW1402ZW1403z check-str-concat-over-line-jumpsFZynz<y_or_n>z¢This flag controls whether the implicit-str-concat-in-sequence should generate a warning on implicit string concatenation in sequences defined over several lines.)Údefaultrv   ÚmetavarÚhelpzabfnrtvx
	\'"01234567ZuUNc                s   t t| ƒj||Ž i | _d S )N)Úsuperr¸   Ú__init__Ústring_tokens)r|   rb   rœ   )Ú	__class__rO   rP   rÆ   T  s    zStringConstantChecker.__init__c             C   s   d|j k| _d S )NÚunicode_literals)Zfuture_importsZ_unicode_literals)r|   ÚmodulerO   rO   rP   Úprocess_moduleX  s    z$StringConstantChecker.process_modulec             C   sâ   d}xØt |ƒD ]Ì\}\}}}}}|tjkr0|}q|tjkr| j||d ƒ |d }	x2|	t|ƒk r„||	 jtjtjtj	fkr„|	d7 }	qTW |	t|ƒk rš||	 nd }
|dkrÈ|d t|d |d … j
|ƒƒf}t|ƒ|
f| j|< qW d S )NÚasciir   rd   )Ú	enumerateÚtokenizeÚENCODINGÚSTRINGÚprocess_string_tokenry   rv   ÚNEWLINEÚNLÚCOMMENTÚencodeÚstr_evalrÇ   )r|   ÚtokensÚencodingÚiÚtok_typeÚtokenÚstartr‚   ÚlineÚjÚ
next_tokenrO   rO   rP   Úprocess_tokens[  s     


"z$StringConstantChecker.process_tokensc             C   s   | j |dƒ d S )NÚlist)Úcheck_for_concatenated_strings)r|   ra   rO   rO   rP   Ú
visit_listt  s    z StringConstantChecker.visit_listc             C   s   | j |dƒ d S )Nrn   )râ   )r|   ra   rO   rO   rP   Ú	visit_setx  s    zStringConstantChecker.visit_setc             C   s   | j |dƒ d S )NÚtuple)râ   )r|   ra   rO   rO   rP   Úvisit_tuple|  s    z!StringConstantChecker.visit_tuplec             C   sª   x¤|j D ]š}t|tƒr|jƒ tkr|jdk r.q|j|jf| jkrBq| j|j|jf \}}||jkr|d k	r|j	t
jkr|jd |jksŽ| jjr| jd|j|fd� qW d S )Nr   zimplicit-str-concat-in-sequence)rÝ   rb   )rc   rT   r   rW   Ú_AST_NODE_STR_TYPESÚ
col_offsetÚlinenorÇ   rh   rv   rÎ   rÐ   rÜ   ÚconfigZ check_str_concat_over_line_jumpsrj   )r|   Ziterable_nodeZiterable_typeÚeltZmatching_tokenrß   rO   rO   rP   râ   €  s     
z4StringConstantChecker.check_for_concatenated_stringsc       	      C   s´   d }d }x"t |ƒD ]\}}|dkr|}P qW |d kr8d S |d |… jƒ }||d … }|d d… |dd …   kozd| kn  rŽ|dd… }n|dd… }d|kr°| j|||ƒ d S )Nz'"é   rd   Úréýÿÿÿrî   éÿÿÿÿ)rÍ   ÚlowerÚprocess_non_raw_string_token)	r|   rÛ   Ú	start_rowÚ
quote_charri   ÚcharÚprefixZafter_prefixÚstring_bodyrO   rO   rP   rÑ   š  s    ,z*StringConstantChecker.process_string_tokenc             C   sš   d}x�|j d|ƒ}|dkrP ||d  }|||d … }|| jkrld|krLqŠd|krVqŠ| jd||f|d� n|| jkrŠ| jd	||f|d� |d7 }qW d
S )a  check for bad escapes in a non-raw string.

        prefix: lowercase string of eg 'ur' string prefix markers.
        string_body: the un-parsed body of the string, not including the quote
        marks.
        start_row: integer line number in the source.
        r   ú\rd   é   ÚuÚbz"anomalous-unicode-escape-in-string)rÝ   rb   rè   zanomalous-backslash-in-stringNrï   )ÚfindÚUNICODE_ESCAPE_CHARACTERSrj   ÚESCAPE_CHARACTERS)r|   rõ   rö   rò   ri   Z	next_charÚmatchrO   rO   rP   rñ   ®  s0    


z2StringConstantChecker.process_non_raw_string_token)r¹   rº   r»   )r¼   r½   r¾   )r¿   rÀ   rÁ   )rw   r²   r³   r´   r	   r   r
   rµ   rŽ   r·   Úoptionsrý   rü   rÆ   rË   rà   r   r€   rã   rä   ræ   râ   rÑ   rñ   Ú__classcell__rO   rO   )rÈ   rP   r¸   "  s8   
      
r¸   c             C   s    | j t| ƒƒ | j t| ƒƒ dS )z.required method to auto register this checker N)Zregister_checkerr^   r¸   )ZlinterrO   rO   rP   Úregisterà  s    r  c             C   sf   | dd… j ƒ dkr"| dd… } n| d j ƒ dkr>| d	d… } | dd
… dkrZ| d
d… S | d	d… S )a%  
    Mostly replicate `ast.literal_eval(token)` manually to avoid any performance hit.
    This supports f-strings, contrary to `ast.literal_eval`.
    We have to support all string literal notations:
    https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals
    r   rø   ÚfrÚrfNrí   rù   Úfrd   rì   ú"""ú''')r  r  )rí   rù   r  )r  r  rî   rï   )rð   )rÛ   rO   rO   rP   rÖ   æ  s    rÖ   )r   r   r   )r   r   r   )r   r   r   )r   r   r   )r   r   r   )r   r   r   )r   r   r    )r!   r"   r#   )r$   r%   r&   )r'   r(   r)   )r*   r+   r,   )r-   r.   r/   )r0   r1   r2   )r3   r4   r5   )r6   r7   r8   )r9   r:   r;   )r<   r=   r>   )r?   r@   rA   )rB   rC   rD   )(r´   Úbuiltinsr¨   rÎ   Úcollectionsr   rU   Zastroid.argumentsr   Zastroid.node_classesr   Zpylint.checkersr   r   r   Zpylint.checkers.utilsr   Zpylint.interfacesr	   r
   r   rç   r¶   ÚListÚLambdaÚFunctionDefÚListCompÚSetCompÚGeneratorExprt   rw   rX   rY   rZ   rQ   r]   r^   r¸   r  rÖ   rO   rO   rO   rP   Ú<module>   s¨                                       


  Z ?