ISSUE #99

* Add docstring.

Author: Sergio García Prado

packages/core/minos-microservice-saga/minos/saga/executions/repositories/abc.py

@@ -19,7 +19,7 @@
 
 
 class SagaExecutionRepository(SetupMixin, ABC):
-    """TODO"""
+    """Saga Execution Repository class."""
 
     async def store(self, execution: SagaExecution) -> None:
         """Store an execution.

packages/core/minos-microservice-saga/minos/saga/executions/repositories/database/factories.py

@@ -13,19 +13,32 @@
 
 
 class SagaExecutionDatabaseOperationFactory(DatabaseOperationFactory, ABC):
-    """TODO"""
+    """Saga Execution Database Operation Factory class."""
 
     @abstractmethod
     def build_store(self, uuid: UUID, **kwargs) -> DatabaseOperation:
-        """TODO"""
+        """Build the database operation to store a saga execution.
+
+        :param uuid: The identifier of the saga execution.
+        :param kwargs: The attributes of the saga execution.
+        :return: A ``DatabaseOperation`` instance.
+        """
         raise NotImplementedError
 
     @abstractmethod
     def build_load(self, uuid: UUID) -> DatabaseOperation:
-        """TODO"""
+        """Build the database operation to load a saga execution.
+
+        :param uuid: The identifier of the saga execution.
+        :return: A ``DatabaseOperation`` instance.
+        """
         raise NotImplementedError
 
     @abstractmethod
     def build_delete(self, uuid: UUID) -> DatabaseOperation:
-        """TODO"""
+        """Build the database operation to delete a saga execution.
+
+        :param uuid: The identifier of the saga execution.
+        :return: A ``DatabaseOperation`` instance.
+        """
         raise NotImplementedError

packages/plugins/minos-database-lmdb/minos/plugins/lmdb/clients.py

@@ -29,7 +29,7 @@
 
 
 class LmdbDatabaseClient(DatabaseClient):
-    """TODO"""
+    """Lmdb Database Client class."""
 
     _environment: Optional[Environment]
 

packages/plugins/minos-database-lmdb/minos/plugins/lmdb/factories/saga/executions.py

@@ -19,7 +19,7 @@
 
 
 class LmdbSagaExecutionDatabaseOperationFactory(SagaExecutionDatabaseOperationFactory):
-    """TODO"""
+    """Lmdb Saga Execution Database Operation Factory class."""
 
     # noinspection PyMethodMayBeStatic
     def build_table_name(self) -> str:
@@ -30,19 +30,32 @@ def build_table_name(self) -> str:
         return "LocalState"
 
     def build_store(self, uuid: UUID, **kwargs) -> DatabaseOperation:
-        """TODO"""
+        """Build the database operation to store a saga execution.
+
+        :param uuid: The identifier of the saga execution.
+        :param kwargs: The attributes of the saga execution.
+        :return: A ``DatabaseOperation`` instance.
+        """
         key = str(uuid)
         value = kwargs | {"uuid": str(uuid)}
 
         return LmdbDatabaseOperation(LmdbDatabaseOperationType.CREATE, self.build_table_name(), key, value)
 
     def build_load(self, uuid: UUID) -> DatabaseOperation:
-        """TODO"""
+        """Build the database operation to load a saga execution.
+
+        :param uuid: The identifier of the saga execution.
+        :return: A ``DatabaseOperation`` instance.
+        """
         key = str(uuid)
         return LmdbDatabaseOperation(LmdbDatabaseOperationType.READ, self.build_table_name(), key)
 
     def build_delete(self, uuid: UUID) -> DatabaseOperation:
-        """TODO"""
+        """Build the database operation to delete a saga execution.
+
+        :param uuid: The identifier of the saga execution.
+        :return: A ``DatabaseOperation`` instance.
+        """
         key = str(uuid)
         return LmdbDatabaseOperation(LmdbDatabaseOperationType.DELETE, self.build_table_name(), key)
 

packages/plugins/minos-database-lmdb/minos/plugins/lmdb/operations.py

@@ -12,7 +12,7 @@
 
 
 class LmdbDatabaseOperationType(str, Enum):
-    """TODO"""
+    """Lmdb Database Operation Type class."""
 
     CREATE = "create"
     READ = "read"
@@ -21,7 +21,7 @@ class LmdbDatabaseOperationType(str, Enum):
 
 
 class LmdbDatabaseOperation(DatabaseOperation):
-    """TODO"""
+    """Lmdb Database Operation class."""
 
     def __init__(
         self, type_: LmdbDatabaseOperationType, table: str, key: str, value: Optional[Any] = None, *args, **kwargs