Refactor import microcontroller

Author: makermelissa

src/adafruit_blinka/importing.py

@@ -9,6 +9,7 @@
 * Author(s): Melissa LeBlanc-Williams
 """
 
+
 try:
     from importlib import import_module
 except ImportError as e:
@@ -21,6 +22,9 @@ def import_module(module_name: str, package: str = None):
         return __import__(module_name, globals(), locals(), package_list)
 
 
+from adafruit_blinka.agnostic import detector
+
+
 def get_import_file(json_file_name, script_file_location):
     """Get the full path to the microcontroller imports file."""
     try:
@@ -53,3 +57,47 @@ def import_mod(caller_globals, module_name: str, package_name: str = "*"):
     else:
         module = import_module(module_name, package=package_name)
         caller_globals[package_name] = getattr(module, package_name)
+
+
+def import_microcontroller(
+    caller_globals,
+    microcontroller_imports,
+    module_extension: str = "",
+    package_name: str = "*",
+):
+    """Detect and import the microcontroller module and package based on detected hardware"""
+    if module_extension[0:1] != "." and module_extension != "":
+        # Make sure the module extension starts with a dot if it's not empty
+        module_extension = f".{module_extension}"
+    for chip_key, chip_module in microcontroller_imports.items():
+        if getattr(detector.chip, chip_key):
+            if isinstance(chip_module, dict):
+                # Loop through the children and import the first one that matches
+                for board_key, board_chip_module in chip_module.items():
+                    if board_key.startswith("any_") and getattr(
+                        detector.board, board_key
+                    ):
+                        # import Pin from the microcontroller module
+                        import_mod(
+                            caller_globals,
+                            f"{board_chip_module}{module_extension}",
+                            package_name,
+                        )
+                        return True
+                    if board_key == getattr(detector.board, board_key):
+                        print(f"Detected board: {board_key}")
+                        import_mod(
+                            caller_globals,
+                            f"{board_chip_module}{module_extension}",
+                            package_name,
+                        )
+                        return True
+                import_mod(
+                    caller_globals,
+                    f"{chip_module['default']}{module_extension}",
+                    package_name,
+                )
+                return True
+            import_mod(caller_globals, f"{chip_module}{module_extension}", package_name)
+            return True
+    return False

src/digitalio.py

@@ -10,35 +10,15 @@
 * Author(s): cefn, Melissa LeBlanc-Williams
 """
 import json
-from adafruit_blinka.agnostic import board_id, detector
-from adafruit_blinka.importing import import_mod, get_import_file
+from adafruit_blinka.agnostic import board_id
+from adafruit_blinka.importing import get_import_file, import_microcontroller
 from adafruit_blinka import Enum, ContextManaged
 
 Pin = None
 
-
 with open(get_import_file("microcontroller_imports.json", __file__)) as f:
     microcontroller_imports = json.load(f)
-
-    for chip_key, chip_module in microcontroller_imports.items():
-        if getattr(detector.chip, chip_key):
-            if isinstance(chip_module, dict):
-                # Loop through the children and import the first one that matches
-                for board_key, board_chip_module in chip_module.items():
-                    if board_key.startswith("any_") and getattr(
-                        detector.board, board_key
-                    ):
-                        # import Pin from the microcontroller module
-                        import_mod(globals(), f"{board_chip_module}.pin", "Pin")
-                        break
-                    if board_key == getattr(detector.board, board_key):
-                        import_mod(globals(), f"{board_chip_module}.pin", "Pin")
-                        break
-                else:
-                    import_mod(globals(), f"{chip_module['default']}.pin", "Pin")
-                break
-            import_mod(globals(), f"{chip_module}.pin", "Pin")
-            break
+    import_microcontroller(globals(), microcontroller_imports, "pin", "Pin")
 
 
 class DriveMode(Enum):

src/microcontroller/__init__.py

@@ -12,8 +12,8 @@
 import time
 
 from adafruit_platformdetect.constants import chips as ap_chip
-from adafruit_blinka.agnostic import chip_id, detector
-from adafruit_blinka.importing import import_mod, get_import_file
+from adafruit_blinka.agnostic import chip_id
+from adafruit_blinka.importing import get_import_file, import_microcontroller
 from microcontroller import pin  # pylint: disable=unused-import
 from microcontroller.pin import Pin  # pylint: disable=unused-import
 
@@ -28,27 +28,7 @@ def delay_us(delay):
 
 with open(get_import_file("../microcontroller_imports.json", __file__)) as f:
     microcontroller_imports = json.load(f)
-
-    for chip_key, chip_module in microcontroller_imports.items():
-        if getattr(detector.chip, chip_key):
-            if isinstance(chip_module, dict):
-                # Loop through the children and import the first one that matches
-                for board_key, board_chip_module in chip_module.items():
-                    if board_key.startswith("any_") and getattr(
-                        detector.board, board_key
-                    ):
-                        # import Pin from the microcontroller module
-                        import_mod(globals(), f"{board_chip_module}.pin", "*")
-                        break
-                    if board_key == getattr(detector.board, board_key):
-                        import_mod(globals(), f"{board_chip_module}.pin", "*")
-                        break
-                else:
-                    import_mod(globals(), f"{chip_module['default']}.pin", "*")
-                break
-            import_mod(globals(), f"{chip_module}.pin", "*")
-            break
-    else:
+    if not import_microcontroller(globals(), microcontroller_imports, "", "*"):
         if chip_id == ap_chip.GENERIC_X86:
             print(
                 "WARNING: GENERIC_X86 is not fully supported. Some features may not work."

src/microcontroller/pin.py

@@ -5,36 +5,16 @@
 import sys
 import json
 from adafruit_platformdetect.constants import chips as ap_chip
-from adafruit_blinka.agnostic import chip_id, detector
-from adafruit_blinka.importing import import_mod, get_import_file
+from adafruit_blinka.agnostic import chip_id
+from adafruit_blinka.importing import get_import_file, import_microcontroller
 
 # We intentionally are patching into this namespace so skip the wildcard check.
 # pylint: disable=unused-wildcard-import,wildcard-import,ungrouped-imports
 
 
 with open(get_import_file("../microcontroller_imports.json", __file__)) as f:
     microcontroller_imports = json.load(f)
-
-    for chip_key, chip_module in microcontroller_imports.items():
-        if getattr(detector.chip, chip_key):
-            if isinstance(chip_module, dict):
-                # Loop through the children and import the first one that matches
-                for board_key, board_chip_module in chip_module.items():
-                    if board_key.startswith("any_") and getattr(
-                        detector.board, board_key
-                    ):
-                        # import Pin from the microcontroller module
-                        import_mod(globals(), f"{board_chip_module}.pin", "*")
-                        break
-                    if board_key == getattr(detector.board, board_key):
-                        import_mod(globals(), f"{board_chip_module}.pin", "*")
-                        break
-                else:
-                    import_mod(globals(), f"{chip_module['default']}.pin", "*")
-                break
-            import_mod(globals(), f"{chip_module}.pin", "*")
-            break
-    else:
+    if not import_microcontroller(globals(), microcontroller_imports, "pin", "*"):
         if "sphinx" in sys.modules:
             # pylint: disable=unused-import
             from adafruit_blinka.microcontroller.generic_micropython import Pin