Merge pull request #17 from Enapter/rnovatorov/dev

Split Enapter MQTT API Logic Into A Separate Package

Author: rnovatorov

enapter/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.8.0"
+__version__ = "0.9.0"
 
 from . import async_, log, mdns, mqtt, types, vucm
 

enapter/mqtt/__init__.py

@@ -1,14 +1,9 @@
+from . import api
 from .client import Client
-from .command import CommandRequest, CommandResponse, CommandState
 from .config import Config
-from .device_channel import DeviceChannel, DeviceLogSeverity
 
 __all__ = [
+    "api",
     "Client",
-    "CommandRequest",
-    "CommandResponse",
-    "CommandState",
     "Config",
-    "DeviceChannel",
-    "DeviceLogSeverity",
 ]

enapter/mqtt/api/__init__.py

@@ -0,0 +1,11 @@
+from .command import CommandRequest, CommandResponse, CommandState
+from .device_channel import DeviceChannel
+from .log_severity import LogSeverity
+
+__all__ = [
+    "CommandRequest",
+    "CommandResponse",
+    "CommandState",
+    "DeviceChannel",
+    "LogSeverity",
+]

enapter/mqtt/command.py renamed to enapter/mqtt/api/command.py

@@ -1,9 +1,9 @@
-import enum
 import json
 import logging
 import time
 
-from .. import async_
+import enapter
+
 from .command import CommandRequest
 
 LOGGER = logging.getLogger(__name__)
@@ -29,7 +29,7 @@ def _new_logger(hardware_id, channel_id):
         extra = {"hardware_id": hardware_id, "channel_id": channel_id}
         return logging.LoggerAdapter(LOGGER, extra=extra)
 
-    @async_.generator
+    @enapter.async_.generator
     async def subscribe_to_command_requests(self):
         async with self._subscribe("v1/command/requests") as messages:
             async for msg in messages:
@@ -72,10 +72,3 @@ async def _publish(self, path, payload, **kwargs):
             await self._client.publish(topic, payload, **kwargs)
         except Exception as e:
             self._logger.error("failed to publish %s: %r", path, e)
-
-
-class DeviceLogSeverity(enum.Enum):
-    DEBUG = "debug"
-    INFO = "info"
-    WARNING = "warning"
-    ERROR = "error"

enapter/mqtt/device_channel.py renamed to enapter/mqtt/api/device_channel.py

@@ -0,0 +1,8 @@
+import enum
+
+
+class LogSeverity(enum.Enum):
+    DEBUG = "debug"
+    INFO = "info"
+    WARNING = "warning"
+    ERROR = "error"

enapter/mqtt/api/log_severity.py

@@ -7,17 +7,16 @@
 
 import aiomqtt
 
-from .. import async_, mdns
-from .device_channel import DeviceChannel
+import enapter
 
 LOGGER = logging.getLogger(__name__)
 
 
-class Client(async_.Routine):
+class Client(enapter.async_.Routine):
     def __init__(self, config):
         self._logger = self._new_logger(config)
         self._config = config
-        self._mdns_resolver = mdns.Resolver()
+        self._mdns_resolver = enapter.mdns.Resolver()
         self._tls_context = self._new_tls_context(config)
         self._client = None
         self._client_ready = asyncio.Event()
@@ -31,16 +30,11 @@ def _new_logger(config):
     def config(self):
         return self._config
 
-    def device_channel(self, hardware_id, channel_id):
-        return DeviceChannel(
-            client=self, hardware_id=hardware_id, channel_id=channel_id
-        )
-
     async def publish(self, *args, **kwargs):
         client = await self._wait_client()
         await client.publish(*args, **kwargs)
 
-    @async_.generator
+    @enapter.async_.generator
     async def subscribe(self, topic):
         while True:
             client = await self._wait_client()

enapter/mqtt/client.py

@@ -1,20 +1,21 @@
 import asyncio
 
-from .. import async_, log, mqtt
+import enapter
+
 from .config import Config
 from .ucm import UCM
 
 
 async def run(device_factory):
