V0.3 global config cleanup (#150)

* test precommit
* add SAST comments
* refactor usage of global_config
* cleanup filenames
* verify most basic tests pass with log file settings changes
* cleanup db filenames little more
* bump version
* refactor DB models
* use dots in event publisher name
* optimize based on diff, move logger instances to structlog
* redo basicConfig
* add some tests

Author: VigneshVSV

hololinked/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.9"
+__version__ = "0.3.10"
 
 from .config import global_config  # noqa
 import hololinked.core  # noqa: F401

hololinked/client/__init__.py

@@ -1,2 +1,3 @@
+from ..config import global_config  # noqa: F401
 from .factory import ClientFactory as ClientFactory
 from .proxy import ObjectProxy as ObjectProxy

hololinked/client/abstractions.py

@@ -25,12 +25,13 @@
 
 import asyncio
 import builtins
-import logging
 import threading
 
 from dataclasses import dataclass
 from typing import Any, Callable
 
+import structlog
+
 from ..constants import Operations
 from ..td import ActionAffordance, EventAffordance, PropertyAffordance
 from ..td.forms import Form
@@ -45,7 +46,7 @@ def __init__(
         self,
         resource: ActionAffordance,
         owner_inst: Any,
-        logger: logging.Logger,
+        logger: structlog.stdlib.BoundLogger,
     ) -> None:
         """
         Parameters
@@ -54,7 +55,7 @@ def __init__(
             dataclass TD fragment representing the action (must have forms).
         owner_inst: Any
             instance of the owning consumed Thing or `ObjectProxy`
-        logger: logging.Logger
+        logger: structlog.stdlib.BoundLogger
             logger instance
         """
         self.resource = resource
@@ -172,15 +173,15 @@ class ConsumedThingProperty:
     # property get set abstraction
     # Dont add doc otherwise __doc__ in slots will conflict with class variable
 
-    def __init__(self, resource: PropertyAffordance, owner_inst: Any, logger: logging.Logger) -> None:
+    def __init__(self, resource: PropertyAffordance, owner_inst: Any, logger: structlog.stdlib.BoundLogger) -> None:
         """
         Parameters
         ----------
         resource: PropertyAffordance
             dataclass object TD fragment representing the property (must have forms).
         owner_inst: Any
             instance of the owning consumed Thing or `ObjectProxy`
-        logger: logging.Logger
+        logger: structlog.stdlib.BoundLogger
             logger instance
         """
         self.resource = resource
@@ -320,15 +321,15 @@ class ConsumedThingEvent:
     def __init__(
         self,
         resource: EventAffordance,
-        logger: logging.Logger,
+        logger: structlog.stdlib.BoundLogger,
         owner_inst: Any,
     ) -> None:
         """
         Parameters
         ----------
         resource: EventAffordance
             dataclass object representing the event
-        logger: logging.Logger
+        logger: structlog.stdlib.BoundLogger
             logger instance
         owner_inst: Any
             the parent object that owns this event

hololinked/client/factory.py

@@ -20,7 +20,7 @@
     EventAffordance,
     PropertyAffordance,
 )
-from ..utils import set_global_event_loop_policy, uuid_hex
+from ..utils import uuid_hex
 from .abstractions import ConsumedThingAction, ConsumedThingEvent, ConsumedThingProperty
 from .http.consumed_interactions import HTTPAction, HTTPEvent, HTTPProperty
 from .mqtt.consumed_interactions import MQTTConsumer  # only one type for now
@@ -35,9 +35,6 @@
 )
 
 
-set_global_event_loop_policy()
-
-
 class ClientFactory:
     """
     An factory class for creating clients to interact with Things over different protocols.
@@ -68,7 +65,7 @@ def zmq(
         kwargs:
             Additional configuration options:
 
-            - `logger`: `logging.Logger`, optional.
+            - `logger`: `structlog.stdlib.BoundLogger`, optional.
                  A custom logger instance to use for logging
             - `ignore_TD_errors`: `bool`, default `False`.
                 Whether to ignore errors while fetching the Thing Description (TD)
@@ -204,10 +201,8 @@ def http(self, url: str, **kwargs) -> ObjectProxy:
         kwargs:
             Additional configuration options:
 
-            - `logger`: `logging.Logger`, optional.
+            - `logger`: `structlog.stdlib.BoundLogger`, optional.
                 A custom logger instance to use for logging
-            - `log_level`: `int`, default `logging.INFO`.
-                The logging level to use for the client (e.g., logging.DEBUG, logging.INFO)
             - `ignore_TD_errors`: `bool`, default `False`.
                 Whether to ignore errors while fetching the Thing Description (TD)
             - `skip_interaction_affordances`: `list[str]`, default `[]`.
@@ -220,6 +215,8 @@ def http(self, url: str, **kwargs) -> ObjectProxy:
                 The timeout for establishing a HTTP connection (in seconds)
             - `request_timeout`: `float`, optional, default `60.0`.
                 The timeout for completing a HTTP request (in seconds)
+            - `security`: `BasicSecurity`, optional.
+                The security scheme to use for authentication
             - `username`: `str`, optional.
                 The username for HTTP Basic Authentication
             - `password`: `str`, optional.
@@ -378,10 +375,8 @@ def mqtt(
         kwargs:
             Additional configuration options:
 
-            - `logger`: `logging.Logger`, optional.
+            - `logger`: `structlog.stdlib.BoundLogger`, optional.
                  A custom logger instance to use for logging
-            - `log_level`: `int`, default `logging.INFO`.
-                The logging level to use for the client (e.g., logging.DEBUG, logging.INFO
         """
         id = kwargs.get("id", f"mqtt-client|{hostname}:{port}|{uuid_hex()}")
         logger = kwargs.get("logger", structlog.get_logger()).bind(

hololinked/client/http/consumed_interactions.py

@@ -4,14 +4,14 @@
 
 import asyncio
 import contextlib
-import logging
 import threading
 
 from copy import deepcopy
 from typing import Any, AsyncIterator, Callable, Iterator
 
 import httpcore
 import httpx
+import structlog
 
 from ...constants import Operations
 from ...serializers import Serializers
@@ -103,7 +103,7 @@ def __init__(
         invokation_timeout: int = 5,
         execution_timeout: int = 5,
         owner_inst: Any = None,
-        logger: logging.Logger = None,
+        logger: structlog.stdlib.BoundLogger = None,
     ) -> None:
         ConsumedThingAction.__init__(self=self, resource=resource, owner_inst=owner_inst, logger=logger)
         HTTPConsumedAffordanceMixin.__init__(
@@ -188,7 +188,7 @@ def __init__(
         invokation_timeout: int = 5,
         execution_timeout: int = 5,
         owner_inst: Any = None,
-        logger: logging.Logger = None,
+        logger: structlog.stdlib.BoundLogger = None,
     ) -> None:
         ConsumedThingProperty.__init__(self=self, resource=resource, owner_inst=owner_inst, logger=logger)
         HTTPConsumedAffordanceMixin.__init__(
@@ -311,7 +311,7 @@ def __init__(
         invokation_timeout: int = 5,
         execution_timeout: int = 5,
         owner_inst: Any = None,
-        logger: logging.Logger = None,
+        logger: structlog.stdlib.BoundLogger = None,
     ) -> None:
         ConsumedThingEvent.__init__(self, resource=resource, owner_inst=owner_inst, logger=logger)
         HTTPConsumedAffordanceMixin.__init__(

hololinked/client/mqtt/consumed_interactions.py

@@ -1,8 +1,7 @@
-import logging
-
 from typing import Any, Callable
 
 import aiomqtt
+import structlog
 
 from paho.mqtt.client import Client as PahoMQTTClient
 from paho.mqtt.client import MQTTMessage
@@ -22,7 +21,7 @@ def __init__(
         async_client: aiomqtt.Client,
         resource: EventAffordance,
         qos: int,
-        logger: logging.Logger,
+        logger: structlog.stdlib.BoundLogger,
         owner_inst: Any,
     ) -> None:
         super().__init__(resource=resource, logger=logger, owner_inst=owner_inst)

hololinked/client/proxy.py

@@ -48,10 +48,12 @@ def __init__(self, id: str, **kwargs) -> None:
 
             - `allow_foreign_attributes`: `bool`, default `False`.
                 allows local attributes for proxy apart from properties fetched from the server.
-            - `logger`: `logging.Logger`, default `None`.
+            - `logger`: `structlog.stdlib.BoundLogger`, default `None`.
                 logger instance
-            - `log_level`: `int`, default `logging.INFO`.
-                log level corresponding to logging.Logger when internally created
+            - `td`: `dict[str, Any]`, default `dict()`.
+                Thing Description of the consumed thing
+            - `security`: `BasicSecurity`, optional.
+                security scheme to be used for authentication
         """
         self.id = id
         self._allow_foreign_attributes = kwargs.get("allow_foreign_attributes", False)

hololinked/client/zmq/consumed_interactions.py

@@ -1,12 +1,13 @@
 import asyncio
-import logging
 import threading
 import traceback
 import uuid
 import warnings
 
 from typing import Any, Callable
 
+import structlog
+
 from ...client.abstractions import (
     SSE,
     ConsumedThingAction,
@@ -135,7 +136,7 @@ def __init__(
         sync_client: SyncZMQClient,
         async_client: AsyncZMQClient,
         owner_inst: Any,
-        logger: logging.Logger,
+        logger: structlog.stdlib.BoundLogger,
         **kwargs,
     ) -> None:
         """
@@ -149,7 +150,7 @@ def __init__(
             asynchronous ZMQ client for async calls
         owner_inst: Any
             the parent object that owns this action
-        logger: logging.Logger
+        logger: structlog.stdlib.BoundLogger
             logger instance
         """
         ConsumedThingAction.__init__(self, resource=resource, owner_inst=owner_inst, logger=logger)
@@ -263,7 +264,7 @@ def __init__(
         sync_client: SyncZMQClient,
         async_client: AsyncZMQClient,
         owner_inst: Any,
-        logger: logging.Logger,
+        logger: structlog.stdlib.BoundLogger,
         **kwargs,
     ) -> None:
         """
@@ -277,7 +278,7 @@ def __init__(
             asynchronous ZMQ client for async calls
         owner_inst: Any
             the parent object that owns this property
-        logger: logging.Logger
+        logger: structlog.stdlib.BoundLogger
             logger instance for logging
         """
         ConsumedThingProperty.__init__(self, resource=resource, owner_inst=owner_inst, logger=logger)
@@ -420,7 +421,7 @@ class ZMQEvent(ConsumedThingEvent, ZMQConsumedAffordanceMixin):
     def __init__(
         self,
         resource: EventAffordance,
-        logger: logging.Logger,
+        logger: structlog.stdlib.BoundLogger,
         owner_inst: Any,
         **kwargs,
     ) -> None: