!feat: Implement logging (#31)

Moved some items around in CLI and changed how context is passed, hence
the breaking change flag

Author: KC3ZVD

src/kc3zvd/iot_state/__init__.py

@@ -1,3 +1,3 @@
 # SPDX-FileCopyrightText: 2024-present KC3ZVD <[email protected]>
 #
-# SPDX-License-Identifier: MIT
+# SPDX-License-Identifier: MIT

src/kc3zvd/iot_state/cli/__init__.py

@@ -4,40 +4,38 @@
 import click
 from kc3zvd.iot_state.__about__ import __version__
 from kc3zvd.iot_state.publishers import mqtt
+from .core.mqtt import mqtt
+import logging
+import sys
+
+
+logger = logging.getLogger('kc3zvd.iot_state')
+handler = logging.StreamHandler(sys.stdout)
+formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+handler.setFormatter(formatter)
+logger.addHandler(handler)
 
 @click.group(context_settings={"help_option_names": ["-h", "--help"], "auto_envvar_prefix": "IOT"}, invoke_without_command=False)
 @click.version_option(version=__version__, prog_name="iot-state")
+@click.option('--log-level', help="Log level", default="INFO", type=str)
 @click.option('--redis-username', help="Redis instance username", default='', type=str)
 @click.option('--redis-password', help="Redis instance password", default='', type=str)
 @click.option('--redis-host', help="Redis instance host", default='localhost', type=str)
 @click.option('--redis-port', help="Redis instance port", default=6379, type=int)
 @click.option('--redis-db', help="Redis instance DB number", default=0, type=int)
 @click.pass_context
-def iot_state(ctx, redis_username, redis_password, redis_host, redis_port, redis_db):
+def iot_state(ctx, log_level, redis_username, redis_password, redis_host, redis_port, redis_db):
+    logger.setLevel(level=log_level)
+    handler.setLevel(level=log_level)
+
     ctx.ensure_object(dict)
 
     if redis_username or redis_password:
         if not redis_username or not redis_password:
-            click.echo("Provide both username and password for redis")
+            logger.error("Provide both username and password for redis")
             exit()
         ctx.obj['redis_url'] = f"redis://{redis_username}:{redis_password}@{redis_host}:{redis_port}/{redis_db}"
     else:
         ctx.obj['redis_url'] = f"redis://{redis_host}:{redis_port}/{redis_db}"
-    click.echo("Starting IOT state platform")
 
-@iot_state.command()
-@click.option('--platform', help="The platform to publish to", required=True, 
-              type=click.Choice(['mqtt'], case_sensitive=False))
-@click.option('--mqtt-host', help="The MQTT host to connect to", default='localhost', type=str)
-@click.option('--mqtt-port', help="The port to use to connect to the MQTT host", default=1883, type=int)
-@click.option('--mqtt-prefix', help="The prefix to use for the MQTT topic", default='', type=str)
-@click.pass_context
-def publisher(ctx, platform, mqtt_host, mqtt_port, mqtt_prefix):
-    match platform:
-        case 'mqtt':
-            click.echo("mqtt platform selected")
-            mqtt.run(
-                redis_url=ctx.obj['redis_url'],
-            )
-        case _:
-            exit()
+iot_state.add_command(mqtt)

src/kc3zvd/iot_state/cli/core/mqtt.py

@@ -0,0 +1,28 @@
+from kc3zvd.iot_state.publishers import mqtt as p
+import click
+
+@click.group()
+@click.option('--host', help="The MQTT host to connect to", default='localhost', type=str)
+@click.option('--port', help="The port to use to connect to the MQTT host", default=1883, type=int)
+@click.option('--topic_prefix', help="The prefix to use for the MQTT topic", default='', type=str)
+@click.pass_context
+def mqtt(ctx, host, port, topic_prefix):
+    ctx.ensure_object(dict)
+    try:
+        if topic_prefix[-1] != '/':
+            topic_prefix = f"{topic_prefix}/"
+    except IndexError:
+        pass
+
+
+    ctx.obj['mqtt'] = {
+        "host": host,
+        "port": port,
+        "topic_prefix": topic_prefix
+    }
+
+@mqtt.command() 
+
+@click.pass_context
+def publisher(ctx):
+    p.run()

src/kc3zvd/iot_state/publishers/mqtt.py

@@ -4,54 +4,54 @@
 import asyncio
 import json
 import click
+import logging
+logger = logging.getLogger(__name__)
 # prefix/device_type/area_name/device_name/state_class
 
 async def handle_state_messages(channel: redis.client.PubSub):
 
-    c = click.get_current_context()
-    print(c.params)
-
+    ctx = click.get_current_context()
     mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
-    mqttc.connect(host=c.params['mqtt_host'], port=c.params['mqtt_port'])
+    mqttc.connect(host=ctx.obj['mqtt']['host'], port=ctx.obj['mqtt']['port'])
     mqttc.loop_start()
     while True:
         message = await channel.get_message(ignore_subscribe_messages=True)
         if message is not None:
-            print(f"(Reader) Message Received: {message}")
+            logger.info("Handling state message")
+            logger.debug(message)
 
             payload = json.loads(message['data'].decode('utf-8'))
 
             try:
                 device = payload['data']['device']
                 state = payload['data']['state']
             except KeyError:
-                print("Missing key in message")
+                logger.infq:("Missing key in message")
                 continue
 
 
-            print(f"area: {device['area']}")
-
-            if c.params['mqtt_prefix']:
-                if c.params['mqtt_prefix'][-1] != '/':
-                    mqtt_prefix = f"{c.params['mqtt_prefix']}/"
-
-            topic = f"{c.params['mqtt_prefix']}{device['device_type']}/{device['area_name']}/{device['friendly_name']}/{state['state_class']}"
+            topic = f"{ctx.obj['mqtt']['topic_prefix']}{device['device_type']}/{device['area_name']}/{device['friendly_name']}/{state['state_class']}"
 
             message = {
                 "device": device,
                 "state": state
             }
 
             message = json.dumps(device)
-            print(f"Sending message to topic {topic}: {message}")
+            logger.info("Sending message to mqtt")
+            logger.debug(f"Topic: {topic}")
+            logger.debug(f"Message: {message}")
             mqttc.publish(topic=topic, payload=json.dumps(message)).wait_for_publish()
     mqttc.disconnect()
     mqttc.loop_stop()
 
 async def handle_notification_messages(channel: redis.client.PubSub):
     pass
 
-async def subscribe(redis_url: str):
+async def subscribe():
+    ctx = click.get_current_context()
+    redis_url = ctx.obj['redis_url']
+    logger.debug('Creating event queue subscribers...')
     update = asyncio.create_task(redis.subscribe('device:state:update', handle_state_messages, redis_url))
     create = asyncio.create_task(redis.subscribe('device:state:create', handle_state_messages, redis_url))
     p_all = asyncio.create_task(redis.subscribe('notification:all', handle_notification_messages, redis_url))
@@ -61,7 +61,7 @@ async def subscribe(redis_url: str):
     await p_all
     await p_mqtt
 
-def run(redis_url: str):
+def run():
     """Begins monitoring of queue to publish events to mqtt
 
     Note: Events Monitored
@@ -70,10 +70,7 @@ def run(redis_url: str):
         - `notification:all`
         - `notification:mqtt`
     
-    Args:
-        redis_url: The connection string to the redis instance in URL form
-        publisher: MQTT connection details
     """
-
-    asyncio.run(subscribe(redis_url))
+    logger.info("Starting iot-state service(s)...")
+    asyncio.run(subscribe())
 

src/kc3zvd/iot_state/subscribers/redis.py

@@ -2,11 +2,14 @@
 from typing import Callable
 import redis.asyncio as redis
 import asyncio
+import logging
+logger = logging.getLogger(__name__)
 
 async def subscribe(channel: str, callback: Callable[[], None], redis_url: str):
     client = redis.Redis.from_url(redis_url)
 
-    print(f"Subscribing to channel: {channel}")
+    message = f"Subscribing to channel: {channel}"
+    logger.info(message)
     async with client.pubsub() as pubsub:
         await pubsub.subscribe(channel)
         future = asyncio.create_task(callback(pubsub))

src/kc3zvd/iot_state/subscribers/wled.py

@@ -76,12 +76,7 @@ async def async_close(self) -> None:
 
 def listen() -> None:
     # Set up logging
-    logger.setLevel(level=logging.DEBUG)
-    handler = logging.StreamHandler(sys.stdout)
-    handler.setLevel(level=logging.DEBUG)
-    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-    handler.setFormatter(formatter)
-    logger.addHandler(handler)
+    
 
     # set up event loop
     loop = asyncio.get_event_loop()

src/kc3zvd/iot_state/utility.py

@@ -1,2 +1,5 @@
+from __future__ import annotations
+
+
 def normalize(content: str) -> str:
-    return content.lower().replace(" ", "_")
+    return content.lower().replace(" ", "_")