fastapi-factory-utilities 0.2.2__tar.gz → 0.8.3__tar.gz

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/PKG-INFO

@@ -1,9 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fastapi_factory_utilities
-Version: 0.2.2
-Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
+Version: 0.8.3
+Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Taskiq, AioPika and OpenTelemetry.
 License: MIT
-Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices
+License-File: LICENSE
+Keywords: python,fastapi,beanie,taskiq,opentelemetry,microservices
 Author: miragecentury
 Author-email: victorien.vanroye@gmail.com
 Maintainer: miragecentury
@@ -18,23 +19,31 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: beanie (>=1.27.0,<2.0.0)
-Requires-Dist: fastapi (>=0.115.4,<0.116.0)
-Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: aio-pika (>=9.5.7,<10.0.0)
+Requires-Dist: aiohttp[speedups] (>=3.12.13,<4.0.0)
+Requires-Dist: beanie (>=1.30.0,<2.0.0)
+Requires-Dist: fastapi (>=0.115.13,<1)
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc (>=1.26.0,<2.0.0)
 Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.26.0,<2.0.0)
-Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.49b1,<0.50)
-Requires-Dist: opentelemetry-instrumentation-pymongo (>=0.49b2,<0.50)
+Requires-Dist: opentelemetry-instrumentation-aio-pika (>=0.59b0,<0.60)
+Requires-Dist: opentelemetry-instrumentation-aiohttp-client (>=0,<1)
+Requires-Dist: opentelemetry-instrumentation-fastapi (>=0,<1)
+Requires-Dist: opentelemetry-instrumentation-pymongo (>=0,<1)
 Requires-Dist: opentelemetry-propagator-b3 (>=1.26.0,<2.0.0)
 Requires-Dist: opentelemetry-sdk (>=1.26.0,<2.0.0)
 Requires-Dist: pyaml (>=25.1.0,<26.0.0)
 Requires-Dist: pydantic (>=2.8.2,<3.0.0)
-Requires-Dist: pymongo (>=4.9.2,<4.10.0)
+Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
+Requires-Dist: pymongo (>=4.9.2,<4.16.0)
 Requires-Dist: reactivex (>=4.0.4,<5.0.0)
 Requires-Dist: structlog (>=24.1,<26.0)
-Requires-Dist: typer (>=0.15.1,<0.16.0)
-Requires-Dist: uvicorn (>=0.32.0,<0.33.0)
-Project-URL: Homepage, https://github.com/miragecentury/fastapi_factory_utilities
-Project-URL: Repository, https://github.com/miragecentury/fastapi_factory_utilities
+Requires-Dist: taskiq-dependencies (>=1.5.8,<2.0.0)
+Requires-Dist: taskiq-fastapi (>=0.3.5,<0.4.0)
+Requires-Dist: taskiq-redis (>=1.0.9,<2.0.0)
+Requires-Dist: typer (>=0,<1)
+Requires-Dist: uvicorn (>=0.34.3,<1)
+Project-URL: Homepage, https://github.com/DeerHide/fastapi_factory_utilities
+Project-URL: Repository, https://github.com/DeerHide/fastapi_factory_utilities
 Description-Content-Type: text/markdown
 
 # fastapi_factory_utilities

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "fastapi_factory_utilities"
-homepage = "https://github.com/miragecentury/fastapi_factory_utilities"
-repository = "https://github.com/miragecentury/fastapi_factory_utilities"
-keywords = ["python", "fastapi", "beanie", "httpx", "opentelemetry", "microservices"]
-version = "0.2.2"
-description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
+homepage = "https://github.com/DeerHide/fastapi_factory_utilities"
+repository = "https://github.com/DeerHide/fastapi_factory_utilities"
+keywords = ["python", "fastapi", "beanie", "taskiq", "opentelemetry", "microservices"]
+version = "0.8.3"
+description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Taskiq, AioPika and OpenTelemetry."
 authors = ["miragecentury <victorien.vanroye@gmail.com>"]
 maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]
 license = "MIT"
