Added tested libraries as submodules

[hackapet/Adafruit_Blinka.git] / python / mcp / __init__.py

diff --git a/python/mcp/__init__.py b/python/mcp/__init__.py
index d52c0b9cfe635834f58b595fb68d28c85809cb2e..2ee42c22601ca91c6d0b6c24ecb6fe9fecfef95a 100644 (file)
--- a/python/mcp/__init__.py
+++ b/python/mcp/__init__.py
@@ -1,21 +1,32 @@
+"""Module providing runtime utility objects to support the Micro/CircuitPython api"""
+

 class Enum(object):
 class Enum(object):

+    """
+        Object supporting CircuitPython-style of static symbols
+        as seen with Direction.OUTPUT, Pull.UP
+    """

 
 

+    def __repr__(self):
+        """
+        Assumes instance will be found as attribute of own class.
+        Returns dot-subscripted path to instance
+        (assuming absolute import of containing package)
+        """
+        cls = type(self)
+        for key in dir(cls):
+            if getattr(cls, key) is self:
+                return "{}.{}.{}".format(cls.__module__, cls.__qualname__, key)
+        return repr(self)

 
     @classmethod
     def iteritems(cls):
 
     @classmethod
     def iteritems(cls):

+        """
+            Inspects attributes of the class for instances of the class
+            and returns as key,value pairs mirroring dict#iteritems
+        """

         for key in dir(cls):
             val = getattr(cls, key)
             if type(val) is cls:
                 yield (key, val)
 
 
         for key in dir(cls):
             val = getattr(cls, key)
             if type(val) is cls:
                 yield (key, val)
 
 

-    def __repr__(self):
-        """
-        Assumes instance will be found as attribute of own
-        class. Returns dot-subscripted path to instance
-        """
-        cls = type(self)
-        for key in dir(cls):
-            if getattr(cls, key) is self:
-                return "{}.{}.{}".format(cls.__module__, cls.__qualname__, key)
-        return repr(self)
\ No newline at end of file