diff --git a/changes/ticket30752 b/changes/ticket30752 index 754a9003d1..044c7c7d93 100644 --- a/changes/ticket30752 +++ b/changes/ticket30752 @@ -1,6 +1,6 @@ o Minor features (best practices tracker): - Give a warning rather than an error when a practracker exception is - violated by a small amount; add a --list-overstrict option to + violated by a small amount; add a --list-overbroad option to practracker that lists exceptions that are stricter than they need to be, and provide an environment variable for disabling practracker. Closes ticekt 30752. diff --git a/scripts/maint/practracker/practracker.py b/scripts/maint/practracker/practracker.py index 245d01d36d..a4e951ac7c 100755 --- a/scripts/maint/practracker/practracker.py +++ b/scripts/maint/practracker/practracker.py @@ -153,7 +153,7 @@ def main(argv): parser = argparse.ArgumentParser(prog=progname) parser.add_argument("--regen", action="store_true", help="Regenerate the exceptions file") - parser.add_argument("--list-overstrict", action="store_true", + parser.add_argument("--list-overbroad", action="store_true", help="List over-strict exceptions") parser.add_argument("--exceptions", help="Override the location for the exceptions file") @@ -200,7 +200,7 @@ def main(argv): # 2.1) Adjust the exceptions so that we warn only about small problems, # and produce errors on big ones. - if not (args.regen or args.list_overstrict or args.strict): + if not (args.regen or args.list_overbroad or args.strict): ProblemVault.set_tolerances(TOLERANCE_FNS) # 3) Go through all the files and report problems if they are not exceptions @@ -234,10 +234,10 @@ variable. """.format(found_new_issues, exceptions_file) print(new_issues_str) - if args.list_overstrict: + if args.list_overbroad: def k_fn(tup): return tup[0].key() - for (ex,p) in sorted(ProblemVault.list_overstrict_exceptions(), key=k_fn): + for (ex,p) in sorted(ProblemVault.list_overbroad_exceptions(), key=k_fn): if p is None: print(ex, "->", 0) else: diff --git a/scripts/maint/practracker/problem.py b/scripts/maint/practracker/problem.py index d09e941518..73519d446f 100644 --- a/scripts/maint/practracker/problem.py +++ b/scripts/maint/practracker/problem.py @@ -82,7 +82,7 @@ class ProblemVault(object): return status - def list_overstrict_exceptions(self): + def list_overbroad_exceptions(self): """Return an iterator of tuples containing (ex,prob) where ex is an exceptions in this vault that are stricter than it needs to be, and prob is the worst problem (if any) that it covered.