fred-oss 0.42.0__tar.gz → 0.43.0__tar.gz

{fred_oss-0.42.0/src/main/fred_oss.egg-info → fred_oss-0.43.0}/PKG-INFO

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

fred_oss-0.43.0/src/main/fred/dao/comp/_pubsub.py

@@ -0,0 +1,78 @@
+import uuid
+from dataclasses import dataclass
+from typing import Optional
+
+from fred.settings import logger_manager
+from fred.dao.service.catalog import ServiceCatalog
+from fred.dao.comp.interface import ComponentInterface
+
+logger = logger_manager.get_logger(name=__name__)
+
+
+class FredSubscriptionMixin:
+    # TODO: Improve typing... and better underlying subscriptions management!
+    # This only works within the same python process.
+    subs: dict = {}
+
+
+@dataclass(frozen=True, slots=True)
+class FredPubSub(ComponentInterface, FredSubscriptionMixin):
+    """A simple publish-subscribe (pub-sub) implementation using a backend service.
+    This class provides methods to interact with pub-sub channels, such as publishing
+    messages, subscribing to channels, and managing subscriptions. The actual implementation
+    of these methods depends on the underlying service being used (e.g., Redis).
+    Attributes:
+        name: str: The name of the pub-sub channel.
+    """
+    name: str
+
+    def publish(self, item: str) -> int:
+        match self._cat:
+            case ServiceCatalog.REDIS:
+                return self._srv.client.publish(self.name, item)
+            case ServiceCatalog.STDLIB:
+                raise NotImplementedError("Publish method not implemented for STDLIB service")
+            case _:
+                raise NotImplementedError(f"Publish method not implemented for service {self._nme}")
+
+    def subscribe(self, subscription_id: Optional[str] = None):
+        """Subscribe to the pub/sub channel and yield messages as they arrive.
+
+        This method creates (or reuses) a subscription to the channel specified by `self.name`.
+        It returns a generator that yields messages received on the channel.
+        The implementation depends on the underlying service (e.g., Redis).
+
+        Args:
+            subscription_id (Optional[str]): An optional identifier for the subscription. If not provided, a new UUID is generated.
+
+        Yields:
+            Messages received from the channel.
+        Raises:
+            NotImplementedError: If the method is not implemented for the current service.
+        """
+        subscription_id = subscription_id or (
+            logger.info(f"Creating new subscriber for channel: {self.name}")
+            or str(uuid.uuid4())
+        )
+        logger.info(f"Using subscription ID: {subscription_id}")
+        match self._cat:
+            case ServiceCatalog.REDIS:
+                subscriber = self.subs[subscription_id] = self.subs.get(subscription_id, None) or self._srv.client.pubsub()
+                subscriber.subscribe(self.name)
+                yield from subscriber.listen()
+            case ServiceCatalog.STDLIB:
+                raise NotImplementedError("Subscribe method not implemented for STDLIB service")
+            case _:
+                raise NotImplementedError(f"Subscribe method not implemented for service {self._nme}")
+
+    @classmethod
+    def unsubscribe(cls, subscription_id: str, close: bool = False) -> None:
+        # TODO: Implement the 'unsubscribe' and optially close the subscriber.
+        logger.error("The unsubscribe method not implemented yet.")
+        raise NotImplementedError("Unsubscribe method not implemented yet.")
+
+    @classmethod
+    def subscribers(cls) -> list[str]:
+        # TODO: Implement the 'subscribers' method to list active subscriptions.
+        logger.error("The subscribers method not implemented yet.")
+        raise NotImplementedError("Subscribers method not implemented yet.")

{fred_oss-0.42.0 → fred_oss-0.43.0}/src/main/fred/dao/comp/catalog.py

@@ -5,6 +5,7 @@ from typing import Optional
 from fred.dao.comp.interface import ComponentInterface, SRV_REF_TYPE
 from fred.dao.comp._queue import FredQueue
 from fred.dao.comp._keyval import FredKeyVal
+from fred.dao.comp._pubsub import FredPubSub
 
 
 class _PreconfCatalogMixin:
@@ -34,6 +35,7 @@ class CompCatalog(enum.Enum):
     """
     QUEUE = FredQueue
     KEYVAL = FredKeyVal
+    PUBSUB = FredPubSub
 
     @classmethod
     def from_classname(cls, classname: str) -> "CompCatalog":

{fred_oss-0.42.0 → fred_oss-0.43.0}/src/main/fred/dao/service/utils.py

@@ -28,10 +28,10 @@ def get_redis_configs_from_payload(
         if (db := payload.get(db_key) if keep else payload.pop(db_key, None)):
             break
     return {
-        "host": host or get_environ_variable(name="REDIS_HOST", default="localhost"),
-        "port": int(port or get_environ_variable(name="REDIS_PORT", default=6379)),
+        "host": host or get_environ_variable(name="REDIS_HOST", default=None) or "localhost",
+        "port": int(port or get_environ_variable(name="REDIS_PORT", default=None) or 6379),
         "password": password or get_environ_variable(name="REDIS_PASSWORD", default=None),
-        "db": int(db or get_environ_variable(name="REDIS_DB", default=0)),
+        "db": int(db or get_environ_variable(name="REDIS_DB", default=None) or 0),
         "decode_responses": True,
         **(payload.get("redis_configs", {}) if keep else payload.pop("redis_configs", {})),
     }

fred_oss-0.43.0/src/main/fred/version

@@ -0,0 +1 @@
+0.43.0

{fred_oss-0.42.0 → fred_oss-0.43.0/src/main/fred_oss.egg-info}/PKG-INFO

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

{fred_oss-0.42.0 → fred_oss-0.43.0}/src/main/fred_oss.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ src/main/fred/cli/main.py
 src/main/fred/dao/__init__.py
 src/main/fred/dao/comp/__init__.py
 src/main/fred/dao/comp/_keyval.py
+src/main/fred/dao/comp/_pubsub.py
 src/main/fred/dao/comp/_queue.py
 src/main/fred/dao/comp/catalog.py
 src/main/fred/dao/comp/interface.py

fred_oss-0.42.0/src/main/fred/version

@@ -1 +0,0 @@
-0.42.0