B A!p\E@sVdZddlZddlZddlZddlmZddlmZddlm Z m Z m Z ddl m Z ddlmZddlmZmZd Zd d d d ddddgZddd d d d dddddddg Zejdkreddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-gZd.d/d0gZd1d2d3gZd4ZeejejejgZ ejejfZ!dZ"d5Z#d6Z$d7Z%d8Z&d9Z'e&e%e'gZ(e&e%gZ)d:d;dd?d@dAdBdCdDdEdFej*ifdGdHdIdJdKdLdMdNgifdOdPdQZ+dRdSZ,dTdUZ-dVdWZ.dXdYZ/dZd[Z0d\d]Z1d^d_Z2Gd`dadaZ3dbZ4dcZ5ddZ6deZ7dfZ8dgZ9dhZ:e4die5dje6dke7dle8dmiZ;dnZGdsdtdtZ?GdudvdvZ@Gdwdxdxe ZAdydzZBd{d|ZCdS)}zPython code format's checker. By default try to follow Guido's style guide : https://www.python.org/doc/essays/styleguide/ Some parts of the process_token method is based from The Tab Nanny std module. N)reduce)nodes) ITokenCheckerIAstroidChecker IRawChecker)BaseTokenChecker)check_messages) WarningScope OPTION_RGXasyncelifexceptforifwhiledefclasswithassertdelinnotraisereturnyield)rprintz==<>z!=z<>z<=z>=z+=z-=z*=z**=z/=z//=z&=z|=z^=z%=z>>=z<<=([{)]}zdict-separatorztrailing-commaz empty-line)zLine too long (%s/%s)z line-too-longz=Used when a line is longer than a given number of characters.)z Too many lines in module (%s/%s)ztoo-many-linesz@Used when a module has too many lines, reducing its readability.)zTrailing whitespaceztrailing-whitespacezHUsed when there is whitespace between the end of a line and the newline.)zFinal newline missingzmissing-final-newlinez7Used when the last line in a file is missing a newline.)zTrailing newlinesztrailing-newlinesz3Used when there are trailing blank lines in a file.)z)Bad indentation. Found %s %s, expected %szbad-indentationzUUsed when an unexpected number of indentation's tabulations or spaces has been found.)zWrong %s indentation%s%s. %s%szbad-continuationZTODO)z)Found indentation with %ss instead of %sszmixed-indentationz;Used when there are some mixed tabs and spaces in a module.)zUnnecessary semicolonzunnecessary-semicolonzeUsed when a statement is ended by a semi-colon (";"), which isn't necessary (that's python, not C ;).z(More than one statement on a single linezmultiple-statementszr?r@r-r-r1_get_indent_lengths   rDc Cs|sdSdd|D}t|}d}dd|D}t|dkr~|dd}t||}||kr`dnd }t|||dkrvd ndf}||d f|d g|d dd}x|D]\}} | ||<qWd||fS)zCReturn a line with |s for each of the positions in the given lists.)r=r=cSsg|] }t|qSr-)rD).0indentr-r-r1 sz)_get_indent_hint_line..r=cSsg|] }|dfqS)|r-)rEposr-r-r1rGsr&raddremovesr,r+r))rDlenabs_CONTINUATION_HINT_MESSAGEappendsortjoin) Z bar_positionsZ bad_position delta_messageZmarkersZexpected_positionZdelta directionr>r;Zmarkerr-r-r1_get_indent_hint_lines(    rUc@seZdZdZddZdS)_ContinuedIndent)valid_outdent_stringsvalid_continuation_strings context_typer.r;cCs"||_||_||_||_||_dS)N)rWrXrYr;r.)selfrYr.r;rWrXr-r-r1__init__5s z_ContinuedIndent.__init__N)__name__ __module__ __qualname__ __slots__r[r-r-r-r1rV,srVz dict-valuehangingz hanging-block continuedzcontinued-blocksingleZmulti)r`z in dict value)r`r=)r`z before block)rar=)raz before blockz (%s %d space%s)cGsdd|DS)z/Valid indentation strings for a continued line.cSsi|] }d|qS)Nr-)rEar-r-r1 `sz!_Indentations..r-)argsr-r-r1 _Indentations^srfcCs |t|tiS)aValid alternative indentation strings for continued lines before blocks. :param int single: Valid indentation string for statements on a single logical line. :param int with_body: Valid indentation string for statements on several lines. :returns: A dictionary mapping indent offsets to a string representing whether the indent if for a line or block. :rtype: dict ) SINGLE_LINE WITH_BODY)rbZ with_bodyr-r-r1_BeforeBlockIndentationscs ric@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS) TokenWrapperz3A wrapper for readable access to token information.cCs ||_dS)N)_tokens)rZr7r-r-r1r[sszTokenWrapper.__init__cCs|j|dS)Nr&)rk)rZidxr-r-r1r.vszTokenWrapper.tokencCs|j|dS)Nr)rk)rZrlr-r-r1r4yszTokenWrapper.typecCs|j|ddS)Nr'r)rk)rZrlr-r-r1 start_line|szTokenWrapper.start_linecCs|j|ddS)Nr'r&)rk)rZrlr-r-r1 start_colszTokenWrapper.start_colcCs|j|dS)Nr()rk)rZrlr-r-r1r>szTokenWrapper.linecCst||S)zPGet the string of TABs and Spaces used for indentation of the line of this token)rAr>)rZrlr-r-r1 line_indentszTokenWrapper.line_indentcCs$||}|d||t|S)aGet an indentation string for hanging indentation, consisting of the line-indent plus a number of spaces to fill up to the column of this token. e.g. the token indent for foo in "print(foo)" is " " r+)rornrM)rZrlror-r-r1 token_indents zTokenWrapper.token_indentN) r\r]r^__doc__r[r.r4rmrnr>rorpr-r-r-r1rjpsrjc@seZdZdZddZeddZeddZedd Zed d Z d d Z ddZ ddZ ddZ ddZddZddZddZddZdS)ContinuedLineStatez8Tracker for continued indentation inside a logical line.cCs,d|_g|_d|_g|_||_t||_dS)Nr)F) _line_start _cont_stack_is_block_openerretained_warnings_configrjrk)rZr7configr-r-r1r[s zContinuedLineState.__init__cCs t|jS)N)boolrt)rZr-r-r1 has_contentszContinuedLineState.has_contentcCs|jjddS)Nz\trB)rw indent_stringreplace)rZr-r-r1_block_indent_stringsz'ContinuedLineState._block_indent_stringcCs|jd|jjS)Nr)r}rwindent_after_paren)rZr-r-r1_continuation_stringsz'ContinuedLineState._continuation_stringcCs|jjS)N)rwr~)rZr-r-r1_continuation_sizesz%ContinuedLineState._continuation_sizecCsF|jdkrdS|}|j|tkr*|d7}|j|tk|_||_dS)z7Record the first non-junk token at the start of a line.r)Nr&)rsrkr. _ASYNC_TOKEN_CONTINUATION_BLOCK_OPENERSru)rZrIZcheck_token_positionr-r-r1handle_line_starts z$ContinuedLineState.handle_line_startcCsd|_d|_dS)z2Prepares the tracker for a new physical line (NL).r)FN)rsru)rZr-r-r1next_physical_linesz%ContinuedLineState.next_physical_linecCs|g|_g|_dS)zPrepares the tracker for a new logical line (NEWLINE). A new logical line only starts with block indentation. N)rrvrt)rZr-r-r1next_logical_linesz$ContinuedLineState.next_logical_linecCs|j|||fdS)N)rvrP)rZZtoken_positionstatevalid_indentationsr-r-r1add_block_warningsz$ContinuedLineState.add_block_warningcCs\d}|j|dkr(|jdjdkr(d}|j|}|j|tkrJ|j}n|j}||fS)z>Returns the valid offsets for the token at the given position.r))r$r:)rkr.rt_CLOSING_BRACKETSrWrXcopy)rZrlZ stack_toprFrr-r-r1get_valid_indentationss z)ContinuedLineState.get_valid_indentationsc Cs|j|}|jrP|j|jkrPtt||t||j|t||j||jdS|dkr|j dj }|j dj }t |}d||d|j<tt||||Stt||t|||jt||jS)abExtracts indentation information for a hanging indent Case of hanging indent after a bracket (including parenthesis) :param str bracket: bracket in question :param int position: Position of bracket in self._tokens :returns: the state and valid positions for hanging indentation :rtype: _ContinuedIndent r'rr)Tr)rkrorurr}rV HANGING_BLOCKrfrirtrWrXrlistkeysHANGING_DICT_VALUEHANGING)rZbracketr; indentationZ paren_alignZ next_alignZnext_align_keysr-r-r1_hanging_indent_after_brackets0    z0ContinuedLineState._hanging_indent_after_bracketc Csv|j|}|j|}|j|d}|jr\|||jkr\tt||t|t|||j Stt ||t||t|S)z8Extracts indentation information for a continued indent.r&) rkrorprur}rVCONTINUED_BLOCKrfrir CONTINUED)rZrr;rrpZnext_token_indentr-r-r1_continuation_inside_brackets$  z/ContinuedLineState._continuation_inside_bracketcCs|jdS)N)rtpop)rZr-r-r1 pop_token,szContinuedLineState.pop_tokencCs:t|j|r"|j|||n|j|||dS)aPushes a new token for continued indentation on the stack. Tokens that can modify continued indentation offsets are: * opening brackets * 'lambda' * : inside dictionaries push_token relies on the caller to filter out those interesting tokens. :param int token: The concrete token :param int position: The position of the token in the stream. N)r<rkrtrPrr)rZr.r;r-r-r1 push_token/s zContinuedLineState.push_tokenN)r\r]r^rqr[propertyrzr}rrrrrrrrrrrr-r-r-r1rrs      3rrc@seZdZdZeeefZdZe Z ddddddfd d d d d dfddddddfddddddfdd e d e de dedededdfddddd dfd!d"d#d$d%dfd&ddd'd(dfd)d*d+d,d,d-d.gd/d0ff Zdgd2d3Zd4d5Zd6d7Zd8d9Zd:d;Zdd?Zd@dAZdBdCZdDdEZdFdGZdHdIZdJdKZdLdMZdNdOZ dPdQZ!dRdSZ"dTdUZ#dVdWZ$dXdYZ%dZd[Z&d\d]Z'e(d^d_d`Z)dadbZ*dcddZ+dedfZ,d1S)h FormatCheckerz]checks for : * unauthorized constructions * strict indentation * line length formatzmax-line-lengthdintzz.Maximum number of characters on a single line.)defaultr4metavarhelpzignore-long-linesZregexpzz^\s*(# )??$z>Regexp for a line that is allowed to be longer than the limit.)r4rrrzsingle-line-if-stmtFZynzzOAllow the body of an if to be on the same line as the test if there is no else.zsingle-line-class-stmtzfAllow the body of a class to be on the same line as the declaration if body contains single statement.zno-space-check,Zmultiple_choicezHList of optional constructs for which whitespace checking is disabled. `zB` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. `z<` allows a space between comma and closing bracket: (a, ). `z` allows space-only lines.)rrr4choicesrzmax-module-linesiz$Maximum number of lines in a module.z indent-stringz Znon_empty_stringzzSString used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).zindent-after-parenr(zGNumber of spaces of indent required inside a hanging or continued line.zexpected-line-ending-formatZchoicezr=LFCRLFzIExpected format of line ending, e.g. empty (any line ending), LF or CRLF.)r4rrrrNcCs$t||d|_d|_dg|_dS)N)rr[_lines_visited_lines_bracket_stack)rZlinterr-r-r1r[s zFormatChecker.__init__cCs|j|jdS)N)rr _current_liner)rZr-r-r1 _pop_tokens zFormatChecker._pop_tokencCs|j||j||dS)N)rrPrr)rZr.rlr-r-r1 _push_tokens zFormatChecker._push_tokencCsft||dr |jd||d||}||}||tkrV|dd|j|<|||dS)z8a new line has been encountered, process it if necessary;zunnecessary-semicolon)r>r*rN) r9 add_messagermr>r4 _JUNK_TOKENSsplitr check_lines)rZr7r8Z line_startline_numr>r-r-r1new_lines   zFormatChecker.new_linecCs"t|_d|jkr|jddS)NZprint_functionr)set_keywords_with_parensZfuture_importsrJ)rZmoduler-r-r1process_modules zFormatChecker.process_modulec Cs|dr"||ddkr"|||dddkr:dSd}d}t||d}||dd}xft|t|dD]N}||}|dtjkrdS|ddkr|d7}qx|dd krx|d8}|rqx||ddd ks||ddtjtjtj fkrt||dkrdS|d kr6|st|j d ||d n>|dkrR|j d ||d n"||j krt|st|j d ||d dS|dkrx|ddkrdS|ddkrd}qx|ddkrdS|ddkrxdSqxWdS)aCheck that there are not unnecessary parens after a keyword. Parens are unnecessary if there is exactly one balanced outer pair on a line, and it is followed by a colon, and contains no commas (i.e. is not a tuple). Args: tokens: list of Tokens; the entire list of Tokens. start: int; the position of the keyword in the token list. rr&rrNFrr'r")rr"r#r$rrzsuperfluous-parens)r>re)rrr)andorTr) _inside_bracketsrstrrangerMr5r:NEWLINE ENDMARKERr6rr) rZr7startZ found_and_orZdepthZ keyword_tokenrir.r-r-r1_check_keyword_parenthesessX         z(FormatChecker._check_keyword_parenthesescCs|||d|||ddkr<||dddkr._policy_stringcsR|ddkrdS|ddkr dS|ddkr0dS|ddkr@dSd rNd Sd S) Nr&rZcommarz()[]{}r)rrz<=z>=z!=z==Z comparisonrzkeyword argument assignmentZ assignment)r)r.)rZr-r1_name_constructs     z3FormatChecker._check_space.._name_constructTr&rZaround)ZbeforeZafterzbad-whitespacer')r>re col_offset) enumeratezip_EOLrr3rranyrPrr2)rZr7rZpoliciesrrZ good_spacer.ZpairsZ other_idxrZ token_pairZdistancewarningsokr;Z constructcountrr-)rZr1rs6    zFormatChecker._check_spacecCs|jd|kS)Nr))r)rZleftr-r-r1rszFormatChecker._inside_bracketsc Cs|t|jft|jft|jfdg|jft|jfdg|j fdg|j fdg|j fg}i}x&|D]\}}x|D] }|||<qdWqVW|S)N=rrr) _KEYWORD_TOKENSr_OPENING_BRACKETSrrrr_SPACED_OPERATORSrrrr)rZrawdispatchr7handlerr.r-r-r1_prepare_token_dispatchers    z'FormatChecker._prepare_token_dispatcherc Csdg|_dg}d}d}i|_i|_|}d|_d}t||j|_xt|D]\}\}} } } } | d|kr| d}|t j kr| t ||d|dn| t ||d||t j krd}|t |||j|| |n|t j kr"d}|| |dd|||ddn|t jkrHd}t|dkr|d=nv|t jkr| dsd|}|t ||d|jn:|t jt jfkr|j||rd}|| |d||t jkr| dr|jd |d y || } Wntk rYqNX| ||qNW|d8}||jj kr||j!j"#d d}|j$d f}t%t&dt'|j!j(j)|d} |jd ||jj f| d ||kr|dkr|jd |d dS)a=process tokens and search for : _ non strict indentation (i.e. not always using the parameter as indent unit) _ too long lines (i.e. longer than ) _ optionally bad construct (if given, bad_construct must be a compiled regular expression). NrFr&Tr)z lzlowercase-l-suffix)r>ztoo-many-lines)rer>ztrailing-newlines)*rrrr_last_line_endingrrrxrrr5INDENTrrjr_process_retained_warningsr_check_line_endingcheck_indent_levelrPDEDENTrMr:strip_check_continued_indentationrr6ENCODINGrNUMBERendswithrKeyErrorZmax_module_linesrZ msgs_storeZget_message_definitionsZmsgidnextfiltermapZ_pragma_linenoget)rZr7indentsZ check_equalrZtoken_handlersZlast_blank_line_numrltok_typer.r_r>rZmessage_definitionnamesr-r-r1process_tokenssv               zFormatChecker.process_tokenscCsx|jdk r&|r&||jkr&|jd|d||_|jj}|rttdd|d}|dkrTdnd}||krt|jd ||f|d dS) Nzmixed-line-endings)r>cSs||kr||S|S)Nr-)xyr-r-r1Csz2FormatChecker._check_line_ending..r=r*rrzunexpected-line-ending-format)rer>)rrrxZexpected_line_ending_formatr)rZZ line_endingrexpectedr-r-r1r4s z FormatChecker._check_line_endingcst||d }xt|jjD]h\}}}|||fdd|D}|rdtkrd|||||q|stkr|||||qWdS)Nrcsi|]\}}|kr||qSr-r-)rEkv) block_typer-r1rdQsz.)r9rrvrpitemsrh_add_continuation_messagerg)rZr7Z current_posZsingle_line_block_stmtZ indent_posr indentationsZhintsr-)r r1rLs  z(FormatChecker._process_retained_warningscsfdd}|jjr&tjkr*dS|j\}}|tjsN|tjr`d|d<|j t t fkr|kr|j ||nB|krt tfdd|Ds|||dS)Ncs |kod|kS)Nr')r4) token_type)next_idxr7r-r1same_token_around_nlXszHFormatChecker._check_continued_indentation..same_token_around_nlTr'c3s|]}dt|kVqdS)r'N)rM)rEr)length_indentationr-r1 wsz=FormatChecker._check_continued_indentation..)rrzr4r5r:rr6rrprYrrrrMrr )rZr7rrrrr-)rrr7r1rWs"   z*FormatChecker._check_continued_indentationc CsLt|j\}}t|||\}}|jd||||||||fddS)Nzbad-continuation)r>re)_CONTINUATION_MSG_PARTSrYrUrprrmr>) rZrr r7r;Z readable_typeZreadable_positionZ hint_linerSr-r-r1r ~sz'FormatChecker._add_continuation_messagezmultiple-statementsc CsH|js dS|jsdS|}|dk r0|j}n:t|jtjr^||jj kr^|jj dj d}n |j j}|j}|s|t |||kr|j|dkr|||dS||jkrdSy |j}Wntk r|j }YnX|st |g}xZt||dD]H}d|j|<y||j|Wqtk r>|dYqXqWdS)z7check the node line number and check it if not yet doneNrr&r'r=)Z is_statementrootZ pure_pythonZprevious_siblingZ fromlineno isinstanceparentr TryFinallyZ finalbodybodytolinenoZ statementAssertionErrorrr_check_multi_statement_lineZblockstart_tolinenoAttributeErrorrrPrrstripr)rZnodeZ prev_siblZ prev_liner>rlinesr-r-r1 visit_defaults<          zFormatChecker.visit_defaultcCst|tjrdSt|tjr.t|jtjr.dSt|jtjrP|jjsP|jj rPdSt|jtj rzt |jj dkrz|jj rzdS|jd|dd|j|<dS)z/Check for lines containing multiple statements.Nr&zmultiple-statements)rr')rrZWithZ TryExceptrrZIfZorelserxZsingle_line_if_stmtZClassDefrMrZsingle_line_class_stmtrr)rZrr>r-r-r1rs  z)FormatChecker._check_multi_statement_linec sjjjjfdd}ddddddddd d h }g}xZ|d D]L}|d |krd||qH|r||d |}g}|||}|dkrHPqHW|r|d ||dS)zBcheck lines have less than a maximum number of characters cs|dsjd|dnH|d}|s6tjjkr6n(|t|ddkr^jd|t|d|}t|}|rd|kr| d  d\}}}| d krd d d | dDkrdS| dd d}t|kr|sjd |t|fd|d S)Nr*zmissing-final-newline)r>z )r*z ztrailing-whitespace)r>rrr&disablez line-too-longcSsh|] }|qSr-)r)rEZ_msg_idr-r-r1 sz@FormatChecker.check_lines..check_line..r#r)r>re)rrr _EMPTY_LINErxrrMr searchgroup partitionrrrsplit)r>rZ stripped_lineZmobjZfront_of_equalrZ back_of_equal)ignore_long_line max_charsrZr-r1 check_lines(     z-FormatChecker.check_lines..check_line  …u
u
Tr)r=N)rxZmax_line_lengthZignore_long_lines splitlinesrPrR)rZrrr*Z unsplit_endsZunsplitr>r-)r(r)rZr1rs6     zFormatChecker.check_linesc Cs|jj}|dkrd}d}t|}x(|d||krH||d}|d7}q"Wd}xf|r|ddkr|d|dkr|ddkrd}nd }|jd ||d |S||d7}|dd}qPW||ks|rd } |ddkrd } |jd|||t|| ||fddS)z.return the indent level of the string z\trBrNr&r=z )tabspace)r3r2zmixed-indentation)rer>ZspacesZtabszbad-indentation)r>re)rxr{rMr) rZstringrrrFlevelZ unit_sizeZsupplreZi_typer-r-r1rs6      z FormatChecker.check_indent_level)N)-r\r]r^rqrrrZ__implements__nameMSGSZmsgsrR_DEFAULT_NO_SPACE_CHECK_CHOICES_NO_SPACE_CHECK_CHOICESrrr#Zoptionsr[rrrrrrrrrrrrrrrrrrrrr rrrrrr-r-r-r1rCs     L  3d '*ArcCs|t|dS)z.required method to auto register this checker N)Zregister_checkerr)rr-r-r1register7sr:cCsxtdD]}q Wt|dS)Nr)rr)valr-r-r1funkier<sr<)Drqrsysr5 functoolsrZastroidrZpylint.interfacesrrrZpylint.checkersrZpylint.checkers.utilsrZ pylint.utilsr r rrr version_inforPrrrrC frozensetrr:r6rrrrrrrr#r9r8ZNODEr7r2r3r9r<rArDrUrVrrrrrrgrhrrOrfrirjrrrr:r<r-r-r-r1,s                 %/y