a NPYC@sdZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl m Z zddlmZddlmZWneyddlmZYn0dZd Zd Zze7d&Z?e7d'Z@e7d(ZAe7d)d*e'ZBe7d+ZCe7d,ZDe7d-ZEe Fd.gjGHdd/d.kZId0d1ZJd2d3ZKd4d5ZLd6d7ZMd8d9ZNd:d;ZOdd?ZQd@dAZRdBdCZSdDdEZTdFdGZUdHdIZVdJdKZWdLdMZXdNdOZYdPdQZZdRdSZ[dTdUZ\dVdWZ]dXdYZ^dZd[Z_d\d]Z`d^d_Zad`daZbdbdcZcdddeZddfdgZedhdiZfejgdjkrdkdlZhe7dmjiZjejkjlZmndndlZhenjjZjdodpZme7dqejojpZqdrdsZrdtduZsddwdxZtejufdydzZvdd|d}Zwd~dZxeIrexfddZxiiidZyddZzdddZ{ddZ|e|Gddde}Z~Gddde}ZGdddeZGdddeZGdddeZGddde}ZdefddZddZdddZdddZddZedkredS)a~ Check Python source code formatting, according to PEP 8. For usage and a list of options, try this: $ python pep8.py -h This program and its regression test suite live here: https://github.com/pycqa/pep8 Groups of errors and warnings: E errors W warnings 100 indentation 200 whitespace 300 blank lines 400 imports 500 line length 600 deprecation 700 statements 900 syntax error )with_statementN) OptionParserfnmatch)RawConfigParser) TextIOWrapperz1.7.1z'.svn,CVS,.bzr,.hg,.git,__pycache__,.toxzE121,E123,E126,E226,E24,E704Zwin32z~\.pep8ZXDG_CONFIG_HOMEz ~/.configZpep8)z setup.cfgztox.iniz.pep8 testsuiteOz+%(path)s:%(row)d:%(col)d: %(code)s %(text)sz%%(path)s:%(row)d: [%(code)s] %(text)s)defaultZpylinti)FalseNoneTrueprint)>>***+-)rr/z//rr)^&|z<<>z%=z^=z&=z|===z<=z>=z<<=z>>==z ) directoriesfiles logical linesphysical linesz([ \t]*)zraise\s+\w+\s*,zraise\s+\w+\s*,.*,\s*\w+\s*$z\b[A-Z]\d{3}\bz u?r?["\']z[[({] | []}),;:]z[,;:]\s*(?: |\t)z?(\bNone|\bFalse|\bTrue)?\s*([=!]=)\s*(?(1)|(None|False|True))\bz!\b(not)\s+[^][)(}{ ]+\s+(in|is)\szE(?:[=!]=|is(?:\s+not)?)\s*type(?:s.\w+Type|\s*\(\s*([^)]*[^ )])\s*\))z(\s*)\b(?:%s)\b(\s*)rz'(?:[^,\s])(\s*)(?:[-+*/|!<=>%&^]+)(\s*)z \blambda\bz*^@@ -\d+(?:,\d+)? \+(\d+)(?:,(\d+))? @@.*$z# cCs:t|d}t|D]\}}||kr|dfSqdS)aINever mix tabs and spaces. The most popular way of indenting Python is with spaces only. The second-most popular way is with tabs only. Code indented with a mixture of tabs and spaces should be converted to using spaces exclusively. When invoking the Python command line interpreter with the -t option, it issues warnings about code that illegally mixes tabs and spaces. When using -tt these warnings become errors. These options are highly recommended! Okay: if a == 0:\n a = 1\n b = 1 E101: if a == 0:\n a = 1\n\tb = 1 r"z/E101 indentation contains mixed spaces and tabsN) INDENT_REGEXmatchgroup enumerate) physical_line indent_charindentoffsetcharr,#lib/python3.9/site-packages/pep8.pytabs_or_spacess r.cCs*t|d}d|vr&|ddfSdS)zFor new projects, spaces-only are strongly recommended over tabs. Okay: if True:\n return W191: if True:\n\treturn r" zW191 indentation contains tabsN)r#r$r%index)r'r)r,r,r- tabs_obsoletesr1cCsH|d}|d}|d}|d}||krD|r@t|dfSdSdS)aTrailing whitespace is superfluous. The warning returned varies on whether the line itself is blank, for easier filtering for those who want to indent their blank lines. Okay: spam(1)\n# W291: spam(1) \n# W293: class Foo(object):\n \n bang = 12    z zW291 trailing whitespace)rz#W293 blank line contains whitespaceNrstriplen)r'strippedr,r,r-trailing_whitespaces     r9cCs0||kr,|}|sdS||kr,t|dfSdS)zTrailing blank lines are superfluous. Okay: spam(1) W391: spam(1)\n However the last line should end with a new line (warning W292). )rzW391 blank line at end of filezW292 no newline at end of fileNr5)r'lines line_number total_linesZstripped_last_liner,r,r-trailing_blank_liness r=cCs|}t|}||krt|s|}t|dkr8|sPt|dkrp|ddkrpt|t|d|dkrpdSt|drzt|d }WntyYn0||kr|d ||ffSdS) aLimit all lines to a maximum of 79 characters. There are still many devices around that are limited to 80 character lines; plus, limiting windows to 80 characters makes it possible to have several windows side-by-side. The default wrapping on such devices looks ugly. Therefore, please limit all lines to a maximum of 79 characters. For flowing long blocks of text (docstrings or comments), limiting the length to 72 characters is recommended. Reports error E501. r"r#Ndecodezutf-8z'E501 line too long (%d > %d characters))r6r7noqasplithasattrrB UnicodeError)r'max_line_length multilinelinelengthZchunksr,r,r-maximum_line_lengths*     rKccs|dkr|sdS|dr&|rdVnf|dks:|rJ|dkrJdd|fVnB|dr|rv|s||kst|sd Vn|dkrdd |fVdS) a"Separate top-level function and class definitions with two blank lines. Method definitions inside a class are separated by a single blank line. Extra blank lines may be used (sparingly) to separate groups of related functions. Blank lines may be omitted between a bunch of related one-liners (e.g. a set of dummy implementations). Use blank lines in functions, sparingly, to indicate logical sections. Okay: def a():\n pass\n\n\ndef b():\n pass Okay: def a():\n pass\n\n\n# Foo\n# Bar\n\ndef b():\n pass E301: class Foo:\n b = 0\n def bar():\n pass E302: def a():\n pass\n\ndef b(n):\n pass E303: def a():\n pass\n\n\n\ndef b(n):\n pass E303: def a():\n\n\n\n pass E304: @decorator\n\ndef a():\n pass N@)rz/E304 blank lines found after function decoratorr>rzE303 too many blank lines (%d))def zclass rM)rz#E301 expected 1 blank line, found 0z%E302 expected 2 blank lines, found %d) startswithDOCSTRING_REGEXr$) logical_line blank_lines indent_levelr; blank_beforeprevious_logicalprevious_indent_levelr,r,r-rRs    rRccs|}t|D]n}|}|}|}||dkrJ|dd|fVq||ddkr|dvrfdnd}|d||ffVqd S) aHAvoid extraneous whitespace. Avoid extraneous whitespace in these situations: - Immediately inside parentheses, brackets or braces. - Immediately before a comma, semicolon, or colon. Okay: spam(ham[1], {eggs: 2}) E201: spam( ham[1], {eggs: 2}) E201: spam(ham[ 1], {eggs: 2}) E201: spam(ham[1], { eggs: 2}) E202: spam(ham[1], {eggs: 2} ) E202: spam(ham[1 ], {eggs: 2}) E202: spam(ham[1], {eggs: 2 }) E203: if x == 4: print x, y; x, y = y , x E203: if x == 4: print x, y ; x, y = y, x E203: if x == 4 : print x, y; x, y = y, x  r"zE201 whitespace after '%s',}])ZE202ZE203z%s whitespace before '%s'N)EXTRANEOUS_WHITESPACE_REGEXfinditerr%stripstart)rQrIr$textr+foundcoder,r,r-extraneous_whitespaces raccst|D]|}|\}}d|vr4|ddfVnt|dkrP|ddfVd|vrj|ddfVq t|dkr |ddfVq dS) zAvoid extraneous whitespace around keywords. Okay: True and False E271: True and False E272: True and False E273: True and\tFalse E274: True\tand False r/r"zE274 tab before keywordz#E272 multiple spaces before keywordr>zE273 tab after keywordz"E271 multiple spaces after keywordN) KEYWORD_REGEXr[groupsr]r7rQr$beforeZafterr,r,r-whitespace_around_keywords2s    rfccs|}tt|dD]}||}|dvr||dtvr|d|}|dkrv|d|dkrv|d|dkrvq|dkr||dd krq|d |fVqdS) zEach comma, semicolon or colon should be followed by whitespace. Okay: [a, b] Okay: (3,) Okay: a[1:4] Okay: a[:4] Okay: a[1:] Okay: a[1:4:2] E231: ['a','b'] E231: foo(bar,baz) E231: [{'a':'b'}] r"z,;:N:[]{rX)z"E231 missing whitespace after '%s')ranger7 WHITESPACEcountrfind)rQrIr0r+rer,r,r-missing_whitespaceIs  rpccs|rdnd}|rdnd}|dr6d|d|dffV|d}|rd||krdd|d |d ffVn"|s||krd|d|d ffVd S) aUse 4 spaces per indentation level. For really old code that you don't want to mess up, you can continue to use 8-space tabs. Okay: a = 1 Okay: if a == 0:\n a = 1 E111: a = 1 E114: # a = 1 Okay: for item in items:\n pass E112: for item in items:\npass E115: for item in items:\n# Hi\n pass Okay: a = 1\nb = 2 E113: a = 1\n b = 2 E116: a = 1\n # b = 2 rrLzE11%d %szE11%d %s (comment)r"z%indentation is not a multiple of fourrgr>zexpected an indented blockzunexpected indentationN)endswith)rQrUr(rSrVcZtmplZ indent_expectr,r,r- indentationcs     rtc'cs|ddd}d|ddd|}|s4|dkr8dS|d} d} } |dkrVdnd } dg|} dg|}dgg}dg}i}|dd}d}d }|dg}|d krtd |dd |D]\}}}}}| |d|k}|r|d|} | o|tv}|r|}|d kr(td|t|||| <|tjkoJ|dv}t|| D]*}|| ||}|| v}|rXqqX|| r||| k}| o|dko||d}|r|| r|d|| kr|dfVn|r|s|r|dfVn|| r:|d|| kr:|dur|dfVn|sT| rt|| dkrt|rj|sj|dfV||| <n|dur|d|| <np||t fvrn`|dkrd} nB|| rd} n2|s|| rd} n||| <|d krd} nd} |d| fV| | rZ|tj tj fvrZ|| sZ|d|| <d||d<|d krtd| |dfn|tj tj fvsv|dvrt ||d<n\|s| s| s|dkrd||dd<n.|dkr||dd r|| | |tjkrn|dvrn| d7} |d|dt|| kr*|g|| | | | d7<|d kr>td | |d|| fn|d!vr>| dkr>|p|d}!|t| D]}"||"|!krd||"<qt|D]}#|#|!kr||#=q|| dd=| d8} | r d||| <t| ddD]&}$| |$r| |$d8<q>qt|| dksTJ|d|vrn|||d<|d|dk}|r|| ||d|<q| rt||d kr|d|dd f}%|rd"}&nd#}&|%d$|&fVdS)%a2Continuation lines indentation. Continuation lines should align wrapped elements either vertically using Python's implicit line joining inside parentheses, brackets and braces, or using a hanging indent. When using a hanging indent these considerations should be applied: - there should be no arguments on the first line, and - further indentation should be used to clearly distinguish itself as a continuation line. Okay: a = (\n) E123: a = (\n ) Okay: a = (\n 42) E121: a = (\n 42) E122: a = (\n42) E123: a = (\n 42\n ) E124: a = (24,\n 42\n) E125: if (\n b):\n pass E126: a = (\n 42) E127: a = (24,\n 42) E128: a = (24,\n 42) E129: if (a or\n b):\n pass E131: a = (\n 42\n 24) rr>r"r@Nrgr/)rq)rqFrLz>>> rqz... z]})z6E124 closing bracket does not match visual indentationz+E133 closing bracket is missing indentationTz7E128 continuation line under-indented for visual indentruzIE123 closing bracket does not match indentation of opening bracket's line)ZE122z missing indentation or outdented)ZE127zover-indented for visual indent)ZE131zunaligned for hanging indent)ZE126z over-indented for hanging indent)ZE121z!under-indented for hanging indentz%s continuation line %szbracket depth %s indent to %s)uZurbbrif([{z.bracket depth %s seen, col %s, visual min = %s)]}zE129 visually indented linezE125 continuation linez(%s with same indent as next logical line)rrrr6NEWLINE expand_indenttokenizeOPreversedgetstrNLCOMMENTSTRINGisspaceappendr7poprllist)'rQtokensrS hang_closingr(rCverboseZ first_rownrowsZ indent_nextrowZdepthZ valid_hangsparensZ rel_indentZ open_rowsZhangsZindent_chancesZ last_indentZ visual_indentZlast_token_multiliner) token_typer^r]endrInewlineZ close_bracketZopen_rowZhangZhanging_indenterrorZ prev_indentdZindidxposr`r,r,r-continued_indentations                                           rc cs|d\}}}}}tdt|D]}||\}}} } }|tjkr|dvr| |kr|tjksb|dvr|dks~||dddkrt|s|d|fV|}|}| }q dS) aAvoid extraneous whitespace. Avoid extraneous whitespace in the following situations: - before the open parenthesis that starts the argument list of a function call. - before the open parenthesis that starts an indexing or slicing. Okay: spam(1) E211: spam (1) Okay: dict['key'] = list[index] E211: dict ['key'] = list[index] E211: dict['key'] = list [index] rr"z([rYr>classzE211 whitespace before '%s'N)rlr7r~rNAMEkeyword iskeyword) rQr prev_type prev_text__prev_endr0rr^r]rr,r,r-whitespace_before_parametersIs, rccst|D]|}|\}}d|vr4|ddfVnt|dkrP|ddfVd|vrj|ddfVq t|dkr |ddfVq dS) zAvoid extraneous whitespace around an operator. Okay: a = 12 + 3 E221: a = 4 + 5 E222: a = 4 + 5 E223: a = 4\t+ 5 E224: a = 4 +\t5 r/r"zE223 tab before operatorz$E221 multiple spaces before operatorr>zE224 tab after operatorz#E222 multiple spaces after operatorN)OPERATOR_REGEXr[rcr]r7rdr,r,r-whitespace_around_operatoris    rccsd}d}tj}d}}|D]\}}} } } |tvr4q|dvrF|d7}n|dkrV|d8}|r| |kr|dur|ds|ddfVd}nz|d kr|d vrnh|dus|dr|dfVnH|d krd \} } |d krd\} } n|tvrd\} } |dd| | ffVd}n|tjkr|dur|dkr,|r,nP|tvr, !=, <=, >=, in, not in, is, is not), Booleans (and, or, not). - If operators with different priorities are used, consider adding whitespace around the operators with the lowest priorities. Okay: i = i + 1 Okay: submitted += 1 Okay: x = x * 2 - 1 Okay: hypot2 = x * x + y * y Okay: c = (a + b) * (a - b) Okay: foo(bar, key='word', *args, **kwargs) Okay: alpha[:-i] E225: i=i+1 E225: submitted +=1 E225: x = x /2 - 1 E225: z = x **y E226: c = (a+b) * (a-b) E226: hypot2 = x*x + y*y E227: c = a|b E228: msg = fmt%(errno, errmsg) rFN)(lambdar"rkTz'E225 missing whitespace around operatorr)rrr)ZE226Z arithmeticr)ZE228Zmodulo)ZE227zbitwise or shiftz(%s missing whitespace around %s operatorrrY)r~r SKIP_COMMENTS ARITHMETIC_OPWS_NEEDED_OPERATORSUNARY_OPERATORSKEYWORDSWS_OPTIONAL_OPERATORS)rQrrZ need_spacerrrrr^r]rrIr`Zoptyper,r,r-"missing_whitespace_around_operatorsh        rccs^|}t|D]J}|d}d|vrB|d|dfVq|d|dfVqdS)zAvoid extraneous whitespace after a comma or a colon. Note: these checks are disabled by default Okay: a = (1, 2) E241: a = (1, 2) E242: a = (1,\t2) r"r/zE242 tab after '%s'rzE241 multiple spaces after '%s'N)WHITESPACE_AFTER_COMMA_REGEXr[r]r%)rQrImr_r,r,r-whitespace_around_commas   rc csd}d}d}d}|d}d}|D]\}} } } } |tjkr|}|dr:|d}d|kr:d|d|vr:|dfVdS)a,Imports should usually be on separate lines. Okay: import os\nimport sys E401: import sys, os Okay: from subprocess import Popen, PIPE Okay: from myclas import MyClass Okay: from foo.bar.yourclass import YourClass Okay: import myclass Okay: import foo.bar.yourclass import rXr@;Nz!E401 multiple imports on one line)rOfind)rQrIr_r,r,r-imports_on_separate_linesHs   rc#sdd}d}|rdS|sdS|r$dS|ds<drP|ddrd VnJtfd d |DrjdS|r|d drd |d<qd |d <nd |d<dS)a]Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants. Okay: import os Okay: # this is a comment\nimport os Okay: '''this is a module docstring'''\nimport os Okay: r'''this is a module docstring'''\nimport os Okay: try:\n import x\nexcept:\n pass\nelse:\n pass\nimport y Okay: try:\n import x\nexcept:\n pass\nfinally:\n pass\nimport y E402: a=1\nimport os E402: 'One string'\n"Two string"\nimport os E402: a=1\nfrom sys import x Okay: if x:\n import os cSsP|ddvr|dd}|r4|ddvr4|dd}|oN|ddkpN|ddkS)NrZuUbBr"ZrR"'r,rIr,r,r-is_string_literalls    z8module_imports_on_top_of_file..is_string_literal)tryexceptelsefinallyNrzfrom Zseen_non_importsF)rz+E402 module level import not at top of filec3s|]}|VqdSNrO).0kwrr,r- z0module_imports_on_top_of_file..Zseen_docstringT)rOrany)rQrS checker_staterCrZallowed_try_keywordsr,rr-module_imports_on_top_of_file[s&    rccsB|}t|d}|d}d|kr.|krnn|d|}|d|dkr|d|dkr|d |d krt|}|r|d|}|ddd krt|ddrd Vq| d rdVn |dfV|d|d}q|d}d|kr>||kr |dfVn |dfV|d|d}qdS)aCompound statements (on the same line) are generally discouraged. While sometimes it's okay to put an if/for/while with a small body on the same line, never do this for multi-clause statements. Also avoid folding such long lines! Always use a def statement instead of an assignment statement that binds a lambda expression directly to a name. Okay: if foo == 'blah':\n do_blah_thing() Okay: do_one() Okay: do_two() Okay: do_three() E701: if foo == 'blah': do_blah_thing() E701: for x in lst: total += x E701: while t < 10: t = delay() E701: if foo == 'blah': do_blah_thing() E701: else: do_non_blah_thing() E701: try: something() E701: finally: cleanup() E701: if foo == 'blah': one(); two(); three() E702: do_one(); do_two(); do_three() E703: do_four(); # useless semicolon E704: def f(x): return 2*x E731: f = lambda x: 2*x r"rgr@Nrj}rhrirrkr)rz1E731 do not assign a lambda expression, use a defrN)rz*E704 multiple statements on one line (def)z,E701 multiple statements on one line (colon)rz0E702 multiple statements on one line (semicolon)z$E703 statement ends with a semicolon) r7rrn LAMBDA_REGEXsearchr]r6 isidentifierr\rO)rQrIZ last_charr_reZ lambda_kwr,r,r-compound_statementss4    $       rc csd}}}d}d}|D]\}}} } } |tjkr4d}| d|krV|rV|rV|sV|dfV| d|kr| ddr| dt| dd f}nd}| d}}n| d}|tjkr|d vr|d 7}q|d vr|d 8}qdS) a?Avoid explicit line join between brackets. The preferred way of wrapping long lines is by using Python's implied line continuation inside parentheses, brackets and braces. Long lines can be broken over multiple lines by wrapping expressions in parentheses. These should be used in preference to using a backslash for line continuation. E502: aaa = [123, \\n 123] E502: aaa = ("bbb " \\n "ccc") Okay: aaa = [123,\n 123] Okay: aaa = ("bbb "\n "ccc") Okay: aaa = "bbb " \\n "ccc" Okay: aaa = 123 # \\ rFNTz0E502 the backslash is redundant between brackets \r@r"rzr{)r~rr6rrr7 splitlinesr) rQrZ prev_startrrrZ backslashrr^r]rrIr,r,r-explicit_line_joins&      rc cs|dd}d}d}|D]b\}}}}} |tjkr.qd|vs>d|vrN|tjkrNd}q|||rj|rj|sj|dfV|dv}d}qd S) a Avoid breaks before binary operators. The preferred place to break around a binary operator is after the operator, not before it. W503: (width == 0\n + height == 0) W503: (width == 0\n and height == 0) Okay: (width == 0 +\n height == 0) Okay: foo(\n -x) Okay: foo(x\n []) Okay: x = '''\n''' + '' Okay: foo(x,\n -y) Okay: foo(x, # comment\n -y) cSs|tjks|dvo|dvS)N)andorz ()[]{},:.;@=%)r~r)rr^r,r,r-is_binary_operatorsz8break_around_binary_operator..is_binary_operatorFTr2r3z&W503 line break before binary operatorz([{,;N)r~rr) rQrrZ line_breakZ unary_contextrr^r]rrIr,r,r-break_around_binary_operators  rccs| ot|}|r|dp&|d}|ddk}d|r@dnd|}|dvrXd }n2d }|d krh|pt|d kot| }|d |rdnd7}|dd|||ffVdS)aXComparison to singletons should use "is" or "is not". Comparisons to singletons like None should always be done with "is" or "is not", never the equality operators. Okay: if arg is not None: E711: if arg != None: E711: if None == arg: E712: if arg == True: E712: if False == arg: Also, beware of writing if x when you really mean if x is not None -- e.g. when testing whether a variable or argument that defaults to None was set to some other value. The other value might have a type (such as a container) that could be false in a boolean context! r"rLr>rz'if cond is %s:'znot )r ZE711ZE712r r z or 'if %scond:'z %s comparison to %s should be %sN)COMPARE_SINGLETON_REGEXrr%r])rQrCr$Z singletonZsamemsgr`Znonzeror,r,r-comparison_to_singletons   rccs@t|}|r<|d}|ddkr2|dfVn |dfVdS)aGNegative comparison should be done using "not in" and "is not". Okay: if x not in y:\n pass Okay: assert (X in Y or X is Z) Okay: if not (X in Y):\n pass Okay: zz = x is not y E713: Z = not X in Y E713: if not X.B in Y:\n pass E714: if not X is Y:\n pass E714: Z = not X.B is Y r"r>inz+E713 test for membership should be 'not in'z0E714 test for object identity should be 'is not'N)COMPARE_NEGATIVE_REGEXrr]r%)rQr$rr,r,r-comparison_negative6s   rccsFt|}|rB|sB|d}|r4t|r4|tvr4dS|dfVdS)aObject type comparisons should always use isinstance(). Do not compare types directly. Okay: if isinstance(obj, int): E721: if type(obj) is type(1): When checking if an object is a string, keep in mind that it might be a unicode string too! In Python 2.3, str and unicode have a common base class, basestring, so you can do: Okay: if isinstance(obj, basestring): Okay: if type(a1) is type(b1): r"Nz-E721 do not compare types, use 'isinstance()')COMPARE_TYPE_REGEXrr%r SINGLETONSr])rQrCr$instr,r,r-comparison_typeKs   rccs$|d}|dkr |s |dfVdS)zThe {}.has_key() method is removed in Python 3: use the 'in' operator. Okay: if "alph" in d:\n print d["alph"] W601: assert d.has_key('alph') z .has_key(r@z'W601 .has_key() is deprecated, use 'in'Nr)rQrCrr,r,r-python_3000_has_keybs  rccs.t|}|r*t|s*|ddfVdS)zWhen raising an exception, use "raise ValueError('message')". The older form is removed in Python 3. Okay: raise DummyError("Message") W602: raise DummyError, "Message" r"z)W602 deprecated form of raising exceptionN)RAISE_COMMA_REGEXr$RERAISE_COMMA_REGEXr)rQr$r,r,r-python_3000_raise_commams rccs |d}|dkr|dfVdS)zNew code should always use != instead of <>. The older syntax is removed in Python 3. Okay: if a != 'no': W603: if a <> 'no': rr@z!W603 '<>' is deprecated, use '!='NrrQrr,r,r-python_3000_not_equalzs rccs |d}|dkr|dfVdS)zpBackticks are removed in Python 3: use repr() instead. Okay: val = repr(1 + 2) W604: val = `1 + 2` `r@z+W604 backticks are deprecated, use 'repr()'Nrrr,r,r-python_3000_backtickss r)rLcCs6t|d}|WdS1s(0YdS)Read the source code.ZrUN)open readlines)filenamefr,r,r-rs rz [a-zA-Z_]\w*$c szht|dJ}t|j\}t|dd}fdd|D|WdWS1s\0YWnPtttfyt|dd}|WdYS1s0YYn0dS) rrbT)line_bufferingcsg|]}|qSr,)rB)rlZcodingr,r- rzreadlines..Nzlatin-1)encoding) rr~detect_encodingreadlinerr LookupError SyntaxErrorrF)rrr:r,rr-rs >cCsttjjddS)Nignore)errors)rsysstdinbufferreadr,r,r,r-stdin_get_valuesrz# no(?:qa|pep8)\bcCs^d|vrt|t|Sd}|D]4}|dkrB|ddd}q$|dkrT|d7}q$qZq$|S)zReturn the amount of indentation. Tabs are expanded to the next multiple of 8. >>> expand_indent(' ') 4 >>> expand_indent('\t') 8 >>> expand_indent(' \t') 8 >>> expand_indent(' \t') 16 r/rrurWr")r7r)rIresultr+r,r,r-r}s r}cCsb||dd}t|d}|dddvr>|d7}|d8}|d|d||||dS)zReplace contents with 'xxx' to prevent syntax matching. >>> mute_string('"abc"') '"xxx"' >>> mute_string("'''abc'''") "'''xxx'''" >>> mute_string("r'abc'") "r'xxx'" r@r"N)z"""z'''r>x)r0r7)r^r]rr,r,r- mute_strings  r.c si}d}}|D]}|r6|dddkr|d8}q|dddkrt|}dd|D\}}||t|||q|dddkr|d dd dd }|dd d kr|d d}t||<qtfdd| DS)z&Return a dictionary of matching lines.Nr"rrLz@@ cSsg|]}t|pdqS)1)int)rgr,r,r-rrzparse_udiff..z+++rqr/rr>zb/cs0g|](\}}|rt|rtj||fqSr,)filename_matchospathjoin)rr Zrowsparentpatternsr,r-rs) r HUNK_REGEXr$rcupdaterlrDsetdictitems) diffrrrvr rrIZ hunk_matchrr,rr- parse_udiffs&    rcCsd|sgSt|tr|Sg}|dD]:}|}d|vrNtjtj||}|| dq$|S)zQParse a comma-separated list of paths. Return a list of absolute paths. rXr) isinstancerrDr\r r abspathrrr6)valuerpathsr r,r,r-normalize_pathss rTcs|s|Stfdd|DS)z{Check if patterns contains a pattern that matches filename. If patterns is unspecified, this always returns True. c3s|]}t|VqdSrr)rpatternrr,r-rrz!filename_match..)r)rrr r,r r-r  sr cCs,|dtvp*|d|ddddkS)NrrqrLr"z\ )r|r)tokenr,r,r- _is_eol_tokensr"cCs&||p$|dtjko$|d|dkS)Nrr"rq)r~r)r!Z _eol_tokenr,r,r-r"s)r'rQtreecCs6tjdkr$ddt|jDSt|dSdS)N)rLrLcSsg|]}|j|jkr|jqSr,)kindZPOSITIONAL_OR_KEYWORDname)rZ parameterr,r,r-r(s z#_get_parameters..r)r version_infoinspectZ signature parametersvaluesZ getargspec)functionr,r,r-_get_parameters&s  r+cCsdd}t|rVt|}|r|ddvr|durBt|jp>d}|||d||n2t|rt|jdddd gkr||d |ddS) zRegister a new check object.cSsB|t|vr(t||d|p"gn|p0dg|ft||<dS)Nrr)_checksextend)checkr$codesargsr,r,r- _add_check2s z"register_check.._add_checkr)r'rQNrr>selfr#)r' isfunctionr+ERRORCODE_REGEXfindall__doc__Zisclass__init__)r.r/r1r0r,r,r-register_check0s  r8cCs.tt}t|tjD]\}}t|qdS)zwRegister all globally visible functions. The first argument name is either 'physical_line' or 'logical_line'. N)r'Z getmoduler8Z getmembersr3)modr%r*r,r,r-init_checks_registryBs r:c@steZdZdZdddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZdddZdS)Checkerz;Load a Python source file, tokenize it, check coding style.Nc Ks|durt|j}n|rJd|_|j|_|j|_|j|_|j |_ d|_ |j |_ |j |_ ||_ i|_|dur~d|_ |pxg|_nz|dkrd|_ td|_n\|durzt||_Wqtytdd\}}d|j|f|_g|_Yq0n||_|jrpt|jdd}|dvrp|d kr@|jdd d|jd<n0|jddd d krp|jdd d|jd<|pz|j|_|jj|_dS) NFrrTr>z%s: %sr)r=r"rLu) StyleGuideoptions _io_errorphysical_checks_physical_checkslogical_checks_logical_checks ast_checks _ast_checksrGrHrrr_checker_statesr:rrrIOErrorrexc_info__name__ordreportr report_error) r2rr:r?rLkwargsexc_typeexcZord0r,r,r-r7PsH     zChecker.__init__cCs|tdd\}}t|jdkrF|jd}t|dkrJ|dd}nd}||d|dp^dd|j|jdf|jdS)zCheck if the syntax is valid.Nr>r"rL)r"rrz E901 %s: %s)rrIr7r0rMrJreport_invalid_syntax)r2rOrPr*r,r,r-rQzs  zChecker.report_invalid_syntaxcCsR|j|jkrdS|j|j}|jd7_|jdurN|ddtvrN|d|_|S)z(Get the next line from the input buffer.rr"Nr)r;r<r:r(rm)r2rIr,r,r-rs   zChecker.readlinecCs&g}|D]}|t||q||S)zRun a check plugin.)rgetattr)r2r.argument_namesZ argumentsr%r,r,r- run_checkszChecker.run_checkcCsd|vr|j|i|_dS)z9 Prepares a custom state for the specific checker plugin.rN)rG setdefaultr)r2r%rSr,r,r-init_checker_stateszChecker.init_checker_statecCsp||_|jD]^\}}}||||||}|dur |\}}||j||||dddkr |d|_q dS)z,Run all physical checks on a raw input line.NrqZE101r)r'rBrVrTrMr;r()r2rIr%r.rSrr*r^r,r,r-check_physicals  zChecker.check_physicalcCs$g}g}d}d}}}|jD]\}}} } } |tvr6q|sDd| fg}|tjkrZ||q|tjkrlt|}|r| \} } || kr|j|d|d}|dks|dvr|dvrd|}n|| kr| || |}|||t|7}||| f| \}}qd ||_ |ot d ||_ |S) z!Build a logical line from tokens.rNr"rXz{[(rYrWr) r SKIP_TOKENSr~rrrrr:r7rrQrC)r2ZlogicalZcommentsrJprev_rowprev_colmappingrr^r]rrI start_row start_colrr,r,r-build_tokens_lines>          zChecker.build_tokens_linec CsJ|j|}|sdS|dd\}}|j|d}t|d||_|j|jkr^|j|_|jdkr~t |j dd |j D]\}}}|jdkrt d|| |||||pdD]^\}} t|ts|D]\} } || krqq| d| d|| f}||d|d| |qq|j r:|j|_|j |_d|_g|_dS) z:Build a line from tokens and run all logical checks on it.Nrr"r>Prqz r,)rLincrement_logical_liner^r:r}rSrTrRrrrQr6rDrVrTrtuplerMrVrUr) r2r[r\r]Z start_liner%r.rSr*r^Z token_offsetrr,r,r- check_logicals6        zChecker.check_logicalc Csztd|jddt}Wn tttfy:|YS0|jD]T\}}}|||j }| D]4\}}}} |jrt |j|ds`| |||| q`qBdS)z,Build the file's AST and run all AST checks.rexecr"N) compilerr: PyCF_ONLY_AST ValueErrorr TypeErrorrQrFrrunrCrM) r2r#r%clsrZcheckerlinenor*r^r.r,r,r- check_asts zChecker.check_astc cs|jr|ddd|jtt|j}z8|D].}|dd|jkrLWdS|||Vq.Wn ttj fy| Yn0dS)z=Tokenize the file, run physical line checks and yield tokens.r"rzE902 %sr>N) r@rMrr~generate_tokensrr<maybe_check_physicalr TokenErrorrQ)r2Ztokengenr!r,r,r-rls   zChecker.generate_tokenscCst|r||dn||dtjkrd|dvrt|drBdSd|_|dd|_|ddddD] }||d|jd7_qld |_dS) z@If appropriate (based on token), check current physical line(s).rqrr2r"NTr>r@F)r"rWr~rrCrHr;rD)r2r!rIr,r,r-rms zChecker.maybe_check_physicalrcCs4|j|j|j||t|j|_|jr0|d|_d|_ d|_ |_ d|_ g|_ d|_|_d}|D]}|j ||dd\}}|jdkr |dd|ddkrd|ddpd|ddf}nd|dd}td |dd|tj|d|f|tjkr>|d vr*|d7}n|d vr|d8}ql|sl|tvr|tjkrh|d|_n0t|j dkr|jd7_|j d=n|qltrl|tjkrlt|j dkrlt|}|d |d<|dd|ddt|df|d<t|g|_ |ql|j r*||jd ||jS)z!Run all checks on the input file.rNrr>rLz[%s:%s]r"zl.%sz l.%s %s %s %rrzrYrr@) rL init_filerr:r7r<rFrkr;r(rSrVrUrrRrTrlrrrr~tok_namerr|rbCOMMENT_WITH_NLrrr6rarWget_file_results)r2expected line_offsetrr!rr^rr,r,r- check_all"s\     "         (  zChecker.check_all)NNNN)Nr)rJ __module__ __qualname__r6r7rQrrTrVrWr^rbrkrlrmrur,r,r,r-r;Ms *   !  r;c@sreZdZdZdZddZddZddZd d Zd d Z d dZ ddZ dddZ dddZ dddZddZdS) BaseReportz"Collect the results of the checks.FcCs6|j|_|j|_d|_d|_t|jd|_i|_ dS)Nr) benchmark_keys_benchmark_keys ignore_code _ignore_codeelapsed total_errorsrfromkeyscountersmessagesr2r?r,r,r-r7\s zBaseReport.__init__cCst|_dS)zStart the timer.N)time _start_timer2r,r,r-r]eszBaseReport.startcCst|j|_dS)zStop the timer.N)rrr}rr,r,r-stopiszBaseReport.stopcCsN||_||_|pd|_||_d|_|jdd7<|jdt|7<dS)Signal a new file.r,rrr"r!N)rr:rsrt file_errorsrr7r2rr:rsrtr,r,r-roms zBaseReport.init_filecCs|jdd7<dS)zSignal a new logical line.r r"N)rrr,r,r-r`wsz!BaseReport.increment_logical_linecCs|dd}||rdS||jvr8|j|d7<nd|j|<|dd|j|<||jvrbdS|jrx|jsxt|j|jd7_|jd7_|S)&Report an error, according to options.Nrqr") r|rrrsprint_filenamerrrr~r2r;r*r^r.r`r,r,r-r{s       zBaseReport.errorcCs|jS)z6Return the count of errors and warnings for this file.)rrr,r,r-rrszBaseReport.get_file_resultsrcstfddjDS)z.Return the total count of errors and warnings.cs g|]}|rj|qSr,)rOrrkeyprefixr2r,r-rs z(BaseReport.get_count..)sumrr2rr,rr- get_countszBaseReport.get_countcsfddtjDS)a Get statistics for message codes that start with the prefix. prefix='' matches all errors and warnings prefix='E' matches all errors prefix='W' matches all warnings prefix='E4' matches all errors that have to do with imports cs0g|](}|rdj||j|fqS)z %-7s %s %s)rOrrrrr,r-rs z-BaseReport.get_statistics..)sortedrrr,rr-get_statisticss zBaseReport.get_statisticscCs||D] }t|q dS)z9Print overall statistics (number of errors and warnings).N)rr)r2rrIr,r,r-print_statisticsszBaseReport.print_statisticscCsLtd|jdf|jrH|jD](}td|j||j||j|fqdS)zPrint benchmark numbers.z %-7.2f %szseconds elapsedz%-7d %s per second (%d total)N)rr}rzr)r2rr,r,r-print_benchmarks zBaseReport.print_benchmarkN)r)r)r)rJrvrwr6rr7r]rror`rrrrrrrr,r,r,r-rxWs    rxc@seZdZdZdZdS) FileReportz?Collect the results of the checks and print only the filenames.TN)rJrvrwr6rr,r,r,r-rsrcs@eZdZdZfddZfddZfddZdd ZZS) StandardReportz,Collect and print the results of the checks.csBtt||t|j|j|_|j|_ |j |_ |j |_ dSr)superrr7 REPORT_FORMATrformatlower_fmtrepeat_repeatZ show_source _show_sourceZ show_pep8 _show_pep8r __class__r,r-r7s zStandardReport.__init__csg|_tt|||||S)r)_deferred_printrrrorrr,r-ros zStandardReport.init_filecsRtt|||||}|rN|j|dks.|jrN|j||||dd|jf|S)rr"rN)rrrrrrrr6rrr,r-rszStandardReport.errorc Cs|j|jD]\}}}}}t|j|j|j||d||d|jr|t|jkr^d}n|j|d}t| tt dd|d|d|j r|rtd| tjq|jS) zz-Initialize a PEP-8 instance with few options.c OsH|dt|_|dd}|dd}|dd}t|i|}|rHdn |dd}t||||\}|_|r|j|d|vr|d|_|j |_ ||_ |j s|j rtnt|_ t|jpd|_|js|js|js|jstrttd|_n|jrd nt|j|_tdd|_|j|_|d |_|d |_|d |_|dS) N checker_class parse_argvF config_fileparserrr,rX)rr'rQr#)rr;rrrprocess_optionsr__dict__r input_filerunnerr?reporterquietrxrraselectrrdoctestDEFAULT_IGNORErDBENCHMARK_KEYSryr{ get_checksrArCrE init_report) r2r0rNrrrZ options_dictarglistr?r,r,r-r7sB          zStyleGuide.__init__NcCs|p |jj|j|j_|jjS)zInitialize the report instance.)r?rrL)r2rr,r,r-r"szStyleGuide.init_reportcCs|dur|j}|jj}|j}|z8|D].}tj|rF||q*| |s*||q*Wnt yvt dYn0| |S)zRun all checks on the paths.Nz ... stopped) rr?rLrr]r r isdir input_direxcludedKeyboardInterruptrr)r2rrLrr r,r,r- check_files's    zStyleGuide.check_filesrcCs4|jjrtd||j|||jd}|j||dS)z'Run all checks on a Python source file.z checking %s)r:r?)rsrt)r?rrrru)r2rr:rsrtZfcheckerr,r,r-r9s  zStyleGuide.input_filec Cs|d}||rdS|jjj}|jj}|jj}|j}t |D]\}}}|r\t d||dd7<t |D]} || |rt| | qtt |D],} t | |r|| |s|tj|| qqBdS)z9Check all files in this directory and all subdirectories.rrz directory rr"N)r6rr?rLrrrrr walkrrremover r r) r2dirnamerrZ filepatternsrrootdirsrZsubdirrr,r,r-rAs&          zStyleGuide.input_dircCsV|jjs dStj|}t||jjr*dS|r.F)r7rr?rrOr)r2r`r,rr-r{fszStyleGuide.ignore_codecsRg}t|D]8\}}|\}}tfdd|Dr||j||fqt|S)zGet all the checks for this category. Find all globally visible functions where the first argument name starts with argument_name and which contain selected tests. c3s|]}|o| VqdSr)r{)rr`rr,r-r|rz(StyleGuide.get_checks..)r,rrrrJr)r2Z argument_nameZchecksr.attrsr/r0r,rr-rss zStyleGuide.get_checks)N)N)NNr)N) rJrvrwr6r7rrrrrr{rr,r,r,r-r>s%     r>cCst||dd}gd|_|jdddddd |jd d ddd d |jd ddddd |jddddd|jddtdd|jddddd|jddd d!d|jd"dd d#td|jd$dd%d&|jd'dd(d&|jd)dd*d&|jd+dd,d&|jd-d.d/td0d1|jd2dd3d&|jd4d5d6d7d|jd8dd9d&|d:}tj t rp|jd;d|jd?dd@d&|jdAddBd&|S)CNz%prog [options] input ...)progversionZusage) rrrrzmax-line-lengthz hang-closingrnrrz show-pep8z show-source statisticsrz-vz --verboserrnz(print status messages, or debug with -vv)r actionhelpz-qz--quietz+report only file names, or nothing with -qqz-rz--repeatT store_truez1(obsolete) show all occurrences of the same errorz--first store_falserz#show first occurrence of each error)rdestrz --excluderz[exclude files or directories which match these comma separated patterns (default: %default)metavarr rz --filenamez*.pyzjwhen parsing directories, only check filenames matching these comma separated patterns (default: %default)z--selectrrz&select errors and warnings (e.g. E,W6)z--ignorez2skip errors and warnings (e.g. E4,W) (default: %s)z --show-sourcezshow source code for each error)rrz --show-pep8z3show text of PEP 8 for each error (implies --first)z --statisticszcount errors and warningsz--countzgprint total number of errors and warnings to standard error and set exit code to 1 if total is not nullz--max-line-lengthr nz3set maximum allowed line length (default: %default))typerr rz--hang-closingzNhang closing bracket instead of matching indentation of opening bracket's linez--formatrr z.set the error format [default|pylint|]z--diffzSreport changes only within line number ranges in the unified diff received on STDINzTesting Optionsz --testsuitedirzrun regression tests from dir)rrz --doctestzrun doctest on myselfz --benchmarkzmeasure processing speed) rconfig_options add_optionDEFAULT_EXCLUDErMAX_LINE_LENGTHadd_option_groupr r existsTESTSUITE_PATH)rrrr%r,r,r- get_parsers            rcst}|j}tj}tr>tjtr>|jr4tdt| t|oTtj tj |}|r| fddt Dr}|jrtdqtj \}qZ|rtj|r|jrtd|| ||j}||rtdd|jD} |g\} } ||D]} | dd |jvr2td | q |jd krVtd | ||| f| d d} | | }|d vr||| }nF|dkr||| }| dkrt||}n|dvsJ||| }t| | |q |j|| d\}} d|_|_|S)aoRead and parse configurations If a config file is specified on the command line with the "--config" option, then only it is used for configuration. Otherwise, the user configuration (~/.config/pep8) and any local configurations in the current directory or above will be merged together (in that order) using the read method of ConfigParser. zuser configuration: %sc3s|]}tj|VqdSr)r r r)rfnrr,r-rrzread_config..zlocal configuration: in %szcli configuration: %scSsg|]}|j|jp|jfqSr,)rrrror,r,r-rszread_config.._rz unknown option '%s' ignoredr"z %s = %s)r rnstringr)rr)r)F)rconfigr curdir USER_CONFIGr isfilerrrr commonprefixPROJECT_CONFIGrDrZ has_sectionr option_list parse_argsr?replacerrZgetintrZ getbooleansetattrrr)r?r0rrrZcli_confZ local_dirtailZ pep8_sectionrZ new_optionsrZoptZnormalized_optZopt_typerr,rr- read_configsZ                 rFcCsJ|s t}|dsF|jdd|jd|jfd}|jdd|dd|sR|sRg}||\}}d |_| d d r| |j n`| d d s|r|s|j st d dtDrdg}n |dt||||}|o|jdkot|_t|j|_t|j|_t|j|_t|j|_|j rBt|_t}t||j|d|_t|j}||fS)zProcess options passed either via arglist or via command line args. Passing in the ``config_file`` parameter allows other tools, such as flake8 to specify their own options to be processed in pep8. z--configZ ConfigurationzThe project options are read from the [%s] section of the tox.ini file or the setup.cfg file located in any parent folder of the path(s) being processed. Allowed options are: %s.z, )Z descriptionr zuser config file locationrNrFrcss|]}tj|VqdSr)r r r)rr%r,r,r-r sz"process_options..rzinput not specifiedr"r)rZ has_optionrrrrrrrZ ensure_valuerrrrrrrrr_parse_multi_optionsrrrrrrrrrr)rrrrr%r?r0rr,r,r-rsH          rrXcCs |rdd||DS|SdS)zgSplit and strip and discard empties. Turns the following: A, B, into ["A", "B"] cSsg|]}|r|qSr,)r\rr,r,r-rArz(_parse_multi_options..N)rD)r?Z split_tokenr,r,r-r6s rcCstdddl}z||jddWnty:Yn0tdd}|j}|jsX|jrnddl m }||}n| }|j r| |jr||jr|js||jr|jrtjt|jd td dS) zwParse options and run checks on Python source. Warn of deprecation and advise users to switch to pycodestyle. z pep8 has been renamed to pycodestyle (GitHub issue #466) Use of the pep8 tool will be removed in a future release. Please install and use `pycodestyle` instead. $ pip install pycodestyle $ pycodestyle ... rNcSs tdS)Nr")rexit)Zsignumframer,r,r-Xrz_main..T)r) run_testsr2r")warningswarnsignalSIGPIPEAttributeErrorr>r?rrZtestsuite.supportrrrrZ benchmarkrrZ print_resultsr~rnrstderrwriterr)rZ pep8styler?rrLr,r,r-_mainFs0       r__main__)Nr)T)N)NFNN)rX)r6Z __future__rr rrrr'rr~rZoptparserrZ configparserrior ImportErrorZ ConfigParser __version__rrplatformr  expanduserrrgetenvrr__file__rrrre frozensetrkwlistrrrunionrrrmrr|INDENTDEDENTrXr ERRORTOKENrrrdr#rrr4rPrZrrrrrbrrrrlrsendrqr.r1r9r=rKrRrarfrprtrrrrrrrrrrrrrrrrrrrr&rr$rrrrrIrrCr}rrrrr r"r,r+r8r:objectr;rxrrrr>rrrrrrJr,r,r,r-s                         &% H \1)29''"            Z7 =E 3 .