ISSUE #346

* Add missing docstring.

Author: Sergio García Prado

packages/core/minos-microservice-common/minos/common/database/abc.py

@@ -219,7 +219,7 @@ def pool(self) -> DatabaseClientPool:
 
 
 class PostgreSqlMinosDatabase(DatabaseMixin):
-    """TODO"""
+    """PostgreSql Minos Database class."""
 
     def __init__(self, *args, **kwargs):
         warnings.warn(

packages/core/minos-microservice-common/minos/common/database/locks.py

@@ -48,7 +48,7 @@ async def __aexit__(self, exc_type, exc_val, exc_tb):
 
 
 class PostgreSqlLock(DatabaseLock):
-    """TODO"""
+    """PostgreSql Lock class."""
 
     def __init__(self, *args, **kwargs):
         warnings.warn(f"{PostgreSqlLock!r} has been deprecated. Use {DatabaseLock} instead.", DeprecationWarning)

packages/core/minos-microservice-common/minos/common/database/pools.py

@@ -102,8 +102,9 @@ async def _check_instance(self, instance: Optional[Connection]) -> bool:
         return not instance.closed
 
 
+@Injectable("postgresql_pool")
 class PostgreSqlPool(DatabaseClientPool):
-    """TODO"""
+    """PostgreSql Pool class."""
 
     def __init__(self, *args, **kwargs):
         warnings.warn(f"{PostgreSqlPool!r} has been deprecated. Use {DatabaseClientPool} instead.", DeprecationWarning)
@@ -122,9 +123,8 @@ def acquire(self, key: Hashable, *args, **kwargs) -> DatabaseLock:
         return DatabaseLock(super().acquire(), key, *args, **kwargs)
 
 
-@Injectable("postgresql_pool")
 class PostgreSqlLockPool(DatabaseLockPool):
-    """TODO"""
+    """PostgreSql Lock Pool class"""
 
     def __init__(self, *args, **kwargs):
         warnings.warn(

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

@@ -41,7 +41,7 @@
 
 @Injectable("pool_factory")
 class PoolFactory(SetupMixin):
-    """TODO"""
+    """Pool Factory class."""
 
     _pools: dict[str, Pool]
 
@@ -64,12 +64,12 @@ async def _destroy(self) -> None:
         await super()._destroy()
 
     def get_pool(self, type_: str, key: Optional[str] = None, **kwargs) -> Pool:
-        """TODO
+        """Get a pool from the factory.
 
-        :param type_: TODO
-        :param key: TODO
-        :param kwargs: TODO
-        :return: TODO
+        :param type_: The type of the pool.
+        :param key:  An optional key that identifies the pool.
+        :param kwargs: Additional named arguments.
+        :return: A ``Pool`` instance.
         """
         if key is None:
             key = type_

packages/core/minos-microservice-common/tests/test_common/test_pools.py

@@ -29,7 +29,6 @@
 
 
 class TestPoolFactory(CommonTestCase):
-
     def setUp(self):
         super().setUp()
         self.factory = PoolFactory(self.config, {"lock": FakeLockPool})