3
tûœ]$  ã               @   s˜   d dl mZ d dlmZ d dlmZ d dlmZmZ d dl	m
Z
 d dlmZmZmZmZ d dlmZ d dlmZmZ G d	d
„ d
eƒZG dd„ deƒZdS )é    )Úcleandoc)ÚAny)ÚOptionsProviderMixIn)Ú
_MSG_ORDERÚWarningScope)ÚInvalidMessageError)Ú	UNDEFINEDÚIRawCheckerÚITokenCheckerÚ
implements)ÚMessageDefinition)Úget_rst_sectionÚget_rst_titlec               @   s”   e Zd ZdZdZf Zi Zf ZdZddd„Z	dd„ Z
dd	„ Zd
d„ Zddd„Zddd„Zdd„ Zdd„ Zeedœdd„ƒZdd„ Zdd„ Zdd„ ZdS ) ÚBaseCheckerNé   Tc             C   s*   | j dk	r| j jƒ | _ tj| ƒ || _dS )zwchecker instances should have the linter as argument

        :param ILinter linter: is an object implementing ILinter.N)ÚnameÚlowerr   Ú__init__Úlinter)Úselfr   © r   ú>/tmp/pip-build-fn42xldr/pylint/pylint/checkers/base_checker.pyr   (   s    

zBaseChecker.__init__c             C   s"   dj | j| jƒjdj |j|jƒƒS )z)Permit to sort a list of Checker by name.z{}{})Úformatr   ÚmsgsÚ__gt__)r   Úotherr   r   r   r   1   s    zBaseChecker.__gt__c             C   s*   | j r
dnd}dj|| jdj| jjƒ ƒƒS )NZCheckerzDisabled checkerz{} '{}' (responsible for '{}')z', ')Úenabledr   r   Újoinr   Úkeys)r   Ústatusr   r   r   Ú__repr__7   s    zBaseChecker.__repr__c             C   s   | j | j| jƒ | jd�S )z–This might be incomplete because multiple class inheriting BaseChecker
        can have the same name. Cf MessageHandlerMixIn.get_full_documentation())r   ÚoptionsÚreports)Úget_full_documentationr   Zoptions_and_valuesr"   )r   r   r   r   Ú__str__=   s    zBaseChecker.__str__c             C   sj  d}d| j jddƒjƒ  }|r*|d| 7 }|dt|dƒ 7 }|rL|d| 7 }|d	| j  7 }|r‚|td
j|ƒdƒ7 }|dt|ƒ 7 }t|ƒ}|r´|tdj|ƒdƒ7 }|dtd |ƒ 7 }|�r|tdj|ƒdƒ7 }x@t|j	ƒ dd„ d�D ](\}}	| j
||	ƒ}	|d|	jdd� 7 }qäW |d7 }|�r^|tdj|ƒdƒ7 }x"|D ]}
|d|
d d…  7 }�q8W |d7 }|d7 }|S )NÚ z
%s checkerÚ_ú z	.. _%s:

z%s
ú~z$This checker is provided by ``%s``.
z)Verbatim name of the checker is ``%s``.

z{} Documentationú^z%s