-    log.configure(level=log.LEVEL or "info")
+    enapter.log.configure(level=enapter.log.LEVEL or "info")
 
     config = Config.from_env()
 
     async with App(config=config, device_factory=device_factory) as app:
         await app.join()
 
 
-class App(async_.Routine):
+class App(enapter.async_.Routine):
     def __init__(self, config, device_factory):
         self._config = config
         self._device_factory = device_factory
@@ -23,7 +24,7 @@ async def _run(self):
         tasks = set()
 
         mqtt_client = await self._stack.enter_async_context(
-            mqtt.Client(config=self._config.mqtt)
+            enapter.mqtt.Client(config=self._config.mqtt)
         )
         tasks.add(mqtt_client.task())
 
@@ -35,7 +36,7 @@ async def _run(self):
 
         device = await self._stack.enter_async_context(
             self._device_factory(
-                channel=mqtt_client.device_channel(
+                channel=enapter.mqtt.api.DeviceChannel(
                     hardware_id=self._config.hardware_id,
                     channel_id=self._config.channel_id,
                 )

enapter/vucm/app.py

@@ -2,7 +2,7 @@
 import json
 import os
 
-from .. import mqtt
+import enapter
 
 
 class Config:
@@ -23,7 +23,7 @@ def from_env(cls, prefix="ENAPTER_VUCM_", env=os.environ):
         hardware_id = os.environ[prefix + "HARDWARE_ID"]
         channel_id = os.environ[prefix + "CHANNEL_ID"]
 
-        mqtt_config = mqtt.Config.from_env(prefix=prefix, env=env)
+        mqtt_config = enapter.mqtt.Config.from_env(prefix=prefix, env=env)
 
         start_ucm = os.environ.get(prefix + "START_UCM", "1") != "0"
 
@@ -38,7 +38,7 @@ def from_env(cls, prefix="ENAPTER_VUCM_", env=os.environ):
     def from_blob(cls, blob):
         payload = json.loads(base64.b64decode(blob))
 
-        mqtt_config = mqtt.Config(
+        mqtt_config = enapter.mqtt.Config(
             host=payload["mqtt_host"],
             port=int(payload["mqtt_port"]),
             tls_ca_cert=payload["mqtt_ca"],

enapter/vucm/config.py

@@ -4,11 +4,12 @@
 import traceback
 from typing import Optional, Set
 
-from .. import async_, mqtt, types
+import enapter
+
 from .logger import Logger
 
 
-class Device(async_.Routine):
+class Device(enapter.async_.Routine):
     def __init__(
         self,
         channel,
@@ -28,7 +29,9 @@ def __init__(
         self.log = Logger(channel=channel)
         self.alerts: Set[str] = set()
 
-    async def send_telemetry(self, telemetry: Optional[types.JSON] = None) -> None:
+    async def send_telemetry(
+        self, telemetry: Optional[enapter.types.JSON] = None
+    ) -> None:
         if telemetry is None:
             telemetry = {}
         else:
@@ -38,7 +41,9 @@ async def send_telemetry(self, telemetry: Optional[types.JSON] = None) -> None:
 
         await self.__channel.publish_telemetry(telemetry)
 
-    async def send_properties(self, properties: Optional[types.JSON] = None) -> None:
+    async def send_properties(
+        self, properties: Optional[enapter.types.JSON] = None
+    ) -> None:
         if properties is None:
             properties = {}
         else:
@@ -104,9 +109,11 @@ async def __execute_command(self, req):
         try:
             cmd = getattr(self, self.__cmd_prefix + req.name)
         except AttributeError:
-            return mqtt.CommandState.ERROR, {"reason": "unknown command"}
+            return enapter.mqtt.api.CommandState.ERROR, {"reason": "unknown command"}
 
         try:
-            return mqtt.CommandState.COMPLETED, await cmd(**req.args)
+            return enapter.mqtt.api.CommandState.COMPLETED, await cmd(**req.args)
         except:
-            return mqtt.CommandState.ERROR, {"traceback": traceback.format_exc()}
+            return enapter.mqtt.api.CommandState.ERROR, {
+                "traceback": traceback.format_exc()
+            }