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

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

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: fastapi_factory_utilities
-Version: 0.5.0
-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
 License-File: LICENSE
-Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices
+Keywords: python,fastapi,beanie,taskiq,opentelemetry,microservices
 Author: miragecentury
 Author-email: victorien.vanroye@gmail.com
 Maintainer: miragecentury
@@ -19,12 +19,14 @@ 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: 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-aiohttp-client (>=0.55b1,<0.56)
+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)
@@ -32,13 +34,16 @@ 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: pyjwt (>=2.10.1,<3.0.0)
-Requires-Dist: pymongo (>=4.9.2,<4.14.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: 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/miragecentury/fastapi_factory_utilities
-Project-URL: Repository, https://github.com/miragecentury/fastapi_factory_utilities
+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.5.0 → 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.5.0"
-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,6 +24,11 @@ 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"
@@ -38,12 +43,17 @@ opentelemetry-instrumentation-fastapi = "^0"
 opentelemetry-propagator-b3 = "^1.26.0"
 beanie = "^1.30.0"
 opentelemetry-instrumentation-pymongo = "^0"
-pymongo = ">=4.9.2,<4.14.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.55b1"
+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
@@ -52,18 +62,18 @@ 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,<0.13.0"
-pytest-asyncio = ">=0.25,<1.1"
+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"
@@ -89,6 +99,8 @@ 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"
@@ -109,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.5.0 → 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.5.0 → 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
@@ -61,10 +72,7 @@ class ApplicationAbstract(ABC):
         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
@@ -74,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:
@@ -105,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."""
@@ -122,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.5.0 → 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,7 +63,7 @@ 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()
@@ -97,11 +77,6 @@ class ApplicationGenericBuilder(Generic[T]):
         Returns:
             T: 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)
         # RootConfig
         self._root_config = self._root_config or self._build_from_package_root_config()
         # FastAPIBuilder
@@ -109,7 +84,7 @@ 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,
         )
@@ -125,6 +100,7 @@ class ApplicationGenericBuilder(Generic[T]):
         """Build the application and serve it with Uvicorn."""
         uvicorn_utils: UvicornUtils = self._uvicorn_utils or self.build_as_uvicorn_utils()
 
+        assert self._root_config is not None
         setup_log(mode=LogModeEnum.CONSOLE, logging_config=self._root_config.logging)
 
         try:

{fastapi_factory_utilities-0.5.0 → 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,8 +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.5.0 → fastapi_factory_utilities-0.8.3}/src/fastapi_factory_utilities/core/exceptions.py

@@ -1,8 +1,7 @@
 """FastAPI Factory Utilities exceptions."""
 
 import logging
-from collections.abc import Sequence
-from typing import NotRequired, TypedDict, Unpack
+from typing import Any, cast
 
 from opentelemetry.trace import Span, get_current_span
 from opentelemetry.util.types import AttributeValue
@@ -11,42 +10,49 @@ from structlog.stdlib import BoundLogger, get_logger
 _logger: BoundLogger = get_logger()
 
 
-class ExceptionParameters(TypedDict):
-    """Parameters for the exception."""
-
-    message: NotRequired[str]
-    level: NotRequired[int]
-
-
 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: Unpack[ExceptionParameters],
+        **kwargs: Any,
     ) -> None:
         """Instantiate the exception.
 
         Args:
             *args: The arguments.
-            message: The message.
-            level: The logging level.
             **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 = kwargs.pop("message", None)
-        self.level: int = kwargs.pop("level", logging.ERROR)
+        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()
@@ -55,8 +61,10 @@ class FastAPIFactoryUtilitiesError(Exception):
             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, Sequence)):
+                    if not isinstance(value, (str, bool, int, float)):
                         attribute_value = str(value)
                     else:
                         attribute_value = value

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

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

@@ -0,0 +1,25 @@
+"""Aiopika Plugin Module."""
+
+from .configs import AiopikaConfig
+from .depends import depends_aiopika_robust_connection
+from .exceptions import AiopikaPluginBaseError, AiopikaPluginConfigError
+from .exchange import Exchange
+from .listener import AbstractListener
+from .message import AbstractMessage, SenderModel
+from .plugins import AiopikaPlugin
+from .publisher import AbstractPublisher
+from .queue import Queue
+
+__all__: list[str] = [
+    "AbstractListener",
+    "AbstractMessage",
+    "AbstractPublisher",
+    "AiopikaConfig",
+    "AiopikaPlugin",
+    "AiopikaPluginBaseError",
+    "AiopikaPluginConfigError",
+    "Exchange",
+    "Queue",
+    "SenderModel",
+    "depends_aiopika_robust_connection",
+]

fastapi_factory_utilities-0.8.3/src/fastapi_factory_utilities/core/plugins/aiopika/abstract.py

