Tue, 20 Oct 2015 19:14:55 +0200
Added some TODOs to the various checker dialogs.
3616 | 1 | #!/usr/bin/env python |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | # -*- coding: utf-8 -*- |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | # pep8.py - Check Python source code formatting, according to PEP 8 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
5 | # Copyright (C) 2006-2009 Johann C. Rocholl <johann@rocholl.net> |
3616 | 6 | # Copyright (C) 2009-2014 Florent Xicluna <florent.xicluna@gmail.com> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | # Permission is hereby granted, free of charge, to any person |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | # obtaining a copy of this software and associated documentation files |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | # (the "Software"), to deal in the Software without restriction, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | # including without limitation the rights to use, copy, modify, merge, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | # publish, distribute, sublicense, and/or sell copies of the Software, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | # and to permit persons to whom the Software is furnished to do so, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | # subject to the following conditions: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | # The above copyright notice and this permission notice shall be |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | # included in all copies or substantial portions of the Software. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | # SOFTWARE. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | |
3616 | 28 | r""" |
29 | Check Python source code formatting, according to PEP 8. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | For usage and a list of options, try this: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | $ python pep8.py -h |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | This program and its regression test suite live here: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | http://github.com/jcrocholl/pep8 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | Groups of errors and warnings: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | E errors |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | W warnings |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | 100 indentation |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | 200 whitespace |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | 300 blank lines |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | 400 imports |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | 500 line length |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | 600 deprecation |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | 700 statements |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
47 | 900 syntax error |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | """ |
3616 | 49 | from __future__ import with_statement |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | # |
2861
cdcbca0cea82
Fixed a typo in the included pep8.py modules.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2799
diff
changeset
|
52 | # This is a modified version to make the original pep8.py better suitable |
3670
f0cb7579c0b4
Finished renaming eric5 for PyQt5 to eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3629
diff
changeset
|
53 | # for being called from within the eric6 IDE. The modifications are as |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | # follows: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | # - made messages translatable via Qt |
3670
f0cb7579c0b4
Finished renaming eric5 for PyQt5 to eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3629
diff
changeset
|
57 | # - added code for eric6 integration |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | # |
4021
195a471c327b
Updated copyright for 2015.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3670
diff
changeset
|
59 | # Copyright (c) 2011 - 2015 Detlev Offenbach <detlev@die-offenbachs.de> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | |
3616 | 62 | __version__ = '1.5.6' |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | import os |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | import sys |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | import re |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | import time |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | import inspect |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | import keyword |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | import tokenize |
3210
8f4fe6f76729
Fixed some dubious code related to AST generation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3160
diff
changeset
|
71 | import ast |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | from optparse import OptionParser |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | from fnmatch import fnmatch |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | try: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
75 | from configparser import RawConfigParser |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
76 | from io import TextIOWrapper |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
77 | except ImportError: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
78 | from ConfigParser import RawConfigParser # __IGNORE_WARNING__ |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
80 | DEFAULT_EXCLUDE = '.svn,CVS,.bzr,.hg,.git,__pycache__' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
81 | DEFAULT_IGNORE = 'E123,E226,E24' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
82 | if sys.platform == 'win32': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
83 | DEFAULT_CONFIG = os.path.expanduser(r'~\.pep8') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
84 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
85 | DEFAULT_CONFIG = os.path.join(os.getenv('XDG_CONFIG_HOME') or |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
86 | os.path.expanduser('~/.config'), 'pep8') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
87 | PROJECT_CONFIG = ('setup.cfg', 'tox.ini', '.pep8') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
88 | TESTSUITE_PATH = os.path.join(os.path.dirname(__file__), 'testsuite') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89 | MAX_LINE_LENGTH = 79 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
90 | REPORT_FORMAT = { |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
91 | 'default': '%(path)s:%(row)d:%(col)d: %(code)s %(text)s', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
92 | 'pylint': '%(path)s:%(row)d: [%(code)s] %(text)s', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
93 | } |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
94 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
95 | SINGLETONS = frozenset(['False', 'None', 'True']) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
96 | KEYWORDS = frozenset(keyword.kwlist + ['print']) - SINGLETONS |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
97 | UNARY_OPERATORS = frozenset(['>>', '**', '*', '+', '-']) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
98 | ARITHMETIC_OP = frozenset(['**', '*', '/', '//', '+', '-']) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
99 | WS_OPTIONAL_OPERATORS = ARITHMETIC_OP.union(['^', '&', '|', '<<', '>>', '%']) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
100 | WS_NEEDED_OPERATORS = frozenset([ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
101 | '**=', '*=', '/=', '//=', '+=', '-=', '!=', '<>', '<', '>', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
102 | '%=', '^=', '&=', '|=', '==', '<=', '>=', '<<=', '>>=', '=']) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
103 | WHITESPACE = frozenset(' \t') |
3616 | 104 | NEWLINE = frozenset([tokenize.NL, tokenize.NEWLINE]) |
105 | SKIP_TOKENS = NEWLINE.union([tokenize.INDENT, tokenize.DEDENT]) | |
106 | # ERRORTOKEN is triggered by backticks in Python 3 | |
107 | SKIP_COMMENTS = SKIP_TOKENS.union([tokenize.COMMENT, tokenize.ERRORTOKEN]) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
108 | BENCHMARK_KEYS = ['directories', 'files', 'logical lines', 'physical lines'] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
110 | INDENT_REGEX = re.compile(r'([ \t]*)') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
111 | RAISE_COMMA_REGEX = re.compile(r'raise\s+\w+\s*,') |
3616 | 112 | RERAISE_COMMA_REGEX = re.compile(r'raise\s+\w+\s*,.*,\s*\w+\s*$') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
113 | ERRORCODE_REGEX = re.compile(r'\b[A-Z]\d{3}\b') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114 | DOCSTRING_REGEX = re.compile(r'u?r?["\']') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115 | EXTRANEOUS_WHITESPACE_REGEX = re.compile(r'[[({] | []}),;:]') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
116 | WHITESPACE_AFTER_COMMA_REGEX = re.compile(r'[,;:]\s*(?: |\t)') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
117 | COMPARE_SINGLETON_REGEX = re.compile(r'([=!]=)\s*(None|False|True)') |
3616 | 118 | COMPARE_NEGATIVE_REGEX = re.compile(r'\b(not)\s+[^[({ ]+\s+(in|is)\s') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
119 | COMPARE_TYPE_REGEX = re.compile(r'(?:[=!]=|is(?:\s+not)?)\s*type(?:s.\w+Type' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
120 | r'|\s*\(\s*([^)]*[^ )])\s*\))') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
121 | KEYWORD_REGEX = re.compile(r'(\s*)\b(?:%s)\b(\s*)' % r'|'.join(KEYWORDS)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
122 | OPERATOR_REGEX = re.compile(r'(?:[^,\s])(\s*)(?:[-+*/|!<=>%&^]+)(\s*)') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
123 | LAMBDA_REGEX = re.compile(r'\blambda\b') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
124 | HUNK_REGEX = re.compile(r'^@@ -\d+(?:,\d+)? \+(\d+)(?:,(\d+))? @@.*$') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
125 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
126 | # Work around Python < 2.6 behaviour, which does not generate NL after |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
127 | # a comment which is on a line by itself. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
128 | COMMENT_WITH_NL = tokenize.generate_tokens(['#\n'].pop).send(None)[1] == '#\n' |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
129 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
130 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
131 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
132 | # Plugins (check functions) for physical lines |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
133 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
134 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
135 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
136 | def tabs_or_spaces(physical_line, indent_char): |
3616 | 137 | r"""Never mix tabs and spaces. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
138 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
139 | The most popular way of indenting Python is with spaces only. The |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
140 | second-most popular way is with tabs only. Code indented with a mixture |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
141 | of tabs and spaces should be converted to using spaces exclusively. When |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
142 | invoking the Python command line interpreter with the -t option, it issues |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
143 | warnings about code that illegally mixes tabs and spaces. When using -tt |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
144 | these warnings become errors. These options are highly recommended! |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
145 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
146 | Okay: if a == 0:\n a = 1\n b = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
147 | E101: if a == 0:\n a = 1\n\tb = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
148 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
149 | indent = INDENT_REGEX.match(physical_line).group(1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
150 | for offset, char in enumerate(indent): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
151 | if char != indent_char: |
3616 | 152 | return offset, "E101 indentation contains mixed spaces and tabs" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
153 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
154 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
155 | def tabs_obsolete(physical_line): |
3616 | 156 | r"""For new projects, spaces-only are strongly recommended over tabs. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
157 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
158 | Okay: if True:\n return |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
159 | W191: if True:\n\treturn |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
160 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
161 | indent = INDENT_REGEX.match(physical_line).group(1) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
162 | if '\t' in indent: |
3616 | 163 | return indent.index('\t'), "W191 indentation contains tabs" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
164 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
165 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
166 | def trailing_whitespace(physical_line): |
3616 | 167 | r"""Trailing whitespace is superfluous. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
168 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
169 | The warning returned varies on whether the line itself is blank, for easier |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
170 | filtering for those who want to indent their blank lines. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
171 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
172 | Okay: spam(1)\n# |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
173 | W291: spam(1) \n# |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
174 | W293: class Foo(object):\n \n bang = 12 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
175 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
176 | physical_line = physical_line.rstrip('\n') # chr(10), newline |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
177 | physical_line = physical_line.rstrip('\r') # chr(13), carriage return |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
178 | physical_line = physical_line.rstrip('\x0c') # chr(12), form feed, ^L |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
179 | stripped = physical_line.rstrip(' \t\v') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
180 | if physical_line != stripped: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
181 | if stripped: |
3616 | 182 | return len(stripped), "W291 trailing whitespace" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
183 | else: |
3616 | 184 | return 0, "W293 blank line contains whitespace" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
185 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
186 | |
3616 | 187 | def trailing_blank_lines(physical_line, lines, line_number, total_lines): |
188 | r"""Trailing blank lines are superfluous. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
189 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
190 | Okay: spam(1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
191 | W391: spam(1)\n |
3616 | 192 | |
193 | However the last line should end with a new line (warning W292). | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
194 | """ |
3616 | 195 | if line_number == total_lines: |
196 | stripped_last_line = physical_line.rstrip() | |
197 | if not stripped_last_line: | |
198 | return 0, "W391 blank line at end of file" | |
199 | if stripped_last_line == physical_line: | |
200 | return len(physical_line), "W292 no newline at end of file" | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
201 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
202 | |
3616 | 203 | def maximum_line_length(physical_line, max_line_length, multiline): |
204 | r"""Limit all lines to a maximum of 79 characters. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
205 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
206 | There are still many devices around that are limited to 80 character |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
207 | lines; plus, limiting windows to 80 characters makes it possible to have |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
208 | several windows side-by-side. The default wrapping on such devices looks |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
209 | ugly. Therefore, please limit all lines to a maximum of 79 characters. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
210 | For flowing long blocks of text (docstrings or comments), limiting the |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
211 | length to 72 characters is recommended. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
212 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
213 | Reports error E501. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
214 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
215 | line = physical_line.rstrip() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
216 | length = len(line) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
217 | if length > max_line_length and not noqa(line): |
3616 | 218 | # Special case for long URLs in multi-line docstrings or comments, |
219 | # but still report the error when the 72 first chars are whitespaces. | |
220 | chunks = line.split() | |
221 | if ((len(chunks) == 1 and multiline) or | |
222 | (len(chunks) == 2 and chunks[0] == '#')) and \ | |
223 | len(line) - len(chunks[-1]) < max_line_length - 7: | |
224 | return | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
225 | if hasattr(line, 'decode'): # Python 2 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
226 | # The line could contain multi-byte characters |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
227 | try: |
1145
2a16484e65c2
Fix for the PEP-8 checker to handle unicode better.
detlev@die-offenbachs.de
parents:
945
diff
changeset
|
228 | length = len(line.decode('utf-8')) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
229 | except UnicodeError: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
230 | pass |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
231 | if length > max_line_length: |
3616 | 232 | return (max_line_length, "E501 line too long ", length, max_line_length) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
233 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
234 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
235 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
236 | # Plugins (check functions) for logical lines |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
237 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
238 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
239 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
240 | def blank_lines(logical_line, blank_lines, indent_level, line_number, |
3616 | 241 | blank_before, previous_logical, previous_indent_level): |
242 | r"""Separate top-level function and class definitions with two blank lines. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
243 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
244 | Method definitions inside a class are separated by a single blank line. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
245 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
246 | Extra blank lines may be used (sparingly) to separate groups of related |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
247 | functions. Blank lines may be omitted between a bunch of related |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
248 | one-liners (e.g. a set of dummy implementations). |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
249 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
250 | Use blank lines in functions, sparingly, to indicate logical sections. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
251 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
252 | Okay: def a():\n pass\n\n\ndef b():\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
253 | Okay: def a():\n pass\n\n\n# Foo\n# Bar\n\ndef b():\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
254 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
255 | E301: class Foo:\n b = 0\n def bar():\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
256 | E302: def a():\n pass\n\ndef b(n):\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
257 | E303: def a():\n pass\n\n\n\ndef b(n):\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
258 | E303: def a():\n\n\n\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
259 | E304: @decorator\n\ndef a():\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
260 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
261 | if line_number < 3 and not previous_logical: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
262 | return # Don't expect blank lines before the first line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
263 | if previous_logical.startswith('@'): |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
264 | if blank_lines: |
3616 | 265 | yield 0, "E304 blank lines found after function decorator" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
266 | elif blank_lines > 2 or (indent_level and blank_lines == 2): |
3616 | 267 | yield 0, "E303 too many blank lines (%d)", blank_lines |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
268 | elif logical_line.startswith(('def ', 'class ', '@')): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
269 | if indent_level: |
3616 | 270 | if not (blank_before or previous_indent_level < indent_level or |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
271 | DOCSTRING_REGEX.match(previous_logical)): |
3616 | 272 | yield 0, "E301 expected 1 blank line, found 0" |
273 | elif blank_before != 2: | |
274 | yield 0, "E302 expected 2 blank lines, found %d", blank_before | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
275 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
276 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
277 | def extraneous_whitespace(logical_line): |
3616 | 278 | r"""Avoid extraneous whitespace. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
279 | |
3616 | 280 | Avoid extraneous whitespace in these situations: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
281 | - Immediately inside parentheses, brackets or braces. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
282 | - Immediately before a comma, semicolon, or colon. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
283 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
284 | Okay: spam(ham[1], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
285 | E201: spam( ham[1], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
286 | E201: spam(ham[ 1], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
287 | E201: spam(ham[1], { eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
288 | E202: spam(ham[1], {eggs: 2} ) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
289 | E202: spam(ham[1 ], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
290 | E202: spam(ham[1], {eggs: 2 }) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
291 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
292 | E203: if x == 4: print x, y; x, y = y , x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
293 | E203: if x == 4: print x, y ; x, y = y, x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
294 | E203: if x == 4 : print x, y; x, y = y, x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
295 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
296 | line = logical_line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
297 | for match in EXTRANEOUS_WHITESPACE_REGEX.finditer(line): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
298 | text = match.group() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
299 | char = text.strip() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
300 | found = match.start() |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
301 | if text == char + ' ': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
302 | # assert char in '([{' |
3616 | 303 | yield found + 1, "E201 whitespace after '%s'", char |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
304 | elif line[found - 1] != ',': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
305 | code = ('E202' if char in '}])' else 'E203') # if char in ',;:' |
3616 | 306 | yield found, "%s whitespace before '%s'" % (code, char), char |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
307 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
308 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
309 | def whitespace_around_keywords(logical_line): |
3616 | 310 | r"""Avoid extraneous whitespace around keywords. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
311 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
312 | Okay: True and False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
313 | E271: True and False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
314 | E272: True and False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
315 | E273: True and\tFalse |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
316 | E274: True\tand False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
317 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
318 | for match in KEYWORD_REGEX.finditer(logical_line): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
319 | before, after = match.groups() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
320 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
321 | if '\t' in before: |
3616 | 322 | yield match.start(1), "E274 tab before keyword" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
323 | elif len(before) > 1: |
3616 | 324 | yield match.start(1), "E272 multiple spaces before keyword" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
325 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
326 | if '\t' in after: |
3616 | 327 | yield match.start(2), "E273 tab after keyword" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
328 | elif len(after) > 1: |
3616 | 329 | yield match.start(2), "E271 multiple spaces after keyword" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
330 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
331 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
332 | def missing_whitespace(logical_line): |
3616 | 333 | r"""Each comma, semicolon or colon should be followed by whitespace. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
334 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
335 | Okay: [a, b] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
336 | Okay: (3,) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
337 | Okay: a[1:4] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
338 | Okay: a[:4] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
339 | Okay: a[1:] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
340 | Okay: a[1:4:2] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
341 | E231: ['a','b'] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
342 | E231: foo(bar,baz) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
343 | E231: [{'a':'b'}] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
344 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
345 | line = logical_line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
346 | for index in range(len(line) - 1): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
347 | char = line[index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
348 | if char in ',;:' and line[index + 1] not in WHITESPACE: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
349 | before = line[:index] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
350 | if char == ':' and before.count('[') > before.count(']') and \ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
351 | before.rfind('{') < before.rfind('['): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
352 | continue # Slice syntax, no space required |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
353 | if char == ',' and line[index + 1] == ')': |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
354 | continue # Allow tuple with only one element: (3,) |
3616 | 355 | yield index, "E231 missing whitespace after '%s'", char |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
356 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
357 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
358 | def indentation(logical_line, previous_logical, indent_char, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
359 | indent_level, previous_indent_level): |
3616 | 360 | r"""Use 4 spaces per indentation level. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
361 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
362 | For really old code that you don't want to mess up, you can continue to |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
363 | use 8-space tabs. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
364 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
365 | Okay: a = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
366 | Okay: if a == 0:\n a = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
367 | E111: a = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
368 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
369 | Okay: for item in items:\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
370 | E112: for item in items:\npass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
371 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
372 | Okay: a = 1\nb = 2 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
373 | E113: a = 1\n b = 2 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
374 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
375 | if indent_char == ' ' and indent_level % 4: |
3616 | 376 | yield 0, "E111 indentation is not a multiple of four" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
377 | indent_expect = previous_logical.endswith(':') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
378 | if indent_expect and indent_level <= previous_indent_level: |
3616 | 379 | yield 0, "E112 expected an indented block" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
380 | if indent_level > previous_indent_level and not indent_expect: |
3616 | 381 | yield 0, "E113 unexpected indentation" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
382 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
383 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
384 | def continued_indentation(logical_line, tokens, indent_level, hang_closing, |
3616 | 385 | indent_char, noqa, verbose): |
386 | r"""Continuation lines indentation. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
387 | |
3616 | 388 | Continuation lines should align wrapped elements either vertically |
389 | using Python's implicit line joining inside parentheses, brackets | |
390 | and braces, or using a hanging indent. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
391 | |
3616 | 392 | When using a hanging indent these considerations should be applied: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
393 | - there should be no arguments on the first line, and |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
394 | - further indentation should be used to clearly distinguish itself as a |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
395 | continuation line. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
396 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
397 | Okay: a = (\n) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
398 | E123: a = (\n ) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
399 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
400 | Okay: a = (\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
401 | E121: a = (\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
402 | E122: a = (\n42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
403 | E123: a = (\n 42\n ) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
404 | E124: a = (24,\n 42\n) |
3616 | 405 | E125: if (\n b):\n pass |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
406 | E126: a = (\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
407 | E127: a = (24,\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
408 | E128: a = (24,\n 42) |
3616 | 409 | E129: if (a or\n b):\n pass |
410 | E131: a = (\n 42\n 24) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
411 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
412 | first_row = tokens[0][2][0] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
413 | nrows = 1 + tokens[-1][2][0] - first_row |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
414 | if noqa or nrows == 1: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
415 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
416 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
417 | # indent_next tells us whether the next block is indented; assuming |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
418 | # that it is indented by 4 spaces, then we should not allow 4-space |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
419 | # indents on the final continuation line; in turn, some other |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
420 | # indents are allowed to have an extra 4 spaces. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
421 | indent_next = logical_line.endswith(':') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
422 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
423 | row = depth = 0 |
3616 | 424 | valid_hangs = (4,) if indent_char != '\t' else (4, 8) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
425 | # remember how many brackets were opened on each line |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
426 | parens = [0] * nrows |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
427 | # relative indents of physical lines |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
428 | rel_indent = [0] * nrows |
3616 | 429 | # for each depth, collect a list of opening rows |
430 | open_rows = [[0]] | |
431 | # for each depth, memorize the hanging indentation | |
432 | hangs = [None] | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
433 | # visual indents |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
434 | indent_chances = {} |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
435 | last_indent = tokens[0][2] |
3616 | 436 | visual_indent = None |
437 | # for each depth, memorize the visual indent column | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
438 | indent = [last_indent[1]] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
439 | if verbose >= 3: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
440 | print(">>> " + tokens[0][4].rstrip()) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
441 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
442 | for token_type, text, start, end, line in tokens: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
443 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
444 | last_token_multiline = (start[0] != end[0]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
445 | newline = row < start[0] - first_row |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
446 | if newline: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
447 | row = start[0] - first_row |
3616 | 448 | newline = not last_token_multiline and token_type not in NEWLINE |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
449 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
450 | if newline: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
451 | # this is the beginning of a continuation line. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
452 | last_indent = start |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
453 | if verbose >= 3: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
454 | print("... " + line.rstrip()) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
455 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
456 | # record the initial indent. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
457 | rel_indent[row] = expand_indent(line) - indent_level |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
458 | |
3616 | 459 | # identify closing bracket |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
460 | close_bracket = (token_type == tokenize.OP and text in ']})') |
3616 | 461 | |
462 | # is the indent relative to an opening bracket line? | |
463 | for open_row in reversed(open_rows[depth]): | |
464 | hang = rel_indent[row] - rel_indent[open_row] | |
465 | hanging_indent = hang in valid_hangs | |
466 | if hanging_indent: | |
467 | break | |
468 | if hangs[depth]: | |
469 | hanging_indent = (hang == hangs[depth]) | |
470 | # is there any chance of visual indent? | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
471 | visual_indent = (not close_bracket and hang > 0 and |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
472 | indent_chances.get(start[1])) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
473 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
474 | if close_bracket and indent[depth]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
475 | # closing bracket for visual indent |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
476 | if start[1] != indent[depth]: |
3616 | 477 | yield (start, "E124 closing bracket does not match " |
478 | "visual indentation") | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
479 | elif close_bracket and not hang: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
480 | # closing bracket matches indentation of opening bracket's line |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
481 | if hang_closing: |
3616 | 482 | yield start, "E133 closing bracket is missing indentation" |
483 | elif indent[depth] and start[1] < indent[depth]: | |
484 | if visual_indent is not True: | |
485 | # visual indent is broken | |
486 | yield (start, "E128 continuation line " | |
487 | "under-indented for visual indent") | |
488 | elif hanging_indent or (indent_next and rel_indent[row] == 8): | |
489 | # hanging indent is verified | |
490 | if close_bracket and not hang_closing: | |
491 | yield (start, "E123 closing bracket does not match " | |
492 | "indentation of opening bracket's line") | |
493 | hangs[depth] = hang | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
494 | elif visual_indent is True: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
495 | # visual indent is verified |
3616 | 496 | indent[depth] = start[1] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
497 | elif visual_indent in (text, str): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
498 | # ignore token lined up with matching one from a previous line |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
499 | pass |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
500 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
501 | # indent is broken |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
502 | if hang <= 0: |
3616 | 503 | error = "E122", "missing indentation or outdented" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
504 | elif indent[depth]: |
3616 | 505 | error = "E127", "over-indented for visual indent" |
506 | elif not close_bracket and hangs[depth]: | |
507 | error = "E131", "unaligned for hanging indent" | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
508 | else: |
3616 | 509 | hangs[depth] = hang |
510 | if hang > 4: | |
511 | error = "E126", "over-indented for hanging indent" | |
512 | else: | |
513 | error = "E121", "under-indented for hanging indent" | |
514 | yield start, "%s continuation line %s" % error | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
515 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
516 | # look for visual indenting |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
517 | if (parens[row] and token_type not in (tokenize.NL, tokenize.COMMENT) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
518 | and not indent[depth]): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
519 | indent[depth] = start[1] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
520 | indent_chances[start[1]] = True |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
521 | if verbose >= 4: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
522 | print("bracket depth %s indent to %s" % (depth, start[1])) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
523 | # deal with implicit string concatenation |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
524 | elif (token_type in (tokenize.STRING, tokenize.COMMENT) or |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
525 | text in ('u', 'ur', 'b', 'br')): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
526 | indent_chances[start[1]] = str |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
527 | # special case for the "if" statement because len("if (") == 4 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
528 | elif not indent_chances and not row and not depth and text == 'if': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
529 | indent_chances[end[1] + 1] = True |
3616 | 530 | elif text == ':' and line[end[1]:].isspace(): |
531 | open_rows[depth].append(row) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
532 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
533 | # keep track of bracket depth |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
534 | if token_type == tokenize.OP: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
535 | if text in '([{': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
536 | depth += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
537 | indent.append(0) |
3616 | 538 | hangs.append(None) |
539 | if len(open_rows) == depth: | |
540 | open_rows.append([]) | |
541 | open_rows[depth].append(row) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
542 | parens[row] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
543 | if verbose >= 4: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
544 | print("bracket depth %s seen, col %s, visual min = %s" % |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
545 | (depth, start[1], indent[depth])) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
546 | elif text in ')]}' and depth > 0: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
547 | # parent indents should not be more than this one |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
548 | prev_indent = indent.pop() or last_indent[1] |
3616 | 549 | hangs.pop() |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
550 | for d in range(depth): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
551 | if indent[d] > prev_indent: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
552 | indent[d] = 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
553 | for ind in list(indent_chances): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
554 | if ind >= prev_indent: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
555 | del indent_chances[ind] |
3616 | 556 | del open_rows[depth + 1:] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
557 | depth -= 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
558 | if depth: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
559 | indent_chances[indent[depth]] = True |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
560 | for idx in range(row, -1, -1): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
561 | if parens[idx]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
562 | parens[idx] -= 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
563 | break |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
564 | assert len(indent) == depth + 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
565 | if start[1] not in indent_chances: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
566 | # allow to line up tokens |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
567 | indent_chances[start[1]] = text |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
568 | |
3616 | 569 | if last_token_multiline: |
570 | rel_indent[end[0] - first_row] = rel_indent[row] | |
571 | ||
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
572 | if indent_next and expand_indent(line) == indent_level + 4: |
3616 | 573 | pos = (start[0], indent[0] + 4) |
574 | if visual_indent: | |
575 | code = "E129 visually indented line" | |
576 | else: | |
577 | code = "E125 continuation line" | |
578 | yield pos, "%s with same indent as next logical line" % code | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
579 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
580 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
581 | def whitespace_before_parameters(logical_line, tokens): |
3616 | 582 | r"""Avoid extraneous whitespace. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
583 | |
3616 | 584 | Avoid extraneous whitespace in the following situations: |
585 | - before the open parenthesis that starts the argument list of a | |
586 | function call. | |
587 | - before the open parenthesis that starts an indexing or slicing. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
588 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
589 | Okay: spam(1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
590 | E211: spam (1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
591 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
592 | Okay: dict['key'] = list[index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
593 | E211: dict ['key'] = list[index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
594 | E211: dict['key'] = list [index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
595 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
596 | prev_type, prev_text, __, prev_end, __ = tokens[0] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
597 | for index in range(1, len(tokens)): |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
598 | token_type, text, start, end, __ = tokens[index] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
599 | if (token_type == tokenize.OP and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
600 | text in '([' and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
601 | start != prev_end and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
602 | (prev_type == tokenize.NAME or prev_text in '}])') and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
603 | # Syntax "class A (B):" is allowed, but avoid it |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
604 | (index < 2 or tokens[index - 2][1] != 'class') and |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
605 | # Allow "return (a.foo for a in range(5))" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
606 | not keyword.iskeyword(prev_text)): |
3616 | 607 | yield prev_end, "E211 whitespace before '%s'", text |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
608 | prev_type = token_type |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
609 | prev_text = text |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
610 | prev_end = end |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
611 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
612 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
613 | def whitespace_around_operator(logical_line): |
3616 | 614 | r"""Avoid extraneous whitespace around an operator. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
615 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
616 | Okay: a = 12 + 3 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
617 | E221: a = 4 + 5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
618 | E222: a = 4 + 5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
619 | E223: a = 4\t+ 5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
620 | E224: a = 4 +\t5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
621 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
622 | for match in OPERATOR_REGEX.finditer(logical_line): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
623 | before, after = match.groups() |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
624 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
625 | if '\t' in before: |
3616 | 626 | yield match.start(1), "E223 tab before operator" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
627 | elif len(before) > 1: |
3616 | 628 | yield match.start(1), "E221 multiple spaces before operator" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
629 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
630 | if '\t' in after: |
3616 | 631 | yield match.start(2), "E224 tab after operator" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
632 | elif len(after) > 1: |
3616 | 633 | yield match.start(2), "E222 multiple spaces after operator" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
634 | |
3209
c5432abceb25
CodeStyleChecker moved to background service and done a little cleanup.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3145
diff
changeset
|
635 | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
636 | def missing_whitespace_around_operator(logical_line, tokens): |
3616 | 637 | r"""Surround operators with a single space on either side. |
638 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
639 | - Always surround these binary operators with a single space on |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
640 | either side: assignment (=), augmented assignment (+=, -= etc.), |
3616 | 641 | comparisons (==, <, >, !=, <=, >=, in, not in, is, is not), |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
642 | Booleans (and, or, not). |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
643 | |
3616 | 644 | - If operators with different priorities are used, consider adding |
645 | whitespace around the operators with the lowest priorities. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
646 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
647 | Okay: i = i + 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
648 | Okay: submitted += 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
649 | Okay: x = x * 2 - 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
650 | Okay: hypot2 = x * x + y * y |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
651 | Okay: c = (a + b) * (a - b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
652 | Okay: foo(bar, key='word', *args, **kwargs) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
653 | Okay: alpha[:-i] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
654 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
655 | E225: i=i+1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
656 | E225: submitted +=1 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
657 | E225: x = x /2 - 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
658 | E225: z = x **y |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
659 | E226: c = (a+b) * (a-b) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
660 | E226: hypot2 = x*x + y*y |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
661 | E227: c = a|b |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
662 | E228: msg = fmt%(errno, errmsg) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
663 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
664 | parens = 0 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
665 | need_space = False |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
666 | prev_type = tokenize.OP |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
667 | prev_text = prev_end = None |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
668 | for token_type, text, start, end, line in tokens: |
3616 | 669 | if token_type in SKIP_COMMENTS: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
670 | continue |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
671 | if text in ('(', 'lambda'): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
672 | parens += 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
673 | elif text == ')': |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
674 | parens -= 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
675 | if need_space: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
676 | if start != prev_end: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
677 | # Found a (probably) needed space |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
678 | if need_space is not True and not need_space[1]: |
3616 | 679 | yield (need_space[0], |
680 | "E225 missing whitespace around operator") | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
681 | need_space = False |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
682 | elif text == '>' and prev_text in ('<', '-'): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
683 | # Tolerate the "<>" operator, even if running Python 3 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
684 | # Deal with Python 3's annotated return value "->" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
685 | pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
686 | else: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
687 | if need_space is True or need_space[1]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
688 | # A needed trailing space was not found |
3616 | 689 | yield prev_end, "E225 missing whitespace around operator" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
690 | else: |
3616 | 691 | code, optype = 'E226', 'arithmetic' |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
692 | if prev_text == '%': |
3616 | 693 | code, optype = 'E228', 'modulo' |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
694 | elif prev_text not in ARITHMETIC_OP: |
3616 | 695 | code, optype = 'E227', 'bitwise or shift' |
696 | yield (need_space[0], "%s missing whitespace " | |
697 | "around %s operator" % (code, optype)) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
698 | need_space = False |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
699 | elif token_type == tokenize.OP and prev_end is not None: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
700 | if text == '=' and parens: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
701 | # Allow keyword args or defaults: foo(bar=None). |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
702 | pass |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
703 | elif text in WS_NEEDED_OPERATORS: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
704 | need_space = True |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
705 | elif text in UNARY_OPERATORS: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
706 | # Check if the operator is being used as a binary operator |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
707 | # Allow unary operators: -123, -x, +1. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
708 | # Allow argument unpacking: foo(*args, **kwargs). |
3616 | 709 | if (prev_text in '}])' if prev_type == tokenize.OP |
710 | else prev_text not in KEYWORDS): | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
711 | need_space = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
712 | elif text in WS_OPTIONAL_OPERATORS: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
713 | need_space = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
714 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
715 | if need_space is None: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
716 | # Surrounding space is optional, but ensure that |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
717 | # trailing space matches opening space |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
718 | need_space = (prev_end, start != prev_end) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
719 | elif need_space and start == prev_end: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
720 | # A needed opening space was not found |
3616 | 721 | yield prev_end, "E225 missing whitespace around operator" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
722 | need_space = False |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
723 | prev_type = token_type |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
724 | prev_text = text |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
725 | prev_end = end |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
726 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
727 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
728 | def whitespace_around_comma(logical_line): |
3616 | 729 | r"""Avoid extraneous whitespace after a comma or a colon. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
730 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
731 | Note: these checks are disabled by default |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
732 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
733 | Okay: a = (1, 2) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
734 | E241: a = (1, 2) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
735 | E242: a = (1,\t2) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
736 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
737 | line = logical_line |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
738 | for m in WHITESPACE_AFTER_COMMA_REGEX.finditer(line): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
739 | found = m.start() + 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
740 | if '\t' in m.group(): |
3616 | 741 | yield found, "E242 tab after '%s'", m.group()[0] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
742 | else: |
3616 | 743 | yield found, "E241 multiple spaces after '%s'", m.group()[0] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
744 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
745 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
746 | def whitespace_around_named_parameter_equals(logical_line, tokens): |
3616 | 747 | r"""Don't use spaces around the '=' sign in function arguments. |
748 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
749 | Don't use spaces around the '=' sign when used to indicate a |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
750 | keyword argument or a default parameter value. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
751 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
752 | Okay: def complex(real, imag=0.0): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
753 | Okay: return magic(r=real, i=imag) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
754 | Okay: boolean(a == b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
755 | Okay: boolean(a != b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
756 | Okay: boolean(a <= b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
757 | Okay: boolean(a >= b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
758 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
759 | E251: def complex(real, imag = 0.0): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
760 | E251: return magic(r = real, i = imag) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
761 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
762 | parens = 0 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
763 | no_space = False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
764 | prev_end = None |
3616 | 765 | message = "E251 unexpected spaces around keyword / parameter equals" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
766 | for token_type, text, start, end, line in tokens: |
3616 | 767 | if token_type == tokenize.NL: |
768 | continue | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
769 | if no_space: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
770 | no_space = False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
771 | if start != prev_end: |
3616 | 772 | yield (prev_end, message) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
773 | elif token_type == tokenize.OP: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
774 | if text == '(': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
775 | parens += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
776 | elif text == ')': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
777 | parens -= 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
778 | elif parens and text == '=': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
779 | no_space = True |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
780 | if start != prev_end: |
3616 | 781 | yield (prev_end, message) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
782 | prev_end = end |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
783 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
784 | |
3616 | 785 | def whitespace_before_comment(logical_line, tokens): |
786 | r"""Separate inline comments by at least two spaces. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
787 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
788 | An inline comment is a comment on the same line as a statement. Inline |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
789 | comments should be separated by at least two spaces from the statement. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
790 | They should start with a # and a single space. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
791 | |
3616 | 792 | Each line of a block comment starts with a # and a single space |
793 | (unless it is indented text inside the comment). | |
794 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
795 | Okay: x = x + 1 # Increment x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
796 | Okay: x = x + 1 # Increment x |
3616 | 797 | Okay: # Block comment |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
798 | E261: x = x + 1 # Increment x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
799 | E262: x = x + 1 #Increment x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
800 | E262: x = x + 1 # Increment x |
3616 | 801 | E265: #Block comment |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
802 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
803 | prev_end = (0, 0) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
804 | for token_type, text, start, end, line in tokens: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
805 | if token_type == tokenize.COMMENT: |
3616 | 806 | inline_comment = line[:start[1]].strip() |
807 | if inline_comment: | |
808 | if prev_end[0] == start[0] and start[1] < prev_end[1] + 2: | |
809 | yield (prev_end, | |
810 | "E261 at least two spaces before inline comment") | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
811 | symbol, sp, comment = text.partition(' ') |
3616 | 812 | bad_prefix = symbol not in ('#', '#:') |
813 | if inline_comment: | |
814 | if bad_prefix or comment[:1].isspace(): | |
815 | yield start, "E262 inline comment should start with '# '" | |
816 | elif bad_prefix: | |
817 | if text.rstrip('#') and (start[0] > 1 or symbol[1] != '!'): | |
818 | yield start, "E265 block comment should start with '# '" | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
819 | elif token_type != tokenize.NL: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
820 | prev_end = end |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
821 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
822 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
823 | def imports_on_separate_lines(logical_line): |
3616 | 824 | r"""Imports should usually be on separate lines. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
825 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
826 | Okay: import os\nimport sys |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
827 | E401: import sys, os |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
828 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
829 | Okay: from subprocess import Popen, PIPE |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
830 | Okay: from myclas import MyClass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
831 | Okay: from foo.bar.yourclass import YourClass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
832 | Okay: import myclass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
833 | Okay: import foo.bar.yourclass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
834 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
835 | line = logical_line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
836 | if line.startswith('import '): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
837 | found = line.find(',') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
838 | if -1 < found and ';' not in line[:found]: |
3616 | 839 | yield found, "E401 multiple imports on one line" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
840 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
841 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
842 | def compound_statements(logical_line): |
3616 | 843 | r"""Compound statements (on the same line) are generally discouraged. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
844 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
845 | While sometimes it's okay to put an if/for/while with a small body |
3616 | 846 | on the same line, never do this for multi-clause statements. |
847 | Also avoid folding such long lines! | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
848 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
849 | Okay: if foo == 'blah':\n do_blah_thing() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
850 | Okay: do_one() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
851 | Okay: do_two() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
852 | Okay: do_three() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
853 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
854 | E701: if foo == 'blah': do_blah_thing() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
855 | E701: for x in lst: total += x |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
856 | E701: while t < 10: t = delay() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
857 | E701: if foo == 'blah': do_blah_thing() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
858 | E701: else: do_non_blah_thing() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
859 | E701: try: something() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
860 | E701: finally: cleanup() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
861 | E701: if foo == 'blah': one(); two(); three() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
862 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
863 | E702: do_one(); do_two(); do_three() |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
864 | E703: do_four(); # useless semicolon |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
865 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
866 | line = logical_line |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
867 | last_char = len(line) - 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
868 | found = line.find(':') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
869 | while -1 < found < last_char: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
870 | before = line[:found] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
871 | if (before.count('{') <= before.count('}') and # {'a': 1} (dict) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
872 | before.count('[') <= before.count(']') and # [1:2] (slice) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
873 | before.count('(') <= before.count(')') and # (Python 3 annotation) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
874 | not LAMBDA_REGEX.search(before)): # lambda x: x |
3616 | 875 | yield found, "E701 multiple statements on one line (colon)" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
876 | found = line.find(':', found + 1) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
877 | found = line.find(';') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
878 | while -1 < found: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
879 | if found < last_char: |
3616 | 880 | yield found, "E702 multiple statements on one line (semicolon)" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
881 | else: |
3616 | 882 | yield found, "E703 statement ends with a semicolon" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
883 | found = line.find(';', found + 1) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
884 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
885 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
886 | def explicit_line_join(logical_line, tokens): |
3616 | 887 | r"""Avoid explicit line join between brackets. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
888 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
889 | The preferred way of wrapping long lines is by using Python's implied line |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
890 | continuation inside parentheses, brackets and braces. Long lines can be |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
891 | broken over multiple lines by wrapping expressions in parentheses. These |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
892 | should be used in preference to using a backslash for line continuation. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
893 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
894 | E502: aaa = [123, \\n 123] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
895 | E502: aaa = ("bbb " \\n "ccc") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
896 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
897 | Okay: aaa = [123,\n 123] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
898 | Okay: aaa = ("bbb "\n "ccc") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
899 | Okay: aaa = "bbb " \\n "ccc" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
900 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
901 | prev_start = prev_end = parens = 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
902 | backslash = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
903 | for token_type, text, start, end, line in tokens: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
904 | if start[0] != prev_start and parens and backslash: |
3616 | 905 | yield backslash, "E502 the backslash is redundant between brackets" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
906 | if end[0] != prev_end: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
907 | if line.rstrip('\r\n').endswith('\\'): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
908 | backslash = (end[0], len(line.splitlines()[-1]) - 1) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
909 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
910 | backslash = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
911 | prev_start = prev_end = end[0] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
912 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
913 | prev_start = start[0] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
914 | if token_type == tokenize.OP: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
915 | if text in '([{': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
916 | parens += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
917 | elif text in ')]}': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
918 | parens -= 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
919 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
920 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
921 | def comparison_to_singleton(logical_line, noqa): |
3616 | 922 | r"""Comparison to singletons should use "is" or "is not". |
923 | ||
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
924 | Comparisons to singletons like None should always be done |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
925 | with "is" or "is not", never the equality operators. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
926 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
927 | Okay: if arg is not None: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
928 | E711: if arg != None: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
929 | E712: if arg == True: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
930 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
931 | Also, beware of writing if x when you really mean if x is not None -- |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
932 | e.g. when testing whether a variable or argument that defaults to None was |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
933 | set to some other value. The other value might have a type (such as a |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
934 | container) that could be false in a boolean context! |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
935 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
936 | match = not noqa and COMPARE_SINGLETON_REGEX.search(logical_line) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
937 | if match: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
938 | same = (match.group(1) == '==') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
939 | singleton = match.group(2) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
940 | msg = "'if cond is %s:'" % (('' if same else 'not ') + singleton) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
941 | if singleton in ('None',): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
942 | code = 'E711' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
943 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
944 | code = 'E712' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
945 | nonzero = ((singleton == 'True' and same) or |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
946 | (singleton == 'False' and not same)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
947 | msg += " or 'if %scond:'" % ('' if nonzero else 'not ') |
3616 | 948 | yield (match.start(1), "%s comparison to %s should be %s" % |
949 | (code, singleton, msg), singleton, msg) | |
950 | ||
951 | ||
952 | def comparison_negative(logical_line): | |
953 | r"""Negative comparison should be done using "not in" and "is not". | |
954 | ||
955 | Okay: if x not in y:\n pass | |
956 | Okay: assert (X in Y or X is Z) | |
957 | Okay: if not (X in Y):\n pass | |
958 | Okay: zz = x is not y | |
959 | E713: Z = not X in Y | |
960 | E713: if not X.B in Y:\n pass | |
961 | E714: if not X is Y:\n pass | |
962 | E714: Z = not X.B is Y | |
963 | """ | |
964 | match = COMPARE_NEGATIVE_REGEX.search(logical_line) | |
965 | if match: | |
966 | pos = match.start(1) | |
967 | if match.group(2) == 'in': | |
968 | yield pos, "E713 test for membership should be 'not in'" | |
969 | else: | |
970 | yield pos, "E714 test for object identity should be 'is not'" | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
971 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
972 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
973 | def comparison_type(logical_line): |
3616 | 974 | r"""Object type comparisons should always use isinstance(). |
975 | ||
976 | Do not compare types directly. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
977 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
978 | Okay: if isinstance(obj, int): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
979 | E721: if type(obj) is type(1): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
980 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
981 | When checking if an object is a string, keep in mind that it might be a |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
982 | unicode string too! In Python 2.3, str and unicode have a common base |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
983 | class, basestring, so you can do: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
984 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
985 | Okay: if isinstance(obj, basestring): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
986 | Okay: if type(a1) is type(b1): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
987 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
988 | match = COMPARE_TYPE_REGEX.search(logical_line) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
989 | if match: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
990 | inst = match.group(1) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
991 | if inst and isidentifier(inst) and inst not in SINGLETONS: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
992 | return # Allow comparison for types which are not obvious |
3616 | 993 | yield match.start(), "E721 do not compare types, use 'isinstance()'" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
994 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
995 | |
3616 | 996 | def python_3000_has_key(logical_line, noqa): |
997 | r"""The {}.has_key() method is removed in Python 3: use the 'in' operator. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
998 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
999 | Okay: if "alph" in d:\n print d["alph"] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1000 | W601: assert d.has_key('alph') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1001 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1002 | pos = logical_line.find('.has_key(') |
3616 | 1003 | if pos > -1 and not noqa: |
1004 | yield pos, "W601 .has_key() is deprecated, use 'in'" | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1005 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1006 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1007 | def python_3000_raise_comma(logical_line): |
3616 | 1008 | r"""When raising an exception, use "raise ValueError('message')". |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1009 | |
3616 | 1010 | The older form is removed in Python 3. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1011 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1012 | Okay: raise DummyError("Message") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1013 | W602: raise DummyError, "Message" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1014 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1015 | match = RAISE_COMMA_REGEX.match(logical_line) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1016 | if match and not RERAISE_COMMA_REGEX.match(logical_line): |
3616 | 1017 | yield match.end() - 1, "W602 deprecated form of raising exception" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1018 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1019 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1020 | def python_3000_not_equal(logical_line): |
3616 | 1021 | r"""New code should always use != instead of <>. |
1022 | ||
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1023 | The older syntax is removed in Python 3. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1024 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1025 | Okay: if a != 'no': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1026 | W603: if a <> 'no': |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1027 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1028 | pos = logical_line.find('<>') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1029 | if pos > -1: |
3616 | 1030 | yield pos, "W603 '<>' is deprecated, use '!='" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1031 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1032 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1033 | def python_3000_backticks(logical_line): |
3616 | 1034 | r"""Backticks are removed in Python 3: use repr() instead. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1035 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1036 | Okay: val = repr(1 + 2) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1037 | W604: val = `1 + 2` |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1038 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1039 | pos = logical_line.find('`') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1040 | if pos > -1: |
3616 | 1041 | yield pos, "W604 backticks are deprecated, use 'repr()'" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1042 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1043 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1044 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1045 | # Helper functions |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1046 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1047 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1048 | |
4331
711e7c35a49b
Changed code to make eric compatible to PyQt 5.5 (QByteArry issue).
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4021
diff
changeset
|
1049 | if '' == ''.encode("utf-8"): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1050 | # Python 2: implicit encoding. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1051 | def readlines(filename): |
3616 | 1052 | """Read the source code.""" |
1053 | with open(filename) as f: | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1054 | return f.readlines() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1055 | isidentifier = re.compile(r'[a-zA-Z_]\w*').match |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1056 | stdin_get_value = sys.stdin.read |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1057 | else: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1058 | # Python 3 |
3616 | 1059 | def readlines(filename): |
1060 | """Read the source code.""" | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1061 | try: |
3616 | 1062 | with open(filename, 'rb') as f: |
1063 | (coding, lines) = tokenize.detect_encoding(f.readline) | |
1064 | f = TextIOWrapper(f, coding, line_buffering=True) | |
1065 | return [l.decode(coding) for l in lines] + f.readlines() | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1066 | except (LookupError, SyntaxError, UnicodeError): |
3616 | 1067 | # Fall back if file encoding is improperly declared |
1068 | with open(filename, encoding='latin-1') as f: | |
1069 | return f.readlines() | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1070 | isidentifier = str.isidentifier |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1071 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1072 | def stdin_get_value(): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1073 | return TextIOWrapper(sys.stdin.buffer, errors='ignore').read() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1074 | noqa = re.compile(r'# no(?:qa|pep8)\b', re.I).search |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1075 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1076 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1077 | def expand_indent(line): |
3616 | 1078 | r"""Return the amount of indentation. |
1079 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1080 | Tabs are expanded to the next multiple of 8. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1081 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1082 | >>> expand_indent(' ') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1083 | 4 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1084 | >>> expand_indent('\t') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1085 | 8 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1086 | >>> expand_indent(' \t') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1087 | 8 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1088 | >>> expand_indent(' \t') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1089 | 16 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1090 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1091 | if '\t' not in line: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1092 | return len(line) - len(line.lstrip()) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1093 | result = 0 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1094 | for char in line: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1095 | if char == '\t': |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1096 | result = result // 8 * 8 + 8 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1097 | elif char == ' ': |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1098 | result += 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1099 | else: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1100 | break |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1101 | return result |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1102 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1103 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1104 | def mute_string(text): |
3616 | 1105 | """Replace contents with 'xxx' to prevent syntax matching. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1106 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1107 | >>> mute_string('"abc"') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1108 | '"xxx"' |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1109 | >>> mute_string("'''abc'''") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1110 | "'''xxx'''" |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1111 | >>> mute_string("r'abc'") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1112 | "r'xxx'" |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1113 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1114 | # String modifiers (e.g. u or r) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1115 | start = text.index(text[-1]) + 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1116 | end = len(text) - 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1117 | # Triple quotes |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1118 | if text[-3:] in ('"""', "'''"): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1119 | start += 2 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1120 | end -= 2 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1121 | return text[:start] + 'x' * (end - start) + text[end:] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1122 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1123 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1124 | def parse_udiff(diff, patterns=None, parent='.'): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1125 | """Return a dictionary of matching lines.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1126 | # For each file of the diff, the entry key is the filename, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1127 | # and the value is a set of row numbers to consider. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1128 | rv = {} |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1129 | path = nrows = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1130 | for line in diff.splitlines(): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1131 | if nrows: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1132 | if line[:1] != '-': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1133 | nrows -= 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1134 | continue |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1135 | if line[:3] == '@@ ': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1136 | hunk_match = HUNK_REGEX.match(line) |
3616 | 1137 | (row, nrows) = [int(g or '1') for g in hunk_match.groups()] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1138 | rv[path].update(range(row, row + nrows)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1139 | elif line[:3] == '+++': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1140 | path = line[4:].split('\t', 1)[0] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1141 | if path[:2] == 'b/': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1142 | path = path[2:] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1143 | rv[path] = set() |
3629
98e90f613114
Little change in pep8.py to get rid of a pyflakes warning.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3617
diff
changeset
|
1144 | return dict([(os.path.join(parent, path_), rows) |
98e90f613114
Little change in pep8.py to get rid of a pyflakes warning.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3617
diff
changeset
|
1145 | for (path_, rows) in rv.items() |
98e90f613114
Little change in pep8.py to get rid of a pyflakes warning.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3617
diff
changeset
|
1146 | if rows and filename_match(path_, patterns)]) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1147 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1148 | |
3616 | 1149 | def normalize_paths(value, parent=os.curdir): |
1150 | """Parse a comma-separated list of paths. | |
1151 | ||
1152 | Return a list of absolute paths. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1153 | """ |
3616 | 1154 | if not value or isinstance(value, list): |
1155 | return value | |
1156 | paths = [] | |
1157 | for path in value.split(','): | |
1158 | if '/' in path: | |
1159 | path = os.path.abspath(os.path.join(parent, path)) | |
1160 | paths.append(path.rstrip('/')) | |
1161 | return paths | |
1162 | ||
1163 | ||
1164 | def filename_match(filename, patterns, default=True): | |
1165 | """Check if patterns contains a pattern that matches filename. | |
1166 | ||
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1167 | If patterns is unspecified, this always returns True. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1168 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1169 | if not patterns: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1170 | return default |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1171 | return any(fnmatch(filename, pattern) for pattern in patterns) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1172 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1173 | |
3616 | 1174 | if COMMENT_WITH_NL: |
1175 | def _is_eol_token(token): | |
1176 | return (token[0] in NEWLINE or | |
1177 | (token[0] == tokenize.COMMENT and token[1] == token[4])) | |
1178 | else: | |
1179 | def _is_eol_token(token): | |
1180 | return token[0] in NEWLINE | |
1181 | ||
1182 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1183 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1184 | # Framework to run all checks |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1185 | ############################################################################## |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1186 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1187 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1188 | _checks = {'physical_line': {}, 'logical_line': {}, 'tree': {}} |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1189 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1190 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1191 | def register_check(check, codes=None): |
3616 | 1192 | """Register a new check object.""" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1193 | def _add_check(check, kind, codes, args): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1194 | if check in _checks[kind]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1195 | _checks[kind][check][0].extend(codes or []) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1196 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1197 | _checks[kind][check] = (codes or [''], args) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1198 | if inspect.isfunction(check): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1199 | args = inspect.getargspec(check)[0] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1200 | if args and args[0] in ('physical_line', 'logical_line'): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1201 | if codes is None: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1202 | codes = ERRORCODE_REGEX.findall(check.__doc__ or '') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1203 | _add_check(check, args[0], codes, args) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1204 | elif inspect.isclass(check): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1205 | if inspect.getargspec(check.__init__)[0][:2] == ['self', 'tree']: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1206 | _add_check(check, 'tree', codes, None) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1207 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1208 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1209 | def init_checks_registry(): |
3616 | 1210 | """Register all globally visible functions. |
1211 | ||
1212 | The first argument name is either 'physical_line' or 'logical_line'. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1213 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1214 | mod = inspect.getmodule(register_check) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1215 | for (name, function) in inspect.getmembers(mod, inspect.isfunction): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1216 | register_check(function) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1217 | init_checks_registry() |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1218 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1219 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1220 | class Checker(object): |
3616 | 1221 | """Load a Python source file, tokenize it, check coding style.""" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1222 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1223 | def __init__(self, filename=None, lines=None, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1224 | options=None, report=None, **kwargs): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1225 | if options is None: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1226 | options = StyleGuide(kwargs).options |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1227 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1228 | assert not kwargs |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1229 | self._io_error = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1230 | self._physical_checks = options.physical_checks |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1231 | self._logical_checks = options.logical_checks |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1232 | self._ast_checks = options.ast_checks |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1233 | self.max_line_length = options.max_line_length |
3616 | 1234 | self.multiline = False # in a multiline string? |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1235 | self.hang_closing = options.hang_closing |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1236 | self.verbose = options.verbose |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1237 | self.filename = filename |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1238 | if filename is None: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1239 | self.filename = 'stdin' |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1240 | self.lines = lines or [] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1241 | elif filename == '-': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1242 | self.filename = 'stdin' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1243 | self.lines = stdin_get_value().splitlines(True) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1244 | elif lines is None: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1245 | try: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1246 | self.lines = readlines(filename) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1247 | except IOError: |
3616 | 1248 | (exc_type, exc) = sys.exc_info()[:2] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1249 | self._io_error = '%s: %s' % (exc_type.__name__, exc) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1250 | self.lines = [] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1251 | else: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1252 | self.lines = lines |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1253 | if self.lines: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1254 | ord0 = ord(self.lines[0][0]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1255 | if ord0 in (0xef, 0xfeff): # Strip the UTF-8 BOM |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1256 | if ord0 == 0xfeff: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1257 | self.lines[0] = self.lines[0][1:] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1258 | elif self.lines[0][:3] == '\xef\xbb\xbf': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1259 | self.lines[0] = self.lines[0][3:] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1260 | self.report = report or options.report |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1261 | self.report_error = self.report.error |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1262 | self.report_error_args = self.report.error_args |
2910
cdc56e9d9f12
Optimized the PEP-8 naming checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2899
diff
changeset
|
1263 | |
3670
f0cb7579c0b4
Finished renaming eric5 for PyQt5 to eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3629
diff
changeset
|
1264 | # added for eric6 integration |
2910
cdc56e9d9f12
Optimized the PEP-8 naming checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2899
diff
changeset
|
1265 | self.options = options |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1266 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1267 | def report_invalid_syntax(self): |
3616 | 1268 | """Check if the syntax is valid.""" |
1269 | (exc_type, exc) = sys.exc_info()[:2] | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1270 | if len(exc.args) > 1: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1271 | offset = exc.args[1] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1272 | if len(offset) > 2: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1273 | offset = offset[1:3] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1274 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1275 | offset = (1, 0) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1276 | self.report_error_args(offset[0], offset[1] or 0, |
2899
88d2458a4739
Fixed an issue in the pep8.py checkers.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2866
diff
changeset
|
1277 | 'E901', self.report_invalid_syntax, |
88d2458a4739
Fixed an issue in the pep8.py checkers.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2866
diff
changeset
|
1278 | exc_type.__name__, exc.args[0]) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1279 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1280 | def readline(self): |
3616 | 1281 | """Get the next line from the input buffer.""" |
1282 | if self.line_number >= self.total_lines: | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1283 | return '' |
3616 | 1284 | line = self.lines[self.line_number] |
1285 | self.line_number += 1 | |
1286 | if self.indent_char is None and line[:1] in WHITESPACE: | |
1287 | self.indent_char = line[0] | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1288 | return line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1289 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1290 | def run_check(self, check, argument_names): |
3616 | 1291 | """Run a check plugin.""" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1292 | arguments = [] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1293 | for name in argument_names: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1294 | arguments.append(getattr(self, name)) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1295 | return check(*arguments) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1296 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1297 | def check_physical(self, line): |
3616 | 1298 | """Run all physical checks on a raw input line.""" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1299 | self.physical_line = line |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1300 | for name, check, argument_names in self._physical_checks: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1301 | result = self.run_check(check, argument_names) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1302 | if result is not None: |
3616 | 1303 | (offset, text) = result[:2] |
2607
e5115553185a
Fixes and consolidation for PEP8-checker.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
2302
diff
changeset
|
1304 | args = result[2:] |
3209
c5432abceb25
CodeStyleChecker moved to background service and done a little cleanup.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3145
diff
changeset
|
1305 | self.report_error_args( |
3616 | 1306 | self.line_number, offset, text, check, *args) |
1307 | if text[:4] == 'E101': | |
1308 | self.indent_char = line[0] | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1309 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1310 | def build_tokens_line(self): |
3616 | 1311 | """Build a logical line from tokens.""" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1312 | logical = [] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1313 | comments = [] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1314 | length = 0 |
3616 | 1315 | prev_row = prev_col = mapping = None |
1316 | for token_type, text, start, end, line in self.tokens: | |
1317 | if token_type in SKIP_TOKENS: | |
1318 | continue | |
1319 | if not mapping: | |
1320 | mapping = [(0, start)] | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1321 | if token_type == tokenize.COMMENT: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1322 | comments.append(text) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1323 | continue |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1324 | if token_type == tokenize.STRING: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1325 | text = mute_string(text) |
3616 | 1326 | if prev_row: |
1327 | (start_row, start_col) = start | |
1328 | if prev_row != start_row: # different row | |
1329 | prev_text = self.lines[prev_row - 1][prev_col - 1] | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1330 | if prev_text == ',' or (prev_text not in '{[(' |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1331 | and text not in '}])'): |
3616 | 1332 | text = ' ' + text |
1333 | elif prev_col != start_col: # different column | |
1334 | text = line[prev_col:start_col] + text | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1335 | logical.append(text) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1336 | length += len(text) |
3616 | 1337 | mapping.append((length, end)) |
1338 | (prev_row, prev_col) = end | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1339 | self.logical_line = ''.join(logical) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1340 | self.noqa = comments and noqa(''.join(comments)) |
3616 | 1341 | return mapping |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1342 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1343 | def check_logical(self): |
3616 | 1344 | """Build a line from tokens and run all logical checks on it.""" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1345 | self.report.increment_logical_line() |
3616 | 1346 | mapping = self.build_tokens_line() |
1347 | (start_row, start_col) = mapping[0][1] | |
1348 | start_line = self.lines[start_row - 1] | |
1349 | self.indent_level = expand_indent(start_line[:start_col]) | |
1350 | if self.blank_before < self.blank_lines: | |
1351 | self.blank_before = self.blank_lines | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1352 | if self.verbose >= 2: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1353 | print(self.logical_line[:80].rstrip()) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1354 | for name, check, argument_names in self._logical_checks: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1355 | if self.verbose >= 4: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1356 | print(' ' + name) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1357 | for result in self.run_check(check, argument_names): |
3616 | 1358 | offset, text = result[:2] |
2607
e5115553185a
Fixes and consolidation for PEP8-checker.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
2302
diff
changeset
|
1359 | args = result[2:] |
3616 | 1360 | if not isinstance(offset, tuple): |
1361 | for token_offset, pos in mapping: | |
1362 | if offset <= token_offset: | |
1363 | break | |
1364 | offset = (pos[0], pos[1] + offset - token_offset) | |
3209
c5432abceb25
CodeStyleChecker moved to background service and done a little cleanup.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3145
diff
changeset
|
1365 | self.report_error_args( |
3616 | 1366 | offset[0], offset[1], text, check, *args) |
1367 | if self.logical_line: | |
1368 | self.previous_indent_level = self.indent_level | |
1369 | self.previous_logical = self.logical_line | |
1370 | self.blank_lines = 0 | |
1371 | self.tokens = [] | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1372 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1373 | def check_ast(self): |
3616 | 1374 | """Build the file's AST and run all AST checks.""" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1375 | try: |
3210
8f4fe6f76729
Fixed some dubious code related to AST generation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3160
diff
changeset
|
1376 | tree = compile(''.join(self.lines), '', 'exec', ast.PyCF_ONLY_AST) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1377 | except (SyntaxError, TypeError): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1378 | return self.report_invalid_syntax() |
3616 | 1379 | for name, cls, __ in self._ast_checks: |
3670
f0cb7579c0b4
Finished renaming eric5 for PyQt5 to eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3629
diff
changeset
|
1380 | # extended API for eric6 integration |
2910
cdc56e9d9f12
Optimized the PEP-8 naming checker.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2899
diff
changeset
|
1381 | checker = cls(tree, self.filename, self.options) |
2911 | 1382 | for args in checker.run(): |
3056
9986ec0e559a
Merge with default branch before style changes.
T.Rzepka <Tobias.Rzepka@gmail.com>
diff
changeset
|
1383 | lineno = args[0] |
3616 | 1384 | if not self.lines or not noqa(self.lines[lineno - 1]): |
3056
9986ec0e559a
Merge with default branch before style changes.
T.Rzepka <Tobias.Rzepka@gmail.com>
diff
changeset
|
1385 | self.report_error_args(lineno, *args[1:]) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1386 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1387 | def generate_tokens(self): |
3616 | 1388 | """Tokenize the file, run physical line checks and yield tokens.""" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1389 | if self._io_error: |
3616 | 1390 | self.report_error_args(1, 0, 'E902', self._io_error, readlines) |
1391 | tokengen = tokenize.generate_tokens(self.readline) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1392 | try: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1393 | for token in tokengen: |
3616 | 1394 | self.maybe_check_physical(token) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1395 | yield token |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1396 | except (SyntaxError, tokenize.TokenError): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1397 | self.report_invalid_syntax() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1398 | |
3616 | 1399 | def maybe_check_physical(self, token): |
1400 | """If appropriate (based on token), check current physical line(s).""" | |
1401 | # Called after every token, but act only on end of line. | |
1402 | if _is_eol_token(token): | |
1403 | # Obviously, a newline token ends a single physical line. | |
1404 | self.check_physical(token[4]) | |
1405 | elif token[0] == tokenize.STRING and '\n' in token[1]: | |
1406 | # Less obviously, a string that contains newlines is a | |
1407 | # multiline string, either triple-quoted or with internal | |
1408 | # newlines backslash-escaped. Check every physical line in the | |
1409 | # string *except* for the last one: its newline is outside of | |
1410 | # the multiline string, so we consider it a regular physical | |
1411 | # line, and will check it like any other physical line. | |
1412 | # | |
1413 | # Subtleties: | |
1414 | # - we don't *completely* ignore the last line; if it contains | |
1415 | # the magical "# noqa" comment, we disable all physical | |
1416 | # checks for the entire multiline string | |
1417 | # - have to wind self.line_number back because initially it | |
1418 | # points to the last line of the string, and we want | |
1419 | # check_physical() to give accurate feedback | |
1420 | if noqa(token[4]): | |
1421 | return | |
1422 | self.multiline = True | |
1423 | self.line_number = token[2][0] | |
1424 | for line in token[1].split('\n')[:-1]: | |
1425 | self.check_physical(line + '\n') | |
1426 | self.line_number += 1 | |
1427 | self.multiline = False | |
1428 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1429 | def check_all(self, expected=None, line_offset=0): |
3616 | 1430 | """Run all checks on the input file.""" |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1431 | self.report.init_file(self.filename, self.lines, expected, line_offset) |
3616 | 1432 | self.total_lines = len(self.lines) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1433 | if self._ast_checks: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1434 | self.check_ast() |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1435 | self.line_number = 0 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1436 | self.indent_char = None |
3616 | 1437 | self.indent_level = self.previous_indent_level = 0 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1438 | self.previous_logical = '' |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1439 | self.tokens = [] |
3616 | 1440 | self.blank_lines = self.blank_before = 0 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1441 | parens = 0 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1442 | for token in self.generate_tokens(): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1443 | self.tokens.append(token) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1444 | token_type, text = token[0:2] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1445 | if self.verbose >= 3: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1446 | if token[2][0] == token[3][0]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1447 | pos = '[%s:%s]' % (token[2][1] or '', token[3][1]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1448 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1449 | pos = 'l.%s' % token[3][0] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1450 | print('l.%s\t%s\t%s\t%r' % |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1451 | (token[2][0], pos, tokenize.tok_name[token[0]], text)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1452 | if token_type == tokenize.OP: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1453 | if text in '([{': |
2799
ec8c717e80f5
Fixed an issue in the pep8 checker tokenising a bad file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2302
diff
changeset
|
1454 | parens += 1 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1455 | elif text in '}])': |
2799
ec8c717e80f5
Fixed an issue in the pep8 checker tokenising a bad file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2302
diff
changeset
|
1456 | parens -= 1 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1457 | elif not parens: |
3616 | 1458 | if token_type in NEWLINE: |
1459 | if token_type == tokenize.NEWLINE: | |
1460 | self.check_logical() | |
1461 | self.blank_before = 0 | |
1462 | elif len(self.tokens) == 1: | |
2799
ec8c717e80f5
Fixed an issue in the pep8 checker tokenising a bad file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2302
diff
changeset
|
1463 | # The physical line contains only this token. |
ec8c717e80f5
Fixed an issue in the pep8 checker tokenising a bad file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2302
diff
changeset
|
1464 | self.blank_lines += 1 |
3616 | 1465 | del self.tokens[0] |
1466 | else: | |
1467 | self.check_logical() | |
1468 | elif COMMENT_WITH_NL and token_type == tokenize.COMMENT: | |
1469 | if len(self.tokens) == 1: | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1470 | # The comment also ends a physical line |
3616 | 1471 | token = list(token) |
1472 | token[1] = text.rstrip('\r\n') | |
1473 | token[3] = (token[2][0], token[2][1] + len(token[1])) | |
1474 | self.tokens = [tuple(token)] | |
1475 | self.check_logical() | |
1476 | if len(self.tokens) > 1 and (token_type == tokenize.ENDMARKER and | |
1477 | self.tokens[-2][0] not in SKIP_TOKENS): | |
1478 | self.tokens.pop() | |
1479 | self.check_physical(self.tokens[-1][4]) | |
1480 | self.check_logical() | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1481 | return self.report.get_file_results() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1482 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1483 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1484 | class BaseReport(object): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1485 | """Collect the results of the checks.""" |
3616 | 1486 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1487 | print_filename = False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1488 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1489 | def __init__(self, options): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1490 | self._benchmark_keys = options.benchmark_keys |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1491 | self._ignore_code = options.ignore_code |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1492 | # Results |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1493 | self.elapsed = 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1494 | self.total_errors = 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1495 | self.counters = dict.fromkeys(self._benchmark_keys, 0) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1496 | self.messages = {} |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1497 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1498 | def start(self): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1499 | """Start the timer.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1500 | self._start_time = time.time() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1501 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1502 | def stop(self): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1503 | """Stop the timer.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1504 | self.elapsed = time.time() - self._start_time |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1505 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1506 | def init_file(self, filename, lines, expected, line_offset): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1507 | """Signal a new file.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1508 | self.filename = filename |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1509 | self.lines = lines |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1510 | self.expected = expected or () |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1511 | self.line_offset = line_offset |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1512 | self.file_errors = 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1513 | self.counters['files'] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1514 | self.counters['physical lines'] += len(lines) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1515 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1516 | def increment_logical_line(self): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1517 | """Signal a new logical line.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1518 | self.counters['logical lines'] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1519 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1520 | def error(self, line_number, offset, text, check): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1521 | """Report an error, according to options.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1522 | code = text[:4] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1523 | if self._ignore_code(code): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1524 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1525 | if code in self.counters: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1526 | self.counters[code] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1527 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1528 | self.counters[code] = 1 |
3413
5e63f809732a
Code style checker: Translations extracted and refactored.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3209
diff
changeset
|
1529 | self.messages[code] = [] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1530 | # Don't care about expected errors or warnings |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1531 | if code in self.expected: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1532 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1533 | if self.print_filename and not self.file_errors: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1534 | print(self.filename) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1535 | self.file_errors += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1536 | self.total_errors += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1537 | return code |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1538 | |
3616 | 1539 | def error_args(self, line_number, offset, text, check, *args): |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1540 | """Report an error, according to options.""" |
3616 | 1541 | code = text[:4] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1542 | if self._ignore_code(code): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1543 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1544 | if code in self.counters: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1545 | self.counters[code] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1546 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1547 | self.counters[code] = 1 |
3413
5e63f809732a
Code style checker: Translations extracted and refactored.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3209
diff
changeset
|
1548 | self.messages[code] = args |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1549 | # Don't care about expected errors or warnings |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1550 | if code in self.expected: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1551 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1552 | if self.print_filename and not self.file_errors: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1553 | print(self.filename) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1554 | self.file_errors += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1555 | self.total_errors += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1556 | return code |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1557 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1558 | def get_file_results(self): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1559 | """Return the count of errors and warnings for this file.""" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1560 | return self.file_errors |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1561 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1562 | def get_count(self, prefix=''): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1563 | """Return the total count of errors and warnings.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1564 | return sum([self.counters[key] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1565 | for key in self.messages if key.startswith(prefix)]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1566 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1567 | def get_statistics(self, prefix=''): |
3616 | 1568 | """Get statistics for message codes that start with the prefix. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1569 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1570 | prefix='' matches all errors and warnings |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1571 | prefix='E' matches all errors |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1572 | prefix='W' matches all warnings |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1573 | prefix='E4' matches all errors that have to do with imports |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1574 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1575 | return ['%-7s %s %s' % (self.counters[key], key, self.messages[key]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1576 | for key in sorted(self.messages) if key.startswith(prefix)] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1577 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1578 | def print_statistics(self, prefix=''): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1579 | """Print overall statistics (number of errors and warnings).""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1580 | for line in self.get_statistics(prefix): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1581 | print(line) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1582 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1583 | def print_benchmark(self): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1584 | """Print benchmark numbers.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1585 | print('%-7.2f %s' % (self.elapsed, 'seconds elapsed')) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1586 | if self.elapsed: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1587 | for key in self._benchmark_keys: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1588 | print('%-7d %s per second (%d total)' % |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1589 | (self.counters[key] / self.elapsed, key, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1590 | self.counters[key])) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1591 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1592 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1593 | class FileReport(BaseReport): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1594 | """Collect the results of the checks and print only the filenames.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1595 | print_filename = True |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1596 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1597 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1598 | class StandardReport(BaseReport): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1599 | """Collect and print the results of the checks.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1600 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1601 | def __init__(self, options): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1602 | super(StandardReport, self).__init__(options) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1603 | self._fmt = REPORT_FORMAT.get(options.format.lower(), |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1604 | options.format) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1605 | self._repeat = options.repeat |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1606 | self._show_source = options.show_source |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1607 | self._show_pep8 = options.show_pep8 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1608 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1609 | def init_file(self, filename, lines, expected, line_offset): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1610 | """Signal a new file.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1611 | self._deferred_print = [] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1612 | return super(StandardReport, self).init_file( |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1613 | filename, lines, expected, line_offset) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1614 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1615 | def error(self, line_number, offset, text, check): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1616 | """Report an error, according to options.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1617 | code = super(StandardReport, self).error(line_number, offset, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1618 | text, check) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1619 | if code and (self.counters[code] == 1 or self._repeat): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1620 | self._deferred_print.append( |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1621 | (line_number, offset, code, text[5:], check.__doc__)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1622 | return code |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1623 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1624 | def error_args(self, line_number, offset, code, check, *args): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1625 | """Report an error, according to options.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1626 | code = super(StandardReport, self).error_args(line_number, offset, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1627 | code, check, *args) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1628 | if code and (self.counters[code] == 1 or self._repeat): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1629 | self._deferred_print.append( |
3413
5e63f809732a
Code style checker: Translations extracted and refactored.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3209
diff
changeset
|
1630 | (line_number, offset, code, args, check.__doc__)) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1631 | return code |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1632 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1633 | def get_file_results(self): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1634 | """Print the result and return the overall count for this file.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1635 | self._deferred_print.sort() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1636 | for line_number, offset, code, text, doc in self._deferred_print: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1637 | print(self._fmt % { |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1638 | 'path': self.filename, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1639 | 'row': self.line_offset + line_number, 'col': offset + 1, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1640 | 'code': code, 'text': text, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1641 | }) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1642 | if self._show_source: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1643 | if line_number > len(self.lines): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1644 | line = '' |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1645 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1646 | line = self.lines[line_number - 1] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1647 | print(line.rstrip()) |
3616 | 1648 | print(re.sub(r'\S', ' ', line[:offset]) + '^') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1649 | if self._show_pep8 and doc: |
3616 | 1650 | print(' ' + doc.strip()) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1651 | return self.file_errors |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1652 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1653 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1654 | class DiffReport(StandardReport): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1655 | """Collect and print the results for the changed lines only.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1656 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1657 | def __init__(self, options): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1658 | super(DiffReport, self).__init__(options) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1659 | self._selected = options.selected_lines |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1660 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1661 | def error(self, line_number, offset, text, check): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1662 | if line_number not in self._selected[self.filename]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1663 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1664 | return super(DiffReport, self).error(line_number, offset, text, check) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1665 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1666 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1667 | class StyleGuide(object): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1668 | """Initialize a PEP-8 instance with few options.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1669 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1670 | def __init__(self, *args, **kwargs): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1671 | # build options from the command line |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1672 | self.checker_class = kwargs.pop('checker_class', Checker) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1673 | parse_argv = kwargs.pop('parse_argv', False) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1674 | config_file = kwargs.pop('config_file', None) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1675 | parser = kwargs.pop('parser', None) |
3616 | 1676 | # build options from dict |
1677 | options_dict = dict(*args, **kwargs) | |
1678 | arglist = None if parse_argv else options_dict.get('paths', None) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1679 | options, self.paths = process_options( |
3616 | 1680 | arglist, parse_argv, config_file, parser) |
1681 | if options_dict: | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1682 | options.__dict__.update(options_dict) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1683 | if 'paths' in options_dict: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1684 | self.paths = options_dict['paths'] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1685 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1686 | self.runner = self.input_file |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1687 | self.options = options |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1688 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1689 | if not options.reporter: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1690 | options.reporter = BaseReport if options.quiet else StandardReport |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1691 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1692 | options.select = tuple(options.select or ()) |
3617
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1693 | # if not (options.select or options.ignore or |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1694 | # options.testsuite or options.doctest) and DEFAULT_IGNORE: |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1695 | # # The default choice: ignore controversial checks |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1696 | # options.ignore = tuple(DEFAULT_IGNORE.split(',')) |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1697 | # else: |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1698 | # Ignore all checks which are not explicitly selected or all if no |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1699 | # check is ignored or explicitly selected |
2f859c5dcfb4
Avoid fallback to default ignore list if not messages explicitly selected or ignored
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3616
diff
changeset
|
1700 | options.ignore = ('',) if options.select else tuple(options.ignore) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1701 | options.benchmark_keys = BENCHMARK_KEYS[:] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1702 | options.ignore_code = self.ignore_code |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1703 | options.physical_checks = self.get_checks('physical_line') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1704 | options.logical_checks = self.get_checks('logical_line') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1705 | options.ast_checks = self.get_checks('tree') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1706 | self.init_report() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1707 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1708 | def init_report(self, reporter=None): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1709 | """Initialize the report instance.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1710 | self.options.report = (reporter or self.options.reporter)(self.options) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1711 | return self.options.report |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1712 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1713 | def check_files(self, paths=None): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1714 | """Run all checks on the paths.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1715 | if paths is None: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1716 | paths = self.paths |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1717 | report = self.options.report |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1718 | runner = self.runner |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1719 | report.start() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1720 | try: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1721 | for path in paths: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1722 | if os.path.isdir(path): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1723 | self.input_dir(path) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1724 | elif not self.excluded(path): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1725 | runner(path) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1726 | except KeyboardInterrupt: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1727 | print('... stopped') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1728 | report.stop() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1729 | return report |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1730 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1731 | def input_file(self, filename, lines=None, expected=None, line_offset=0): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1732 | """Run all checks on a Python source file.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1733 | if self.options.verbose: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1734 | print('checking %s' % filename) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1735 | fchecker = self.checker_class( |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1736 | filename, lines=lines, options=self.options) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1737 | return fchecker.check_all(expected=expected, line_offset=line_offset) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1738 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1739 | def input_dir(self, dirname): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1740 | """Check all files in this directory and all subdirectories.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1741 | dirname = dirname.rstrip('/') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1742 | if self.excluded(dirname): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1743 | return 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1744 | counters = self.options.report.counters |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1745 | verbose = self.options.verbose |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1746 | filepatterns = self.options.filename |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1747 | runner = self.runner |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1748 | for root, dirs, files in os.walk(dirname): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1749 | if verbose: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1750 | print('directory ' + root) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1751 | counters['directories'] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1752 | for subdir in sorted(dirs): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1753 | if self.excluded(subdir, root): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1754 | dirs.remove(subdir) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1755 | for filename in sorted(files): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1756 | # contain a pattern that matches? |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1757 | if ((filename_match(filename, filepatterns) and |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1758 | not self.excluded(filename, root))): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1759 | runner(os.path.join(root, filename)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1760 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1761 | def excluded(self, filename, parent=None): |
3616 | 1762 | """Check if the file should be excluded. |
1763 | ||
1764 | Check if 'options.exclude' contains a pattern that matches filename. | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1765 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1766 | if not self.options.exclude: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1767 | return False |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1768 | basename = os.path.basename(filename) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1769 | if filename_match(basename, self.options.exclude): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1770 | return True |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1771 | if parent: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1772 | filename = os.path.join(parent, filename) |
3616 | 1773 | filename = os.path.abspath(filename) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1774 | return filename_match(filename, self.options.exclude) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1775 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1776 | def ignore_code(self, code): |
3616 | 1777 | """Check if the error code should be ignored. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1778 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1779 | If 'options.select' contains a prefix of the error code, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1780 | return False. Else, if 'options.ignore' contains a prefix of |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1781 | the error code, return True. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1782 | """ |
3616 | 1783 | if len(code) < 4 and any(s.startswith(code) |
1784 | for s in self.options.select): | |
1785 | return False | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1786 | return (code.startswith(self.options.ignore) and |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1787 | not code.startswith(self.options.select)) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1788 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1789 | def get_checks(self, argument_name): |
3616 | 1790 | """Get all the checks for this category. |
1791 | ||
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1792 | Find all globally visible functions where the first argument name |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1793 | starts with argument_name and which contain selected tests. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1794 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1795 | checks = [] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1796 | for check, attrs in _checks[argument_name].items(): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1797 | (codes, args) = attrs |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1798 | if any(not (code and self.ignore_code(code)) for code in codes): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1799 | checks.append((check.__name__, check, args)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1800 | return sorted(checks) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1801 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1802 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1803 | def get_parser(prog='pep8', version=__version__): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1804 | parser = OptionParser(prog=prog, version=version, |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1805 | usage="%prog [options] input ...") |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1806 | parser.config_options = [ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1807 | 'exclude', 'filename', 'select', 'ignore', 'max-line-length', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1808 | 'hang-closing', 'count', 'format', 'quiet', 'show-pep8', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1809 | 'show-source', 'statistics', 'verbose'] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1810 | parser.add_option('-v', '--verbose', default=0, action='count', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1811 | help="print status messages, or debug with -vv") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1812 | parser.add_option('-q', '--quiet', default=0, action='count', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1813 | help="report only file names, or nothing with -qq") |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1814 | parser.add_option('-r', '--repeat', default=True, action='store_true', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1815 | help="(obsolete) show all occurrences of the same error") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1816 | parser.add_option('--first', action='store_false', dest='repeat', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1817 | help="show first occurrence of each error") |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1818 | parser.add_option('--exclude', metavar='patterns', default=DEFAULT_EXCLUDE, |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1819 | help="exclude files or directories which match these " |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1820 | "comma separated patterns (default: %default)") |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1821 | parser.add_option('--filename', metavar='patterns', default='*.py', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1822 | help="when parsing directories, only check filenames " |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1823 | "matching these comma separated patterns " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1824 | "(default: %default)") |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1825 | parser.add_option('--select', metavar='errors', default='', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1826 | help="select errors and warnings (e.g. E,W6)") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1827 | parser.add_option('--ignore', metavar='errors', default='', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1828 | help="skip errors and warnings (e.g. E4,W)") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1829 | parser.add_option('--show-source', action='store_true', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1830 | help="show source code for each error") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1831 | parser.add_option('--show-pep8', action='store_true', |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1832 | help="show text of PEP 8 for each error " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1833 | "(implies --first)") |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1834 | parser.add_option('--statistics', action='store_true', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1835 | help="count errors and warnings") |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1836 | parser.add_option('--count', action='store_true', |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1837 | help="print total number of errors and warnings " |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1838 | "to standard error and set exit code to 1 if " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1839 | "total is not null") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1840 | parser.add_option('--max-line-length', type='int', metavar='n', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1841 | default=MAX_LINE_LENGTH, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1842 | help="set maximum allowed line length " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1843 | "(default: %default)") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1844 | parser.add_option('--hang-closing', action='store_true', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1845 | help="hang closing bracket instead of matching " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1846 | "indentation of opening bracket's line") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1847 | parser.add_option('--format', metavar='format', default='default', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1848 | help="set the error format [default|pylint|<custom>]") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1849 | parser.add_option('--diff', action='store_true', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1850 | help="report only lines changed according to the " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1851 | "unified diff received on STDIN") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1852 | group = parser.add_option_group("Testing Options") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1853 | if os.path.exists(TESTSUITE_PATH): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1854 | group.add_option('--testsuite', metavar='dir', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1855 | help="run regression tests from dir") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1856 | group.add_option('--doctest', action='store_true', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1857 | help="run doctest on myself") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1858 | group.add_option('--benchmark', action='store_true', |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1859 | help="measure processing speed") |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1860 | return parser |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1861 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1862 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1863 | def read_config(options, args, arglist, parser): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1864 | """Read both user configuration and local configuration.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1865 | config = RawConfigParser() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1866 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1867 | user_conf = options.config |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1868 | if user_conf and os.path.isfile(user_conf): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1869 | if options.verbose: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1870 | print('user configuration: %s' % user_conf) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1871 | config.read(user_conf) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1872 | |
3616 | 1873 | local_dir = os.curdir |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1874 | parent = tail = args and os.path.abspath(os.path.commonprefix(args)) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1875 | while tail: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1876 | if config.read([os.path.join(parent, fn) for fn in PROJECT_CONFIG]): |
3616 | 1877 | local_dir = parent |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1878 | if options.verbose: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1879 | print('local configuration: in %s' % parent) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1880 | break |
3616 | 1881 | (parent, tail) = os.path.split(parent) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1882 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1883 | pep8_section = parser.prog |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1884 | if config.has_section(pep8_section): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1885 | option_list = dict([(o.dest, o.type or o.action) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1886 | for o in parser.option_list]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1887 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1888 | # First, read the default values |
3616 | 1889 | (new_options, __) = parser.parse_args([]) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1890 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1891 | # Second, parse the configuration |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1892 | for opt in config.options(pep8_section): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1893 | if options.verbose > 1: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1894 | print(" %s = %s" % (opt, config.get(pep8_section, opt))) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1895 | if opt.replace('_', '-') not in parser.config_options: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1896 | print("Unknown option: '%s'\n not in [%s]" % |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1897 | (opt, ' '.join(parser.config_options))) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1898 | sys.exit(1) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1899 | normalized_opt = opt.replace('-', '_') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1900 | opt_type = option_list[normalized_opt] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1901 | if opt_type in ('int', 'count'): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1902 | value = config.getint(pep8_section, opt) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1903 | elif opt_type == 'string': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1904 | value = config.get(pep8_section, opt) |
3616 | 1905 | if normalized_opt == 'exclude': |
1906 | value = normalize_paths(value, local_dir) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1907 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1908 | assert opt_type in ('store_true', 'store_false') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1909 | value = config.getboolean(pep8_section, opt) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1910 | setattr(new_options, normalized_opt, value) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1911 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1912 | # Third, overwrite with the command-line options |
3616 | 1913 | (options, __) = parser.parse_args(arglist, values=new_options) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1914 | options.doctest = options.testsuite = False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1915 | return options |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1916 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1917 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1918 | def process_options(arglist=None, parse_argv=False, config_file=None, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1919 | parser=None): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1920 | """Process options passed either via arglist or via command line args.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1921 | if not parser: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1922 | parser = get_parser() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1923 | if not parser.has_option('--config'): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1924 | if config_file is True: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1925 | config_file = DEFAULT_CONFIG |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1926 | group = parser.add_option_group("Configuration", description=( |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1927 | "The project options are read from the [%s] section of the " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1928 | "tox.ini file or the setup.cfg file located in any parent folder " |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1929 | "of the path(s) being processed. Allowed options are: %s." % |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1930 | (parser.prog, ', '.join(parser.config_options)))) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1931 | group.add_option('--config', metavar='path', default=config_file, |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1932 | help="user config file location (default: %default)") |
3616 | 1933 | # Don't read the command line if the module is used as a library. |
1934 | if not arglist and not parse_argv: | |
1935 | arglist = [] | |
1936 | # If parse_argv is True and arglist is None, arguments are | |
1937 | # parsed from the command line (sys.argv) | |
1938 | (options, args) = parser.parse_args(arglist) | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1939 | options.reporter = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1940 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1941 | if options.ensure_value('testsuite', False): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1942 | args.append(options.testsuite) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1943 | elif not options.ensure_value('doctest', False): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1944 | if parse_argv and not args: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1945 | if options.diff or any(os.path.exists(name) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1946 | for name in PROJECT_CONFIG): |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1947 | args = ['.'] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1948 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1949 | parser.error('input not specified') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1950 | options = read_config(options, args, arglist, parser) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1951 | options.reporter = parse_argv and options.quiet == 1 and FileReport |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1952 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1953 | options.filename = options.filename and options.filename.split(',') |
3616 | 1954 | options.exclude = normalize_paths(options.exclude) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1955 | options.select = options.select and options.select.split(',') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1956 | options.ignore = options.ignore and options.ignore.split(',') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1957 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1958 | if options.diff: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1959 | options.reporter = DiffReport |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1960 | stdin = stdin_get_value() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1961 | options.selected_lines = parse_udiff(stdin, options.filename, args[0]) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1962 | args = sorted(options.selected_lines) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1963 | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1964 | return options, args |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1965 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1966 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1967 | def _main(): |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1968 | """Parse options and run checks on Python source.""" |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1969 | pep8style = StyleGuide(parse_argv=True, config_file=True) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1970 | options = pep8style.options |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1971 | if options.doctest or options.testsuite: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1972 | from testsuite.support import run_tests |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1973 | report = run_tests(pep8style) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1974 | else: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1975 | report = pep8style.check_files() |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1976 | if options.statistics: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1977 | report.print_statistics() |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1978 | if options.benchmark: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1979 | report.print_benchmark() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1980 | if options.testsuite and not options.quiet: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1981 | report.print_results() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1982 | if report.total_errors: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1983 | if options.count: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1984 | sys.stderr.write(str(report.total_errors) + '\n') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1985 | sys.exit(1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1986 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1987 | if __name__ == '__main__': |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1988 | _main() |