refactor

evolver/adapter/__init__.py

@@ -1,21 +0,0 @@
-from abc import ABC, abstractmethod
-from pydantic import BaseModel
-
-
-class Adapter(ABC):
-    class Config(BaseModel):
-        pass
-
-    def __init__(self, evolver, config: Config = None):
-        self.config = config or self.Config()
-
-    @abstractmethod
-    def react(self):
-        pass
-
-
-class NoOpAdapter(Adapter):
-    ncalls = 0
-
-    def react(self):
-        self.ncalls += 1

evolver/adapter/demo.py

@@ -0,0 +1,8 @@
+from evolver.adapter.interface import Adapter
+
+
+class NoOpAdapter(Adapter):
+    ncalls = 0
+
+    def react(self):
+        self.ncalls += 1

evolver/adapter/interface.py

@@ -0,0 +1,14 @@
+import pydantic
+from abc import ABC, abstractmethod
+
+
+class Adapter(ABC):
+    class Config(pydantic.BaseModel):
+        pass
+
+    def __init__(self, evolver, config: Config = None):
+        self.config = config or self.Config()
+
+    @abstractmethod
+    def react(self):
+        pass

evolver/app/tests/test_app.py

@@ -18,11 +18,11 @@ def test_evolver_app_default_config_dump_endpoint(self, app_client):
         assert sorted(response.json().keys()) == ['config', 'last_read', 'state']
 
     def test_evolver_update_config_endpoint(self, app_client):
-        data = {'hardware': {'test': {'driver': 'evolver.hardware.NoOpSensorDriver'}}}
+        data = {'hardware': {'test': {'driver': 'evolver.hardware.demo.NoOpSensorDriver'}}}
         response = app_client.post('/', json=data)
         assert response.status_code == 200
         newconfig = app_client.get('/').json()['config']
-        assert newconfig['hardware']['test']['driver'] == 'evolver.hardware.NoOpSensorDriver'
+        assert newconfig['hardware']['test']['driver'] == 'evolver.hardware.demo.NoOpSensorDriver'
 
     def test_evolver_app_react_loop_setup(self, app_client):
         # The context manager ensures that startup event loop is called

evolver/device.py

@@ -1,7 +1,7 @@
 import time
-from pydantic import BaseModel
+import pydantic
 from evolver.util import load_class_fqcn, driver_from_descriptor
-from evolver.hardware import SensorDriver, EffectorDriver
+from evolver.hardware.interface import SensorDriver, EffectorDriver
 from evolver.serial import EvolverSerialUART
 from evolver.history import HistoryServer
 
@@ -10,7 +10,7 @@
 DEFAULT_HISTORY = HistoryServer
 
 
-class AdapterDescriptor(BaseModel):
+class AdapterDescriptor(pydantic.BaseModel):
     driver: str
     config: dict = {}
 
@@ -19,7 +19,7 @@ class HardwareDriverDescriptor(AdapterDescriptor):
     calibrator: AdapterDescriptor = None
 
 
-class EvolverConfig(BaseModel):
+class EvolverConfig(pydantic.BaseModel):
     vials: list = list(range(16))
     hardware: dict[str, HardwareDriverDescriptor] = {}
     adapters: list[AdapterDescriptor] = []

evolver/hardware/__init__.py

@@ -1,107 +0,0 @@
-from abc import ABC, abstractmethod
-from copy import copy
-from pydantic import BaseModel
-
-
-class VialConfigBaseModel(BaseModel):
-    vials: list[int] | None = None
-
-
-class VialBaseModel(BaseModel):
-    vial: int
-
-
-class BaseCalibrator(ABC):
-    class Config(BaseModel):
-        calibfile: str = None
-
-    def __init__(self, evovler = None, config: Config = Config()):
-        self.config = config
-
-    @property
-    @abstractmethod
-    def status(self):
-        pass
-
-
-class NoOpCalibrator(BaseCalibrator):
-    @property
-    def status(self):
-        return True
-
-
-class HardwareDriver(ABC):
-    class Config(BaseModel):
-        pass
-    calibrator = NoOpCalibrator()
-
-    def __init__(self, evolver, config = None, calibrator = None):
-        self.evolver = evolver
-        self.reconfigure(config or self.Config())
-        if calibrator:
-            self.calibrator = calibrator
-
-    def reconfigure(self, config):
-        self.config = config
-
-
-class VialHardwareDriver(HardwareDriver):
-    def reconfigure(self, config):
-        super().reconfigure(config)
-        if config.vials is None:
-            config.vials = self.evolver.config.vials
-        else:
-            if not set(config.vials).issubset(self.evolver.all_vials):
-                raise ValueError('invalid vials found in config')
-
-
-class SensorDriver(VialHardwareDriver):
-    class Config(VialConfigBaseModel):
-        pass
-    class Output(VialBaseModel):
-        raw: int
-        value: float
-    outputs: dict[int, Output] = {}
-
-    def get(self) -> list[Output]:
-        return self.outputs
-
-    @abstractmethod
-    def read(self):
-        pass
-
-
-class EffectorDriver(VialHardwareDriver):
-    class Config(VialConfigBaseModel):
-        pass
-    class Input(VialBaseModel):
-        value: float
-    proposal: dict[int, Input] = {}
-    committed: dict[int, Input] = {}
-
-    def set(self, input: Input):
-        self.proposal[input.vial] = input
-
-    @abstractmethod
-    def commit(self):
-        pass
-
-
-class NoOpSensorDriver(SensorDriver):
-    class Config(VialConfigBaseModel):
-        echo_raw: int = 1
-        echo_val: int = 2
-
-    def read(self):
-        self.outputs = {
-            i: self.Output(vial=i, raw=self.config.echo_raw, value=self.config.echo_val)
-            for i in self.config.vials
-        }
-
-    def get(self):
-        return self.outputs
-
-
-class NoOpEffectorDriver(EffectorDriver):
-    def commit(self):
-        self.comitted = copy(self.proposal)