@@ -24,23 +24,36 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Application Frameworks",
 ]
 
+[[tool.poetry.source]]
+name = "velmios"
+url = "https://pypi.velmios.io/simple"
+priority = "explicit"
+
 [tool.poetry.dependencies]
 python = "~3.12"
 structlog = ">=24.1,<26.0"
-typer = "^0.15.1"
+typer = "^0"
 pydantic = "^2.8.2"
-fastapi = "^0.115.4"
-uvicorn = "^0.32.0"
+fastapi = ">=0.115.13,<1"
+uvicorn = ">=0.34.3,<1"
 opentelemetry-sdk = "^1.26.0"
 opentelemetry-exporter-otlp-proto-http = "^1.26.0"
-httpx = "^0.28.1"
-opentelemetry-instrumentation-fastapi = "^0.49b1"
+opentelemetry-exporter-otlp-proto-grpc = "^1.26.0"
+opentelemetry-instrumentation-fastapi = "^0"
 opentelemetry-propagator-b3 = "^1.26.0"
-beanie = "^1.27.0"
-opentelemetry-instrumentation-pymongo = "^0.49b2"
-pymongo = "~4.9.2" # version fixed to fix integration between beanie and pytest-mongo
+beanie = "^1.30.0"
+opentelemetry-instrumentation-pymongo = "^0"
+pymongo = ">=4.9.2,<4.16.0"
 pyaml = "^25.1.0"
 reactivex = "^4.0.4"
+pyjwt = "^2.10.1"
+aiohttp = { version="^3.12.13", extras=["speedups"] }
+opentelemetry-instrumentation-aiohttp-client = "^0"
+aio-pika = "^9.5.7"
+opentelemetry-instrumentation-aio-pika = "^0.59b0"
+taskiq-dependencies = { version="^1.5.8", source="velmios"}
+taskiq-fastapi = "^0.3.5"
+taskiq-redis = "^1.0.9"
 
 [tool.poetry.group.test]
 optional = true
@@ -49,25 +62,26 @@ optional = true
 mypy = "^1.10.0"
 types-requests = "^2.32.0.20240712"
 types-pyyaml = "^6.0.12.20240311"
-pylint = {version="^3.2.2", extras=["spelling"]}
-black = "^24.4.2"
+pylint = {version=">=3.2.2,<5.0.0", extras=["spelling"]}
+black = "^25.9.0"
 pre-commit = "^4.0.1"
 pyupgrade = "^3.15.2"
 pytest = "^8.2.0"
 pytest-xdist = "^3.6.1"
-pytest-cov = "^6.0.0"
-ruff = "^0.7.2"
-pytest-asyncio = "^0.25.0"
+pytest-cov = "^7.0.0"
+ruff = "^0.14"
+pytest-asyncio = ">=0.25,<1.3"
 pytest-mongo = "^3.1.0"
 locust = "^2.32.4"
-testcontainers = { version="^4.9.0", extras=["mongodb"] }
+testcontainers = { version="^4.9.0", extras=["mongodb","rabbitmq", "redis"] }
 types-deprecated = "^1.2.15.20241117"
 types-pygments = "^2.18.0.20240506"
 types-colorama = "^0.4.15.20240311"
-types-protobuf = "^5.29.1.20241207"
-types-psutil = "^6.1.0.20241221"
+types-protobuf = ">=5.29.1.20241207,<7.0.0.0"
+types-psutil = ">=6.1.0.20241221,<8.0.0.0"
 types-pyopenssl = "^24.1.0.20240722"
 types-ujson = "^5.10.0.20240515"
+httpx = "^0.28.1"
 
 [tool.poetry.extras]
 
