fastapi-factory-utilities 0.2.0__py3-none-any.whl → 0.7.1__py3-none-any.whl

fastapi_factory_utilities/core/app/plugin_manager/exceptions.py

@@ -1,33 +0,0 @@
-"""Provide the exceptions for the plugin manager."""
-
-from fastapi_factory_utilities.core.exceptions import FastAPIFactoryUtilitiesError
-
-
-class PluginManagerError(FastAPIFactoryUtilitiesError):
-    """Generic plugin manager error."""
-
-
-class InvalidPluginError(PluginManagerError):
-    """The plugin is invalid."""
-
-    def __init__(self, plugin_name: str, message: str) -> None:
-        """Instantiate the exception.
-
-        Args:
-            plugin_name (str): The plugin name.
-            message (str): The message
-        """
-        super().__init__(message=f"Invalid plugin: {plugin_name}, {message}")
-
-
-class PluginPreConditionNotMetError(PluginManagerError):
-    """The plugin pre-condition is not met."""
-
-    def __init__(self, plugin_name: str, message: str) -> None:
-        """Instantiate the exception.
-
-        Args:
-            plugin_name (str): The plugin name.
-            message (str): The message
-        """
-        super().__init__(message=f"Plugin pre-condition not met: {plugin_name}, {message}")

fastapi_factory_utilities/core/app/plugin_manager/plugin_manager.py

