o gt@sddlZddlmZddlmZddlmZddlmZm Z ddl m Z ddl m Z mZmZmZddlmZdd lmZdd lmZmZejGd d d eZGd ddeZdS)N)cleandoc)Any)OptionsProviderMixIn) _MSG_ORDER WarningScope)InvalidMessageError) UNDEFINED IRawChecker ITokenChecker implements)MessageDefinition) CheckerStats)get_rst_section get_rst_titlec@seZdZUdZeed<dZdZeed<iZ eed<dZ eed<dZ e ed <d$d d Z d dZddZddZd%ddZ d&ddZddZddZedefddZddZd d!Zd"d#Zd S)' BaseCheckernameoptionsmsgsreportsTenabledNcCs0|jdur |j|_t|||_i|_dS)zwchecker instances should have the linter as argument :param ILinter linter: is an object implementing ILinter.N)rlowerr__init__linterstats)selfrrrZ/home/ubuntu/cloudmapper/venv/lib/python3.10/site-packages/pylint/checkers/base_checker.pyr0s    zBaseChecker.__init__cCs"|j|j|j|jS)z)Permit to sort a list of Checker by name.)rr__gt__)rotherrrrr:s"zBaseChecker.__gt__cCs6|jrdnd}d|j}|d|jd|dS)NCheckerzDisabled checkerz', 'z 'z' (responsible for 'z'))rjoinrkeysr)rstatusrrrr__repr__>szBaseChecker.__repr__cCs|j|j||jdS)zThis might be incomplete because multiple class inheriting BaseChecker can have the same name. Cf MessageHandlerMixIn.get_full_documentation())rrr)get_full_documentationroptions_and_valuesrrrrr__str__CszBaseChecker.__str__c Csrd}|jddd}|r|d|d7}|t|dd7}|r,|d |d 7}|d |jd 7}|rJ|t|d d7}|t|d7}t|}|rd|t|dd7}|td|d7}|r|t|dd7}t|dddD]\}} | || } || j ddd7}qz|d7}|r|t|dd7}|D] } |d| dd7}q|d7}|d7}|S)Nr_ z checkerz.. _z: ~ zThis checker is provided by ``z``. z"Verbatim name of the checker is ``z``. z Documentation^z z Optionsz MessagescSst|dd|dfS)Nrr)rindex)kvrrr`sz4BaseChecker.get_full_documentation..)keyF) checkerrefz Reportsz:%s: %s ) rreplacetitlerrlistrsorteditems$create_message_definition_from_tuple format_help) rrrrdocmoduleresult checker_titlemsgidmsgreportrrrr&Js@  z"BaseChecker.get_full_documentationcCs"|st}|j||||||dSN)rr add_message)rr@linenodeargs confidence col_offsetrrrrDoszBaseChecker.add_messagecCsd}g}|jD]6}|dur0||jddkr0d}|d|jd|d7}|d|d 7}t||jdd}||jqdS) a3Check 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.Nrz(Inconsistent checker part in message id 'z' (expected 'xzxx' zbecause we already had z).)messagesr@rappend)r checker_id existing_idsmessage error_msgrrrcheck_consistencyvs  zBaseChecker.check_consistencyc Cst|ttfr tj}ntj}i}t|dkr|\}}}}nt|dkr)|\}}}nd}t||d|t |||||fi|S)NrJr4zMessages should have a msgid and a symbol. Something like this : "W1234": ( "message", "message-symbol", "Message description with detail.", ... ), scope) r r r rLINENODElenr setdefaultr ) rr@ msg_tuple default_scoperrAsymboldescrrQrrrr:s    z0BaseChecker.create_message_definition_from_tuplereturncsfddtjDS)Ncsg|] \}}||qSr)r:).0r@rXr(rr s z(BaseChecker.messages..)r8rr9r(rr(rrLs  zBaseChecker.messagescCsN|jD] }|j|kr|Sqd|d}|ddd|jDd7}t|)NzMessageDefinition for 'z' does not exists. z Choose from cSsg|]}|jqSr)r@)r]mrrrr^sz6BaseChecker.get_message_definition...)rLr@r)rr@message_definitionrQrrrget_message_definitions   z"BaseChecker.get_message_definitioncCdS)z3called before visiting project (i.e set of modules)Nrr(rrropenzBaseChecker.opencCrc)z2called after visiting project (i.e set of modules)Nrr(rrrcloserezBaseChecker.closerC)NN)NNNNN)__name__ __module__ __qualname__rstr__annotations__levelrrrrrboolrrr%r)r&rDrRr:propertyr7rLrbrdrfrrrrr s*        &  rc@seZdZdZddZdS)BaseTokenCheckerzEBase class for checkers that want to have access to the token stream.cCst)z#Should be overridden by subclasses.)NotImplementedError)rtokensrrrprocess_tokensszBaseTokenChecker.process_tokensN)rgrhri__doc__rrrrrrros ro) functoolsinspectrtypingr pylint.configrpylint.constantsrrpylint.exceptionsrpylint.interfacesrr r r !pylint.message.message_definitionr pylint.typingr pylint.utilsrrtotal_orderingrrorrrrs