Wed, 30 Dec 2020 11:00:44 +0100
Updated copyright for 2021.
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 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
4 | # pycodestyle.py - Check Python source code formatting, according to |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
5 | # PEP 8 |
5288
ff831e3e383e
Update pycodestyle to official 2.1.0 version.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5147
diff
changeset
|
6 | # |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
7 | # Copyright (C) 2006-2009 Johann C. Rocholl <johann@rocholl.net> |
3616 | 8 | # Copyright (C) 2009-2014 Florent Xicluna <florent.xicluna@gmail.com> |
4828 | 9 | # Copyright (C) 2014-2016 Ian Lee <ianlee1521@gmail.com> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | # 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
|
12 | # 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
|
13 | # (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
|
14 | # 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
|
15 | # 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
|
16 | # 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
|
17 | # subject to the following conditions: |
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 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
|
20 | # 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
|
21 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | # 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
|
23 | # 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
|
24 | # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | # 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
|
26 | # 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
|
27 | # 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
|
28 | # 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
|
29 | # SOFTWARE. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | |
3616 | 31 | r""" |
32 | 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
|
33 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | For usage and a list of options, try this: |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
35 | $ python pycodestyle.py -h |
832
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 | This program and its regression test suite live here: |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
38 | https://github.com/pycqa/pycodestyle |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | Groups of errors and warnings: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | E errors |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | W warnings |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | 100 indentation |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | 200 whitespace |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | 300 blank lines |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | 400 imports |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | 500 line length |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | 600 deprecation |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | 700 statements |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
50 | 900 syntax error |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | # |
6733
519422827ace
Some minor modifications to Tobias' contribution.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6732
diff
changeset
|
54 | # This is a modified version to make the original pycodestyle.py better |
519422827ace
Some minor modifications to Tobias' contribution.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6732
diff
changeset
|
55 | # suitable for being called from within the eric6 IDE. The modifications |
519422827ace
Some minor modifications to Tobias' contribution.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6732
diff
changeset
|
56 | # are as follows: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | # |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | # - made messages translatable via Qt |
3670
f0cb7579c0b4
Finished renaming eric5 for PyQt5 to eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
3629
diff
changeset
|
59 | # - added code for eric6 integration |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | # |
7924
8a96736d465e
Updated copyright for 2021.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7836
diff
changeset
|
61 | # Copyright (c) 2011 - 2021 Detlev Offenbach <detlev@die-offenbachs.de> |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | # |
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 inspect |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | import keyword |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
66 | import os |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
67 | import re |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
68 | import sys |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
69 | import time |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | import tokenize |
5288
ff831e3e383e
Update pycodestyle to official 2.1.0 version.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5147
diff
changeset
|
71 | import warnings |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
72 | import bisect |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
73 | |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
74 | try: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
75 | from functools import lru_cache |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
76 | except ImportError: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
77 | def lru_cache(maxsize=128): # noqa as it's a fake implementation. |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
78 | """Does not really need a real a lru_cache, it's just |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
79 | optimization, so let's just do nothing here. Python 3.2+ will |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
80 | just get better performances, time to upgrade? |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
81 | """ |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
82 | return lambda function: function |
5288
ff831e3e383e
Update pycodestyle to official 2.1.0 version.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5147
diff
changeset
|
83 | |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
84 | from fnmatch import fnmatch |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
85 | from optparse import OptionParser |
5288
ff831e3e383e
Update pycodestyle to official 2.1.0 version.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5147
diff
changeset
|
86 | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | try: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
88 | from configparser import RawConfigParser |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
89 | from io import TextIOWrapper |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
90 | except ImportError: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
91 | from ConfigParser import RawConfigParser # __IGNORE_WARNING__ |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92 | |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
93 | __version__ = '2.6.0-eric' |
4828 | 94 | |
95 | DEFAULT_EXCLUDE = '.svn,CVS,.bzr,.hg,.git,__pycache__,.tox' | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
96 | DEFAULT_IGNORE = 'E121,E123,E126,E226,E24,E704,W503,W504' |
4828 | 97 | try: |
98 | if sys.platform == 'win32': | |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
99 | USER_CONFIG = os.path.expanduser(r'~\.pycodestyle') |
4828 | 100 | else: |
101 | USER_CONFIG = os.path.join( | |
102 | os.getenv('XDG_CONFIG_HOME') or os.path.expanduser('~/.config'), | |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
103 | 'pycodestyle' |
4828 | 104 | ) |
105 | except ImportError: | |
106 | USER_CONFIG = None | |
107 | ||
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
108 | PROJECT_CONFIG = ('setup.cfg', 'tox.ini') |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
109 | 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
|
110 | MAX_LINE_LENGTH = 79 |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
111 | # Number of blank lines between various code parts. |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
112 | BLANK_LINES_CONFIG = { |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
113 | # Top level class and function. |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
114 | 'top_level': 2, |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
115 | # Methods and nested class and function. |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
116 | 'method': 1, |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
117 | } |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
118 | MAX_DOC_LENGTH = 72 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
119 | REPORT_FORMAT = { |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
120 | '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
|
121 | '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
|
122 | } |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
123 | |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
124 | PyCF_ONLY_AST = 1024 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
125 | SINGLETONS = frozenset(['False', 'None', 'True']) |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
126 | KEYWORDS = frozenset(keyword.kwlist + ['print', 'async']) - SINGLETONS |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
127 | UNARY_OPERATORS = frozenset(['>>', '**', '*', '+', '-']) |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
128 | ARITHMETIC_OP = frozenset(['**', '*', '/', '//', '+', '-', '@']) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
129 | WS_OPTIONAL_OPERATORS = ARITHMETIC_OP.union(['^', '&', '|', '<<', '>>', '%']) |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
130 | # Warn for -> function annotation operator in py3.5+ (issue 803) |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
131 | FUNCTION_RETURN_ANNOTATION_OP = ['->'] if sys.version_info >= (3, 5) else [] |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
132 | ASSIGNMENT_EXPRESSION_OP = [':='] if sys.version_info >= (3, 8) else [] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
133 | WS_NEEDED_OPERATORS = frozenset([ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
134 | '**=', '*=', '/=', '//=', '+=', '-=', '!=', '<>', '<', '>', |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
135 | '%=', '^=', '&=', '|=', '==', '<=', '>=', '<<=', '>>=', '=', |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
136 | 'and', 'in', 'is', 'or'] + |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
137 | FUNCTION_RETURN_ANNOTATION_OP + |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
138 | ASSIGNMENT_EXPRESSION_OP) |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
139 | WHITESPACE = frozenset(' \t') |
3616 | 140 | NEWLINE = frozenset([tokenize.NL, tokenize.NEWLINE]) |
141 | SKIP_TOKENS = NEWLINE.union([tokenize.INDENT, tokenize.DEDENT]) | |
142 | # ERRORTOKEN is triggered by backticks in Python 3 | |
143 | 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
|
144 | 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
|
145 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
146 | 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
|
147 | RAISE_COMMA_REGEX = re.compile(r'raise\s+\w+\s*,') |
3616 | 148 | 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
|
149 | 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
|
150 | DOCSTRING_REGEX = re.compile(r'u?r?["\']') |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
151 | 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
|
152 | WHITESPACE_AFTER_COMMA_REGEX = re.compile(r'[,;:]\s*(?: |\t)') |
4828 | 153 | COMPARE_SINGLETON_REGEX = re.compile(r'(\bNone|\bFalse|\bTrue)?\s*([=!]=)' |
154 | r'\s*(?(1)|(None|False|True))\b') | |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
155 | COMPARE_NEGATIVE_REGEX = re.compile(r'\b(?<!is\s)(not)\s+[^][)(}{ ]+\s+' |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
156 | r'(in|is)\s') |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
157 | COMPARE_TYPE_REGEX = re.compile(r'(?:[=!]=|is(?:\s+not)?)\s+type(?:s.\w+Type' |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
158 | r'|\s*\(\s*([^)]*[^ )])\s*\))') |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
159 | 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
|
160 | 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
|
161 | 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
|
162 | HUNK_REGEX = re.compile(r'^@@ -\d+(?:,\d+)? \+(\d+)(?:,(\d+))? @@.*$') |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
163 | STARTSWITH_DEF_REGEX = re.compile(r'^(async\s+def|def)\b') |
5509
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
164 | STARTSWITH_TOP_LEVEL_REGEX = re.compile(r'^(async\s+def\s+|def\s+|class\s+|@)') |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
165 | STARTSWITH_INDENT_STATEMENT_REGEX = re.compile( |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
166 | r'^\s*({0})\b'.format('|'.join(s.replace(' ', r'\s+') for s in ( |
5509
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
167 | 'def', 'async def', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
168 | 'for', 'async for', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
169 | 'if', 'elif', 'else', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
170 | 'try', 'except', 'finally', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
171 | 'with', 'async with', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
172 | 'class', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
173 | 'while', |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
174 | ))) |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
175 | ) |
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
176 | DUNDER_REGEX = re.compile(r'^__([^\s]+)__ = ') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
177 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
178 | _checks = {'physical_line': {}, 'logical_line': {}, 'tree': {}} |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
179 | |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
180 | |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
181 | def _get_parameters(function): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
182 | if sys.version_info >= (3, 3): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
183 | return [parameter.name |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
184 | for parameter |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
185 | in inspect.signature(function).parameters.values() |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
186 | if parameter.kind == parameter.POSITIONAL_OR_KEYWORD] |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
187 | else: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
188 | return inspect.getargspec(function)[0] |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
189 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
190 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
191 | def register_check(check, codes=None): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
192 | """Register a new check object.""" |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
193 | def _add_check(check, kind, codes, args): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
194 | if check in _checks[kind]: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
195 | _checks[kind][check][0].extend(codes or []) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
196 | else: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
197 | _checks[kind][check] = (codes or [''], args) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
198 | if inspect.isfunction(check): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
199 | args = _get_parameters(check) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
200 | if args and args[0] in ('physical_line', 'logical_line'): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
201 | if codes is None: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
202 | codes = ERRORCODE_REGEX.findall(check.__doc__ or '') |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
203 | _add_check(check, args[0], codes, args) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
204 | elif inspect.isclass(check): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
205 | if _get_parameters(check.__init__)[:2] == ['self', 'tree']: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
206 | _add_check(check, 'tree', codes, None) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
207 | return check |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
208 | |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
209 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
210 | ######################################################################## |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
211 | # Plugins (check functions) for physical lines |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
212 | ######################################################################## |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
213 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
214 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
215 | def tabs_or_spaces(physical_line, indent_char): |
3616 | 216 | r"""Never mix tabs and spaces. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
217 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
218 | The most popular way of indenting Python is with spaces only. The |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
219 | second-most popular way is with tabs only. Code indented with a |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
220 | mixture of tabs and spaces should be converted to using spaces |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
221 | exclusively. When invoking the Python command line interpreter with |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
222 | the -t option, it issues warnings about code that illegally mixes |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
223 | tabs and spaces. When using -tt these warnings become errors. |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
224 | These options are highly recommended! |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
225 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
226 | Okay: if a == 0:\n a = 1\n b = 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
227 | 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
|
228 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
229 | 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
|
230 | for offset, char in enumerate(indent): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
231 | if char != indent_char: |
3616 | 232 | 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
|
233 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
234 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
235 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
236 | def tabs_obsolete(physical_line): |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
237 | r"""On 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
|
238 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
239 | Okay: if True:\n return |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
240 | W191: if True:\n\treturn |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
241 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
242 | 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
|
243 | if '\t' in indent: |
3616 | 244 | 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
|
245 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
246 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
247 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
248 | def trailing_whitespace(physical_line): |
3616 | 249 | r"""Trailing whitespace is superfluous. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
250 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
251 | The warning returned varies on whether the line itself is blank, |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
252 | for easier filtering for those who want to indent their blank lines. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
253 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
254 | Okay: spam(1)\n# |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
255 | W291: spam(1) \n# |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
256 | 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
|
257 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
258 | 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
|
259 | 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
|
260 | 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
|
261 | stripped = physical_line.rstrip(' \t\v') |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
262 | if physical_line != stripped: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
263 | if stripped: |
3616 | 264 | return len(stripped), "W291 trailing whitespace" |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
265 | else: |
3616 | 266 | 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
|
267 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
268 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
269 | @register_check |
3616 | 270 | def trailing_blank_lines(physical_line, lines, line_number, total_lines): |
271 | r"""Trailing blank lines are superfluous. | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
272 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
273 | Okay: spam(1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
274 | W391: spam(1)\n |
3616 | 275 | |
276 | 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
|
277 | """ |
3616 | 278 | if line_number == total_lines: |
279 | stripped_last_line = physical_line.rstrip() | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
280 | if physical_line and not stripped_last_line: |
3616 | 281 | return 0, "W391 blank line at end of file" |
282 | if stripped_last_line == physical_line: | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
283 | return len(lines[-1]), "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
|
284 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
285 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
286 | @register_check |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
287 | def maximum_line_length(physical_line, max_line_length, multiline, |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
288 | line_number, noqa): |
3616 | 289 | 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
|
290 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
291 | There are still many devices around that are limited to 80 character |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
292 | lines; plus, limiting windows to 80 characters makes it possible to |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
293 | have several windows side-by-side. The default wrapping on such |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
294 | devices looks ugly. Therefore, please limit all lines to a maximum |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
295 | of 79 characters. For flowing long blocks of text (docstrings or |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
296 | comments), limiting the 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
|
297 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
298 | Reports error E501. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
299 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
300 | line = physical_line.rstrip() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
301 | length = len(line) |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
302 | if length > max_line_length and not noqa: |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
303 | # Special case: ignore long shebang lines. |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
304 | if line_number == 1 and line.startswith('#!'): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
305 | return |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
306 | # Special case for long URLs in multi-line docstrings or |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
307 | # comments, but still report the error when the 72 first chars |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
308 | # are whitespaces. |
3616 | 309 | chunks = line.split() |
310 | if ((len(chunks) == 1 and multiline) or | |
311 | (len(chunks) == 2 and chunks[0] == '#')) and \ | |
312 | len(line) - len(chunks[-1]) < max_line_length - 7: | |
313 | return | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
314 | if hasattr(line, 'decode'): # Python 2 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
315 | # 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
|
316 | try: |
1145
2a16484e65c2
Fix for the PEP-8 checker to handle unicode better.
detlev@die-offenbachs.de
parents:
945
diff
changeset
|
317 | 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
|
318 | except UnicodeError: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
319 | pass |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
320 | if length > max_line_length: |
4828 | 321 | return (max_line_length, "E501 line too long " |
322 | "(%d > %d characters)" % (length, max_line_length), | |
323 | length, max_line_length) | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
324 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
325 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
326 | ######################################################################## |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
327 | # Plugins (check functions) for logical lines |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
328 | ######################################################################## |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
329 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
330 | |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
331 | def _is_one_liner(logical_line, indent_level, lines, line_number): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
332 | if not STARTSWITH_TOP_LEVEL_REGEX.match(logical_line): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
333 | return False |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
334 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
335 | line_idx = line_number - 1 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
336 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
337 | if line_idx < 1: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
338 | prev_indent = 0 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
339 | else: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
340 | prev_indent = expand_indent(lines[line_idx - 1]) |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
341 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
342 | if prev_indent > indent_level: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
343 | return False |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
344 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
345 | while line_idx < len(lines): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
346 | line = lines[line_idx].strip() |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
347 | if not line.startswith('@') and STARTSWITH_TOP_LEVEL_REGEX.match(line): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
348 | break |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
349 | else: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
350 | line_idx += 1 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
351 | else: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
352 | return False # invalid syntax: EOF while searching for def/class |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
353 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
354 | next_idx = line_idx + 1 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
355 | while next_idx < len(lines): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
356 | if lines[next_idx].strip(): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
357 | break |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
358 | else: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
359 | next_idx += 1 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
360 | else: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
361 | return True # line is last in the file |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
362 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
363 | return expand_indent(lines[next_idx]) <= indent_level |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
364 | |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
365 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
366 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
367 | def blank_lines(logical_line, blank_lines, indent_level, line_number, |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
368 | blank_before, previous_logical, |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
369 | previous_unindented_logical_line, previous_indent_level, |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
370 | lines): |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
371 | r"""Separate top-level function and class definitions with two blank |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
372 | lines. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
373 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
374 | Method definitions inside a class are separated by a single blank |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
375 | line. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
376 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
377 | Extra blank lines may be used (sparingly) to separate groups of |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
378 | related functions. Blank lines may be omitted between a bunch of |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
379 | related one-liners (e.g. a set of dummy implementations). |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
380 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
381 | Use blank lines in functions, sparingly, to indicate logical |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
382 | sections. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
383 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
384 | Okay: def a():\n pass\n\n\ndef b():\n pass |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
385 | Okay: def a():\n pass\n\n\nasync def b():\n pass |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
386 | Okay: def a():\n pass\n\n\n# Foo\n# Bar\n\ndef b():\n pass |
5303
83ab5275f255
Take over pull request #593 to ignore variables starting with "def" or "class" on code E305.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5290
diff
changeset
|
387 | Okay: default = 1\nfoo = 1 |
83ab5275f255
Take over pull request #593 to ignore variables starting with "def" or "class" on code E305.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5290
diff
changeset
|
388 | Okay: classify = 1\nfoo = 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
389 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
390 | 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
|
391 | E302: def a():\n pass\n\ndef b(n):\n pass |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
392 | E302: def a():\n pass\n\nasync def b(n):\n pass |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
393 | E303: def a():\n pass\n\n\n\ndef b(n):\n pass |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
394 | E303: def a():\n\n\n\n pass |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
395 | E304: @decorator\n\ndef a():\n pass |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
396 | E305: def a():\n pass\na() |
5509
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
397 | E306: def a():\n def b():\n pass\n def c():\n pass |
6263
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
398 | E307: def a():\n def b():\n pass\n\n\n def c():\n pass |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
399 | E308: def a():\n\n\n\n pass |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
400 | """ # noqa |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
401 | top_level_lines = BLANK_LINES_CONFIG['top_level'] |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
402 | method_lines = BLANK_LINES_CONFIG['method'] |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
403 | |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
404 | if not previous_logical and blank_before < top_level_lines: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
405 | 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
|
406 | 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
|
407 | if blank_lines: |
3616 | 408 | yield 0, "E304 blank lines found after function decorator" |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
409 | elif (blank_lines > top_level_lines or |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
410 | (indent_level and blank_lines == method_lines + 1) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
411 | ): |
6263
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
412 | if indent_level: |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
413 | if previous_logical.strip().startswith(('def ', 'class ')): |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
414 | yield (0, "E308 too many blank lines (%d)", blank_lines) |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
415 | else: |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
416 | yield (0, "E307 too many blank lines (%d) in a nested " |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
417 | "scope, expected %d", blank_lines, method_lines) |
6263
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
418 | else: |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
419 | yield (0, "E303 too many blank lines (%d), expected %d", |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
420 | blank_lines, top_level_lines) |
5509
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
421 | elif STARTSWITH_TOP_LEVEL_REGEX.match(logical_line): |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
422 | # allow a group of one-liners |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
423 | if ( |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
424 | _is_one_liner(logical_line, indent_level, lines, line_number) and |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
425 | blank_before == 0 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
426 | ): |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
427 | return |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
428 | if indent_level: |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
429 | if not (blank_before == method_lines or |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
430 | previous_indent_level < indent_level or |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
431 | DOCSTRING_REGEX.match(previous_logical) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
432 | ): |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
433 | ancestor_level = indent_level |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
434 | nested = False |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
435 | # Search backwards for a def ancestor or tree root |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
436 | # (top level). |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
437 | for line in lines[line_number - top_level_lines::-1]: |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
438 | if line.strip() and expand_indent(line) < ancestor_level: |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
439 | ancestor_level = expand_indent(line) |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
440 | nested = STARTSWITH_DEF_REGEX.match(line.lstrip()) |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
441 | if nested or ancestor_level == 0: |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
442 | break |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
443 | if nested: |
6263
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
444 | yield (0, "E306 expected %s blank lines before a " |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
445 | "nested definition, found %d", method_lines, |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
446 | blank_before) |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
447 | else: |
6263
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
448 | yield (0, "E301 expected %s blank lines, found %d", |
4dd53711d869
pycodestyle.py: enhanced the 'blank lines before' test to make the reported errors more specific (introduced new error codes E307 and E308)
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
6246
diff
changeset
|
449 | method_lines, blank_before) |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
450 | elif blank_before != top_level_lines: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
451 | yield (0, "E302 expected %s blank lines, found %d", |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
452 | top_level_lines, blank_before) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
453 | elif (logical_line and |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
454 | not indent_level and |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
455 | blank_before != top_level_lines and |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
456 | previous_unindented_logical_line.startswith(('def ', 'class ')) |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
457 | ): |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
458 | yield (0, "E305 expected %s blank lines after " \ |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
459 | "class or function definition, found %d", |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
460 | top_level_lines, blank_before) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
461 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
462 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
463 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
464 | def extraneous_whitespace(logical_line): |
3616 | 465 | r"""Avoid extraneous whitespace. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
466 | |
3616 | 467 | Avoid extraneous whitespace in these situations: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
468 | - Immediately inside parentheses, brackets or braces. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
469 | - Immediately before a comma, semicolon, or colon. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
470 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
471 | Okay: spam(ham[1], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
472 | E201: spam( ham[1], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
473 | E201: spam(ham[ 1], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
474 | E201: spam(ham[1], { eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
475 | E202: spam(ham[1], {eggs: 2} ) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
476 | E202: spam(ham[1 ], {eggs: 2}) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
477 | E202: spam(ham[1], {eggs: 2 }) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
478 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
479 | 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
|
480 | 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
|
481 | 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
|
482 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
483 | line = logical_line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
484 | 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
|
485 | text = match.group() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
486 | char = text.strip() |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
487 | found = match.start() |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
488 | if text == char + ' ': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
489 | # assert char in '([{' |
3616 | 490 | 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
|
491 | elif line[found - 1] != ',': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
492 | code = ('E202' if char in '}])' else 'E203') # if char in ',;:' |
3616 | 493 | 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
|
494 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
495 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
496 | @register_check |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
497 | def whitespace_around_keywords(logical_line): |
3616 | 498 | 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
|
499 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
500 | Okay: True and False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
501 | E271: True and False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
502 | E272: True and False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
503 | E273: True and\tFalse |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
504 | E274: True\tand False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
505 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
506 | 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
|
507 | before, after = match.groups() |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
508 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
509 | if '\t' in before: |
3616 | 510 | 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
|
511 | elif len(before) > 1: |
3616 | 512 | 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
|
513 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
514 | if '\t' in after: |
3616 | 515 | 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
|
516 | elif len(after) > 1: |
3616 | 517 | 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
|
518 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
519 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
520 | @register_check |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
521 | def missing_whitespace_after_import_keyword(logical_line): |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
522 | r"""Multiple imports in form from x import (a, b, c) should have |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
523 | space between import statement and parenthesised name list. |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
524 | |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
525 | Okay: from foo import (bar, baz) |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
526 | E275: from foo import(bar, baz) |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
527 | E275: from importable.module import(bar, baz) |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
528 | """ |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
529 | line = logical_line |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
530 | indicator = ' import(' |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
531 | if line.startswith('from '): |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
532 | found = line.find(indicator) |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
533 | if -1 < found: |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
534 | pos = found + len(indicator) - 1 |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
535 | yield pos, "E275 missing whitespace after keyword" |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
536 | |
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
537 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
538 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
539 | def missing_whitespace(logical_line): |
3616 | 540 | 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
|
541 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
542 | Okay: [a, b] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
543 | Okay: (3,) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
544 | Okay: a[1:4] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
545 | Okay: a[:4] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
546 | Okay: a[1:] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
547 | Okay: a[1:4:2] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
548 | E231: ['a','b'] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
549 | 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
|
550 | E231: [{'a':'b'}] |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
551 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
552 | line = logical_line |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
553 | for index in range(len(line) - 1): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
554 | char = line[index] |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
555 | next_char = line[index + 1] |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
556 | if char in ',;:' and next_char not in WHITESPACE: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
557 | before = line[:index] |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
558 | 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
|
559 | before.rfind('{') < before.rfind('['): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
560 | continue # Slice syntax, no space required |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
561 | if char == ',' and next_char == ')': |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
562 | continue # Allow tuple with only one element: (3,) |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
563 | if char == ':' and next_char == '=' and sys.version_info >= (3, 8): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
564 | continue # Allow assignment expression |
3616 | 565 | 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
|
566 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
567 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
568 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
569 | 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
|
570 | indent_level, previous_indent_level): |
3616 | 571 | 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
|
572 | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
573 | For really old code that you don't want to mess up, you can continue |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
574 | to use 8-space tabs. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
575 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
576 | Okay: a = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
577 | Okay: if a == 0:\n a = 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
578 | E111: a = 1 |
4828 | 579 | E114: # a = 1 |
832
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 | Okay: for item in items:\n pass |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
582 | E112: for item in items:\npass |
4828 | 583 | E115: for item in items:\n# Hi\n pass |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
584 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
585 | Okay: a = 1\nb = 2 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
586 | E113: a = 1\n b = 2 |
4828 | 587 | E116: a = 1\n # b = 2 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
588 | """ |
4828 | 589 | c = 0 if logical_line else 3 |
590 | tmpl = "E11%d %s" if logical_line else "E11%d %s (comment)" | |
591 | if indent_level % 4: | |
592 | yield 0, tmpl % (1 + c, "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
|
593 | indent_expect = previous_logical.endswith(':') |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
594 | if indent_expect and indent_level <= previous_indent_level: |
4828 | 595 | yield 0, tmpl % (2 + c, "expected an indented block") |
596 | elif not indent_expect and indent_level > previous_indent_level: | |
597 | yield 0, tmpl % (3 + c, "unexpected indentation") | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
598 | |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
599 | if indent_expect: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
600 | expected_indent_amount = 8 if indent_char == '\t' else 4 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
601 | expected_indent_level = previous_indent_level + expected_indent_amount |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
602 | if indent_level > expected_indent_level: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
603 | yield 0, tmpl % (7, 'over-indented') |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
604 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
605 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
606 | @register_check |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
607 | def continued_indentation(logical_line, tokens, indent_level, hang_closing, |
3616 | 608 | indent_char, noqa, verbose): |
609 | 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
|
610 | |
3616 | 611 | Continuation lines should align wrapped elements either vertically |
612 | using Python's implicit line joining inside parentheses, brackets | |
613 | 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
|
614 | |
3616 | 615 | 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
|
616 | - there should be no arguments on the first line, and |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
617 | - further indentation should be used to clearly distinguish itself |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
618 | as a continuation line. |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
619 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
620 | Okay: a = (\n) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
621 | E123: a = (\n ) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
622 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
623 | Okay: a = (\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
624 | E121: a = (\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
625 | E122: a = (\n42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
626 | 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
|
627 | E124: a = (24,\n 42\n) |
3616 | 628 | 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
|
629 | E126: a = (\n 42) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
630 | 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
|
631 | E128: a = (24,\n 42) |
3616 | 632 | E129: if (a or\n b):\n pass |
633 | 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
|
634 | """ |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
635 | 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
|
636 | 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
|
637 | 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
|
638 | return |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
639 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
640 | # 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
|
641 | # 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
|
642 | # 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
|
643 | # 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
|
644 | 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
|
645 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
646 | row = depth = 0 |
3616 | 647 | 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
|
648 | # 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
|
649 | parens = [0] * nrows |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
650 | # 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
|
651 | rel_indent = [0] * nrows |
3616 | 652 | # for each depth, collect a list of opening rows |
653 | open_rows = [[0]] | |
654 | # for each depth, memorize the hanging indentation | |
655 | hangs = [None] | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
656 | # visual indents |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
657 | indent_chances = {} |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
658 | last_indent = tokens[0][2] |
3616 | 659 | visual_indent = None |
4828 | 660 | last_token_multiline = False |
3616 | 661 | # 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
|
662 | indent = [last_indent[1]] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
663 | if verbose >= 3: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
664 | 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
|
665 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
666 | 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
|
667 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
668 | 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
|
669 | if newline: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
670 | row = start[0] - first_row |
3616 | 671 | 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
|
672 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
673 | if newline: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
674 | # 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
|
675 | last_indent = start |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
676 | if verbose >= 3: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
677 | print("... " + line.rstrip()) |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
678 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
679 | # record the initial indent. |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
680 | 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
|
681 | |
3616 | 682 | # identify closing bracket |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
683 | close_bracket = (token_type == tokenize.OP and text in ']})') |
3616 | 684 | |
685 | # is the indent relative to an opening bracket line? | |
686 | for open_row in reversed(open_rows[depth]): | |
687 | hang = rel_indent[row] - rel_indent[open_row] | |
688 | hanging_indent = hang in valid_hangs | |
689 | if hanging_indent: | |
690 | break | |
691 | if hangs[depth]: | |
692 | hanging_indent = (hang == hangs[depth]) | |
693 | # 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
|
694 | 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
|
695 | 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
|
696 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
697 | 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
|
698 | # 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
|
699 | if start[1] != indent[depth]: |
3616 | 700 | yield (start, "E124 closing bracket does not match " |
701 | "visual indentation") | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
702 | elif close_bracket and not hang: |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
703 | # closing bracket matches indentation of opening |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
704 | # bracket's line |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
705 | if hang_closing: |
3616 | 706 | yield start, "E133 closing bracket is missing indentation" |
707 | elif indent[depth] and start[1] < indent[depth]: | |
708 | if visual_indent is not True: | |
709 | # visual indent is broken | |
710 | yield (start, "E128 continuation line " | |
711 | "under-indented for visual indent") | |
712 | elif hanging_indent or (indent_next and rel_indent[row] == 8): | |
713 | # hanging indent is verified | |
714 | if close_bracket and not hang_closing: | |
715 | yield (start, "E123 closing bracket does not match " | |
716 | "indentation of opening bracket's line") | |
717 | hangs[depth] = hang | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
718 | 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
|
719 | # visual indent is verified |
3616 | 720 | 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
|
721 | elif visual_indent in (text, str): |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
722 | # ignore token lined up with matching one from a |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
723 | # previous line |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
724 | pass |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
725 | else: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
726 | # indent is broken |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
727 | if hang <= 0: |
3616 | 728 | 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
|
729 | elif indent[depth]: |
3616 | 730 | error = "E127", "over-indented for visual indent" |
731 | elif not close_bracket and hangs[depth]: | |
732 | 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
|
733 | else: |
3616 | 734 | hangs[depth] = hang |
735 | if hang > 4: | |
736 | error = "E126", "over-indented for hanging indent" | |
737 | else: | |
738 | error = "E121", "under-indented for hanging indent" | |
739 | 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
|
740 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
741 | # look for visual indenting |
4828 | 742 | if (parens[row] and |
743 | token_type not in (tokenize.NL, tokenize.COMMENT) and | |
744 | not indent[depth]): | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
745 | indent[depth] = start[1] |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
746 | 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
|
747 | if verbose >= 4: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
748 | 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
|
749 | # 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
|
750 | 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
|
751 | 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
|
752 | indent_chances[start[1]] = str |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
753 | # visual indent after assert/raise/with |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
754 | elif not row and not depth and text in ["assert", "raise", "with"]: |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
755 | indent_chances[end[1] + 1] = True |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
756 | # 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
|
757 | 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
|
758 | indent_chances[end[1] + 1] = True |
3616 | 759 | elif text == ':' and line[end[1]:].isspace(): |
760 | 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
|
761 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
762 | # 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
|
763 | 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
|
764 | if text in '([{': |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
765 | depth += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
766 | indent.append(0) |
3616 | 767 | hangs.append(None) |
768 | if len(open_rows) == depth: | |
769 | open_rows.append([]) | |
770 | 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
|
771 | parens[row] += 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
772 | if verbose >= 4: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
773 | 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
|
774 | (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
|
775 | 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
|
776 | # 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
|
777 | prev_indent = indent.pop() or last_indent[1] |
3616 | 778 | hangs.pop() |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
779 | 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
|
780 | 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
|
781 | indent[d] = 0 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
782 | 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
|
783 | if ind >= prev_indent: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
784 | del indent_chances[ind] |
3616 | 785 | 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
|
786 | depth -= 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
787 | if depth: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
788 | 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
|
789 | 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
|
790 | if parens[idx]: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
791 | parens[idx] -= 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
792 | break |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
793 | 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
|
794 | if start[1] not in indent_chances: |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
795 | # allow lining up tokens |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
796 | 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
|
797 | |
4828 | 798 | last_token_multiline = (start[0] != end[0]) |
3616 | 799 | if last_token_multiline: |
800 | rel_indent[end[0] - first_row] = rel_indent[row] | |
801 | ||
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
802 | if indent_next and expand_indent(line) == indent_level + 4: |
3616 | 803 | pos = (start[0], indent[0] + 4) |
804 | if visual_indent: | |
805 | code = "E129 visually indented line" | |
806 | else: | |
807 | code = "E125 continuation line" | |
808 | 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
|
809 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
810 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
811 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
812 | def whitespace_before_parameters(logical_line, tokens): |
3616 | 813 | r"""Avoid extraneous whitespace. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
814 | |
3616 | 815 | Avoid extraneous whitespace in the following situations: |
816 | - before the open parenthesis that starts the argument list of a | |
817 | function call. | |
818 | - 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
|
819 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
820 | Okay: spam(1) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
821 | E211: spam (1) |
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 | Okay: dict['key'] = list[index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
824 | E211: dict ['key'] = list[index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
825 | E211: dict['key'] = list [index] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
826 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
827 | 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
|
828 | 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
|
829 | 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
|
830 | if (token_type == tokenize.OP and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
831 | text in '([' and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
832 | start != prev_end and |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
833 | (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
|
834 | # 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
|
835 | (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
|
836 | # 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
|
837 | not keyword.iskeyword(prev_text)): |
3616 | 838 | 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
|
839 | prev_type = token_type |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
840 | prev_text = text |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
841 | prev_end = end |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
842 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
843 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
844 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
845 | def whitespace_around_operator(logical_line): |
3616 | 846 | 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
|
847 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
848 | Okay: a = 12 + 3 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
849 | E221: a = 4 + 5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
850 | E222: a = 4 + 5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
851 | E223: a = 4\t+ 5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
852 | E224: a = 4 +\t5 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
853 | """ |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
854 | 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
|
855 | before, after = match.groups() |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
856 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
857 | if '\t' in before: |
3616 | 858 | 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
|
859 | elif len(before) > 1: |
3616 | 860 | 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
|
861 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
862 | if '\t' in after: |
3616 | 863 | 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
|
864 | elif len(after) > 1: |
3616 | 865 | 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
|
866 | |
3209
c5432abceb25
CodeStyleChecker moved to background service and done a little cleanup.
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
3145
diff
changeset
|
867 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
868 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
869 | def missing_whitespace_around_operator(logical_line, tokens): |
3616 | 870 | r"""Surround operators with a single space on either side. |
871 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
872 | - 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
|
873 | either side: assignment (=), augmented assignment (+=, -= etc.), |
3616 | 874 | 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
|
875 | Booleans (and, or, not). |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
876 | |
3616 | 877 | - If operators with different priorities are used, consider adding |
878 | 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
|
879 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
880 | Okay: i = i + 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
881 | Okay: submitted += 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
882 | Okay: x = x * 2 - 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
883 | Okay: hypot2 = x * x + y * y |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
884 | Okay: c = (a + b) * (a - b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
885 | Okay: foo(bar, key='word', *args, **kwargs) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
886 | Okay: alpha[:-i] |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
887 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
888 | E225: i=i+1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
889 | E225: submitted +=1 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
890 | E225: x = x /2 - 1 |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
891 | E225: z = x **y |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
892 | E225: z = 1and 1 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
893 | 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
|
894 | 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
|
895 | E227: c = a|b |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
896 | E228: msg = fmt%(errno, errmsg) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
897 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
898 | parens = 0 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
899 | need_space = False |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
900 | prev_type = tokenize.OP |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
901 | prev_text = prev_end = None |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
902 | operator_types = (tokenize.OP, tokenize.NAME) |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
903 | for token_type, text, start, end, line in tokens: |
3616 | 904 | if token_type in SKIP_COMMENTS: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
905 | continue |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
906 | if text in ('(', 'lambda'): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
907 | parens += 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
908 | elif text == ')': |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
909 | parens -= 1 |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
910 | if need_space: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
911 | 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
|
912 | # 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
|
913 | if need_space is not True and not need_space[1]: |
3616 | 914 | yield (need_space[0], |
915 | "E225 missing whitespace around operator") | |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
916 | need_space = False |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
917 | elif text == '>' and prev_text in ('<', '-'): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
918 | # 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
|
919 | # 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
|
920 | pass |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
921 | elif ( |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
922 | # def f(a, /, b): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
923 | # ^ |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
924 | # def f(a, b, /): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
925 | # ^ |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
926 | prev_text == '/' and text in {',', ')'} or |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
927 | # def f(a, b, /): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
928 | # ^ |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
929 | prev_text == ')' and text == ':' |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
930 | ): |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
931 | # Tolerate the "/" operator in function definition |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
932 | # For more info see PEP570 |
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
933 | pass |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
934 | else: |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
935 | 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
|
936 | # A needed trailing space was not found |
3616 | 937 | yield prev_end, "E225 missing whitespace around operator" |
4828 | 938 | elif prev_text != '**': |
3616 | 939 | 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
|
940 | if prev_text == '%': |
3616 | 941 | 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
|
942 | elif prev_text not in ARITHMETIC_OP: |
3616 | 943 | code, optype = 'E227', 'bitwise or shift' |
944 | yield (need_space[0], "%s missing whitespace " | |
945 | "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
|
946 | need_space = False |
7620
52c2fe0308fd
Code Style Checker: updated pycodestyle to version 2.6.0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
7360
diff
changeset
|
947 | elif token_type in operator_types and prev_end is not None: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
948 | if text == '=' and parens: |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
949 | # 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
|
950 | pass |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
951 | elif text in WS_NEEDED_OPERATORS: |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
952 | need_space = True |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
953 | elif text in UNARY_OPERATORS: |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
954 | # Check if the operator is used as a binary operator |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
955 | # Allow unary operators: -123, -x, +1. |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
956 | # Allow argument unpacking: foo(*args, **kwargs). |
3616 | 957 | if (prev_text in '}])' if prev_type == tokenize.OP |
958 | 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
|
959 | need_space = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
960 | 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
|
961 | need_space = None |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
962 | |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
963 | 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
|
964 | # 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
|
965 | # 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
|
966 | 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
|
967 | 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
|
968 | # A needed opening space was not found |
3616 | 969 | 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
|
970 | need_space = False |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
971 | prev_type = token_type |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
972 | prev_text = text |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
973 | prev_end = end |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
974 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
975 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
976 | @register_check |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
977 | def whitespace_around_comma(logical_line): |
3616 | 978 | 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
|
979 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
980 | Note: these checks are disabled by default |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
981 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
982 | Okay: a = (1, 2) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
983 | E241: a = (1, 2) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
984 | E242: a = (1,\t2) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
985 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
986 | line = logical_line |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
987 | 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
|
988 | found = m.start() + 1 |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
989 | if '\t' in m.group(): |
3616 | 990 | 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
|
991 | else: |
3616 | 992 | 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
|
993 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
994 | |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
995 | @register_check |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
996 | def whitespace_around_named_parameter_equals(logical_line, tokens): |
3616 | 997 | r"""Don't use spaces around the '=' sign in function arguments. |
998 | ||
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
999 | Don't use spaces around the '=' sign when used to indicate a |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
1000 | keyword argument or a default parameter value, except when |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
1001 | using a type annotation. |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1002 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1003 | Okay: def complex(real, imag=0.0): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1004 | Okay: return magic(r=real, i=imag) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1005 | Okay: boolean(a == b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1006 | Okay: boolean(a != b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1007 | Okay: boolean(a <= b) |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1008 | Okay: boolean(a >= b) |
4828 | 1009 | Okay: def foo(arg: int = 42): |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
1010 | Okay: async def foo(arg: int = 42): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1011 | |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1012 | E251: def complex(real, imag = 0.0): |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1013 | E251: return magic(r = real, i = imag) |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1014 | E252: def complex(real, image: float=0.0): |
832
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1015 | """ |
eb5ff61f927b
Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1016 | parens = 0 |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1017 | no_space = False |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1018 | require_space = False |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1019 | prev_end = None |
4828 | 1020 | annotated_func_arg = False |
5509
d4c4763b46ee
Upgraded pycodestyle to version 2.3.1
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
5435
diff
changeset
|
1021 | in_def = bool(STARTSWITH_DEF_REGEX.match(logical_line)) |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1022 | |
3616 | 1023 | message = "E251 unexpected spaces around keyword / parameter equals" |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1024 | missing_message = "E252 missing whitespace around parameter equals" |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1025 | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1026 | for token_type, text, start, end, line in tokens: |
3616 | 1027 | if token_type == tokenize.NL: |
1028 | continue | |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1029 | if no_space: |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1030 | no_space = False |
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1031 | if start != prev_end: |
3616 | 1032 | yield (prev_end, message) |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1033 | if require_space: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1034 | require_space = False |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1035 | if start == prev_end: |
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1036 | yield (prev_end, missing_message) |
4828 | 1037 | if token_type == tokenize.OP: |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
1038 | if text in '([': |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1039 | parens += 1 |
5146
f96c32abd120
Updated the pep8 checker to version 2.1.0dev0.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
4828
diff
changeset
|
1040 | elif text in ')]': |
2862
a1448560d7dc
Started upgrading the pep8 checker to the latest release.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
2861
diff
changeset
|
1041 | parens -= 1 |
4828 | 1042 | elif in_def and text == ':' and parens == 1: |
1043 | annotated_func_arg = True | |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
1044 | elif parens == 1 and text == ',': |
4828 | 1045 | annotated_func_arg = False |
6246
fe07a9f16f23
Updated pycodestyle to 2.4.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6048
diff
changeset
|
1046 | elif parens and text == '=': |
6732
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
1047 | if annotated_func_arg and parens == 1: |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
1048 | require_space = True |
1a4758379c45
Updated pycodestyle to 2.5.0
T.Rzepka <Tobias.Rzepka@gmail.com>
parents:
6645
diff
changeset
|
1049 | if start == prev_end: |