Merge pull request #596 from maxim-belkin/reporter

bin/util.py: Factor out reporter class. Define __all__

Author: zkamvar

bin/lesson_check.py

@@ -8,8 +8,10 @@
 import re
 from argparse import ArgumentParser
 
-from util import (Reporter, read_markdown, load_yaml, check_unwanted_files,
-                  require)
+# This uses the `__all__` list in `util.py` to determine what objects to import 
+# see https://docs.python.org/3/tutorial/modules.html#importing-from-a-package
+from util import *
+from reporter import Reporter
 
 __version__ = '0.3'
 

bin/reporter.py

@@ -0,0 +1,75 @@
+import sys
+
+class Reporter:
+    """Collect and report errors."""
+
+    # Marker to show that an expected value hasn't been provided.
+    # (Can't use 'None' because that might be a legitimate value.)
+    _DEFAULT_REPORTER = []
+
+    def __init__(self):
+        """Constructor."""
+        self.messages = []
+
+    def check_field(self, filename, name, values, key, expected=_DEFAULT_REPORTER):
+        """Check that a dictionary has an expected value."""
+
+        if key not in values:
+            self.add(filename, '{0} does not contain {1}', name, key)
+        elif expected is self._DEFAULT_REPORTER:
+            pass
+        elif type(expected) in (tuple, set, list):
+            if values[key] not in expected:
+                self.add(
+                    filename, '{0} {1} value {2} is not in {3}', name, key, values[key], expected)
+        elif values[key] != expected:
+            self.add(filename, '{0} {1} is {2} not {3}',
+                     name, key, values[key], expected)
+
+    def check(self, condition, location, fmt, *args):
+        """Append error if condition not met."""
+
+        if not condition:
+            self.add(location, fmt, *args)
+
+    def add(self, location, fmt, *args):
+        """Append error unilaterally."""
+
+        self.messages.append((location, fmt.format(*args)))
+
+    @staticmethod
+    def pretty(item):
+        location, message = item
+        if isinstance(location, type(None)):
+            return message
+        elif isinstance(location, str):
+            return location + ': ' + message
+        elif isinstance(location, tuple):
+            return '{0}:{1}: '.format(*location) + message
+
+        print('Unknown item "{0}"'.format(item), file=sys.stderr)
+        return NotImplemented
+
+    @staticmethod
+    def key(item):
+        location, message = item
+        if isinstance(location, type(None)):
+            return ('', -1, message)
+        elif isinstance(location, str):
+            return (location, -1, message)
+        elif isinstance(location, tuple):
+            return (location[0], location[1], message)
+
+        print('Unknown item "{0}"'.format(item), file=sys.stderr)
+        return NotImplemented
+
+    def report(self, stream=sys.stdout):
+        """Report all messages in order."""
+
+        if not self.messages:
+            return
+
+        for m in sorted(self.messages, key=self.key):
+            print(self.pretty(m), file=stream)
+
+

bin/util.py

@@ -10,86 +10,13 @@
     print('Unable to import YAML module: please install PyYAML', file=sys.stderr)
     sys.exit(1)
 
+__all__ = ['check_unwanted_files', 'load_yaml', 'read_markdown', 'require']
 
 # Files that shouldn't be present.
 UNWANTED_FILES = [
     '.nojekyll'
 ]
 
-# Marker to show that an expected value hasn't been provided.
-# (Can't use 'None' because that might be a legitimate value.)
-REPORTER_NOT_SET = []
-
-
-class Reporter:
-    """Collect and report errors."""
-
-    def __init__(self):
-        """Constructor."""
-        self.messages = []
-
-    def check_field(self, filename, name, values, key, expected=REPORTER_NOT_SET):
-        """Check that a dictionary has an expected value."""
-
-        if key not in values:
-            self.add(filename, '{0} does not contain {1}', name, key)
-        elif expected is REPORTER_NOT_SET:
-            pass
-        elif type(expected) in (tuple, set, list):
-            if values[key] not in expected:
-                self.add(
-                    filename, '{0} {1} value {2} is not in {3}', name, key, values[key], expected)
-        elif values[key] != expected:
-            self.add(filename, '{0} {1} is {2} not {3}',
-                     name, key, values[key], expected)
-
-    def check(self, condition, location, fmt, *args):
-        """Append error if condition not met."""
-
-        if not condition:
-            self.add(location, fmt, *args)
-
-    def add(self, location, fmt, *args):
-        """Append error unilaterally."""
-
-        self.messages.append((location, fmt.format(*args)))
-
-    @staticmethod
-    def pretty(item):
-        location, message = item
-        if isinstance(location, type(None)):
-            return message
-        elif isinstance(location, str):
-            return location + ': ' + message
-        elif isinstance(location, tuple):
-            return '{0}:{1}: '.format(*location) + message
-
-        print('Unknown item "{0}"'.format(item), file=sys.stderr)
-        return NotImplemented
-
-    @staticmethod
-    def key(item):
-        location, message = item
-        if isinstance(location, type(None)):
-            return ('', -1, message)
-        elif isinstance(location, str):
-            return (location, -1, message)
-        elif isinstance(location, tuple):
-            return (location[0], location[1], message)
-
-        print('Unknown item "{0}"'.format(item), file=sys.stderr)
-        return NotImplemented
-
-    def report(self, stream=sys.stdout):
-        """Report all messages in order."""
-
-        if not self.messages:
-            return
-
-        for m in sorted(self.messages, key=self.key):
-            print(self.pretty(m), file=stream)
-
-
 def read_markdown(parser, path):
     """
     Get YAML and AST for Markdown file, returning