z
{} Optionsz{} Messagesc             S   s   t j| d d ƒ| d fS )Nr   r   )r   Úindex)Úkvr   r   r   Ú<lambda>Z   s    z4BaseChecker.get_full_documentation.<locals>.<lambda>)ÚkeyF)Z
checkerrefÚ
z
{} Reportsz:%s: %s
é   )r   ÚreplaceÚtitler   r   r   Úlistr   ÚsortedÚitemsÚ$create_message_definition_from_tupleÚformat_help)r   r   r!   r"   ÚdocÚmoduleÚresultZchecker_titleÚmsgidÚmsgÚreportr   r   r   r#   D   s:    
z"BaseChecker.get_full_documentationc             C   s"   |st }| jj||||||ƒ d S )N)r   r   Úadd_message)r   r:   ÚlineÚnodeÚargsÚ
confidenceÚ
col_offsetr   r   r   r=   g   s    zBaseChecker.add_messagec             C   s€   d}g }xr| j D ]h}|dk	r^||jdd… kr^d}|dj|j|d�7 }|dj|d�7 }t|ƒ‚|jdd… }|j|jƒ qW dS )	a4  Check the consistency of msgid.

        msg ids for a checker should be a string of len 4, where the two first
        characters are the checker id and the two last the msg id in this
        checker.

        :raises InvalidMessageError: If the checker id in the messages are not
        always the same. Nr   é   z(Inconsistent checker part in message id z!'{}' (expected 'x{checker_id}xx' )Ú
checker_idz'because we already had {existing_ids}).)Úexisting_ids)Úmessagesr:   r   r   Úappend)r   rD   rE   ÚmessageÚ	error_msgr   r   r   Úcheck_consistencyn   s    	
zBaseChecker.check_consistencyc       	      C   s~   t | ttfƒrtj}ntj}i }t|ƒdkr:|\}}}}n$t|ƒdkrR|\}}}nd}t|ƒ‚|jd|ƒ t	| ||||f|ŽS )NrC   r/   z¥Messages should have a msgid and a symbol. Something like this :

"W1234": (
    "message",
    "message-symbol",
    "Message description with detail.",
    ...
),
Zscope)
r   r	   r
   r   ZLINEZNODEÚlenr   Ú
setdefaultr   )	r   r:   Ú	msg_tupleZdefault_scoper!   r;   ÚsymbolÚdescrrI   r   r   r   r5   †   s    
z0BaseChecker.create_message_definition_from_tuple)Úreturnc                s   ‡ fdd„t ˆ jjƒ ƒD ƒS )Nc                s   g | ]\}}ˆ j ||ƒ‘qS r   )r5   )Ú.0r:   rM   )r   r   r   ú
<listcomp>¡   s   z(BaseChecker.messages.<locals>.<listcomp>)r3   r   r4   )r   r   )r   r   rF   ž   s    
zBaseChecker.messagesc             C   sN   x| j D ]}|j|kr|S qW dj|ƒ}|djdd„ | j D ƒƒ7 }t|ƒ‚d S )Nz,MessageDefinition for '{}' does not exists. zChoose from {}.c             S   s   g | ]
}|j ‘qS r   )r:   )rQ   Úmr   r   r   rR   ¬   s    z6BaseChecker.get_message_definition.<locals>.<listcomp>)rF   r:   r   r   )r   r:   Zmessage_definitionrI   r   r   r   Úget_message_definition§   s    

z"BaseChecker.get_message_definitionc             C   s   dS )z3called before visiting project (i.e set of modules)Nr   )r   r   r   r   Úopen¯   s    zBaseChecker.openc             C   s   dS )z2called after visiting project (i.e set of modules)Nr   )r   r   r   r   Úclose²   s    zBaseChecker.close)N)NN)NNNNN)Ú__name__Ú
__module__Ú__qualname__r   Úlevelr!   r   r"   r   r   r   r    r$   r#   r=   rJ   r5   Úpropertyr2   rF   rT   rU   rV   r   r   r   r   r      s&   
	
$
r   c               @   s   e Zd ZdZdd„ ZdS )ÚBaseTokenCheckerzEBase class for checkers that want to have access to the token stream.c             C   s
   t ƒ ‚dS )z#Should be overridden by subclasses.N)ÚNotImplementedError)r   Útokensr   r   r   Úprocess_tokens¹   s    zBaseTokenChecker.process_tokensN)rW   rX   rY   Ú__doc__r_   r   r   r   r   r\   ¶   s   r\   N)Úinspectr   Útypingr   Zpylint.configr   Zpylint.constantsr   r   Zpylint.exceptionsr   Zpylint.interfacesr   r	   r
   r   Z!pylint.message.message_definitionr   Zpylint.utilsr   r   r   r\   r   r   r   r   Ú<module>   s    