@@ -84,6 +98,9 @@ addopts = "--import-mode=importlib -n auto --color=yes"
 filterwarnings = [
     "ignore:.*datetime.datetime.utcfromtimestamp().*:DeprecationWarning", # reactivex
     "ignore:.*datetime.datetime.utcnow().*:DeprecationWarning", # reactivex
+    "ignore::pydantic.warnings.PydanticDeprecatedSince211",
+    "ignore:The @wait_container_is_ready decorator is deprecated.*:DeprecationWarning", # testcontainers
+    "ignore:The wait_for_logs function with string or callable predicates is deprecated.*:DeprecationWarning", # testcontainers
 ]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
@@ -104,6 +121,7 @@ mypy_path  = "src:tests"
 namespace_packages = true
 plugins = ["pydantic.mypy"]
 follow_imports = "silent"
+follow_untyped_imports = true
 warn_redundant_casts = true
 warn_unused_ignores = true
 disallow_any_generics = true

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/api/__init__.py

@@ -22,4 +22,4 @@ api_v2: APIRouter = APIRouter(prefix="/v2")
 api.include_router(router=api_v1)
 api.include_router(router=api_v2)
 
-__all__: list[str] = ["api", "TagEnum"]
+__all__: list[str] = ["TagEnum", "api"]

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/api/v1/sys/health.py

@@ -10,10 +10,10 @@ from pydantic import BaseModel
 
 from fastapi_factory_utilities.core.services.status.enums import HealthStatusEnum
 from fastapi_factory_utilities.core.services.status.services import (
-    ComponentInstanceKey,
     StatusService,
     depends_status_service,
 )
+from fastapi_factory_utilities.core.services.status.types import ComponentInstanceKey
 
 api_v1_sys_health = APIRouter(prefix="/health")
 

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/app/__init__.py

@@ -2,13 +2,22 @@
 
 from .application import ApplicationAbstract
 from .builder import ApplicationGenericBuilder
-from .config import BaseApplicationConfig, RootConfig
+from .config import (
+    BaseApplicationConfig,
+    DependencyConfig,
+    HttpServiceDependencyConfig,
+    RootConfig,
+    depends_dependency_config,
+)
 from .enums import EnvironmentEnum
 
 __all__: list[str] = [
-    "BaseApplicationConfig",
-    "EnvironmentEnum",
     "ApplicationAbstract",
     "ApplicationGenericBuilder",
+    "BaseApplicationConfig",
+    "DependencyConfig",
+    "EnvironmentEnum",
+    "HttpServiceDependencyConfig",
     "RootConfig",
+    "depends_dependency_config",
 ]

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/app/application.py

@@ -12,10 +12,7 @@ from structlog.stdlib import BoundLogger, get_logger
 from fastapi_factory_utilities.core.api import api
 from fastapi_factory_utilities.core.app.config import RootConfig
 from fastapi_factory_utilities.core.app.fastapi_builder import FastAPIBuilder
-from fastapi_factory_utilities.core.app.plugin_manager.plugin_manager import (
-    PluginManager,
-)
-from fastapi_factory_utilities.core.plugins import PluginsEnum
+from fastapi_factory_utilities.core.plugins import PluginAbstract
 from fastapi_factory_utilities.core.services.status.services import StatusService
 
 _logger: BoundLogger = get_logger(__name__)
@@ -31,12 +28,10 @@ class ApplicationAbstract(ABC):
     # TODO: Find a way to remove this from here
     ODM_DOCUMENT_MODELS: ClassVar[list[type[Document]]]
 
-    DEFAULT_PLUGINS_ACTIVATED: ClassVar[list[PluginsEnum]] = []
-
     def __init__(
         self,
         root_config: RootConfig,
-        plugin_manager: PluginManager,
+        plugins: list[PluginAbstract],
         fastapi_builder: FastAPIBuilder,
     ) -> None:
         """Instantiate the application."""
