src/adafruit_blinka/__init__.py

   1 """Module providing runtime utility objects to support the Micro/CircuitPython api"""
   2
   3
   4 class Enum(object):
   5     """
   6         Object supporting CircuitPython-style of static symbols
   7         as seen with Direction.OUTPUT, Pull.UP
   8     """
   9
  10     def __repr__(self):
  11         """
  12         Assumes instance will be found as attribute of own class.
  13         Returns dot-subscripted path to instance
  14         (assuming absolute import of containing package)
  15         """
  16         cls = type(self)
  17         for key in dir(cls):
  18             if getattr(cls, key) is self:
  19                 return "{}.{}.{}".format(cls.__module__, cls.__qualname__, key)
  20         return repr(self)
  21
  22     @classmethod
  23     def iteritems(cls):
  24         """
  25             Inspects attributes of the class for instances of the class
  26             and returns as key,value pairs mirroring dict#iteritems
  27         """
  28         for key in dir(cls):
  29             val = getattr(cls, key)
  30             if isinstance(cls, val):
  31                 yield (key, val)
  32
  33
  34 class ContextManaged:
  35     """An object that automatically deinitializes hardware with a context manager."""
  36     def __enter__(self):
  37         return self
  38
  39     def __exit__(self, exc_type, exc_value, traceback):
  40         self.deinit()
  41
  42     def deinit(self):
  43         """Free any hardware used by the object."""
  44         pass
  45
  46
  47 class Lockable(ContextManaged):
  48     """An object that must be locked to prevent collisions on a microcontroller resource."""
  49     _locked = False
  50
  51     def try_lock(self):
  52         """Attempt to grab the lock. Return True on success, False if the lock is already taken."""
  53         if self._locked:
  54             return False
  55         self._locked = True
  56         return True
  57
  58     def unlock(self):
  59         """Release the lock so others may use the resource."""
  60         if self._locked:
  61             self._locked = False
  62         else:
  63             raise ValueError("Not locked")
  64
  65 def patch_system():
  66     """Patch modules that may be different due to the platform."""
  67     import sys
  68     from adafruit_blinka.agnostic import time
  69     sys.modules['time'] = time