fastapi-factory-utilities 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

fastapi_factory_utilities/core/app/builder.py

@@ -21,6 +21,7 @@ class ApplicationGenericBuilder(Generic[T]):
 
     def __init__(self, plugins_activation_list: list[PluginsEnum] | None = None) -> None:
         """Instanciate the ApplicationGenericBuilder."""
+        self._uvicorn_utils: UvicornUtils | None = None
         self._root_config: RootConfig | None = None
         self._plugin_manager: PluginManager | None = None
         self._fastapi_builder: FastAPIBuilder | None = None
@@ -109,11 +110,12 @@ class ApplicationGenericBuilder(Generic[T]):
 
     def build_as_uvicorn_utils(self) -> UvicornUtils:
         """Build the application and provide UvicornUtils."""
-        return UvicornUtils(app=self.build())
+        self._uvicorn_utils = UvicornUtils(app=self.build())
+        return self._uvicorn_utils
 
     def build_and_serve(self) -> None:
         """Build the application and serve it with Uvicorn."""
-        uvicorn_utils: UvicornUtils = self.build_as_uvicorn_utils()
+        uvicorn_utils: UvicornUtils = self._uvicorn_utils or self.build_as_uvicorn_utils()
 
         setup_log(mode=LogModeEnum.CONSOLE)
 

fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py

