1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
#!/usr/bin/env python
#
# cpep8.py - Check Python source files for PEP8 compliance.
#
# Copyright 2015 Zachary T Welch <zach@mandolincreekfarm.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import sys
import logging
import argparse
import pep8
parser = argparse.ArgumentParser()
parser.add_argument("-a", "--all", action="store_true",
help="Check all files, ignoring blacklist")
parser.add_argument("-d", "--dir", action="store", default=".",
help="Root directory of source tree")
parser.add_argument("-s", "--stats", action="store_true",
help="Only show statistics")
parser.add_argument("--strict", action="store_true",
help="Ignore listed exceptions")
parser.add_argument("-S", "--scan", action="store_true",
help="Scan for additional files")
parser.add_argument("-u", "--update", action="store_true",
help="Update manifest/blacklist files")
parser.add_argument("-v", "--verbose", action="store_true",
help="Display list of checked files")
parser.add_argument("files", metavar="file", nargs='*',
help="List of files to check (if none, check all)")
args = parser.parse_args()
def file_to_lines(name):
fh = open(name, "r")
lines = fh.read().split("\n")
lines.pop()
fh.close()
return lines
scriptdir = os.path.dirname(sys.argv[0])
manifest_filename = os.path.join(scriptdir, "cpep8.manifest")
blacklist_filename = os.path.join(scriptdir, "cpep8.blacklist")
exceptions_filename = os.path.join(scriptdir, "cpep8.exceptions")
manifest = []
if args.scan:
for root, dirs, files in os.walk(args.dir):
for f in files:
filename = os.path.join(root, f)
if f.endswith('.py'):
manifest.append(filename)
continue
with open(filename, "r") as fh:
shebang = fh.readline()
if shebang.startswith("#!/usr/bin/env python"):
manifest.append(filename)
else:
manifest += file_to_lines(manifest_filename)
# unless we are being --strict, load per-file style exceptions
exceptions = {}
if not args.strict:
exception_lines = file_to_lines(exceptions_filename)
exception_lists = [x.split('\t')
for x in exception_lines if not x.startswith('#')]
for filename, codes in exception_lists:
exceptions[filename] = codes
def get_exceptions(f):
try:
ignore = exceptions[f]
except KeyError:
ignore = None
return ignore
if args.update:
print("Starting update of %d files" % len(manifest))
bad = []
for f in manifest:
checker = pep8.StyleGuide(quiet=True, ignore=get_exceptions(f))
results = checker.check_files([f])
if results.total_errors:
bad.append(f)
print("%s: %s" % (results.total_errors and "FAIL" or "PASS", f))
with open(blacklist_filename, "w") as fh:
fh.write("""\
# cpep8.blacklist: The list of files that do not meet PEP8 standards.
# DO NOT ADD NEW FILES!! Instead, fix the code to be compliant.
# Over time, this list should shrink and (eventually) be eliminated.""")
fh.write("\n".join(sorted(bad)))
if args.scan:
with open(manifest_filename, "w") as fh:
fh.write("\n".join(sorted(manifest)))
sys.exit(0)
if args.files:
manifest = args.files
# read the blacklisted source files
blacklist = file_to_lines(blacklist_filename)
check_list = []
for f in manifest:
if args.all or f not in blacklist:
check_list.append(f)
check_list = sorted(check_list)
total_errors = 0
for f in check_list:
if args.verbose:
print("Checking %s" % f)
checker = pep8.Checker(f, quiet=args.stats, ignore=get_exceptions(f))
results = checker.check_all()
if args.stats:
checker.report.print_statistics()
total_errors += results
sys.exit(total_errors and 1 or 0)
|