@@ -0,0 +1,48 @@
+"""Provides the abstract class for the Aiopika plugin."""
+
+from abc import ABC
+from typing import Self
+
+from aio_pika.abc import AbstractChannel, AbstractRobustConnection
+
+from .exceptions import AiopikaPluginBaseError, AiopikaPluginConnectionNotProvidedError
+
+
+class AbstractAiopikaResource(ABC):
+    """Abstract class for the Aiopika resource."""
+
+    def __init__(self) -> None:
+        """Initialize the Aiopika resource."""
+        self._robust_connection: AbstractRobustConnection | None = None
+        self._channel: AbstractChannel | None = None
+
+    def set_robust_connection(self, robust_connection: AbstractRobustConnection) -> Self:
+        """Set the robust connection."""
+        self._robust_connection = robust_connection
+        return self
+
+    def set_channel(self, channel: AbstractChannel) -> Self:
+        """Set the channel."""
+        self._channel = channel
+        return self
+
+    async def _acquire_channel(self) -> AbstractChannel:
+        """Acquire the channel."""
+        if self._robust_connection is None:
+            raise AiopikaPluginConnectionNotProvidedError(
+                message="Robust connection not provided.",
+            )
+        if self._channel is None:
+            try:
+                self._channel = await self._robust_connection.channel()
+            except Exception as exception:
+                raise AiopikaPluginBaseError(
+                    message="Failed to acquire the channel.",
+                ) from exception
+        return self._channel
+
+    async def setup(self) -> Self:
+        """Setup the Aiopika resource."""
+        if self._channel is None:
+            await self._acquire_channel()
+        return self

fastapi_factory_utilities-0.8.3/src/fastapi_factory_utilities/core/plugins/aiopika/configs.py

@@ -0,0 +1,85 @@
+"""Provides the configuration for the Aiopika plugin."""
+
+from typing import Annotated, Any, ClassVar
+
+from pydantic import BaseModel, ConfigDict, Field, UrlConstraints
+from pydantic_core import Url, ValidationError
+
+from fastapi_factory_utilities.core.utils.importlib import get_path_file_in_package
+from fastapi_factory_utilities.core.utils.yaml_reader import (
+    UnableToReadYamlFileError,
+    YamlFileReader,
+)
+
+from .exceptions import AiopikaPluginConfigError
+
+
+class AiopikaConfig(BaseModel):
+    """Provides the configuration model for the Aiopika plugin.
+
+    https://docs.aio-pika.com/#aio-pika-connect-robust-function-and-aio-pika-robustconnection-class-specific
+
+    Possible query parameters for the AMQP URL:
+        name (str url encoded) - A string that will be visible in the RabbitMQ management console
+        and in the server logs, convenient for diagnostics.
+        cafile (str) - Path to Certificate Authority file
+        capath (str) - Path to Certificate Authority directory
+        cadata (str url encoded) - URL encoded CA certificate content
+        keyfile (str) - Path to client ssl private key file
+        certfile (str) - Path to client ssl certificate file
+        no_verify_ssl - No verify server SSL certificates. 0 by default and means False other value means True.
+        heartbeat (int-like) - interval in seconds between AMQP heartbeat packets. 0 disables this feature.
+        reconnect_interval (float-like) - is the period in seconds, not more often than the attempts
+        to re-establish the connection will take place.
+        fail_fast (true/yes/y/enable/on/enabled/1 means True, otherwise False) - special behavior
+        for the start connection attempt, if it fails, all other attempts stops
+        and an exception will be thrown at the connection stage. Enabled by default, if you are sure you need
+        to disable this feature, be ensures for the passed URL is really working.
+        Otherwise, your program will go into endless reconnection attempts that can not be successed.
+
+    """
+
+    model_config: ClassVar[ConfigDict] = ConfigDict(frozen=True, extra="forbid")
+
+    amqp_url: Annotated[Url, UrlConstraints(allowed_schemes=["amqp", "amqps"])] = Field(description="The AMQP URL.")
+
+
+def build_config_from_package(package_name: str) -> AiopikaConfig:
+    """Build the configuration from the package.
+
+    Args:
+        package_name (str): The package name.
+
+    Returns:
+        AiopikaConfig: The Aiopika configuration.
+
+    Raises:
+        AiopikaPluginConfigError: If the configuration cannot be read or created or the configuration is invalid.
+    """
+    try:
+        yaml_file_content: dict[str, Any] = YamlFileReader(
+            file_path=get_path_file_in_package(
+                filename="application.yaml",
+                package=package_name,
+            ),
+            yaml_base_key="aiopika",
+            use_environment_injection=True,
+        ).read()
+    except (FileNotFoundError, ImportError, UnableToReadYamlFileError) as exception:
+        raise AiopikaPluginConfigError(
+            message="Unable to read the application configuration file for the Aiopika plugin in the package.",
+            package_name=package_name,
+        ) from exception
+
+    # Create the application configuration model
+    config: AiopikaConfig
+    try:
+        config = AiopikaConfig(**yaml_file_content)
+    except ValidationError as exception:
+        raise AiopikaPluginConfigError(
+            message="Unable to create the application configuration model for the Aiopika plugin in the package.",
+            package_name=package_name,
+            validation_errors=exception.errors(),
+        ) from exception
+
+    return config