@@ -1,190 +0,0 @@
-"""Plugin manager.
-
-This module provides the plugin manager for the application.
-
-Objective:
-    - Provide a way to manage plugins for the application.
-    - The plugins are activated based on the configuration.
-    - The plugins are checked for pre-conditions.
-    - The plugins are loaded on application load.
-    - The plugins are started on application startup.
-    - The plugins are stopped on application shutdown.
-"""
-
-from importlib import import_module
-from types import ModuleType
-from typing import Self
-
-from fastapi_factory_utilities.core.plugins import PluginsEnum, PluginState
-from fastapi_factory_utilities.core.protocols import (
-    ApplicationAbstractProtocol,
-    PluginProtocol,
-)
-
-from .exceptions import InvalidPluginError, PluginPreConditionNotMetError
-
-
-class PluginManager:
-    """Plugin manager for the application."""
-
-    DEFAULT_PLUGIN_PACKAGE: str = "fastapi_factory_utilities.core.plugins"
-
-    @classmethod
-    def _import_module(cls, name: str, package: str) -> ModuleType:
-        """Import the module. This is a wrapper around the import_module function to be able to mock it in the tests.
-
-        Args:
-            name (str): The name of the module.
-            package (str): The package of the module.
-
-        Returns:
-            ModuleType: The module.
-
-        Raises:
-            ImportError: If the module cannot be imported.
-            ModuleNotFoundError: If the module is not found.
-        """
-        return import_module(name=f"{package}.{name}")
-
-    @classmethod
-    def _check_pre_conditions(
-        cls, plugin_package: str, want_to_activate_plugins: list[PluginsEnum], application: ApplicationAbstractProtocol
-    ) -> list[PluginProtocol]:
-        """Check the pre-conditions for the plugins.
-
-        Args:
-            plugin_package (str): The package for the plugins.
-            want_to_activate_plugins (list[PluginsEnum]): The plugins to activate.
-            application (BaseApplicationProtocol): The application.
-
-        Returns:
-            list[PluginProtocol]: The activated plugins.
-
-        Raises:
-            InvalidPluginError: If the plugin is invalid.
-            PluginPreConditionNotMetError: If the pre-conditions are not met.
-        """
-        plugins: list[PluginProtocol] = []
-
-        for plugin_enum in want_to_activate_plugins:
-
-            try:
-                # Using a custom import function to be able to mock it in the tests.
-                plugin_module: ModuleType = cls._import_module(name=plugin_enum.value, package=plugin_package)
-            except (ImportError, ModuleNotFoundError) as import_error:
-                # TODO: Later, if we introduce extra mecanism to manage dependencies,
-                # we must handle a part of the error here. To be able to provide a better error message.
-                # For now, we just raise the error.
-                raise InvalidPluginError(
-                    plugin_name=plugin_enum.value, message="Error importing the plugin "
-                ) from import_error
-
-            if not isinstance(plugin_module, PluginProtocol):
-                raise InvalidPluginError(
-                    plugin_name=plugin_enum.value, message="The plugin does not implement the PluginProtocol"
-                )
-
-            if not plugin_module.pre_conditions_check(application=application):
-                raise PluginPreConditionNotMetError(
-                    plugin_name=plugin_enum.value, message="The pre-conditions are not met"
-                )
-
-            plugins.append(plugin_module)
-
-        return plugins
-
-    def __init__(self, activated: list[PluginsEnum] | None = None, plugin_package: str | None = None) -> None:
-        """Instanciate the plugin manager."""
-        self._plugin_package: str = plugin_package or self.DEFAULT_PLUGIN_PACKAGE
-        self._plugins_wanted_to_be_activated: list[PluginsEnum] = activated or []
-        self._activated_plugins: list[PluginProtocol] = []
-        self._states: list[PluginState] = []
-
-    def activate(self, plugin: PluginsEnum) -> Self:
-        """Activate a plugin.
-
-        Args:
-            plugin (PluginsEnum): The plugin to activate.
-
-        Returns:
-            Self: The plugin manager.
-        """
-        self._plugins_wanted_to_be_activated.append(plugin)
-
-        return self
-
-    @property
-    def states(self) -> list[PluginState]:
-        """Get the states."""
-        return self._states
-
-    def add_application_context(self, application: ApplicationAbstractProtocol) -> Self:
-        """Add the application context to the plugins.
-
-        Args:
-            application (BaseApplicationProtocol): The application.
-
-        Returns:
-            Self: The plugin manager.
-        """
-        self._application: ApplicationAbstractProtocol = application
-
-        return self
-
-    def add_states(self, states: list[PluginState]) -> Self:
-        """Add the states to the plugin manager.
-
-        Args:
-            states (list[PluginState]): The states.
-
-        Returns:
-            Self: The plugin manager.
-        """
-        for state in states:
-            self._states.append(state)
-        return self
-
-    def clear_states(self) -> Self:
-        """Clear the states."""
-        self._states = []
-        return self
-
-    def load(self) -> Self:
-        """Load the plugins.
-
-        Returns:
-            Self: The plugin manager.
-
-        Raises:
-            InvalidPluginError: If the plugin is invalid.
-            PluginPreConditionNotMetError: If the pre-conditions are not met.
-
-        """
-        # Remove duplicates.
-        self._plugins_wanted_to_be_activated = list(set(self._plugins_wanted_to_be_activated))
-        # Check the pre-conditions for the plugins.
-        self._activated_plugins = self._check_pre_conditions(
-            plugin_package=self._plugin_package,
-            want_to_activate_plugins=self._plugins_wanted_to_be_activated,
-            application=self._application,
-        )
-        # Load from the previous check.
-        for plugin in self._activated_plugins:
-            self.add_states(states=plugin.on_load(application=self._application) or [])
-
-        return self
-
-    async def trigger_startup(self) -> Self:
-        """Trigger the startup of the plugins."""
-        for plugin in self._activated_plugins:
-            states: list[PluginState] | None = await plugin.on_startup(application=self._application)
-            self.add_states(states=states or [])
-
-        return self
-
-    async def trigger_shutdown(self) -> Self:
-        """Trigger the shutdown of the plugins."""
-        for plugin in self._activated_plugins:
-            await plugin.on_shutdown(application=self._application)
-
-        return self

fastapi_factory_utilities/core/plugins/example/__init__.py

@@ -1,31 +0,0 @@
-"""Example Plugin Module."""
-
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from fastapi_factory_utilities.core.plugins import PluginState
-    from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
-
-
-def pre_conditions_check(application: "ApplicationAbstractProtocol") -> bool:  # pylint: disable=unused-argument
-    """Check the pre-conditions for the example plugin."""
-    return True
-
-
-def on_load(
-    application: "ApplicationAbstractProtocol",  # pylint: disable=unused-argument
-) -> list["PluginState"] | None:
-    """Actions to perform on load for the example plugin."""
-    return
-
-
-async def on_startup(
-    application: "ApplicationAbstractProtocol",  # pylint: disable=unused-argument
-) -> list["PluginState"] | None:
-    """Actions to perform on startup for the example plugin."""
-    return
-
-
-async def on_shutdown(application: "ApplicationAbstractProtocol") -> None:  # pylint: disable=unused-argument
-    """Actions to perform on shutdown for the example plugin."""
-    return

fastapi_factory_utilities/core/plugins/httpx_plugin/__init__.py