@@ -78,6 +78,7 @@ async def on_startup(
 
     try:
         odm_factory: ODMBuilder = ODMBuilder(application=application).build_all()
+        await odm_factory.wait_ping()
     except Exception as exception:  # pylint: disable=broad-except
         _logger.error(f"ODM plugin failed to start. {exception}")
         # TODO: Report the error to the status_service

fastapi_factory_utilities/core/plugins/odm_plugin/builder.py

@@ -1,9 +1,9 @@
 """Provides the module for the ODM plugin."""
 
-import time
 from typing import Any, ClassVar, Self
 
 from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
+from pymongo.server_api import ServerApi, ServerApiVersion
 from structlog.stdlib import get_logger
 
 from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
@@ -124,31 +124,34 @@ class ODMBuilder:
             raise ODMPluginConfigError("Unable to create the application configuration model.") from exception
         return self
 
-    @classmethod
-    def _wait_client_to_be_ready(cls, client: AsyncIOMotorClient[Any], timeout_s: int) -> None:
-        """Wait for the ODM client to be ready.
-
-        Args:
-            client (AsyncIOMotorClient): The ODM client.
-            timeout_s (int): The timeout in seconds.
-
-        Raises:
-            TimeoutError: If the ODM client is not ready in the given timeout.
-        """
-        start_time: float = time.time()
-        message_time: float = time.time()
-        while (time.time() - start_time) < (timeout_s):
-            if len(client.nodes) > 0:  # type: ignore
-                _logger.info(f"Waiting {(time.time() - start_time)*cls.MS_TO_S}ms for the ODM client to be ready.")
-                return
-
-            if (time.time() - message_time) > 1:
-                elaps_time: float = time.time() - start_time
-                _logger.debug(f"Waiting for the ODM client to be ready. (from {int(elaps_time)}s) ")
-                message_time = time.time()
-            time.sleep(cls.SLEEP_TIME_S)
-
-        raise TimeoutError("The ODM client is not ready in the given timeout.")
+    # ======
+    # KEEP IT, Waiting for additional tests
+    # @classmethod
+    # def _wait_client_to_be_ready(cls, client: AsyncIOMotorClient[Any], timeout_s: int) -> None:
+    #     """Wait for the ODM client to be ready.
+
+    #     Args:
+    #         client (AsyncIOMotorClient): The ODM client.
+    #         timeout_s (int): The timeout in seconds.
+
+    #     Raises:
+    #         TimeoutError: If the ODM client is not ready in the given timeout.
+    #     """
+    #     start_time: float = time.time()
+    #     message_time: float = time.time()
+    #     while (time.time() - start_time) < (timeout_s):
+    #         if len(client.nodes) > 0:  # type: ignore
+    #             _logger.info(f"Waiting {(time.time() - start_time)*cls.MS_TO_S}ms for the ODM client to be ready.")
+    #             return
+
+    #         if (time.time() - message_time) > 1:
+    #             elaps_time: float = time.time() - start_time
+    #             _logger.debug(f"Waiting for the ODM client to be ready. (from {int(elaps_time)}s) ")
+    #             message_time = time.time()
+    #         time.sleep(cls.SLEEP_TIME_S)
+
+    #     raise TimeoutError("The ODM client is not ready in the given timeout.")
+    # ======
 
     def build_client(
         self,
@@ -173,11 +176,13 @@ class ODMBuilder:
         self._odm_client = AsyncIOMotorClient(
             host=self._config.uri,
             connect=True,
-            connectTimeoutMS=self._config.connection_timeout_s,
-            serverSelectionTimeoutMS=self._config.connection_timeout_s,
+            connectTimeoutMS=self._config.connection_timeout_ms,
+            serverSelectionTimeoutMS=self._config.connection_timeout_ms,
+            server_api=ServerApi(version=ServerApiVersion.V1),
         )
 
-        self._wait_client_to_be_ready(client=self._odm_client, timeout_s=self._config.connection_timeout_s)
+        # KEEP IT, Waiting for additional tests
+        # self._wait_client_to_be_ready(client=self._odm_client, timeout_s=self._config.connection_timeout_s)
 
         return self
 
@@ -229,3 +234,19 @@ class ODMBuilder:
         self.build_database()
 
         return self
+
+    async def wait_ping(self):
+        """Wait for the ODM client to be ready.
+
+        Returns:
+            Self: The ODM factory.
+        """
+        if self._odm_client is None:
+            raise ODMPluginConfigError(
+                "ODM client is not set. Provide the ODM client using " "build_client method or through parameter."
+            )
+
+        try:
+            await self._odm_client.admin.command("ping")
+        except Exception as exception:  # pylint: disable=broad-except
+            raise ODMPluginConfigError("Unable to ping the ODM client.") from exception

fastapi_factory_utilities/core/plugins/odm_plugin/configs.py

@@ -12,4 +12,4 @@ class ODMConfig(BaseModel):
 
     database: str = "test"
 
-    connection_timeout_s: int = 10
+    connection_timeout_ms: int = 1000

fastapi_factory_utilities/core/utils/uvicorn.py

@@ -1,5 +1,8 @@
 """Provides utilities for the application."""
 
+import os
+from typing import Any
+
 import uvicorn
 import uvicorn.server
 
@@ -20,6 +23,29 @@ class UvicornUtils:
             None
         """
         self._app: ApplicationAbstractProtocol = app
+        self._ssl_keyfile: str | os.PathLike[str] | None = None
+        self._ssl_certfile: str | os.PathLike[str] | None = None
+        self._ssl_keyfile_password: str | None = None
+
+    def add_ssl_certificates(
+        self,
+        ssl_keyfile: str | os.PathLike[str] | None = None,
+        ssl_certfile: str | os.PathLike[str] | None = None,
+        ssl_keyfile_password: str | None = None,
+    ) -> None:
+        """Add SSL certificates to the application.
+
+        Args:
+            ssl_keyfile (str | os.PathLike[str] | None): The SSL key file.
+            ssl_certfile (str | os.PathLike[str] | None): The SSL certificate file.
+            ssl_keyfile_password (str | None): The SSL key file password.
+
+        Returns:
+            None
+        """
+        self._ssl_keyfile = ssl_keyfile
+        self._ssl_certfile = ssl_certfile
+        self._ssl_keyfile_password = ssl_keyfile_password
 
     def build_uvicorn_config(self) -> uvicorn.Config:
         """Build the Uvicorn configuration.
@@ -27,12 +53,22 @@ class UvicornUtils:
         Returns:
             uvicorn.Config: The Uvicorn configuration.
         """
+        kwargs: dict[str, Any] = {}
+
+        if self._ssl_keyfile:
+            kwargs["ssl_keyfile"] = self._ssl_keyfile
+        if self._ssl_certfile:
+            kwargs["ssl_certfile"] = self._ssl_certfile
+        if self._ssl_keyfile_password:
+            kwargs["ssl_keyfile_password"] = self._ssl_keyfile_password
+
         config = uvicorn.Config(
             app=self._app.get_asgi_app(),
             host=self._app.get_config().server.host,
             port=self._app.get_config().server.port,
             reload=self._app.get_config().development.reload,
             workers=self._app.get_config().server.workers,
+            **kwargs,
         )
         clean_uvicorn_logger()
         return config

fastapi_factory_utilities/core/utils/yaml_reader.py

@@ -29,7 +29,7 @@ class UnableToReadYamlFileError(Exception):
 class YamlFileReader:
     """Handles reading YAML files and converting them to Pydantic models."""
 
-    re_pattern: re.Pattern[str] = re.compile(r"\${([A-Za-z0-9\-\_]+):?([A-Za-z0-9\-\_\/\:]*)?}")
+    re_pattern: re.Pattern[str] = re.compile(r"\${([A-Za-z0-9\-\_]+):?([A-Za-z0-9\-\_\/\:\.]*)?}")
 
     def __init__(
         self,

{fastapi_factory_utilities-0.2.1.dist-info → fastapi_factory_utilities-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_factory_utilities
-Version: 0.2.1
+Version: 0.2.3
 Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
 License: MIT
 Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices

{fastapi_factory_utilities-0.2.1.dist-info → fastapi_factory_utilities-0.2.3.dist-info}/RECORD

@@ -7,7 +7,7 @@ fastapi_factory_utilities/core/api/v1/sys/health.py,sha256=IF51Z1seOFn91m3FC57U8
 fastapi_factory_utilities/core/api/v1/sys/readiness.py,sha256=xIY8pQLShU7KWRtlOUK5gTDyZ8aB1KBvLczC6boT-tg,1711
 fastapi_factory_utilities/core/app/__init__.py,sha256=I04abOkkWiY9ChgkUNeiwnuWq8kkBoRAtMLBUKB7J7Y,405
 fastapi_factory_utilities/core/app/application.py,sha256=XdfQRG8IwyukEYXNF6i2s3qq0eAo1_XG9Xa9yV7zKf8,4975
-fastapi_factory_utilities/core/app/builder.py,sha256=aPmtnGPAsCF4vGIlqSLKWW5XW7JF3nBN7bfk_zudR28,4374
+fastapi_factory_utilities/core/app/builder.py,sha256=VbThqoI1qWnADwPQ61D774oNZ5d6OMxW0tyXr_Yz5E4,4503
 fastapi_factory_utilities/core/app/config.py,sha256=7ELIoCy1AGCD4Zq7O-jZk6VJcqDU8H-00CSrvtwzdZE,6466
 fastapi_factory_utilities/core/app/enums.py,sha256=X1upnaehYU0eHExXTde5xsH-pI9q7HZDNsOEF5PApdg,226
 fastapi_factory_utilities/core/app/exceptions.py,sha256=tQDf0_4j5xgCbku7TL7JaZGs3_bjsWG2YLBCydQJpPw,664
@@ -19,9 +19,9 @@ fastapi_factory_utilities/core/exceptions.py,sha256=7ntbaMptYn5OOPeKPVR4zU98NIC0
 fastapi_factory_utilities/core/plugins/__init__.py,sha256=W-BCkqP0xG980980z3mc8T6Vrp1Akv4szA0PRzkUbiU,756
 fastapi_factory_utilities/core/plugins/example/__init__.py,sha256=GF69IygLXxzrCh7VryekEWun663kKBhWtRS3w-1tzBc,1030
 fastapi_factory_utilities/core/plugins/httpx_plugin/__init__.py,sha256=P5FUyv7mQr8RZWQ8ifkoK8GXvqSI71q2b2dm-ag2JhQ,1028
-fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py,sha256=zR1WCBdoXz6RCTJm_NbjSuLTS77hGXuRz0IOAE3kZ1I,5278
-fastapi_factory_utilities/core/plugins/odm_plugin/builder.py,sha256=xmDlyDyXzK2TU-FH4f0QlghBS9E0wvJyaboeI1PBTUE,7692
-fastapi_factory_utilities/core/plugins/odm_plugin/configs.py,sha256=_8sE7h9AkNLSeBdGgUIyaaZqt9HCnocioX324ZNg2wA,328
+fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py,sha256=DwtLFB291G7GQDV8yh_dN7aXPMy6HWvDEh8PbWhbVDA,5316
+fastapi_factory_utilities/core/plugins/odm_plugin/builder.py,sha256=3B5EgY8deS_dr9NYZbeJq9cibPs65kN0Ogg-1yecF3s,8547
+fastapi_factory_utilities/core/plugins/odm_plugin/configs.py,sha256=zQoJC1wLNyq2pZyFhl0bKeNsTl4y_4_82BHCCaOEjCQ,331
 fastapi_factory_utilities/core/plugins/odm_plugin/depends.py,sha256=OcLsfTLzMBk_xFV6qsMy_-qFkiphEbbEuaHUooagxg8,730
 fastapi_factory_utilities/core/plugins/odm_plugin/documents.py,sha256=ENEB-Lm3T7_tN1xuIYPsUh8fpWj4aqh0xmrZt6vJCK0,1075
 fastapi_factory_utilities/core/plugins/odm_plugin/exceptions.py,sha256=acnKJB0lGAzDs-7-LjBap8shjP3iV1a7dw7ouPVF27o,551
@@ -43,8 +43,8 @@ fastapi_factory_utilities/core/utils/configs.py,sha256=qM0pCrsK8ZyfCoyova_VrhR4e
 fastapi_factory_utilities/core/utils/importlib.py,sha256=DYcPo7K0s95WV5xxtucpufWsTj8Pxv25sWunDmmNUYI,797
 fastapi_factory_utilities/core/utils/log.py,sha256=6V9CL3bQio4e47YxcSXM2JQRGhVxuBfmcEbcF4RtCfQ,6393
 fastapi_factory_utilities/core/utils/status.py,sha256=1zxur98Wfum3JzpuzoAPoRIwQmXhFsTS2oxgbn5uFfg,1933
-fastapi_factory_utilities/core/utils/uvicorn.py,sha256=JJ_HNjpJz1IDQz3a4hPcxpf5_nhGypDUSdoZA7HkCvU,1335
-fastapi_factory_utilities/core/utils/yaml_reader.py,sha256=G7F1SFynghUYjuTZTNotNW9OIiCaeGAWkcYvTFYsCMQ,6101
+fastapi_factory_utilities/core/utils/uvicorn.py,sha256=XThylG-nOPVL00w6MIWGODnweoM7VxmpSFcyoPcmqns,2609
+fastapi_factory_utilities/core/utils/yaml_reader.py,sha256=KNlwHvpraAp04JjeXSSk72BLuILH3lhEKrmRaUUgo2k,6103
 fastapi_factory_utilities/example/__init__.py,sha256=LEKnPTBcgDyfHeOjlVxjK5lFdFqS-7-mHDuVuM2Jh_Y,206
 fastapi_factory_utilities/example/__main__.py,sha256=Iwp_6rK7Lcv2F-XAKn6xjxQHOWjx2OjgwKAr91tfUfk,135
 fastapi_factory_utilities/example/api/__init__.py,sha256=qI82eeSwVjR6jSkX1pxm8ALv9WPQ_iHurFY4G2K7VzE,554
@@ -64,8 +64,8 @@ fastapi_factory_utilities/example/models/books/repository.py,sha256=7K63uAsSEGZ2
 fastapi_factory_utilities/example/services/books/__init__.py,sha256=Z06yNRoA7Zg3TGN-Q9rrvJg6Bbx-qJw661MVwukV6vQ,148
 fastapi_factory_utilities/example/services/books/services.py,sha256=-x7d4hotUWLzWo5uImMjFmtNcSTHwWv2bfttIbYYKbA,5380
 fastapi_factory_utilities/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_factory_utilities-0.2.1.dist-info/LICENSE,sha256=iO1nLzMMst6vEiqgSUrfrbetM7b0bvdzXhbed5tqG8o,1074
-fastapi_factory_utilities-0.2.1.dist-info/METADATA,sha256=vmZIAlSo0KVgELzN0LWH9B3GnurywJGoCJ9_5WarIM0,3314
-fastapi_factory_utilities-0.2.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-fastapi_factory_utilities-0.2.1.dist-info/entry_points.txt,sha256=IK0VcBexXo4uXQmTrbfhhnnfq4GmXPRn0GBB8hzlsq4,101
-fastapi_factory_utilities-0.2.1.dist-info/RECORD,,
+fastapi_factory_utilities-0.2.3.dist-info/LICENSE,sha256=iO1nLzMMst6vEiqgSUrfrbetM7b0bvdzXhbed5tqG8o,1074
+fastapi_factory_utilities-0.2.3.dist-info/METADATA,sha256=T3Kpr1rWSa-cgNdz1wOHw4kyhI4cj3bF4McC9XTE0fk,3314
+fastapi_factory_utilities-0.2.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+fastapi_factory_utilities-0.2.3.dist-info/entry_points.txt,sha256=IK0VcBexXo4uXQmTrbfhhnnfq4GmXPRn0GBB8hzlsq4,101
+fastapi_factory_utilities-0.2.3.dist-info/RECORD,,