Fixed logging, tiny code improvements.

Author: chsou

c8y_api/app/__init__.py

@@ -93,9 +93,9 @@ def get_item(key: str, dictionary: dict) -> str | None:
             info = get_item('Authorization', headers)
 
         if not info:
-
             keys = ", ".join([*headers.keys(), *cookies.keys()]) or "None"
             raise KeyError(f"Unable to resolve Authorization information. Found keys: {keys}.")
+
         return info
 
     @staticmethod

c8y_tk/app/__init__.py

@@ -51,8 +51,6 @@ def __init__(
             startup_delay (float):  A minimum delay before a newly added
                 microservice is considered to be "added" (the callback
                 invocation will be delayed by this).
-
-
         """
         self._n = self._n + 1
         self._instance_name = f"{__name__}.{type(self).__name__}[{self._n}]"\
@@ -64,7 +62,7 @@ def __init__(
         self.callbacks = [(callback, blocking)] if callback else []
         self.callbacks_on_add = []
         self.callbacks_on_remove = []
-        self._log = logging.Logger(self._instance_name)
+        self._log = logging.getLogger(self._instance_name)
         self._executor = None
         self._callback_futures = set()
         self._listen_thread = None
@@ -121,10 +119,11 @@ def listen(self):
         This is blocking.
         """
         # safely invoke a callback function blocking or non-blocking
-        def invoke_callback(callback, is_blocking, arg):
+        def invoke_callback(callback, is_blocking, _, arg):
             def safe_invoke(a):
                 # pylint: disable=broad-exception-caught
                 try:
+                    self._log.debug(f"Invoking callback: {callback}")
                     callback(a)
                 except Exception as error:
                     self._log.error(f"Uncaught exception in callback: {error}", exc_info=error)
@@ -154,23 +153,24 @@ def safe_invoke(a):
             removed = last_subscribers - current_subscribers
             # run 'removed' callbacks
             for tenant_id in removed:
-                self._log.info(f"Tenant subscription removed: ${tenant_id}.")
+                self._log.info(f"Tenant subscription removed: {tenant_id}.")
                 for fun, blocking in self.callbacks_on_remove:
-                    invoke_callback(fun, blocking, tenant_id)
+                    invoke_callback(fun, blocking, 'Removed', tenant_id)
             # wait remaining time for startup delay
             if added and self.startup_delay:
                 min_startup_delay = self.startup_delay - (time.monotonic() - now)
                 if min_startup_delay > 0:
                     time.sleep(min_startup_delay)
             # run 'added' callbacks
             for tenant_id in added:
-                self._log.info(f"Tenant subscription added: ${tenant_id}.")
+                self._log.info(f"Tenant subscription added: {tenant_id}.")
                 for fun, blocking in self.callbacks_on_add:
-                    invoke_callback(fun, blocking, tenant_id)
+                    invoke_callback(fun, blocking, 'Added', tenant_id)
             # run 'any' callbacks
             if added or removed:
+                self._log.info(f"Tenant subscriptions changed: {current_subscribers}.")
                 for fun, blocking in self.callbacks:
-                    invoke_callback(fun, blocking, current_subscribers)
+                    invoke_callback(fun, blocking, None, current_subscribers)
             # set new baseline
             last_subscribers = current_subscribers
             # schedule next run, skip if already exceeded

tasks.py

@@ -48,7 +48,7 @@ def init(c):
 def lint(c, scope='all'):
     """Run PyLint."""
     if scope == 'all':
-        scope = 'c8y_api c8y_tk tests integration_tests samples'
+        scope = 'c8y_api/ c8y_tk tests integration_tests samples'
     c.run(f'pylint --rcfile pylintrc --fail-under=9 {scope}')