@@ -44,9 +39,25 @@ class ApplicationAbstract(ABC):
         self.fastapi_builder: FastAPIBuilder = fastapi_builder
         # Add the API router to the FastAPI application
         self.fastapi_builder.add_api_router(router=api, without_resource_path=True)
-        self.plugin_manager: PluginManager = plugin_manager
+        self.plugins: list[PluginAbstract] = plugins
         self._add_to_state: dict[str, Any] = {}
 
+    def load_plugins(self) -> None:
+        """Load the plugins."""
+        for plugin in self.plugins:
+            plugin.set_application(application=self)
+            plugin.on_load()
+
+    async def startup_plugins(self) -> None:
+        """Startup the plugins."""
+        for plugin in self.plugins:
+            await plugin.on_startup()
+
+    async def shutdown_plugins(self) -> None:
+        """Shutdown the plugins."""
+        for plugin in self.plugins:
+            await plugin.on_shutdown()
+
     def setup(self) -> None:
         """Initialize the application."""
         # Initialize FastAPI application
@@ -54,15 +65,14 @@ class ApplicationAbstract(ABC):
         # Status service
         self.status_service: StatusService = StatusService()
         self.add_to_state(key="status_service", value=self.status_service)
+        self.add_to_state(key="config", value=self.config)
+        self.add_to_state(key="application", value=self)
         self._apply_states_to_fastapi_app()
         # Configure the application
         self.configure()
         self._apply_states_to_fastapi_app()
         # Initialize PluginManager
-        self.plugin_manager.add_application_context(application=self)
-        self.plugin_manager.load()
-        # Add the states to the FastAPI app
-        self._import_states_from_plugin_manager()
+        self.load_plugins()
 
     def _apply_states_to_fastapi_app(self) -> None:
         # Add manually added states to the FastAPI app
@@ -72,13 +82,6 @@ class ApplicationAbstract(ABC):
             setattr(self._asgi_app.state, key, value)
         self._add_to_state.clear()
 
-    def _import_states_from_plugin_manager(self) -> None:
-        """Import the states from the plugins."""
-        for state in self.plugin_manager.states:
-            self.add_to_state(key=state.key, value=state.value)
-        self.plugin_manager.clear_states()
-        self._apply_states_to_fastapi_app()
-
     def add_to_state(self, key: str, value: Any) -> None:
         """Add a value to the FastAPI app state."""
         if key in self._add_to_state:
@@ -103,14 +106,13 @@ class ApplicationAbstract(ABC):
     @asynccontextmanager
     async def fastapi_lifespan(self, fastapi: FastAPI) -> AsyncGenerator[None, None]:  # pylint: disable=unused-argument
         """FastAPI lifespan context manager."""
-        await self.plugin_manager.trigger_startup()
-        self._import_states_from_plugin_manager()
+        await self.startup_plugins()
         await self.on_startup()
         try:
             yield
         finally:
             await self.on_shutdown()
-            await self.plugin_manager.trigger_shutdown()
+            await self.shutdown_plugins()
 
     def get_config(self) -> RootConfig:
         """Get the configuration."""
@@ -120,10 +122,6 @@ class ApplicationAbstract(ABC):
         """Get the ASGI application."""
         return self._asgi_app
 
-    def get_plugin_manager(self) -> PluginManager:
-        """Get the plugin manager."""
-        return self.plugin_manager
-
     def get_status_service(self) -> StatusService:
         """Get the status service."""
         return self.status_service

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/app/builder.py

@@ -4,10 +4,7 @@ from typing import Any, Generic, Self, TypeVar, get_args
 
 from fastapi_factory_utilities.core.app.config import GenericConfigBuilder, RootConfig
 from fastapi_factory_utilities.core.app.fastapi_builder import FastAPIBuilder
-from fastapi_factory_utilities.core.app.plugin_manager.plugin_manager import (
-    PluginManager,
-)
-from fastapi_factory_utilities.core.plugins import PluginsEnum
+from fastapi_factory_utilities.core.plugins import PluginAbstract
 from fastapi_factory_utilities.core.utils.log import LogModeEnum, setup_log
 from fastapi_factory_utilities.core.utils.uvicorn import UvicornUtils
 
