Adding :base-interceptor-refactor: tags to # TODOs in the code

#109

flowcept/commons/__init__.py

@@ -4,7 +4,7 @@
 
 logger = FlowceptLogger()
 
-# TODO :ml-refactor: :code-reorg: :usability:
+# TODO :base-interceptor-refactor: :ml-refactor: :code-reorg: :usability:
 #  Consider creating a new concept for instrumentation-based 'interception'.
 #  These adaptors were made for data observability.
 #  Perhaps we should have a BaseAdaptor that would work for both and

flowcept/commons/decorators/responsible_ai.py

@@ -50,6 +50,7 @@ def wrapper(*args, **kwargs):
                 raise Exception(error_format_msg)
             model = result.pop("model", None)
 
+            # TODO: :ml-refactor:
             if hasattr(model, "model_type"):
                 model_type = str(model.model_type)
             elif hasattr(model, "type"):

flowcept/commons/settings_factory.py

@@ -37,7 +37,7 @@ def _build_base_settings(kind: str, settings_dict: dict) -> BaseSettings:
 
 
 def get_settings(adapter_key: str) -> BaseSettings:
-    if adapter_key is None:  # TODO: :ml-refactor:
+    if adapter_key is None:  # TODO: :base-interceptor-refactor:
         return None
     with open(SETTINGS_PATH) as f:
         data = yaml.load(f, Loader=yaml.FullLoader)

flowcept/flowcept_api/consumer_api.py

@@ -7,6 +7,7 @@
 from flowcept.flowceptor.adapters.base_interceptor import BaseInterceptor
 
 
+# TODO: :code-reorg: This may not be considered an API anymore as it's doing critical things for the good functioning of the system.
 class FlowceptConsumerAPI(object):
     def __init__(
         self,
@@ -28,7 +29,7 @@ def start(self):
 
         if self._interceptors and len(self._interceptors):
             for interceptor in self._interceptors:
-                # TODO: :ml-refactor: revise
+                # TODO: :base-interceptor-refactor: revise
                 if interceptor.settings is None:
                     key = id(interceptor)
                 else:
@@ -59,7 +60,7 @@ def stop(self):
         sleep(sleep_time)
         if self._interceptors and len(self._interceptors):
             for interceptor in self._interceptors:
-                # TODO: :ml-refactor: revise
+                # TODO: :base-interceptor-refactor: revise
                 if interceptor.settings is None:
                     key = id(interceptor)
                 else:

flowcept/flowceptor/adapters/base_interceptor.py

@@ -25,7 +25,7 @@
 from flowcept.version import __version__
 
 
-# TODO :ml-refactor: :code-reorg: :usability:
+# TODO :base-interceptor-refactor: :ml-refactor: :code-reorg: :usability:
 #  Consider creating a new concept for instrumentation-based 'interception'.
 #  These adaptors were made for data observability.
 #  Perhaps we should have a BaseAdaptor that would work for both and
@@ -37,7 +37,7 @@ def __init__(self, plugin_key):
         self.logger = FlowceptLogger()
         if (
             plugin_key is not None
-        ):  # TODO :ml-refactor: :code-reorg: :usability:
+        ):  # TODO :base-interceptor-refactor: :code-reorg: :usability:
             self.settings = get_settings(plugin_key)
         else:
             self.settings = None
@@ -156,15 +156,15 @@ def register_workflow(self, task_msg: TaskMessage):
     def intercept(self, task_msg: TaskMessage):
         if (
             self._mq_dao._buffer is None
-        ):  # TODO :ml-refactor: :code-reorg: :usability:
+        ):  # TODO :base-interceptor-refactor: :code-reorg: :usability:
             raise Exception(
                 f"This interceptor {id(self)} has never been started!"
             )
 
         if ENRICH_MESSAGES:
             if (
                 self.settings is not None
-            ):  # TODO :ml-refactor: :code-reorg: :usability: revisit all times we assume settings is not none
+            ):  # TODO :base-interceptor-refactor: :code-reorg: :usability: revisit all times we assume settings is not none
                 key = self.settings.key
             else:
                 key = None