qena-shared-lib 0.1.12__tar.gz → 0.1.14__tar.gz

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/.pre-commit-config.yaml

@@ -17,3 +17,11 @@ repos:
     rev: v1.15.0
     hooks:
     -   id: mypy
+- repo: local
+  hooks:
+    - id: pytest
+      name: pytest
+      entry: bash -c 'PYTHONPATH=$(pwd) pytest tests'
+      language: system
+      types: [python]
+      pass_filenames: false

qena_shared_lib-0.1.14/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## [0.1.14] - 2025-06-16
+
+### Changed
+
+- Remove unused generics variables
+- Remove requirements.txt
+
+
+## [0.1.13] - 2025-06-16
+
+### Added
+
+- Added pytest as one of pre-commit steps.
+- Made http and rabbitmq exception handlers class based.
+- Gracefull shutdown for rabbitmq and scheduler.
+
+### Changed
+
+- Moved logstash to remotelogging to generalize other forms of logging.
+- Added loop class attribute for async event loop mixin.
+- Made mypy type check slightly more strict.
+
+
+## [0.1.12] - 2025-04-05
+
+### Added
+
+- Added a re-export for rabbitmq channel pool (ChannelPool) class.
+
+
+[0.1.14]: https://github.com/Qena-Digital-Lending/qena-shared-kernel/compare/v0.1.13...v0.1.14
+[0.1.13]: https://github.com/Qena-Digital-Lending/qena-shared-kernel/compare/v0.1.12...v0.1.13
+[0.1.12]: https://github.com/Qena-Digital-Lending/qena-shared-kernel/compare/v0.1.11...v0.1.12

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qena-shared-lib
-Version: 0.1.12
+Version: 0.1.14
 Summary: A shared tools for other services
 Requires-Python: >=3.10
 Requires-Dist: cronsim==2.6
@@ -21,7 +21,8 @@ A shared tools for other services. It includes.
 - FastAPI app builder
 - A wrapper around fastapi to make it class based.
 - RabbitMQ utility class to listen, respond, publish and make rpc request.
-- Logstash utility class to log message in `ecs` ( elastic common schema ).
+- Remote logging
+    - Logstash utility class to log message in `ecs` ( elastic common schema ).
 - A simple task scheduler, to schedule task to run in specific time.
 - Background task runner.
 - Security tools ( password hasher, jwt, acl ).
@@ -178,41 +179,43 @@ def main() -> FastAPI:
     ...
 ```
 
-## Logstash
+## Remote logging
 
+### Logstash
 ``` py
-from qena_shared_lib.logstash import BaseLogstashSender, HTTPSender, # TCPSender
+from qena_shared_lib.remotelogging import BaseRemoteLogSender
+from qena_shared_lib.remotelogging.logstash import HTTPSender, # TCPSender
 
 
 @asynccontextmanager
 async def lifespan(app: FastAPI):
-    logstash = get_service(BaseLogstashSender)
+    remote_logger = get_service(BaseRemoteLogSender)
 
-    await logstash.start()
+    await remote_logger.start()
 
     yield
 
-    await logstash.stop()
+    await remote_logger.stop()
 
 
 def main() -> FastAPI:
     ...
 