@@ -19,21 +16,16 @@ T = TypeVar("T", bound=ApplicationAbstract)
 class ApplicationGenericBuilder(Generic[T]):
     """Application generic builder."""
 
-    def __init__(self, plugins_activation_list: list[PluginsEnum] | None = None) -> None:
+    def __init__(self, plugins: list[PluginAbstract] | 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._plugins: list[PluginAbstract] = plugins or []
         self._fastapi_builder: FastAPIBuilder | None = None
         generic_args: tuple[Any, ...] = get_args(self.__orig_bases__[0])  # type: ignore
         self._application_class: type[T] = generic_args[0]
-        self._plugins_activation_list: list[PluginsEnum]
-        if plugins_activation_list is None:
-            self._plugins_activation_list = self._application_class.DEFAULT_PLUGINS_ACTIVATED
-        else:
-            self._plugins_activation_list = plugins_activation_list
 
-    def add_plugin_to_activate(self, plugin: PluginsEnum) -> Self:
+    def add_plugin_to_activate(self, plugin: PluginAbstract) -> Self:
         """Add a plugin to activate.
 
         Args:
@@ -42,7 +34,7 @@ class ApplicationGenericBuilder(Generic[T]):
         Returns:
             Self: The builder.
         """
-        self._plugins_activation_list.append(plugin)
+        self._plugins.append(plugin)
         return self
 
     def add_config(self, config: RootConfig) -> Self:
@@ -57,18 +49,6 @@ class ApplicationGenericBuilder(Generic[T]):
         self._root_config = config
         return self
 
-    def add_plugin_manager(self, plugin_manager: PluginManager) -> Self:
-        """Add the plugin manager to the builder.
-
-        Args:
-            plugin_manager (PluginManager): The plugin manager.
-
-        Returns:
-            Self: The builder.
-        """
-        self._plugin_manager = plugin_manager
-        return self
-
     def add_fastapi_builder(self, fastapi_builder: FastAPIBuilder) -> Self:
         """Add the FastAPI builder to the builder.
 
@@ -83,18 +63,20 @@ class ApplicationGenericBuilder(Generic[T]):
 
     def _build_from_package_root_config(self) -> RootConfig:
         """Build the configuration from the package."""
-        return GenericConfigBuilder[self._application_class.CONFIG_CLASS](
+        return GenericConfigBuilder[self._application_class.CONFIG_CLASS](  # type: ignore
             package_name=self._application_class.PACKAGE_NAME,
             config_class=self._application_class.CONFIG_CLASS,
         ).build()
 
-    def build(self) -> T:
-        """Build the application."""
-        # Plugin manager
-        if self._plugin_manager is None:
-            self._plugin_manager = PluginManager()
-        for plugin in self._plugins_activation_list:
-            self._plugin_manager.activate(plugin=plugin)
+    def build(self, **kwargs: Any) -> T:
+        """Build the application.
+
+        Args:
+            **kwargs: The keyword arguments to pass to the application.
+
+        Returns:
+            T: The application.
+        """
         # RootConfig
         self._root_config = self._root_config or self._build_from_package_root_config()
         # FastAPIBuilder
@@ -102,8 +84,9 @@ class ApplicationGenericBuilder(Generic[T]):
 
         application: T = self._application_class(
             root_config=self._root_config,
-            plugin_manager=self._plugin_manager,
+            plugins=self._plugins,
             fastapi_builder=self._fastapi_builder,
+            **kwargs,
         )
         application.setup()
         return application
@@ -117,7 +100,8 @@ class ApplicationGenericBuilder(Generic[T]):
         """Build the application and serve it with Uvicorn."""
         uvicorn_utils: UvicornUtils = self._uvicorn_utils or self.build_as_uvicorn_utils()
 
-        setup_log(mode=LogModeEnum.CONSOLE)
+        assert self._root_config is not None
+        setup_log(mode=LogModeEnum.CONSOLE, logging_config=self._root_config.logging)
 
         try:
             uvicorn_utils.serve()

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/app/config.py

@@ -2,7 +2,8 @@
 
 from typing import Any, ClassVar, Generic, TypeVar, get_args
 
-from pydantic import BaseModel, ConfigDict, Field
+from fastapi import Request
+from pydantic import BaseModel, ConfigDict, Field, HttpUrl
 
 from fastapi_factory_utilities.core.app.exceptions import ConfigBuilderError
 from fastapi_factory_utilities.core.utils.configs import (
@@ -71,6 +72,20 @@ class BaseApplicationConfig(BaseModel):
     root_path: str = Field(default="", description="Root path")
 
 
+class HttpServiceDependencyConfig(BaseModel):
+    """Http service dependency config."""
+
+    url: HttpUrl
+
+
+class DependencyConfig(BaseModel):
+    """Dependency config."""
+
+    kratos: HttpServiceDependencyConfig | None = Field(default=None, description="Kratos dependency config")
+    hydra_admin: HttpServiceDependencyConfig | None = Field(default=None, description="Hydra admin dependency config")
+    hydra_public: HttpServiceDependencyConfig | None = Field(default=None, description="Hydra public dependency config")
+
+
 class RootConfig(BaseModel):
     """Root configuration."""
 
@@ -84,6 +99,7 @@ class RootConfig(BaseModel):
     cors: CorsConfig = Field(description="CORS configuration", default_factory=CorsConfig)
     development: DevelopmentConfig = Field(description="Development configuration", default_factory=DevelopmentConfig)
     logging: list[LoggingConfig] = Field(description="Logging configuration", default_factory=list)
+    dependencies: DependencyConfig = Field(description="Dependencies configuration", default_factory=DependencyConfig)
 
 
 GenericConfig = TypeVar("GenericConfig", bound=BaseModel)
@@ -162,3 +178,8 @@ class GenericConfigBuilder(Generic[GenericConfig]):
             ) from exception
 
         return config
+
+
+def depends_dependency_config(request: Request) -> DependencyConfig:
+    """Get the dependency config."""
+    return request.app.state.config.dependencies

{fastapi_factory_utilities-0.2.2 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/app/fastapi_builder.py

@@ -64,7 +64,7 @@ class FastAPIBuilder:
             title=self._root_config.application.service_name,
             description="",
             version=self._root_config.application.version,
-            lifespan=lifespan,  # type: ignore
+            lifespan=lifespan,
         )
 
         fastapi.add_middleware(
@@ -77,7 +77,8 @@ class FastAPIBuilder:
 
         for middleware_args in self._middleware_list:
             fastapi.add_middleware(
-                middleware_class=middleware_args.middleware_class, **middleware_args.kwargs  # type: ignore
+                middleware_class=middleware_args.middleware_class,  # type: ignore
+                **middleware_args.kwargs,  # pyright: ignore
             )
 
         fastapi.include_router(router=self._base_router)

fastapi_factory_utilities-0.8.3/src/fastapi_factory_utilities/core/exceptions.py

@@ -0,0 +1,87 @@
+"""FastAPI Factory Utilities exceptions."""
+
+import logging
+from typing import Any, cast
+
+from opentelemetry.trace import Span, get_current_span
+from opentelemetry.util.types import AttributeValue
+from structlog.stdlib import BoundLogger, get_logger
+
+_logger: BoundLogger = get_logger()
+
+
+class FastAPIFactoryUtilitiesError(Exception):
+    """Base exception for the FastAPI Factory Utilities."""
+
+    FILTERED_ATTRIBUTES: tuple[str, ...] = ()
+    DEFAULT_LOGGING_LEVEL: int = logging.ERROR
+    DEFAULT_MESSAGE: str | None = None
+
+    def __init__(
+        self,
+        *args: object,
+        **kwargs: Any,
+    ) -> None:
+        """Instantiate the exception.
+
+        Args:
+            *args: The arguments.
+            **kwargs: The keyword arguments.
+
+        """
+        # If Default Message is not set, try to extract it from docstring (first line)
+        default_message: str = self.DEFAULT_MESSAGE or "An error occurred"
+        if self.DEFAULT_MESSAGE is None and self.__doc__ is not None:
+            default_message = self.__doc__.split("\n", maxsplit=1)[0]
+        # Extract the message and the level from the kwargs if they are present
+        self.message: str | None = cast(str | None, kwargs.pop("message", None))
+        self.level: int = cast(int, kwargs.pop("level", self.DEFAULT_LOGGING_LEVEL))
+
+        # If the message is not present, try to extract it from the args
+        if self.message is None and len(args) > 0 and isinstance(args[0], str):
+            self.message = args[0]
+        elif self.message is None:
+            self.message = default_message
+
+        # Log the Exception
+        if self.message:
+            _logger.log(level=self.level, event=self.message)
+
+        # Set the kwargs as attributes of the exception
+        for key, value in kwargs.items():
+            if key in self.FILTERED_ATTRIBUTES:
+                continue
+            setattr(self, key, value)
+
+        try:
+            # Propagate the exception
+            span: Span = get_current_span()
+            # If not otel is setup, INVALID_SPAN is retrieved from get_current_span
+            # and it will respond False to the is_recording method
+            if span.is_recording():
+                span.record_exception(self)
+                for key, value in kwargs.items():
+                    if key in self.FILTERED_ATTRIBUTES:
+                        continue
+                    attribute_value: AttributeValue
+                    if not isinstance(value, (str, bool, int, float)):
+                        attribute_value = str(value)
+                    else:
+                        attribute_value = value
+                    span.set_attribute(key, attribute_value)
+        except Exception:  # pylint: disable=broad-exception-caught
+            # Suppress any errors that occur while propagating the exception
+            pass
+
+        # Call the parent class
+        super().__init__(*args)
+
+    def __str__(self) -> str:
+        """Return the string representation of the exception.
+
+        Returns:
+            str: The message if available, otherwise the default exception string.
+        """
+        if self.message is not None:
+            return self.message
+        return super().__str__()

fastapi_factory_utilities-0.8.3/src/fastapi_factory_utilities/core/plugins/__init__.py

@@ -0,0 +1,7 @@
+"""Package for plugins."""
+
+from .abstracts import PluginAbstract
+
+__all__: list[str] = [
+    "PluginAbstract",
+]

fastapi_factory_utilities-0.8.3/src/fastapi_factory_utilities/core/plugins/abstracts.py

@@ -0,0 +1,40 @@
+"""Abstracts for the plugins."""
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Any, Self
+
+if TYPE_CHECKING:
+    from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
+
+
+class PluginAbstract(ABC):
+    """Abstract class for the plugins."""
+
+    def __init__(self) -> None:
+        """Initialize the plugin."""
+        self._application: ApplicationAbstractProtocol | None = None
+
+    def set_application(self, application: "ApplicationAbstractProtocol") -> Self:
+        """Set the application."""
+        self._application = application
+        return self
+
+    def _add_to_state(self, key: str, value: Any) -> None:
+        """Add to the state."""
+        assert self._application is not None
+        setattr(self._application.get_asgi_app().state, key, value)
+
+    @abstractmethod
+    def on_load(self) -> None:
+        """On load."""
+        raise NotImplementedError
+
+    @abstractmethod
+    async def on_startup(self) -> None:
+        """On startup."""
+        raise NotImplementedError
+
+    @abstractmethod
+    async def on_shutdown(self) -> None:
+        """On shutdown."""
+        raise NotImplementedError