[chirp_devel] [PATCH 04/12] Add pep8 checker script (#2355)
Zach Welch
Fri Feb 27 02:24:41 PST 2015
# HG changeset patch
# User Zach Welch <zach at mandolincreekfarm.com>
# Fake Node ID 3db4f1501a5afde03ce0fbfd6d3b45d54bee5818
Add pep8 checker script (#2355)
This patch adds a new script that runs the pep8 tool on the CHIRP source
code files. This script is intended to be included in the repository
pre-commit hook, preventing patches from causing style regressions.
The script checks a blacklist of files that are not yet compliant with
the style standards, and those files will not be scanned (unless -a is
given). Since no new files should ever be added to the blacklist, it
should eventually shrink to empty, and the script will check the entire
codebase.
The blacklist makes it safe to begin using this tool immediately, so
this patch also adds a call to it from run_all_tests.sh.
diff --git a/run_all_tests.sh b/run_all_tests.sh
index 48e20a4..2437d19 100755
--- a/run_all_tests.sh
+++ b/run_all_tests.sh
@@ -26,8 +26,15 @@ function style_tests() {
./tools/checkpatch.sh
}
-TESTS="unit_tests driver_tests make_supported style_tests"
-for testname in $TESTS; do
+function pep8() {
+ echo "Checking for PEP8 regressions..."
+ time ./tools/cpep8.py --stats
+}
+
+if test -z "${TESTS[*]}"; then
+ TESTS=( unit_tests driver_tests make_supported style_tests pep8 )
+fi
+for testname in "${TESTS[@]}"; do
eval "$testname" || record_failure "$testname"
done
diff --git a/tools/cpep8.blacklist b/tools/cpep8.blacklist
new file mode 100644
index 0000000..e74c723
--- /dev/null
+++ b/tools/cpep8.blacklist
@@ -0,0 +1,137 @@
+# 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.
+./chirp/__init__.py
+./chirp/alinco.py
+./chirp/anytone.py
+./chirp/ap510.py
+./chirp/bandplan.py
+./chirp/bandplan_au.py
+./chirp/bandplan_iaru_r1.py
+./chirp/bandplan_iaru_r2.py
+./chirp/bandplan_iaru_r3.py
+./chirp/bandplan_na.py
+./chirp/baofeng_uv3r.py
+./chirp/bitwise.py
+./chirp/bitwise_grammar.py
+./chirp/bjuv55.py
+./chirp/chirp_common.py
+./chirp/detect.py
+./chirp/directory.py
+./chirp/elib_intl.py
+./chirp/errors.py
+./chirp/ft1802.py
+./chirp/ft1d.py
+./chirp/ft2800.py
+./chirp/ft50.py
+./chirp/ft50_ll.py
+./chirp/ft60.py
+./chirp/ft7800.py
+./chirp/ft817.py
+./chirp/ft857.py
+./chirp/ft90.py
+./chirp/ftm350.py
+./chirp/generic_csv.py
+./chirp/generic_tpe.py
+./chirp/generic_xml.py
+./chirp/h777.py
+./chirp/ic208.py
+./chirp/ic2100.py
+./chirp/ic2200.py
+./chirp/ic2720.py
+./chirp/ic2820.py
+./chirp/ic9x.py
+./chirp/ic9x_icf.py
+./chirp/ic9x_icf_ll.py
+./chirp/ic9x_ll.py
+./chirp/icf.py
+./chirp/icomciv.py
+./chirp/icq7.py
+./chirp/ict70.py
+./chirp/ict8.py
+./chirp/icw32.py
+./chirp/icx8x.py
+./chirp/icx8x_ll.py
+./chirp/id31.py
+./chirp/id800.py
+./chirp/id880.py
+./chirp/idrp.py
+./chirp/import_logic.py
+./chirp/kenwood_hmk.py
+./chirp/kenwood_itm.py
+./chirp/kenwood_live.py
+./chirp/kguv8d.py
+./chirp/kyd.py
+./chirp/leixen.py
+./chirp/memmap.py
+./chirp/platform.py
+./chirp/puxing.py
+./chirp/pyPEG.py
+./chirp/radioreference.py
+./chirp/rfinder.py
+./chirp/settings.py
+./chirp/template.py
+./chirp/th9800.py
+./chirp/th_uv3r.py
+./chirp/th_uv3r25.py
+./chirp/th_uvf8d.py
+./chirp/thd72.py
+./chirp/thuv1f.py
+./chirp/tk8102.py
+./chirp/tmv71.py
+./chirp/tmv71_ll.py
+./chirp/util.py
+./chirp/uv5r.py
+./chirp/uvb5.py
+./chirp/vx170.py
+./chirp/vx2.py
+./chirp/vx3.py
+./chirp/vx5.py
+./chirp/vx510.py
+./chirp/vx6.py
+./chirp/vx7.py
+./chirp/vx8.py
+./chirp/vxa700.py
+./chirp/wouxun.py
+./chirp/wouxun_common.py
+./chirp/xml_ll.py
+./chirp/yaesu_clone.py
+./chirpc
+./chirpui/bankedit.py
+./chirpui/clone.py
+./chirpui/cloneprog.py
+./chirpui/common.py
+./chirpui/config.py
+./chirpui/dstaredit.py
+./chirpui/editorset.py
+./chirpui/fips.py
+./chirpui/importdialog.py
+./chirpui/inputdialog.py
+./chirpui/mainapp.py
+./chirpui/memdetail.py
+./chirpui/memedit.py
+./chirpui/miscwidgets.py
+./chirpui/radiobrowser.py
+./chirpui/reporting.py
+./chirpui/settingsedit.py
+./chirpui/shiftdialog.py
+./chirpw
+./csvdump/__init__.py
+./csvdump/csvapp.py
+./csvdump/csvdump.py
+./locale/check_parameters.py
+./rpttool
+./setup.py
+./share/make_supported.py
+./tests/run_tests
+./tests/unit/base.py
+./tests/unit/test_bitwise.py
+./tests/unit/test_chirp_common.py
+./tests/unit/test_import_logic.py
+./tests/unit/test_mappingmodel.py
+./tests/unit/test_memedit_edits.py
+./tests/unit/test_platform.py
+./tests/unit/test_settings.py
+./tests/unit/test_shiftdialog.py
+./tools/bitdiff.py
+./tools/img2thd72.py
diff --git a/tools/cpep8.manifest b/tools/cpep8.manifest
new file mode 100644
index 0000000..2fe9d77
--- /dev/null
+++ b/tools/cpep8.manifest
@@ -0,0 +1,4 @@
+./chirpc
+./chirpw
+./rpttool
+./tests/run_tests
diff --git a/tools/cpep8.py b/tools/cpep8.py
new file mode 100755
index 0000000..efaca7a
--- /dev/null
+++ b/tools/cpep8.py
@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+#
+# cpep8.py - Check Python source files for PEP8 compliance.
+#
+# Copyright 2015 Zachary T Welch <zach at 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
+
+scriptdir = os.path.dirname(sys.argv[0])
+
+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("-u", "--update", action="store_true",
+ help="Update the blacklist file")
+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 = file(name, "r")
+ lines = fh.read().split("\n")
+ lines.pop()
+ fh.close()
+ return lines
+
+# read manifest and search for python files
+manifest = file_to_lines(os.path.join(scriptdir, "cpep8.manifest"))
+for root, dirs, files in os.walk(args.dir):
+ for f in files:
+ if f.endswith('.py'):
+ manifest.append(os.path.join(root, f))
+
+# read the blacklisted source files
+blacklist_filename = os.path.join(scriptdir, "cpep8.blacklist")
+blacklist = file_to_lines(blacklist_filename)
+
+if args.update:
+ bad = []
+ for f in manifest:
+ checker = pep8.StyleGuide(quiet=True)
+ results = checker.check_files([f])
+ if results.total_errors:
+ bad.append(f)
+ with file(blacklist_filename, "w") as fh:
+ print >>fh, """\
+# 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."""
+ print >>fh, "\n".join(sorted(bad))
+ sys.exit(0)
+
+if args.files:
+ manifest = args.files
+
+check_list = []
+for f in manifest:
+ if args.all or f not in blacklist:
+ check_list.append(f)
+check_list = sorted(check_list)
+
+if args.verbose:
+ print "Checking the following files:\n", "\n".join(check_list)
+
+checker = pep8.StyleGuide(quiet=args.stats)
+results = checker.check_files(check_list)
+if args.stats:
+ results.print_statistics()
+
+sys.exit(results.total_errors and 1 or 0)
More information about the chirp_devel
mailing list