[tor-commits] [tor/master] practracker: allow comments in exceptions file

[nickm at torproject.org]

commit 135b51c9d3436b3afcf323a193c755deafa53f7d
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Mar 25 09:28:24 2019 -0400

    practracker: allow comments in exceptions file
    
    Also, distinguish between empty lines (which we should ignore)
    and incorrect lines (which we should warn about).
---
 scripts/maint/practracker/problem.py | 31 +++++++++++++++++++++++--------
 1 file changed, 23 insertions(+), 8 deletions(-)

diff --git a/scripts/maint/practracker/problem.py b/scripts/maint/practracker/problem.py
index ab3d55057..d5ebedd17 100644
--- a/scripts/maint/practracker/problem.py
+++ b/scripts/maint/practracker/problem.py
@@ -10,6 +10,7 @@ get worse.
 from __future__ import print_function
 
 import os.path
+import re
 import sys
 
 class ProblemVault(object):
@@ -30,8 +31,15 @@ class ProblemVault(object):
 
     def register_exceptions(self, exception_file):
         # Register exceptions
-        for line in exception_file:
-            problem = get_old_problem_from_exception_str(line)
+        for lineno, line in enumerate(exception_file, 1):
+            try:
+                problem = get_old_problem_from_exception_str(line)
+            except ValueError as v:
+                print("Exception file line {} not recognized: {}"
+                      .format(lineno,v),
+                      file=sys.stderr)
+                continue
+
             if problem is None:
                 continue
 
@@ -122,11 +130,20 @@ class FunctionSizeProblem(Problem):
     def __init__(self, problem_location, metric_value):
         super(FunctionSizeProblem, self).__init__("function-size", problem_location, metric_value)
 
+comment_re = re.compile(r'#.*$')
+
 def get_old_problem_from_exception_str(exception_str):
-    try:
-        _, problem_type, problem_location, metric_value = exception_str.split(" ")
-    except ValueError:
+    orig_str = exception_str
+    exception_str = comment_re.sub("", exception_str)
+    fields = exception_str.split()
+    if len(fields) == 0:
+        # empty line or comment
         return None
+    elif len(fields) == 4:
+        # valid line
+        _, problem_type, problem_location, metric_value = fields
+    else:
+        raise ValueError("Misformatted line {!r}".format(orig_str))
 
     if problem_type == "file-size":
         return FileSizeProblem(problem_location, metric_value)
@@ -135,6 +152,4 @@ def get_old_problem_from_exception_str(exception_str):
     elif problem_type == "function-size":
         return FunctionSizeProblem(problem_location, metric_value)
     else:
-#        print("Unknown exception line '{}'".format(exception_str))
-        return None
-
+        raise ValueError("Unknown exception type {!r}".format(orig_str))