ISSUE #150

* Add docstring.

Author: Sergio García Prado

packages/core/minos-microservice-common/minos/common/builders.py

@@ -63,10 +63,10 @@ def new(cls: type[B]) -> B:
         return cls()
 
     def with_cls(self: B, cls: type) -> B:
-        """TODO
+        """Set class to be built.
 
-        :param cls: TODO
-        :return: TODO
+        :param cls: The class to be set.
+        :return: This method return the builder instance.
         """
         self.instance_cls = cls
         return self
@@ -92,7 +92,7 @@ def with_config(self: B, config: Config) -> B:
     def build(self) -> Instance:
         """Build the instance.
 
-        :return: A ``BrokerSubscriber`` instance.
+        :return: A ``Instance`` instance.
         """
         return self.instance_cls(**self.kwargs)
 

packages/core/minos-microservice-networks/minos/networks/brokers/collections/queues/pg.py

@@ -201,7 +201,7 @@ async def _dequeue_rows(self, cursor: Cursor) -> list[Any]:
 
 
 class PostgreSqlBrokerQueueBuilder(Builder):
-    """TODO"""
+    """PostgreSql Broker Queue Builder class."""
 
     def with_config(self, config: Config):
         """Set config.

packages/core/minos-microservice-networks/minos/networks/brokers/publishers/abc.py

@@ -30,7 +30,8 @@
 
 if TYPE_CHECKING:
     from .queued import (
-        QueuedBrokerPublisher,BrokerPublisherQueue
+        BrokerPublisherQueue,
+        QueuedBrokerPublisher,
     )
 
 logger = logging.getLogger(__name__)
@@ -81,10 +82,10 @@ def __init__(
         self.queued_cls = queued_cls
 
     def with_queued_cls(self, queued_cls: type[QueuedBrokerPublisher]):
-        """TODO
+        """Set the queued class.
 
-        :param queued_cls: TODO
-        :return: TODO
+        :param queued_cls: A subclass of ``QueuedBrokerPublisher``.
+        :return: This method return the builder instance.
         """
         self.queued_cls = queued_cls
 
@@ -114,10 +115,10 @@ def _with_builders_from_config(self, config):
             self.with_queue(broker_publisher_config["queue"])
 
     def with_queue(self, queue: Union[type[BrokerPublisherQueue], Builder[BrokerPublisherQueue]]):
-        """TODO
+        """Set the queue builder.
 
-        :param queue: TODO
-        :return: TODO
+        :param queue: The queue builder to be set.
+        :return: This method return the builder instance.
         """
         if not isinstance(queue, Builder):
             queue = queue.get_builder()

packages/core/minos-microservice-networks/minos/networks/brokers/subscribers/abc.py

@@ -123,20 +123,20 @@ def __init__(
         self.queued_cls = queued_cls
 
     def with_idempotent_cls(self, idempotent_cls: type[IdempotentBrokerSubscriber]):
-        """TODO
+        """Set the idempotent class.
 
-        :param idempotent_cls: TODO
-        :return: TODO
+        :param idempotent_cls: A subclass of ``IdempotentBrokerSubscriber``.
+        :return: This method return the builder instance.
         """
         self.idempotent_cls = idempotent_cls
 
         return self
 
     def with_queued_cls(self, queued_cls: type[QueuedBrokerSubscriber]):
-        """TODO
+        """Set the queued class.
 
-        :param queued_cls: TODO
-        :return: TODO
+        :param queued_cls: A subclass of ``QueuedBrokerSubscriber``.
+        :return: This method return the builder instance.
         """
         self.queued_cls = queued_cls
 
@@ -174,21 +174,21 @@ def with_duplicate_detector(
         self,
         duplicate_detector: Union[type[BrokerSubscriberDuplicateDetector], Builder[BrokerSubscriberDuplicateDetector]],
     ):
-        """TODO
+        """Set the duplicate detector.
 
-        :param duplicate_detector: TODO
-        :return: TODO
+        :param duplicate_detector: The duplicate detector to be set.
+        :return: This method return the builder instance.
         """
         if not isinstance(duplicate_detector, Builder):
             duplicate_detector = duplicate_detector.get_builder()
         self.duplicate_detector_builder = duplicate_detector.copy()
         return self
 
     def with_queue(self, queue: Union[type[BrokerSubscriberQueue], BrokerSubscriberQueueBuilder]):
-        """TODO
+        """Set the queue builder.
 
-        :param queue: TODO
-        :return: TODO
+        :param queue: The queue to be set.
+        :return: This method return the builder instance.
         """
         if not isinstance(queue, Builder):
             queue = queue.get_builder()

packages/core/minos-microservice-networks/minos/networks/brokers/subscribers/idempotent/detectors/pg.py

@@ -69,7 +69,7 @@ async def _is_valid(self, topic: str, uuid: UUID) -> bool:
 
 
 class PostgreSqlBrokerSubscriberDuplicateDetectorBuilder(Builder[PostgreSqlBrokerSubscriberDuplicateDetector]):
-    """TODO"""
+    """PostgreSql Broker Subscriber Duplicate Detector Builder class."""
 
     def with_config(self, config: Config):
         """Set config.

packages/core/minos-microservice-networks/tests/test_networks/test_brokers/test_publishers/test_abc.py

@@ -4,25 +4,29 @@
 )
 from unittest.mock import (
     AsyncMock,
-    call, MagicMock,
+    MagicMock,
+    call,
 )
 
 from minos.common import (
     Builder,
+    Config,
+    MinosConfigException,
     SetupMixin,
-    Config, MinosConfigException,
 )
 from minos.networks import (
     BrokerMessage,
     BrokerMessageV1,
     BrokerMessageV1Payload,
     BrokerPublisher,
     BrokerPublisherBuilder,
+    InMemoryBrokerPublisher,
     InMemoryBrokerPublisherQueue,
     QueuedBrokerPublisher,
-    InMemoryBrokerPublisher,
 )
-from tests.utils import CONFIG_FILE_PATH
+from tests.utils import (
+    CONFIG_FILE_PATH,
+)
 
 
 class _BrokerPublisher(BrokerPublisher):

packages/plugins/minos-broker-kafka/minos/plugins/kafka/common.py

@@ -25,7 +25,7 @@ def __init__(self, *args, circuit_breaker_exceptions: Iterable[type] = tuple(),
 
 
 class KafkaBrokerBuilderMixin(Builder):
-    """TODO"""
+    """Kafka Broker Builder Mixin class."""
 
     def with_config(self, config: Config):
         """Set config.

packages/plugins/minos-broker-kafka/minos/plugins/kafka/publisher.py

@@ -121,7 +121,7 @@ def _bootstrap_servers(self):
 
 
 class KafkaBrokerPublisherBuilder(BrokerPublisherBuilder[KafkaBrokerPublisher], KafkaBrokerBuilderMixin):
-    """TODO"""
+    """Kafka Broker Publisher Builder class."""
 
 
 KafkaBrokerPublisher.set_builder(KafkaBrokerPublisherBuilder)