Update registration process for devices to be explicit (#177)

Author: stefren

requirements.txt

@@ -1,17 +1,13 @@
 # type: ignore[attr-defined]
 """wearables in development"""
-
-import importlib
-import importlib.util
-from importlib import import_module
+import os
 
 try:
     from importlib import metadata as importlib_metadata
 except ImportError:  # for Python<3.8
     import importlib_metadata as importlib_metadata
 
-from .constants import *
-from .devices import *
+from .devices import registry
 
 
 def get_device(device_name, **kwargs):
@@ -34,56 +30,22 @@ def get_device(device_name, **kwargs):
         device = wearipedia.get_device("whoop/whoop_4")
         ...
     """
-    company, model = device_name.split("/")
-
-    module_path = f"{PACKAGE_PATH}/devices/{device_name}.py"
-
-    spec = importlib.util.spec_from_file_location(
-        name=f"wearipedia.devices.{company}.{model}",
-        location=module_path,
-    )
-
-    module = importlib.util.module_from_spec(spec)
-
-    spec.loader.exec_module(module)
-
-    class_name = getattr(module, "class_name")
+    try:
+        device_class = registry.get_device_class(device_name)
+    except KeyError:
+        raise ValueError(f"Device '{device_name}' is not registered")
 
-    return getattr(module, class_name)(**kwargs)
+    return device_class(**kwargs)
 
 
-def get_all_device_names():
+def get_all_device_names() -> list[str]:
     """Get a list of all device names.
 
     :return: a list of device names
     :rtype: List
     """
 
-    return [
-        "apple/healthkit",
-        "biostrap/evo",
-        "cronometer/cronometer",
-        "whoop/whoop_4",
-        "withings/scanwatch",
-        "withings/bodyplus",
-        "withings/sleepmat",
-        "dreem/headband_2",
-        "dexcom/pro_cgm",
-        "garmin/fenix_7s",
-        "google/googlefit",
-        "polar/h10",
-        "polar/verity_sense",
-        "nutrisense/cgm",
-        "fitbit/fitbit_charge_4",
-        "fitbit/fitbit_charge_6",
-        "fitbit/fitbit_sense",
-        "oura/oura_ring3",
-        "coros/coros_pace_2",
-        "polar/vantage",
-        "strava/strava",
-        "myfitnesspal/myfitnesspal",
-        "qualtrics/qualtrics",
-    ]
+    return registry.REGISTRY.keys()
 
 
 def get_version() -> str:

wearipedia/__init__.py

@@ -1,14 +1,59 @@
-from .apple import *
-from .biostrap import *
-from .cronometer import *
-from .dexcom import *
-from .dreem import *
-from .fitbit import *
-from .garmin import *
-from .google import *
-from .myfitnesspal import *
-from .oura import *
-from .polar import *
-from .strava import *
-from .whoop import *
-from .withings import *
+"""Device registration module."""
+
+# Import all device classes
+from .apple.healthkit import HealthKit
+from .biostrap.evo import EVO
+from .coros.coros_pace_2 import CorosPace2
+from .cronometer.cronometer import Cronometer
+from .dexcom.pro_cgm import DexcomProCGM
+from .dreem.headband_2 import DreemHeadband2
+from .fitbit.fitbit_charge_4 import FitbitCharge4
+from .fitbit.fitbit_charge_6 import FitbitCharge6
+from .fitbit.fitbit_sense import FitbitSense
+from .fitbit.google_pixel_watch import GooglePixelWatch
+from .garmin.fenix_7s import Fenix7S
+from .google.googlefit import GoogleFit
+from .myfitnesspal.myfitnesspal import MyFitnessPal
+from .nutrisense.cgm import NutrisenseCGM
+from .oura.oura_ring3 import OuraRing3
+from .polar.h10 import H10
+from .polar.vantage import PolarVantage
+from .polar.verity_sense import VeritySense
+from .qualtrics.qualtrics import Qualtrics
+from .registry import register_device
+from .strava.strava import Strava
+from .whoop.whoop_4 import Whoop4
+from .withings.bodyplus import BodyPlus
+from .withings.scanwatch import ScanWatch
+from .withings.sleepmat import SleepMat
+
+ALL_DEVICES = [
+    HealthKit,
+    EVO,
+    CorosPace2,
+    Cronometer,
+    DexcomProCGM,
+    DreemHeadband2,
+    FitbitCharge4,
+    FitbitCharge6,
+    FitbitSense,
+    GooglePixelWatch,
+    Fenix7S,
+    GoogleFit,
+    MyFitnessPal,
+    NutrisenseCGM,
+    OuraRing3,
+    H10,
+    PolarVantage,
+    VeritySense,
+    Qualtrics,
+    Whoop4,
+    ScanWatch,
+    BodyPlus,
+    SleepMat,
+    Strava,
+]
+
+# Register all devices
+for device in ALL_DEVICES:
+    register_device(device)

wearipedia/constants.py

@@ -7,8 +7,6 @@
 from ...utils import bin_search, seed_everything
 from .apple_gen import *
 
-class_name = "HealthKit"
-
 
 class HealthKit(BaseDevice):
     """This device allows you to work with data from `Apple HealthKit <https://www.apple.com/ios/health/>`_ .
@@ -30,6 +28,8 @@ class HealthKit(BaseDevice):
     :type use_cache: bool, optional
     """
 
+    name = "apple/healthkit"
+
     def __init__(
         self,
         seed=0,

wearipedia/devices/__init__.py

@@ -11,10 +11,11 @@
 from .evo_fetch import *
 from .evo_gen import *
 
-class_name = "EVO"
-
 
 class EVO(BaseDevice):
+
+    name = "biostrap/evo"
+
     def __init__(self, seed=0, start_date="2023-06-05", end_date="2023-06-20"):
         params = {
             "seed": seed,

wearipedia/devices/apple/healthkit.py

@@ -6,10 +6,8 @@
 from .coros_pace_2_fetch import *
 from .coros_pace_2_gen import *
 
-class_name = "Coros_pace_2"
 
-
-class Coros_pace_2(BaseDevice):
+class CorosPace2(BaseDevice):
     """This device allows you to work with data from the `Fitbit charge  <(https://www.fitbit.com/global/au/products/trackers/charge4)>`_ device.
     Available datatypes for this device are:
 
@@ -28,6 +26,8 @@ class Coros_pace_2(BaseDevice):
     :type synthetic_end_date: str, optional
     """
 
+    name = "coros/coros_pace_2"
+
     def __init__(
         self,
         seed=0,

wearipedia/devices/biostrap/evo.py

@@ -9,8 +9,6 @@
 from .cronometer_fetch import *
 from .cronometer_synthetic import *
 
-class_name = "Cronometer"
-
 # todo: change this to better path
 CRED_CACHE_PATH = "/tmp/wearipedia_cronometer_data.pkl"
 
@@ -38,6 +36,8 @@ class Cronometer(BaseDevice):
     :type use_cache: bool, optional
     """
 
+    name = "cronometer/cronometer"
+
     def __init__(self, seed=0, start_date="2022-03-01", end_date="2022-06-17"):
         params = {
             "seed": seed,

wearipedia/devices/coros/coros_pace_2.py

@@ -9,8 +9,6 @@
 from .pro_cgm_fetch import *
 from .pro_cgm_gen import *
 
-class_name = "DexcomProCGM"
-
 
 class DexcomProCGM(BaseDevice):
     """This device allows you to work with data from the `Dexcom Pro CGM <https://provider.dexcom.com/products/dexcom-g6-pro>`_ device.
@@ -26,6 +24,8 @@ class DexcomProCGM(BaseDevice):
     :type synthetic_end_date: str, optional
     """
 
+    name = "dexcom/pro_cgm"
+
     def __init__(
         self, seed=0, synthetic_start_date="2022-02-16", synthetic_end_date="2022-05-15"
     ):

wearipedia/devices/cronometer/cronometer.py

@@ -10,10 +10,11 @@
 from .dreem_fetch import *
 from .dreem_gen import *
 
-class_name = "DreemHeadband2"
-
 
 class DreemHeadband2(BaseDevice):
+
+    name = "dreem/headband_2"
+
     def __init__(
         self, seed=0, synthetic_start_date="2022-03-01", synthetic_end_date="2022-06-17"
     ):