@@ -1,31 +0,0 @@
-"""Httpx Plugin Module."""
-
-from typing import TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from fastapi_factory_utilities.core.plugins import PluginState
-    from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
-
-
-def pre_conditions_check(application: "ApplicationAbstractProtocol") -> bool:  # pylint: disable=unused-argument
-    """Check the pre-conditions for the example plugin."""
-    return True
-
-
-def on_load(
-    application: "ApplicationAbstractProtocol",  # pylint: disable=unused-argument
-) -> list["PluginState"] | None:
-    """Actions to perform on load for the example plugin."""
-    return
-
-
-async def on_startup(
-    application: "ApplicationAbstractProtocol",  # pylint: disable=unused-argument
-) -> list["PluginState"] | None:
-    """Actions to perform on startup for the example plugin."""
-    return
-
-
-async def on_shutdown(application: "ApplicationAbstractProtocol") -> None:  # pylint: disable=unused-argument
-    """Actions to perform on shutdown for the example plugin."""
-    return

fastapi_factory_utilities-0.2.0.dist-info/RECORD

@@ -1,70 +0,0 @@
-fastapi_factory_utilities/__main__.py,sha256=w8o9KpyHcxGyLHmTK8ixbIqJIsB3NbIGuAMY7OfnxrA,147
-fastapi_factory_utilities/core/__init__.py,sha256=tt5a-MgeFt_oACkc9K5xl2rynIbca9DGqsKBDEqGzto,34
-fastapi_factory_utilities/core/api/__init__.py,sha256=eehUFVDPk07MUPIorGdC8WqDRB8NjdSy7Za55CdLrps,542
-fastapi_factory_utilities/core/api/tags.py,sha256=3hQcTeW0FS78sPTJ2PB44dMDTSkoW-xKj7rrfKX2Lk0,154
-fastapi_factory_utilities/core/api/v1/sys/__init__.py,sha256=mTXhpn3_KgQ1snt0-0PFmGvFr4n5srQRRADEdRSGFJM,345
-fastapi_factory_utilities/core/api/v1/sys/health.py,sha256=IF51Z1seOFn91m3FC57U8uWfAA7c_EhhBpjbu_ly9WQ,2807
-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/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
-fastapi_factory_utilities/core/app/fastapi_builder.py,sha256=DgIqiCnJK6cqsG-sg4H7Pi0lkhaxOhSLQt_ksHjpjW0,2835
-fastapi_factory_utilities/core/app/plugin_manager/__init__.py,sha256=eMfxCsk41Caw_juAawmDZHhytNI_ubXmqfRDug2AzvQ,319
-fastapi_factory_utilities/core/app/plugin_manager/exceptions.py,sha256=CFrZvROT7mLzNpXWwDra1j08lA_7ZrSrOHN94sEEfnQ,1026
-fastapi_factory_utilities/core/app/plugin_manager/plugin_manager.py,sha256=5E_Qp535xNJHNujZ_QRiMfIkDUy9F_3Rbjlclny5P08,6682
-fastapi_factory_utilities/core/exceptions.py,sha256=7ntbaMptYn5OOPeKPVR4zU98NIC0j53NQSkqVP1bD68,1362
-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/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
-fastapi_factory_utilities/core/plugins/odm_plugin/repositories.py,sha256=Wxh5C_gnU4jY8H5qpvcFuSlaM1dLrsDXqxGuuaxwB68,6912
-fastapi_factory_utilities/core/plugins/opentelemetry_plugin/__init__.py,sha256=UsXPjiAASn5GIHW8vrF32mklxGNq8ajILV-ty4K1Tbs,4371
-fastapi_factory_utilities/core/plugins/opentelemetry_plugin/builder.py,sha256=DsD1vUtTIMXCxLsQ2KbMaQthdPfvZsI95uLdD7pkeiE,9838
-fastapi_factory_utilities/core/plugins/opentelemetry_plugin/configs.py,sha256=4mMa5SrmnPY1R_gVFRtFhi9WNaTGEGZL5iNNhyjcZQ0,3448
-fastapi_factory_utilities/core/plugins/opentelemetry_plugin/exceptions.py,sha256=CpsHayfQpP0zghN8y5PP6TBy-cXhHoNxBR--I86gAdE,327
-fastapi_factory_utilities/core/plugins/opentelemetry_plugin/helpers.py,sha256=qpTIzX67orJz7vy6SBIwRs24omMBoToJkhpurZRjPuk,1533
-fastapi_factory_utilities/core/protocols.py,sha256=TzZKr_KfmTphk2LL-TD2XzxNlLbihbGM2DxWMhc5lEQ,2428
-fastapi_factory_utilities/core/services/status/__init__.py,sha256=N5H0cCN9ZFu_0YZar4RLdCDEjKMICrIhNtfKgB0LI78,370
-fastapi_factory_utilities/core/services/status/enums.py,sha256=IUxWAd0Ecknri4BqzaqoDRRhT_8LdcgtQcNqgNVDXGE,599
-fastapi_factory_utilities/core/services/status/exceptions.py,sha256=_fQFGqHKnG54Hs-ZtC4gs0xwzSH246_WwQOonraoGKw,856
-fastapi_factory_utilities/core/services/status/health_calculator_strategies.py,sha256=p2KKJo-dq1j9iWHT0mvlBKtldH9m8l31aytLkUsb9nQ,1634
-fastapi_factory_utilities/core/services/status/readiness_calculator_strategies.py,sha256=hA1LX2pSxva-7bVaQ0dw8NpTbl1ZWDtXd9xzqQUGUsI,1354
-fastapi_factory_utilities/core/services/status/services.py,sha256=qtgYdnxNQMbb6q6G9uGasRO3lZcpiWNmw1padPkh6jA,8490
-fastapi_factory_utilities/core/services/status/types.py,sha256=GJOGRra6NtpUS4q1cr4cdWR0BbIUtEwP7vQX-sXX5jQ,3297
-fastapi_factory_utilities/core/utils/configs.py,sha256=qM0pCrsK8ZyfCoyova_VrhR4eUX3LSPCbWunGMWcSVg,2581
-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/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
-fastapi_factory_utilities/example/api/books/__init__.py,sha256=zXARBnjywJwg1XsLbcixYWcHH4uC9mF-kbbX4P8cVgA,160
-fastapi_factory_utilities/example/api/books/responses.py,sha256=21WeD6bdg0MCD_0vRHwmsL4W79iDcG9NnDLemXysc84,540
-fastapi_factory_utilities/example/api/books/routes.py,sha256=bwg8Bhvoj9vx2SdwunzFS-Z3cHECtjl_yGdo8MfiGEM,1529
-fastapi_factory_utilities/example/app.py,sha256=mcXQOg0A74mc8xFT0XuRHne3YjXXI7dTMV48G_Ypng8,1555
-fastapi_factory_utilities/example/application.yaml,sha256=5xRyFSuMxmgZ5Mikai94UqKYJ7PxJp8omlXobTjv14M,485
-fastapi_factory_utilities/example/entities/books/__init__.py,sha256=q2UTwLyCs3te38n7RgwT0go3Hp0bE9-NvoX7P-DR-3o,185
-fastapi_factory_utilities/example/entities/books/entities.py,sha256=rLE01lE7U6WizrD5ZHMRwkynd8_dWF6DltBFH61f-Do,405
-fastapi_factory_utilities/example/entities/books/enums.py,sha256=lXYUvhIkT1pi0teflMpnqeafeiBZMokyWxoFLgzV6a8,330
-fastapi_factory_utilities/example/entities/books/types.py,sha256=7LYGPu-CcI3noIORJyIZlVF-CBugWPXEqgDzWrO3XmQ,1558
-fastapi_factory_utilities/example/models/__init__.py,sha256=RJmp3R9bhbQv7n0WOlsHP65LqbEs_DjF9hzYKwYTRGo,22
-fastapi_factory_utilities/example/models/books/__init__.py,sha256=1GJFCYMGZugQRxlFl-q7fPBFvNsl2ykeW8lV7rpURHU,181
-fastapi_factory_utilities/example/models/books/document.py,sha256=lYJfMGr5GqEEsn7L--PFs75hC2q-jQx77wl7EhTrp5U,568
-fastapi_factory_utilities/example/models/books/repository.py,sha256=7K63uAsSEGZ2EXqufU4Tc8KpymgXK8JX8WjAE2Sw8ok,387
-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-0.2.0.dist-info/LICENSE,sha256=iO1nLzMMst6vEiqgSUrfrbetM7b0bvdzXhbed5tqG8o,1074
-fastapi_factory_utilities-0.2.0.dist-info/METADATA,sha256=ROGr-AWsaQ1tLxOx0YTZCk6ayy84W2wa2ZrXmZbjRIc,3314
-fastapi_factory_utilities-0.2.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-fastapi_factory_utilities-0.2.0.dist-info/entry_points.txt,sha256=IK0VcBexXo4uXQmTrbfhhnnfq4GmXPRn0GBB8hzlsq4,101
-fastapi_factory_utilities-0.2.0.dist-info/RECORD,,