fastapi-factory-utilities 0.4.1__py3-none-any.whl → 0.4.2__py3-none-any.whl

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/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/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/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/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/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/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/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/core/utils/status.py

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

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/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/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/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.dist-info → fastapi_factory_utilities-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_factory_utilities
-Version: 0.4.1
+Version: 0.4.2
 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.4.1.dist-info → fastapi_factory_utilities-0.4.2.dist-info}/RECORD

@@ -1,32 +1,33 @@
 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/__init__.py,sha256=fAwgRcRry1nIyAL7CsCbpwR87n5tWnBWKEPH6QZCpp8,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=IHHkcu3t-fX8vxQk12A36cE-yTjGn_PInDpL_OlRSE8,596
+fastapi_factory_utilities/core/app/__init__.py,sha256=6Ee_zK-KzJWoOElsAnGdBz8giRJlhAPMaEzs0I3gvrA,596
 fastapi_factory_utilities/core/app/application.py,sha256=WrDXh00r_jzQTtZGeFO43lIzvDraplitejTaSJj_uFE,5091
 fastapi_factory_utilities/core/app/builder.py,sha256=XKtJuRxvaqzNdhfNXGkyyxEH4MkZCgAUjkqYnOws8n0,4728
 fastapi_factory_utilities/core/app/config.py,sha256=MuV4G_M4QgZWYHoulusJLv_m4Qr2php-Cg9Jum4qkNA,7303
 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=KoywPbWu9wY5s1KpBAwxgqH07PYT3Y6Mtlq-PP4__5I,2852
-fastapi_factory_utilities/core/app/plugin_manager/__init__.py,sha256=eMfxCsk41Caw_juAawmDZHhytNI_ubXmqfRDug2AzvQ,319
+fastapi_factory_utilities/core/app/plugin_manager/__init__.py,sha256=hHk_fet3d41I-MzohGlvbNjqWQtAbxWaaEfbt41Zweo,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=b6wDStsjAdCKExFFNCFEmeMERNsVCeIp1qseKfn5TO4,6681
 fastapi_factory_utilities/core/exceptions.py,sha256=HAd0RDJNBVc1NOcwfHQo_Xya8SCYuD9edynx3VKMYVs,1784
 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=L6iZW7beZLpvXbcXoTjP6iALEwWWymworb6Mok72s2w,5741
-fastapi_factory_utilities/core/plugins/odm_plugin/builder.py,sha256=Wf9Geo2ayCX9no8ENJcsfLRo-zrAuZFfUJkvnb01PRk,8759
+fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py,sha256=EyjshkhEseri659k7YISJEVH0-cpSlAWaKvhnCPNNbY,5797
+fastapi_factory_utilities/core/plugins/odm_plugin/builder.py,sha256=D6UUDOJYv6IWugilodi6x9fwj_kZkqzPfKT_pL9UW7c,8753
 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=BFQYHxHBmTacJRfhZi2OffvT_RAFvAAiDVQAa_d6Y7w,1141
 fastapi_factory_utilities/core/plugins/odm_plugin/exceptions.py,sha256=acnKJB0lGAzDs-7-LjBap8shjP3iV1a7dw7ouPVF27o,551
+fastapi_factory_utilities/core/plugins/odm_plugin/helpers.py,sha256=s9iEujDZbTmTb9FByJAVUzLkjQpsciQT9dytkeosKuE,463
 fastapi_factory_utilities/core/plugins/odm_plugin/repositories.py,sha256=GJ3ovlxzTpiJ2_XlgARtwn6j0SbQxxAray_r8QWvGok,11313
-fastapi_factory_utilities/core/plugins/opentelemetry_plugin/__init__.py,sha256=4mq4a6U_nRxe3VxpHnC0FhRh0hpKO8l6QSUE7AazeBw,4689
+fastapi_factory_utilities/core/plugins/opentelemetry_plugin/__init__.py,sha256=gXM-apuR1xdjVxfOzurF-db3SauKyeWjK_7SFWkVWxw,4689
 fastapi_factory_utilities/core/plugins/opentelemetry_plugin/builder.py,sha256=9npQImifYAbEg0lFG7KwZ8V78SNrPoaINgd8vKitdMw,12509
 fastapi_factory_utilities/core/plugins/opentelemetry_plugin/configs.py,sha256=pMG9leMB7rtdkdGFLIxXflV7bf9epGrrYPt2N97KZcM,3750
 fastapi_factory_utilities/core/plugins/opentelemetry_plugin/exceptions.py,sha256=CpsHayfQpP0zghN8y5PP6TBy-cXhHoNxBR--I86gAdE,327
@@ -43,7 +44,7 @@ fastapi_factory_utilities/core/services/kratos/enums.py,sha256=ULJppowlZbOjdnUIX
 fastapi_factory_utilities/core/services/kratos/exceptions.py,sha256=xAX01-lQvPpADgcwhB5YWSy1UqAxG38s2rlU9AJBJd8,472
 fastapi_factory_utilities/core/services/kratos/objects.py,sha256=a0npt4Q6d9UbF0w3e6EvyKLwMWO2l639_dFjruA8_2c,980
 fastapi_factory_utilities/core/services/kratos/services.py,sha256=RFKrME6M6omWiHORMBCSyvIG0BsimQaCfnmtsOdFfsg,3158
-fastapi_factory_utilities/core/services/status/__init__.py,sha256=N5H0cCN9ZFu_0YZar4RLdCDEjKMICrIhNtfKgB0LI78,370
+fastapi_factory_utilities/core/services/status/__init__.py,sha256=kkR2Xx-kbHb_QXkkBSUNIK5y_eNM4YCElFftBAooIY0,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
@@ -53,30 +54,30 @@ fastapi_factory_utilities/core/services/status/types.py,sha256=GJOGRra6NtpUS4q1c
 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=kOUX96D0IeOO8YOk2QTDF1_5rH69_93BSmxerjmrhwk,1934
+fastapi_factory_utilities/core/utils/status.py,sha256=ADdi4NzkJy0qNVC86tKV09wdpuPhuCKSrvYn9tzNVn8,1934
 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/core/utils/yaml_reader.py,sha256=2XenSHqymZsgff70upPZtyx0-BsiUdTENKmrxaOBLeE,6100
 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/app.py,sha256=SkQwK2Z29I0Kz36wiWyoh2V_CvBexQ5LJ3Ka-npCQUI,1579
 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/__init__.py,sha256=cpTMhLpenb359lOT9HHUv6DzKX8fKl4WCzcsB3ddk6Q,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/__init__.py,sha256=IPS3rLLnZncV-VAxgsipxUD7l4r04ewo_Hx2Naj2lT0,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/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_factory_utilities-0.4.1.dist-info/LICENSE,sha256=iO1nLzMMst6vEiqgSUrfrbetM7b0bvdzXhbed5tqG8o,1074
-fastapi_factory_utilities-0.4.1.dist-info/METADATA,sha256=mFUKdMVor7-1TzUxjzALV4JW6MWFUJy9zEo3KdiJlQw,3478
-fastapi_factory_utilities-0.4.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-fastapi_factory_utilities-0.4.1.dist-info/entry_points.txt,sha256=IK0VcBexXo4uXQmTrbfhhnnfq4GmXPRn0GBB8hzlsq4,101
-fastapi_factory_utilities-0.4.1.dist-info/RECORD,,
+fastapi_factory_utilities-0.4.2.dist-info/LICENSE,sha256=iO1nLzMMst6vEiqgSUrfrbetM7b0bvdzXhbed5tqG8o,1074
+fastapi_factory_utilities-0.4.2.dist-info/METADATA,sha256=TQga1orWq9y3GXz54xm-7WkZRX-8gAl-iWJ3g7XE3lM,3478
+fastapi_factory_utilities-0.4.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+fastapi_factory_utilities-0.4.2.dist-info/entry_points.txt,sha256=IK0VcBexXo4uXQmTrbfhhnnfq4GmXPRn0GBB8hzlsq4,101
+fastapi_factory_utilities-0.4.2.dist-info/RECORD,,