-    logstash = HTTPSender(
+    remote_logger = HTTPSender(
         service_name="qena-shared-lib",
         url="http://127.0.0.1:18080",
         user="logstash",
         password="logstash",
     )
     # or
-    # logstash = TCPSender(
+    # remote_logger = TCPSender(
     #   service_name="qena-shared-lib",
     #   host="127.0.0.1",
     #   port=18090
     # )
     builder.with_singleton(
-        service=BaseLogstashSender,
-        instance=logstash,
+        service=BaseRemoteLogSender,
+        instance=remote_logger,
     )
 
     ...
@@ -220,13 +223,13 @@ def main() -> FastAPI:
 
 @router.get("")
 def log_message(
-    logstash: Annotated[
-        BaseLogstashSender,
-        DependsOn(BaseLogstashSender),
+    remote_logger: Annotated[
+        BaseRemoteLogSender,
+        DependsOn(BaseRemoteLogSender),
     ],
     message: str,
 ):
-    logstash.info(message)
+    remote_logger.info(message)
 ```
 
 ## Rabbitmq
@@ -263,7 +266,7 @@ def main() -> FastAPI:
     ...
 
     rabbitmq = RabbitMqManager(
-        logstash=logstash,
+        remote_logger=remote_logger,
         container=builder.container,
     )
 
@@ -402,7 +405,7 @@ def main() -> FastAPI:
     ...
 
     rabbitmq = RabbitMqManager(
-        logstash=logstash,
+        remote_logger=remote_logger,
         container=builder.container,
         # or globally for all consumers
         listener_global_retry_policy=RetryPolicy(
@@ -473,7 +476,7 @@ def main() -> FastAPI:
     ...
 
     schedule_manager = ScheduleManager(
-        logstash=logstash,
+        remote_logger=remote_logger,
         container=builder.container
     )
 
@@ -507,8 +510,8 @@ def main() -> FastAPI:
     ...
 
     builder.with_singleton(
-        service=BaseLogstashSender,
-        instance=logstash,
+        service=BaseRemoteLogSender,
+        instance=remote_logger,
     )
     builder.with_singleton(Background)
 

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/README.md

@@ -5,7 +5,8 @@ A shared tools for other services. It includes.
 - FastAPI app builder
 - A wrapper around fastapi to make it class based.
 - RabbitMQ utility class to listen, respond, publish and make rpc request.
-- Logstash utility class to log message in `ecs` ( elastic common schema ).
+- Remote logging
+    - Logstash utility class to log message in `ecs` ( elastic common schema ).
 - A simple task scheduler, to schedule task to run in specific time.
 - Background task runner.
 - Security tools ( password hasher, jwt, acl ).
@@ -162,41 +163,43 @@ def main() -> FastAPI:
     ...
 ```
 
-## Logstash
+## Remote logging
 
+### Logstash
 ``` py
-from qena_shared_lib.logstash import BaseLogstashSender, HTTPSender, # TCPSender
+from qena_shared_lib.remotelogging import BaseRemoteLogSender
+from qena_shared_lib.remotelogging.logstash import HTTPSender, # TCPSender
 
 
 @asynccontextmanager
 async def lifespan(app: FastAPI):
-    logstash = get_service(BaseLogstashSender)
+    remote_logger = get_service(BaseRemoteLogSender)
 
-    await logstash.start()
+    await remote_logger.start()
 
     yield
 
-    await logstash.stop()
+    await remote_logger.stop()
 
 
 def main() -> FastAPI:
     ...
 
-    logstash = HTTPSender(
+    remote_logger = HTTPSender(
         service_name="qena-shared-lib",
         url="http://127.0.0.1:18080",
         user="logstash",
         password="logstash",
     )
     # or
-    # logstash = TCPSender(
+    # remote_logger = TCPSender(
     #   service_name="qena-shared-lib",
     #   host="127.0.0.1",
     #   port=18090
     # )
     builder.with_singleton(
-        service=BaseLogstashSender,
-        instance=logstash,
+        service=BaseRemoteLogSender,
+        instance=remote_logger,
     )
 
     ...
@@ -204,13 +207,13 @@ def main() -> FastAPI:
 
 @router.get("")
 def log_message(
-    logstash: Annotated[
-        BaseLogstashSender,
-        DependsOn(BaseLogstashSender),
+    remote_logger: Annotated[
+        BaseRemoteLogSender,
+        DependsOn(BaseRemoteLogSender),
     ],
     message: str,
 ):
-    logstash.info(message)
+    remote_logger.info(message)
 ```
 
 ## Rabbitmq
@@ -247,7 +250,7 @@ def main() -> FastAPI:
     ...
 
     rabbitmq = RabbitMqManager(
-        logstash=logstash,
+        remote_logger=remote_logger,
         container=builder.container,
     )
 
@@ -386,7 +389,7 @@ def main() -> FastAPI:
     ...
 
     rabbitmq = RabbitMqManager(
-        logstash=logstash,
+        remote_logger=remote_logger,
         container=builder.container,
         # or globally for all consumers
         listener_global_retry_policy=RetryPolicy(
@@ -457,7 +460,7 @@ def main() -> FastAPI:
     ...
 
     schedule_manager = ScheduleManager(
-        logstash=logstash,
+        remote_logger=remote_logger,
         container=builder.container
     )
 
@@ -491,8 +494,8 @@ def main() -> FastAPI:
     ...
 
     builder.with_singleton(
-        service=BaseLogstashSender,
-        instance=logstash,
+        service=BaseRemoteLogSender,
+        instance=remote_logger,
     )
     builder.with_singleton(Background)
 

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qena-shared-lib"
-version = "0.1.12"
+version = "0.1.14"
 description = "A shared tools for other services"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -74,13 +74,8 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.mypy]
+strict = true
 explicit_package_bases = true
-ignore_missing_imports = true
-disallow_untyped_defs = true
-disallow_incomplete_defs = true
-check_untyped_defs = true
-warn_redundant_casts = true
-warn_unreachable = true
-allow_redefinition = true
-local_partial_types = true
-strict_equality = true
+disallow_untyped_decorators = false
+disallow_subclassing_any = false
+warn_unused_ignores = false

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/src/qena_shared_lib/__init__.py

@@ -5,8 +5,8 @@ from . import (
     exceptions,
     http,
     logging,
-    logstash,
     rabbitmq,
+    remotelogging,
     scheduler,
     security,
     utils,
@@ -19,7 +19,7 @@ __all__ = [
     "exceptions",
     "http",
     "logging",
-    "logstash",
+    "remotelogging",
     "rabbitmq",
     "scheduler",
     "security",

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/src/qena_shared_lib/application.py

@@ -2,17 +2,17 @@ from enum import Enum
 from typing import Any, TypeVar
 
 from fastapi import APIRouter, FastAPI
-from fastapi.exceptions import RequestValidationError
 from prometheus_fastapi_instrumentator import Instrumentator
 from punq import Container, Scope, empty
 from starlette.types import Lifespan
+from typing_extensions import Self
 
 from .exception_handlers import (
-    handle_general_http_exception,
-    handle_http_service_error,
-    handle_request_validation_error,
+    AbstractHttpExceptionHandler,
+    GeneralHttpExceptionHandler,
+    HTTPServiceExceptionHandler,
+    RequestValidationErrorHandler,
 )
-from .exceptions import ServiceException
 from .http import ControllerBase
 
 __all__ = [
@@ -21,6 +21,7 @@ __all__ = [
     "FastAPI",
 ]
 
+
 D = TypeVar("D")
 
 
@@ -46,7 +47,7 @@ class Builder:
         self._container = Container()
         self._built = False
 
-    def with_environment(self, environment: Environment) -> "Builder":
+    def with_environment(self, environment: Environment) -> Self:
         match environment:
             case Environment.DEVELOPMENT:
                 self._environment = Environment.DEVELOPMENT
@@ -60,35 +61,33 @@ class Builder:
 
         return self
 
-    def with_title(self, title: str) -> "Builder":
+    def with_title(self, title: str) -> Self:
         self._title = title
 
         return self
 
-    def with_description(self, description: str) -> "Builder":
+    def with_description(self, description: str) -> Self:
         self._description = description
 
         return self
 
-    def with_version(self, version: str) -> "Builder":
+    def with_version(self, version: str) -> Self:
         self._version = version
 
         return self
 
-    def with_lifespan(self, lifespan: Lifespan) -> "Builder":
+    def with_lifespan(self, lifespan: Lifespan) -> Self:
         self._lifespan = lifespan
 
         return self
 
-    def with_controllers(
-        self, controllers: list[type[ControllerBase]]
-    ) -> "Builder":
+    def with_controllers(self, *controllers: type[ControllerBase]) -> Self:
         for index, controller in enumerate(controllers):
             if not isinstance(controller, type) or not issubclass(
                 controller, ControllerBase
             ):
                 raise TypeError(
-                    f"controller {index} is {type(ControllerBase)}, expected instance of type or subclass of `ControllerBase`"
+                    f"controller {index} is {type(controller)}, expected instance of type or subclass of `ControllerBase`"
                 )
 
             self._container.register(
@@ -99,7 +98,7 @@ class Builder:
 
         return self
 
-    def with_routers(self, routers: list[APIRouter]) -> "Builder":
+    def with_routers(self, *routers: APIRouter) -> Self:
         if any(not isinstance(router, APIRouter) for router in routers):
             raise TypeError("some routers are not type `APIRouter`")
 
@@ -107,13 +106,41 @@ class Builder:
 
         return self
 
+    def with_exception_handlers(
+        self, *exception_handlers: type[AbstractHttpExceptionHandler]
+    ) -> Self:
+        for index, exception_handler in enumerate(exception_handlers):
+            if not isinstance(exception_handler, type) or not issubclass(
+                exception_handler, AbstractHttpExceptionHandler
+            ):
+                raise TypeError(
+                    f"exception handler {index} is {type(exception_handler)}, expected instance of type or subclass of `AbstractHttpExceptionHandler`"
+                )
+
+            self._container.register(
+                service=AbstractHttpExceptionHandler,
+                factory=exception_handler,
+                scope=Scope.singleton,
+            )
+
+        return self
+
+    def with_default_exception_handlers(self) -> Self:
+        self.with_exception_handlers(
+            GeneralHttpExceptionHandler,
+            HTTPServiceExceptionHandler,
+            RequestValidationErrorHandler,
+        )
+
+        return self
+
     def with_singleton(
         self,
         service: type[D],
         factory: Any = empty,
         instance: Any = empty,
         **kwargs: Any,
-    ) -> "Builder":
+    ) -> Self:
         self._container.register(
             service=service,
             factory=factory,
@@ -126,7 +153,7 @@ class Builder:
 
     def with_transient(
         self, service: type[D], factory: Any = empty, **kwargs: Any
-    ) -> "Builder":
+    ) -> Self:
         self._container.register(
             service=service,
             factory=factory,
@@ -136,7 +163,7 @@ class Builder:
 
         return self
 
-    def with_metrics(self, endpoint: str = "/metrics") -> "Builder":
+    def with_metrics(self, endpoint: str = "/metrics") -> Self:
         self._metrics_endpoint = endpoint
         self._instrumentator = Instrumentator()
 
@@ -158,13 +185,8 @@ class Builder:
         )
         app.state.container = self._container
 
-        app.exception_handler(ServiceException)(handle_http_service_error)
-        app.exception_handler(RequestValidationError)(
-            handle_request_validation_error
-        )
-        app.exception_handler(Exception)(handle_general_http_exception)
-
-        self._resolve_api_controllers(app)
+        self._register_api_controllers(app)
+        self._register_exception_handlers(app)
 
         if self._instrumentator is not None:
             self._instrumentator.instrument(app).expose(
@@ -177,14 +199,34 @@ class Builder:
 
         return app
 
-    def _resolve_api_controllers(self, app: FastAPI) -> None:
-        api_controller_routers = [
+    def _register_api_controllers(self, app: FastAPI) -> None:
+        for router in self._routers + self._resolve_api_controllers():
+            app.include_router(router)
+
+    def _resolve_api_controllers(self) -> list[APIRouter]:
+        return [
             api_controller.register_route_handlers()
             for api_controller in self._container.resolve_all(ControllerBase)
         ]
 
-        for router in self._routers + api_controller_routers:
-            app.include_router(router)
+    def _register_exception_handlers(self, app: FastAPI) -> None:
+        for exception_handler in self._resolve_exception_handlers():
+            if not callable(exception_handler):
+                raise ValueError(
+                    f"exception handler {exception_handler.__class__.__name__} is not callable"
+                )
+
+            app.exception_handler(exception_handler.exception)(
+                exception_handler
+            )
+
+    def _resolve_exception_handlers(self) -> list[AbstractHttpExceptionHandler]:
+        return [
+            exception_handler
+            for exception_handler in self._container.resolve_all(
+                AbstractHttpExceptionHandler
+            )
+        ]
 
     @property
     def environment(self) -> Environment:

{qena_shared_lib-0.1.12 → qena_shared_lib-0.1.14}/src/qena_shared_lib/background.py

@@ -3,13 +3,14 @@ from asyncio import (
     Task,
     gather,
 )
+from typing import Any
 from uuid import uuid4
 
 from prometheus_client import Enum as PrometheusEnum
 from starlette.background import BackgroundTask
 
 from .logging import LoggerProvider
-from .logstash import BaseLogstashSender
+from .remotelogging import BaseRemoteLogSender
 from .utils import AsyncEventLoopMixin
 
 __all__ = [
@@ -27,14 +28,14 @@ class Background(AsyncEventLoopMixin):
 
     def __init__(
         self,
-        logstash: BaseLogstashSender,
+        remote_logger: BaseRemoteLogSender,
     ) -> None:
         self._queue: Queue[tuple[BackgroundTask | None, str | None]] = Queue()
         self._started = False
         self._stopped = False
-        self._logstash = logstash
+        self._remote_logger = remote_logger
         self._logger = LoggerProvider.default().get_logger("backgroud")
-        self._tasks: dict[str, Task] = {}
+        self._tasks: dict[str, Task[Any]] = {}
 
     async def _task_manager(
         self, task: BackgroundTask, task_id: str | None = None
@@ -53,7 +54,7 @@ class Background(AsyncEventLoopMixin):
 
             await self._tasks[task_id]
         except Exception:
-            self._logstash.error(
+            self._remote_logger.error(
                 "exception occured when running background task {task.func.__name__} with id {task_id}"
             )
         finally: