Moved Pin definition back so that __module__ properly rendered by repr(). Fear of...

[Adafruit_Blinka-hackapet.git] / python / testing / mcp.py

diff --git a/python/testing/mcp.py b/python/testing/mcp.py
index 01545f6ba4433c25bbc9424fdb762a627d8cee47..131def0fd814b612b946d79e397fe8e69f6b42c0 100644 (file)
--- a/python/testing/mcp.py
+++ b/python/testing/mcp.py
@@ -2,8 +2,13 @@ import unittest
 
 
 class TestEnum(unittest.TestCase):
+    """
+        Verifies the repl() and str() behaviour of an example Enum
+        Enums represent configuration values such as digitalio.Direction, digitalio.Pull etc.
+    """
 
     def setUp(self):
+        """Create an example Enum, mocking __module__ and __qualname__"""
         import mcp
         class Cls(mcp.Enum):
             pass
@@ -16,11 +21,13 @@ class TestEnum(unittest.TestCase):
 
 
     def test_iteritems(self):
+        """A subtype of Enum can list all attributes of its own type"""
         items = list(self.Cls.iteritems())
         self.assertEqual( items, [("one",self.Cls.one),("two",self.Cls.two),])
 
 
     def test_repr(self):
+        """A repr() call on an Enum gives its fully-qualified name"""
         name = "one"
         actual = repr(getattr(self.Cls, name))
         expected = "{}.{}.{}".format(self.Cls.__module__, self.Cls.__qualname__, name)
@@ -28,4 +35,5 @@ class TestEnum(unittest.TestCase):
 
 
     def test_str(self):
+        """A str() call on an Enum performs the same as repr()"""
         self.assertEqual(str(self.Cls.one), repr(self.Cls.one))
\ No newline at end of file