mqtt: extract api into a separate package

Author: rnovatorov

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,10 @@
+from .command import CommandRequest, CommandResponse, CommandState
+from .device_channel import DeviceChannel, DeviceLogSeverity
+
+__all__ = [
+    "CommandRequest",
+    "CommandResponse",
+    "CommandState",
+    "DeviceChannel",
+    "DeviceLogSeverity",
+]

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

@@ -9,8 +9,6 @@
 
 import enapter
 
-from .device_channel import DeviceChannel
-
 LOGGER = logging.getLogger(__name__)
 
 
@@ -32,11 +30,6 @@ 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)

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

@@ -36,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/mqtt/client.py

@@ -109,11 +109,11 @@ async def __execute_command(self, req):
         try:
             cmd = getattr(self, self.__cmd_prefix + req.name)
         except AttributeError:
-            return enapter.mqtt.CommandState.ERROR, {"reason": "unknown command"}
+            return enapter.mqtt.api.CommandState.ERROR, {"reason": "unknown command"}
 
         try:
-            return enapter.mqtt.CommandState.COMPLETED, await cmd(**req.args)
+            return enapter.mqtt.api.CommandState.COMPLETED, await cmd(**req.args)
         except:
-            return enapter.mqtt.CommandState.ERROR, {
+            return enapter.mqtt.api.CommandState.ERROR, {
                 "traceback": traceback.format_exc()
             }

enapter/vucm/app.py

@@ -18,29 +18,32 @@ def _new_logger(hardware_id, channel_id):
     async def debug(self, msg: str, persist: bool = False):
         self._logger.debug(msg)
         await self.log(
-            msg, severity=enapter.mqtt.DeviceLogSeverity.DEBUG, persist=persist
+            msg, severity=enapter.mqtt.api.DeviceLogSeverity.DEBUG, persist=persist
         )
 
     async def info(self, msg: str, persist: bool = False):
         self._logger.info(msg)
         await self.log(
-            msg, severity=enapter.mqtt.DeviceLogSeverity.INFO, persist=persist
+            msg, severity=enapter.mqtt.api.DeviceLogSeverity.INFO, persist=persist
         )
 
     async def warning(self, msg: str, persist: bool = False):
         self._logger.warning(msg)
         await self.log(
-            msg, severity=enapter.mqtt.DeviceLogSeverity.WARNING, persist=persist
+            msg, severity=enapter.mqtt.api.DeviceLogSeverity.WARNING, persist=persist
         )
 
     async def error(self, msg: str, persist: bool = False):
         self._logger.error(msg)
         await self.log(
-            msg, severity=enapter.mqtt.DeviceLogSeverity.ERROR, persist=persist
+            msg, severity=enapter.mqtt.api.DeviceLogSeverity.ERROR, persist=persist
         )
 
     async def log(
-        self, msg: str, severity: enapter.mqtt.DeviceLogSeverity, persist: bool = False
+        self,
+        msg: str,
+        severity: enapter.mqtt.api.DeviceLogSeverity,
+        persist: bool = False,
     ):
         await self._channel.publish_logs(msg=msg, severity=severity, persist=persist)
 

enapter/vucm/device.py

@@ -9,7 +9,7 @@ async def test_publish_telemetry(self, fake):
         channel_id = fake.channel_id()
         timestamp = fake.timestamp()
         mock_client = mock.Mock()
-        device_channel = enapter.mqtt.DeviceChannel(
+        device_channel = enapter.mqtt.api.DeviceChannel(
             client=mock_client, hardware_id=hardware_id, channel_id=channel_id
         )
         await device_channel.publish_telemetry({"timestamp": timestamp})
@@ -23,7 +23,7 @@ async def test_publish_telemetry_without_timestamp(self, fake):
         channel_id = fake.channel_id()
         timestamp = fake.timestamp()
         mock_client = mock.Mock()
-        device_channel = enapter.mqtt.DeviceChannel(
+        device_channel = enapter.mqtt.api.DeviceChannel(
             client=mock_client, hardware_id=hardware_id, channel_id=channel_id
         )
         with mock.patch("time.time") as mock_time:
@@ -39,7 +39,7 @@ async def test_publish_properties(self, fake):
         channel_id = fake.channel_id()
         timestamp = fake.timestamp()
         mock_client = mock.Mock()
-        device_channel = enapter.mqtt.DeviceChannel(
+        device_channel = enapter.mqtt.api.DeviceChannel(
             client=mock_client, hardware_id=hardware_id, channel_id=channel_id
         )
         await device_channel.publish_properties({"timestamp": timestamp})
@@ -53,7 +53,7 @@ async def test_publish_properties_without_timestamp(self, fake):
         channel_id = fake.channel_id()
         timestamp = fake.timestamp()
         mock_client = mock.Mock()
-        device_channel = enapter.mqtt.DeviceChannel(
+        device_channel = enapter.mqtt.api.DeviceChannel(
             client=mock_client, hardware_id=hardware_id, channel_id=channel_id
         )
         with mock.patch("time.time") as mock_time: