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

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

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fastapi_factory_utilities
-Version: 0.4.1
+Version: 0.5.0
 Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
 License: MIT
+License-File: LICENSE
 Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices
 Author: miragecentury
 Author-email: victorien.vanroye@gmail.com

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/pyproject.toml

@@ -3,7 +3,7 @@ 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.4.1"
+version = "0.5.0"
 description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
 authors = ["miragecentury <victorien.vanroye@gmail.com>"]
 maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]
@@ -88,6 +88,7 @@ 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",
 ]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"

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

@@ -0,0 +1,79 @@
+"""FastAPI Factory Utilities exceptions."""
+
+import logging
+from collections.abc import Sequence
+from typing import NotRequired, TypedDict, Unpack
+
+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 ExceptionParameters(TypedDict):
+    """Parameters for the exception."""
+
+    message: NotRequired[str]
+    level: NotRequired[int]
+
+
+class FastAPIFactoryUtilitiesError(Exception):
+    """Base exception for the FastAPI Factory Utilities."""
+
+    def __init__(
+        self,
+        *args: object,
+        **kwargs: Unpack[ExceptionParameters],
+    ) -> None:
+        """Instantiate the exception.
+
+        Args:
+            *args: The arguments.
+            message: The message.
+            level: The logging level.
+            **kwargs: The keyword arguments.
+
+        """
+        # 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)
+
+        # 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]
+
+        # Log the Exception
+        if self.message:
+            _logger.log(level=self.level, event=self.message)
+
+        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():
+                    attribute_value: AttributeValue
+                    if not isinstance(value, (str, bool, int, float, Sequence)):
+                        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.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py

@@ -25,6 +25,7 @@ from .builder import ODMBuilder
 from .depends import depends_odm_client, depends_odm_database
 from .documents import BaseDocument
 from .exceptions import OperationError, UnableToCreateEntityDueToDuplicateKeyError
+from .helpers import PersistedEntity
 from .repositories import AbstractRepository
 
 _logger: BoundLogger = get_logger()