evolver/hardware/demo.py

@@ -0,0 +1,28 @@
+from copy import copy
+from evolver.hardware.interface import SensorDriver, EffectorDriver, VialConfigBaseModel, BaseCalibrator
+
+
+class NoOpSensorDriver(SensorDriver):
+    class Config(VialConfigBaseModel):
+        echo_raw: int = 1
+        echo_val: int = 2
+
+    def read(self):
+        self.outputs = {
+            i: self.Output(vial=i, raw=self.config.echo_raw, value=self.config.echo_val)
+            for i in self.config.vials
+        }
+
+    def get(self):
+        return self.outputs
+
+
+class NoOpEffectorDriver(EffectorDriver):
+    def commit(self):
+        self.comitted = copy(self.proposal)
+
+
+class NoOpCalibrator(BaseCalibrator):
+    @property
+    def status(self):
+        return True

evolver/hardware/interface.py

@@ -0,0 +1,80 @@
+import pydantic
+from abc import ABC, abstractmethod
+
+
+class VialConfigBaseModel(pydantic.BaseModel):
+    vials: list[int] | None = None
+
+
+class VialBaseModel(pydantic.BaseModel):
+    vial: int
+
+
+class BaseCalibrator(ABC):
+    class Config(pydantic.BaseModel):
+        calibfile: str = None
+
+    def __init__(self, evovler = None, config: Config = Config()):
+        self.config = config
+
+    @property
+    @abstractmethod
+    def status(self):
+        pass
+
+
+class HardwareDriver(ABC):
+    class Config(pydantic.BaseModel):
+        pass
+    calibrator = None
+
+    def __init__(self, evolver, config = None, calibrator = None):
+        self.evolver = evolver
+        self.reconfigure(config or self.Config())
+        if calibrator:
+            self.calibrator = calibrator
+
+    def reconfigure(self, config):
+        self.config = config
+
+
+class VialHardwareDriver(HardwareDriver):
+    def reconfigure(self, config):
+        super().reconfigure(config)
+        if config.vials is None:
+            config.vials = self.evolver.config.vials
+        else:
+            if not set(config.vials).issubset(self.evolver.all_vials):
+                raise ValueError('invalid vials found in config')
+
+
+class SensorDriver(VialHardwareDriver):
+    class Config(VialConfigBaseModel):
+        pass
+    class Output(VialBaseModel):
+        raw: int
+        value: float
+    outputs: dict[int, Output] = {}
+
+    def get(self) -> list[Output]:
+        return self.outputs
+
+    @abstractmethod
+    def read(self):
+        pass
+
+
+class EffectorDriver(VialHardwareDriver):
+    class Config(VialConfigBaseModel):
+        pass
+    class Input(VialBaseModel):
+        value: float
+    proposal: dict[int, Input] = {}
+    committed: dict[int, Input] = {}
+
+    def set(self, input: Input):
+        self.proposal[input.vial] = input
+
+    @abstractmethod
+    def commit(self):
+        pass

evolver/history.py

@@ -1,11 +1,11 @@
 import time
+import pydantic
 from abc import ABC, abstractmethod
 from collections import defaultdict
-from pydantic import BaseModel
 
 
 class History(ABC):
-    class Config(BaseModel):
+    class Config(pydantic.BaseModel):
         pass
 
     @abstractmethod

evolver/serial.py

@@ -1,17 +1,17 @@
 import serial
 from abc import ABC, abstractmethod
-from pydantic import BaseModel
+import pydantic
 from threading import Lock
 
 
-class SerialData(BaseModel):
+class SerialData(pydantic.BaseModel):
     addr: str
     data: list[bytes]
     kind: str = 'r'
 
 
 class Serial(ABC):
-    class Config(BaseModel):
+    class Config(pydantic.BaseModel):
         pass
 
     def __init__(self, evolver = None, config: Config = None):
@@ -24,7 +24,7 @@ def communicate(cmd: SerialData) -> SerialData:
 
 
 class EvolverSerialUART(Serial):
-    class Config(BaseModel):
+    class Config(pydantic.BaseModel):
         port: str = '/dev/ttyAMA0'
         baudrate: int = 9600
         timeout: float = 1

evolver/tests/test_device.py

@@ -1,6 +1,6 @@
 import pytest
 from evolver.device import Evolver, EvolverConfig
-from evolver.hardware import NoOpSensorDriver
+from evolver.hardware.demo import NoOpSensorDriver
 
 
 @pytest.fixture
@@ -10,16 +10,16 @@ def conf_with_driver():
         'hardware': {
             'testsensor': {
                 'driver':
-                'evolver.hardware.NoOpSensorDriver',
+                'evolver.hardware.demo.NoOpSensorDriver',
                 'config': {},
                 'calibrator': {
-                    'driver': 'evolver.hardware.NoOpCalibrator'
+                    'driver': 'evolver.hardware.demo.NoOpCalibrator'
                 }
             },
-            'testeffector': {'driver': 'evolver.hardware.NoOpEffectorDriver', 'config': {}},
+            'testeffector': {'driver': 'evolver.hardware.demo.NoOpEffectorDriver', 'config': {}},
         },
         'adapters': [
-            {'driver': 'evolver.adapter.NoOpAdapter'},
+            {'driver': 'evolver.adapter.demo.NoOpAdapter'},
         ],
         'serial': { 'driver': 'evolver.serial.EchoSerial' },
     }