fred-oss 0.4.1__tar.gz → 0.5.0__tar.gz

{fred_oss-0.4.1/src/main/fred_oss.egg-info → fred_oss-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fred-oss
-Version: 0.4.1
+Version: 0.5.0
 Summary: FREDOSS
 Home-page: https://fred.fahera.mx
 Author: Fahera Research, Education, and Development

{fred_oss-0.4.1 → fred_oss-0.5.0}/src/main/fred/integrations/runpod/cli_ext.py

@@ -1,4 +1,4 @@
-from fred.integrations.runpod.helper import HandlerHelper
+from fred.worker.interface import HandlerInterface
 from fred.cli.interface import IntegrationExtCLI
 from fred.settings import logger_manager
 
@@ -8,8 +8,8 @@ logger = logger_manager.get_logger(name=__name__)
 
 class RunPodExt(IntegrationExtCLI):
 
-    def get_handler_instance(self, import_pattern: str, handler_classname: str) -> HandlerHelper:
-        return HandlerHelper.find_handler(
+    def get_handler_instance(self, import_pattern: str, handler_classname: str) -> HandlerInterface:
+        return HandlerInterface.find_handler(
             import_pattern=import_pattern,
             handler_classname=handler_classname,
         )

fred_oss-0.5.0/src/main/fred/integrations/runpod/helper.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+
+from fred.maturity import Maturity, MaturityLevel
+from fred.worker.interface import HandlerInterface
+from fred.settings import logger_manager
+
+logger = logger_manager.get_logger(name=__name__)
+
+
+module_maturity = Maturity(
+    level=MaturityLevel.TO_BE_DEPRECATED,
+    reference=__name__,
+    message=(
+        "Runpod Helper implementation is soon to be deprecated! "
+        "Please use the Fred-Worker interface instead (HandlerInterface)."
+    )
+)
+
+
+@dataclass(frozen=True, slots=False)
+class HandlerHelper(HandlerInterface):
+    
+    def __post_init__(self):
+        super().__post_init__()
+        logger.warning("Runpod Helper is soon to be deprecated! Please use Fred-Worker interface instead.")

fred_oss-0.5.0/src/main/fred/version

@@ -0,0 +1 @@
+0.5.0

fred_oss-0.5.0/src/main/fred/worker/__init__.py

@@ -0,0 +1,11 @@
+from fred.maturity import Maturity, MaturityLevel
+
+
+module_maturity = Maturity(
+    level=MaturityLevel.ALPHA,
+    reference=__name__,
+    message=(
+        "Fred-Worker implementation is in early development "
+        "and therefore currently with incomplete and unstable features."
+    )
+)

fred_oss-0.4.1/src/main/fred/integrations/runpod/helper.py → fred_oss-0.5.0/src/main/fred/worker/interface.py

@@ -1,15 +1,29 @@
 import time
-from dataclasses import dataclass, field
 from typing import Optional
+from dataclasses import dataclass, field
 
 from fred.utils.dateops import datetime_utcnow
-from fred.settings import logger_manager
+from fred.settings import (
+    get_environ_variable,
+    logger_manager,
+)
 
 logger = logger_manager.get_logger(name=__name__)
 
 
-@dataclass(frozen=True, slots=True)
-class HandlerHelper:
+@dataclass(frozen=True, slots=False)
+class HandlerInterface:
+    """Base interface for handling events in a worker environment.
+    
+    This class provides a structure for processing events with metadata tracking.
+    Subclasses should implement the `handler` method to define specific event processing logic.
+    
+    Considerations: This interface is designed to be extended for various worker implementations, starting with Runpod.
+
+    Attributes:
+        context (dict): A dictionary to hold contextual information for the handler; this can be modified as needed.
+        metadata (dict): A dictionary to track metadata about the handler's operations.
+    """
     context: dict = field(default_factory=dict)
     metadata: dict = field(default_factory=dict)
 
@@ -22,16 +36,16 @@ class HandlerHelper:
             import_pattern: str,
             handler_classname: str,
             **init_kwargs,
-    ) -> 'HandlerHelper':
+    ) -> 'HandlerInterface':
         import importlib
 
         # Dynamically import the handler class
         handler_module = importlib.import_module(import_pattern)
         handler_cls = getattr(handler_module, handler_classname)
-        # Ensure the handler class exists and is a subclass of HandlerHelper
+        # Ensure the handler class exists and is a subclass of HandlerInterface
         if not handler_cls or not issubclass(handler_cls, cls):
-            logger.error(f"Handler class '{handler_classname}' not found or is not a subclass of HandlerHelper.")
-            raise ValueError(f"Handler '{handler_classname}' not found in module '{import_pattern}' or is not a subclass of HandlerHelper.")
+            logger.error(f"Handler class '{handler_classname}' not found or is not a subclass of HandlerInterface: {handler_cls}")
+            raise ValueError(f"Handler '{handler_classname}' not found in module '{import_pattern}' or is not a subclass of HandlerInterface.")
         kwargs = {
             "metadata": {
                 "handler_found_at": datetime_utcnow().isoformat()
@@ -44,6 +58,16 @@ class HandlerHelper:
         logger.warning("Handler method not implemented.")
         return payload
 
+    @property
+    def metadata_prepared(self) -> dict:
+        if not int(get_environ_variable("FRD_ENFORCE_METADATA_SERIALIZATION", default="0")):
+            return self.metadata
+        import json
+        # Ensure serializability
+        # TODO: Allow custom serialization methods
+        metadata_serialized = json.dumps(self.metadata, default=str)
+        return json.loads(metadata_serialized)
+
     def run(self, event: dict) -> dict:
         job_event_identifier = event.get("id")
         self.metadata["run_seq"] = self.metadata.get("run_seq", 0) + 1
@@ -65,5 +89,5 @@ class HandlerHelper:
             "duration": time.perf_counter() - start_time,
             "started_at": started_at,
             "response": response,
-            "metadata": self.metadata,
+            "metadata": self.metadata_prepared,
         }

{fred_oss-0.4.1 → fred_oss-0.5.0/src/main/fred_oss.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fred-oss
-Version: 0.4.1
+Version: 0.5.0
 Summary: FREDOSS
 Home-page: https://fred.fahera.mx
 Author: Fahera Research, Education, and Development

{fred_oss-0.4.1 → fred_oss-0.5.0}/src/main/fred_oss.egg-info/SOURCES.txt

@@ -25,6 +25,8 @@ src/main/fred/integrations/runpod/helper.py
 src/main/fred/utils/__init__.py
 src/main/fred/utils/dateops.py
 src/main/fred/utils/runtime.py
+src/main/fred/worker/__init__.py
+src/main/fred/worker/interface.py
 src/main/fred_oss.egg-info/PKG-INFO
 src/main/fred_oss.egg-info/SOURCES.txt
 src/main/fred_oss.egg-info/dependency_links.txt

fred_oss-0.4.1/src/main/fred/version

@@ -1 +0,0 @@
-0.4.1