@@ -94,7 +95,7 @@ async def on_startup(
 
     if odm_factory.odm_database is None or odm_factory.odm_client is None:
         _logger.error(
-            f"ODM plugin failed to start. Database: {odm_factory.odm_database} - " f"Client: {odm_factory.odm_client}"
+            f"ODM plugin failed to start. Database: {odm_factory.odm_database} - Client: {odm_factory.odm_client}"
         )
         # TODO: Report the error to the status_service
         # this will report the application as unhealthy
@@ -160,9 +161,10 @@ async def on_shutdown(application: ApplicationAbstractProtocol) -> None:
 
 
 __all__: list[str] = [
-    "BaseDocument",
     "AbstractRepository",
+    "BaseDocument",
     "OperationError",
+    "PersistedEntity",
     "UnableToCreateEntityDueToDuplicateKeyError",
     "depends_odm_client",
     "depends_odm_database",

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/plugins/odm_plugin/builder.py

@@ -215,7 +215,7 @@ class ODMBuilder:
 
         if self._odm_client is None:
             raise ODMPluginConfigError(
-                "ODM client is not set. Provide the ODM client using " "build_client method or through parameter."
+                "ODM client is not set. Provide the ODM client using build_client method or through parameter."
             )
 
         self._odm_database = self._odm_client.get_database(
@@ -250,7 +250,7 @@ class ODMBuilder:
         """
         if self._odm_client is None:
             raise ODMPluginConfigError(
-                "ODM client is not set. Provide the ODM client using " "build_client method or through parameter."
+                "ODM client is not set. Provide the ODM client using build_client method or through parameter."
             )
 
         try:

fastapi_factory_utilities-0.5.0/src/fastapi_factory_utilities/core/plugins/odm_plugin/helpers.py

@@ -0,0 +1,16 @@
+"""Helper functions for ODM plugins."""
+
+import datetime
+import uuid
+
+from pydantic import BaseModel, Field
+
+
+class PersistedEntity(BaseModel):
+    """Base class for persisted entities."""
+
+    id: uuid.UUID = Field(default_factory=uuid.uuid4)
+
+    revision_id: uuid.UUID | None = Field(default=None)
+    created_at: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    updated_at: datetime.datetime = Field(default_factory=datetime.datetime.now)

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/utils/yaml_reader.py

@@ -72,7 +72,7 @@ class YamlFileReader:
                 try:
                     yaml_data = yaml_data[key]
                 except KeyError:
-                    logger.warning(f"Base key {key}" " not found in YAML file" + " from {self._yaml_base_key}")
+                    logger.warning(f"Base key {key} not found in YAML file" + " from {self._yaml_base_key}")
                     return dict()
         return yaml_data
 

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/example/app.py

@@ -31,7 +31,8 @@ class App(ApplicationAbstract):
     def configure(self) -> None:
         """Configure the application."""
         # Prevent circular import
-        from .api import api_router  # pylint: disable=import-outside-toplevel
+        # pylint: disable=import-outside-toplevel
+        from .api import api_router  # noqa: PLC0415
 
         self.get_asgi_app().include_router(router=api_router)
 

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/example/entities/books/__init__.py

@@ -4,4 +4,4 @@ from .entities import BookEntity
 from .enums import BookType
 from .types import BookName
 
-__all__: list[str] = ["BookEntity", "BookType", "BookName"]
+__all__: list[str] = ["BookEntity", "BookName", "BookType"]

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/example/models/books/__init__.py

@@ -3,4 +3,4 @@
 from .document import BookDocument
 from .repository import BookRepository
 
-__all__: list[str] = ["BookRepository", "BookDocument"]
+__all__: list[str] = ["BookDocument", "BookRepository"]

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

@@ -1,52 +0,0 @@
-"""FastAPI Factory Utilities exceptions."""
-
-import logging
-from collections.abc import Sequence
-from typing import Any
-
-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."""
-
-    def __init__(
-        self,
-        *args: tuple[Any],
-        message: str | None = None,
-        level: int = logging.ERROR,
-        **kwargs: dict[str, Any],
-    ) -> None:
-        """Instanciate the exception.
-
-        Args:
-            *args (Tuple[Any]): The arguments.
-            message (str | None): The message.
-            level (int): The logging level.
-            **kwargs (dict[str, Any]): The keyword arguments
-        """
-        # Log the Exception
-        if message:
-            _logger.log(level=level, event=message)
-            self.message = message
-            self.level = level
-            args = (message, *args)  # type: ignore
-        # Propagate the exception
-        span: Span = get_current_span()
-        # If not otel is setup, INVALID_SPAN is retrive 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():
-                attribute_value: AttributeValue
-                if not isinstance(value, (str, bool, int, float, Sequence)):
-                    attribute_value = str(value)
-                else:
-                    attribute_value = value
-                span.set_attribute(key, attribute_value)
-        # Call the parent class
-        super().__init__(*args)

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/app/__init__.py

@@ -12,12 +12,12 @@ from .config import (
 from .enums import EnvironmentEnum
 
 __all__: list[str] = [
-    "BaseApplicationConfig",
-    "EnvironmentEnum",
     "ApplicationAbstract",
     "ApplicationGenericBuilder",
-    "RootConfig",
-    "HttpServiceDependencyConfig",
+    "BaseApplicationConfig",
     "DependencyConfig",
+    "EnvironmentEnum",
+    "HttpServiceDependencyConfig",
+    "RootConfig",
     "depends_dependency_config",
 ]

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/app/plugin_manager/__init__.py

@@ -8,8 +8,8 @@ from .exceptions import (
 from .plugin_manager import PluginManager
 
 __all__: list[str] = [
+    "InvalidPluginError",
     "PluginManager",
     "PluginManagerError",
-    "InvalidPluginError",
     "PluginPreConditionNotMetError",
 ]

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/plugins/opentelemetry_plugin/__init__.py

@@ -20,8 +20,8 @@ from .exceptions import OpenTelemetryPluginBaseException, OpenTelemetryPluginCon
 __all__: list[str] = [
     "OpenTelemetryConfig",
     "OpenTelemetryPluginBaseException",
-    "OpenTelemetryPluginConfigError",
     "OpenTelemetryPluginBuilder",
+    "OpenTelemetryPluginConfigError",
 ]
 
 _logger: BoundLogger = get_logger()

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/services/status/__init__.py

@@ -5,10 +5,10 @@ from .services import StatusService
 from .types import ComponentInstanceType, Status
 
 __all__: list[str] = [
-    "ComponentTypeEnum",
     "ComponentInstanceType",
+    "ComponentTypeEnum",
     "HealthStatusEnum",
     "ReadinessStatusEnum",
-    "StatusService",
     "Status",
+    "StatusService",
 ]

{fastapi_factory_utilities-0.4.1 → fastapi_factory_utilities-0.5.0}/src/fastapi_factory_utilities/core/utils/status.py

@@ -64,9 +64,9 @@ class MonitoredAbstract(ABC):
 
 
 __all__: list[str] = [
-    "MonitoredAbstract",
     "ComponentInstanceType",
     "ComponentTypeEnum",
+    "MonitoredAbstract",
     "Status",
     "StatusService",
 ]