Use list class with is_not_subset_of

Author: John Nonweiler

scripts/filter_expected_warnings.py

@@ -22,49 +22,59 @@ def approx_equals(self, other):
             return False
         return self.otherlines == other.otherlines
 
-    def is_in_list(self, warnings_list):
-        """Check if this (or a similar warning) is in the list."""
-        for other in warnings_list:
-            if self.approx_equals(other):
-                return True
-        return False
-
     def print_with_prefix(self, prefix):
         print(prefix + self.firstline)
         for line in self.otherlines:
             print(prefix + '  ' + line)
 
 
-def build_warnings_list(all_lines):
-    """Create a list of the warnings in this file."""
-    warnings_list = []
-    current = None
-
-    warning_start_expr = re.compile(r'[^:]+/([^:/]+):\d+: (warning.*$)')
-
-    for line in all_lines:
-        if line.isspace():
-            continue
-
-        # Allow comments in the list of expected warnings.
-        if line.startswith('#'):
-            continue
-
-        matched = warning_start_expr.match(line)
-        if matched:
-            filename = matched.group(1)
-            warning = matched.group(2)
-            current = DoxygenWarning(line.strip(), filename, warning)
-            warnings_list.append(current)
-        elif line.startswith('  '):
-            current.otherlines.append(line.strip())
-        else:
-            # Assuming all warnings are of the form [path:line: warning:...]
-            # (and the warnings about too many nodes have been filtered out).
-            print('Error filtering warnings: Unexpected input format.')
-            print('  Input:' + line)
+class WarningsList(object):
+    """List of Doxygen warnings."""
+
+    def __init__(self, all_lines):
+        """Create a list of the warnings in this file."""
+        self.warnings_list = []
+        current = None
+
+        warning_start_expr = re.compile(r'[^:]+/([^:/]+):\d+: (warning.*$)')
+
+        for line in all_lines:
+            if line.isspace():
+                continue
+
+            # Allow comments in the list of expected warnings.
+            if line.startswith('#'):
+                continue
+
+            matched = warning_start_expr.match(line)
+            if matched:
+                filename = matched.group(1)
+                warning = matched.group(2)
+                current = DoxygenWarning(line.strip(), filename, warning)
+                self.warnings_list.append(current)
+            elif line.startswith('  '):
+                current.otherlines.append(line.strip())
+            else:
+                # Assuming all warnings are of the form [path:line: warning:...]
+                # (and the warnings about too many nodes have been filtered out).
+                print('Error filtering warnings: Unexpected input format.')
+                print('  Input:' + line)
+
+    def contains(self, warning):
+        """Check if a similar warning is in this list."""
+        for other in self.warnings_list:
+            if warning.approx_equals(other):
+                return True
+        return False
 
-    return warnings_list
+    def is_not_subset_of(self, superset, prefix):
+        """Check if this a subset of superset, and print anything missing."""
+        missing_element_found = False
+        for warning in self.warnings_list:
+            if not superset.contains(warning):
+                missing_element_found = True
+                warning.print_with_prefix(prefix)
+        return missing_element_found
 
 
 def ignore_too_many_nodes(all_lines):
@@ -75,30 +85,20 @@ def ignore_too_many_nodes(all_lines):
     return [x for x in all_lines if not too_many_nodes_expr.match(x)]
 
 
-def list1_is_in_list2(list1, list2, prefix):
-    missing_element_found = False
-    for warning in list1:
-        if not warning.is_in_list(list2):
-            missing_element_found = True
-            warning.print_with_prefix(prefix)
-    return missing_element_found
-
-
 def filter_expected_warnings(expected_warnings_path):
     """Filter lines from stdin and print to stdout."""
     with open(expected_warnings_path, "r") as warnings_file:
-        expected_warnings = build_warnings_list(warnings_file.readlines())
+        expected_warnings = WarningsList(warnings_file.readlines())
 
-    new_warnings = build_warnings_list(
-        ignore_too_many_nodes(sys.stdin.readlines()))
+    new_warnings = WarningsList(ignore_too_many_nodes(sys.stdin.readlines()))
 
     # print unexpected warnings
-    unexpected_warning_found = list1_is_in_list2(
-        new_warnings, expected_warnings, '')
+    unexpected_warning_found = new_warnings.is_not_subset_of(
+        expected_warnings, '')
 
     # print expected warnings which aren't found
-    expected_warning_not_found = list1_is_in_list2(
-        expected_warnings, new_warnings, '-')
+    expected_warning_not_found = expected_warnings.is_not_subset_of(
+        new_warnings, '-')
 
     if expected_warning_not_found:
         print('NOTE: Warnings prefixed with \'-\' are expected ' +