qena-shared-lib 0.1.8__tar.gz → 0.1.9__tar.gz

{qena_shared_lib-0.1.8 → qena_shared_lib-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qena-shared-lib
-Version: 0.1.8
+Version: 0.1.9
 Summary: A shared tools for other services
 Requires-Python: >=3.10
 Requires-Dist: cronsim==2.6
@@ -40,6 +40,9 @@ A shared tools for other services. It includes.
 To create fastapi app.
 
 ``` py
+from qena_shared_lib.application import Builder, Environment
+
+
 def main() -> FastAPI:
     builder = (
         Builder()
@@ -63,6 +66,11 @@ $ uvicorn --factory main:main
 ### Lifespan
 
 ``` py
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
 @asynccontextmanager
 def lifespan(app: FastAPI):
     ...
@@ -83,6 +91,16 @@ def main() -> FastAPI:
 ### Dependencies
 
 ``` py
+class EmailService:
+    def __init__(self):
+        ...
+
+
+class Database:
+    def __init__(self):
+        ...
+
+
 def main() -> FastAPI:
     ...
 
@@ -95,7 +113,10 @@ def main() -> FastAPI:
 ### Controllers
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.http import ControllerBase, api_controller, post
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     def __init__(self, email_service: EmailService):
@@ -112,11 +133,18 @@ def main() -> FastAPI:
     builder.with_controllers([
         UserController
     ])
+
+    ...
 ```
 
 ### Routers
 
 ``` py
+from fastapi import APIRouter
+
+from qena_shared_lib.dependencies.http import DependsOn
+
+
 router = APIRouter(prefix="/auth")
 
 
@@ -153,6 +181,9 @@ def main() -> FastAPI:
 ## Logstash
 
 ``` py
+from qena_shared_lib.logstash import BaseLogstashSender, HTTPSender, # TCPSender
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     logstash = get_service(BaseLogstashSender)
@@ -203,6 +234,9 @@ def log_message(
 To create rabbitmq connection manager.
 
 ``` py
+from qena_shared_lib.rabbitmq import ListenerBase, consume, consumer
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     rabbitmq = get_service(RabbitMqManager)
@@ -214,7 +248,7 @@ async def lifespan(app: FastAPI):
     rabbitmq.disconnect()
 
 
-@Consumer("UserQueue")
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     def __init__(self, db: Database):
@@ -249,7 +283,7 @@ def main() -> FastAPI:
 async def store_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user: User,
 )
@@ -266,7 +300,7 @@ async def store_user(
 async def get_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user_id: str,
 )
@@ -281,7 +315,10 @@ async def get_user(
 ### Flow control
 
 ``` py
-@Consumer("UserQueue")
+from qena_shared_lib.rabbitmq import ... , ListenerContext
+
+
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     @consume()
@@ -299,7 +336,10 @@ class UserConsumer(ListenerBase):
 Optionally it is possible to reply to rpc calls, through.
 
 ``` py
-@RpcWorker("UserQueue")
+from qena_shared_lib.rabbitmq import ... , rpc_worker
+
+
+@rpc_worker("UserQueue")
 class UserWorker(ListenerBase):
 
     @execute()
@@ -311,10 +351,92 @@ class UserWorker(ListenerBase):
         ...
 ```
 
+### Retry consumer
+
+Consumer can retry to consumer a message in an event of failure.
+
+``` py
+from qena_shared_lib.rabbitmq import (
+    BackoffRetryDelay,
+    FixedRetryDelay,
+    RabbitMqManager,
+    RetryDelayJitter,
+    RetryPolicy,
+)
+
+
+@consumer(
+    queue="UserQueue",
+    # can be defined for consumer of specific queue
+    retry_policy=RetryPolicy(
+        exceptions=(AMQPError,),
+        max_retry=5,
+        retry_delay_strategy=FixedRetryDelay(
+            retry_delay=2
+        ),
+        retry_delay_jitter=RetryDelayJitter(min=0.5, max=5.0),
+    )
+)
+class UserConsumer(ListenerBase):
+
+    @consume(
+        # for specific target
+        retry_policy=RetryPolicy(
+            exceptions=(AMQPError,),
+            max_retry=5,
+            retry_delay_strategy=FixedRetryDelay(
+                retry_delay=2
+            ),
+            retry_delay_jitter=RetryDelayJitter(min=0.5, max=5.0),
+        )
+    )
+    async def store_user(self, ctx: ListenerContext, user: User):
+        ...
+
+        await ctx.flow_control.request(10)
+
+        ...
+
+
+def main() -> FastAPI:
+    ...
+
+    rabbitmq = RabbitMqManager(
+        logstash=logstash,
+        container=builder.container,
+        # or globally for all consumers
+        listener_global_retry_policy=RetryPolicy(
+            exceptions=(AMQPError,),
+            max_retry=10,
+            retry_delay_strategy=BackoffRetryDelay(
+                multiplier=1.5, min=2, max=10
+            ),
+            retry_delay_jitter=RetryDelayJitter(min=0.5, max=5.0),
+            match_by_cause=True,
+        ),
+    )
+
+    rabbitmq.include_listener(UserConsumer)
+    builder.add_singleton(
+        service=RabbitMqManager,
+        instance=rabbitmq,
+    )
+```
+
+
 
 ## Scheduler
 
 ``` py
+from qena_shared_lib.scheduler import (
+    ScheduleManager,
+    # Scheduler,
+    SchedulerBase,
+    schedule,
+    scheduler,
+)
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     schedule_manager = get_service(ScheduleManager)
@@ -326,7 +448,7 @@ async def lifespan(app: FastAPI):
     schedule_manager.stop()
 
 
-@Scheduler()
+@scheduler()
 class TaskScheduler(SchedulerBase):
 
     def __init__(self, db: Database)
@@ -367,6 +489,9 @@ def main() -> FastAPI:
 ## Background
 
 ``` py
+from qena_shared_lib.background import Background
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     background = get_service(Background)
@@ -410,7 +535,10 @@ async def process_data(
 ### Password hasher
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import PasswordHasher
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     def __init__(self, password_hasher: PasswordHasher):
@@ -439,6 +567,9 @@ def main() -> FastAPI:
 ### JWT
 
 ``` py
+from qena_shared_lib.security import JwtAdapter
+
+
 @ApiController("/users")
 class UserController(ControllerBase):
 
@@ -478,7 +609,10 @@ def main() -> FastAPI:
 ### ACL
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import Authorization
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     @post()
@@ -486,7 +620,7 @@ class UserController(ControllerBase):
         self,
         user: Annotated[
             UserInfo,
-            EndpointACL(
+            Authorization(
                 user_type="ADMIN",
                 persmission=[
                     "READ"
@@ -501,7 +635,7 @@ class UserController(ControllerBase):
 async def get_users(
     user: Annotated[
         UserInfo,
-        EndpointACL("ADMIN")
+        Authorization("ADMIN")
     ]
 )
     ...

{qena_shared_lib-0.1.8 → qena_shared_lib-0.1.9}/README.md

@@ -24,6 +24,9 @@ A shared tools for other services. It includes.
 To create fastapi app.
 
 ``` py
+from qena_shared_lib.application import Builder, Environment
+
+
 def main() -> FastAPI:
     builder = (
         Builder()
@@ -47,6 +50,11 @@ $ uvicorn --factory main:main
 ### Lifespan
 
 ``` py
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
 @asynccontextmanager
 def lifespan(app: FastAPI):
     ...
@@ -67,6 +75,16 @@ def main() -> FastAPI:
 ### Dependencies
 
 ``` py
+class EmailService:
+    def __init__(self):
+        ...
+
+
+class Database:
+    def __init__(self):
+        ...
+
+
 def main() -> FastAPI:
     ...
 
@@ -79,7 +97,10 @@ def main() -> FastAPI:
 ### Controllers
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.http import ControllerBase, api_controller, post
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     def __init__(self, email_service: EmailService):
@@ -96,11 +117,18 @@ def main() -> FastAPI:
     builder.with_controllers([
         UserController
     ])
+
+    ...
 ```
 
 ### Routers
 
 ``` py
+from fastapi import APIRouter
+
+from qena_shared_lib.dependencies.http import DependsOn
+
+
 router = APIRouter(prefix="/auth")
 
 
@@ -137,6 +165,9 @@ def main() -> FastAPI:
 ## Logstash
 
 ``` py
+from qena_shared_lib.logstash import BaseLogstashSender, HTTPSender, # TCPSender
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     logstash = get_service(BaseLogstashSender)
@@ -187,6 +218,9 @@ def log_message(
 To create rabbitmq connection manager.
 
 ``` py
+from qena_shared_lib.rabbitmq import ListenerBase, consume, consumer
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     rabbitmq = get_service(RabbitMqManager)
@@ -198,7 +232,7 @@ async def lifespan(app: FastAPI):
     rabbitmq.disconnect()
 
 
-@Consumer("UserQueue")
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     def __init__(self, db: Database):
@@ -233,7 +267,7 @@ def main() -> FastAPI:
 async def store_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user: User,
 )
@@ -250,7 +284,7 @@ async def store_user(
 async def get_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user_id: str,
 )
@@ -265,7 +299,10 @@ async def get_user(
 ### Flow control
 
 ``` py
-@Consumer("UserQueue")
+from qena_shared_lib.rabbitmq import ... , ListenerContext
+
+
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     @consume()
@@ -283,7 +320,10 @@ class UserConsumer(ListenerBase):
 Optionally it is possible to reply to rpc calls, through.
 
 ``` py
-@RpcWorker("UserQueue")
+from qena_shared_lib.rabbitmq import ... , rpc_worker
+
+
+@rpc_worker("UserQueue")
 class UserWorker(ListenerBase):
 
     @execute()
@@ -295,10 +335,92 @@ class UserWorker(ListenerBase):
         ...
 ```
 
+### Retry consumer
+
+Consumer can retry to consumer a message in an event of failure.
+
+``` py
+from qena_shared_lib.rabbitmq import (
+    BackoffRetryDelay,
+    FixedRetryDelay,
+    RabbitMqManager,
+    RetryDelayJitter,
+    RetryPolicy,
+)
+
+
+@consumer(
+    queue="UserQueue",
+    # can be defined for consumer of specific queue
+    retry_policy=RetryPolicy(
+        exceptions=(AMQPError,),
+        max_retry=5,
+        retry_delay_strategy=FixedRetryDelay(
+            retry_delay=2
+        ),
+        retry_delay_jitter=RetryDelayJitter(min=0.5, max=5.0),
+    )
+)
+class UserConsumer(ListenerBase):
+
+    @consume(
+        # for specific target
+        retry_policy=RetryPolicy(
+            exceptions=(AMQPError,),
+            max_retry=5,
+            retry_delay_strategy=FixedRetryDelay(
+                retry_delay=2
+            ),
+            retry_delay_jitter=RetryDelayJitter(min=0.5, max=5.0),
+        )
+    )
+    async def store_user(self, ctx: ListenerContext, user: User):
+        ...
+
+        await ctx.flow_control.request(10)
+
+        ...
+
+
+def main() -> FastAPI:
+    ...
+
+    rabbitmq = RabbitMqManager(
+        logstash=logstash,
+        container=builder.container,
+        # or globally for all consumers
+        listener_global_retry_policy=RetryPolicy(
+            exceptions=(AMQPError,),
+            max_retry=10,
+            retry_delay_strategy=BackoffRetryDelay(
+                multiplier=1.5, min=2, max=10
+            ),
+            retry_delay_jitter=RetryDelayJitter(min=0.5, max=5.0),
+            match_by_cause=True,
+        ),
+    )
+
+    rabbitmq.include_listener(UserConsumer)
+    builder.add_singleton(
+        service=RabbitMqManager,
+        instance=rabbitmq,
+    )
+```
+
+
 
 ## Scheduler
 
 ``` py
+from qena_shared_lib.scheduler import (
+    ScheduleManager,
+    # Scheduler,
+    SchedulerBase,
+    schedule,
+    scheduler,
+)
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     schedule_manager = get_service(ScheduleManager)
@@ -310,7 +432,7 @@ async def lifespan(app: FastAPI):
     schedule_manager.stop()
 
 
-@Scheduler()
+@scheduler()
 class TaskScheduler(SchedulerBase):
 
     def __init__(self, db: Database)
@@ -351,6 +473,9 @@ def main() -> FastAPI:
 ## Background
 
 ``` py
+from qena_shared_lib.background import Background
+
+
 @asynccontextmanager
 async def lifespan(app: FastAPI):
     background = get_service(Background)
@@ -394,7 +519,10 @@ async def process_data(
 ### Password hasher
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import PasswordHasher
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     def __init__(self, password_hasher: PasswordHasher):
@@ -423,6 +551,9 @@ def main() -> FastAPI:
 ### JWT
 
 ``` py
+from qena_shared_lib.security import JwtAdapter
+
+
 @ApiController("/users")
 class UserController(ControllerBase):
 
@@ -462,7 +593,10 @@ def main() -> FastAPI:
 ### ACL
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import Authorization
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     @post()
@@ -470,7 +604,7 @@ class UserController(ControllerBase):
         self,
         user: Annotated[
             UserInfo,
-            EndpointACL(
+            Authorization(
                 user_type="ADMIN",
                 persmission=[
                     "READ"
@@ -485,7 +619,7 @@ class UserController(ControllerBase):
 async def get_users(
     user: Annotated[
         UserInfo,
-        EndpointACL("ADMIN")
+        Authorization("ADMIN")
     ]
 )
     ...

{qena_shared_lib-0.1.8 → qena_shared_lib-0.1.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qena-shared-lib"
-version = "0.1.8"
+version = "0.1.9"
 description = "A shared tools for other services"
 readme = "README.md"
 requires-python = ">=3.10"

{qena_shared_lib-0.1.8 → qena_shared_lib-0.1.9}/src/qena_shared_lib/exception_handlers.py

@@ -121,8 +121,8 @@ def handle_http_service_error(
     if exception.logstash_logging:
         logstash_logger_method(
             message=exception.message,
-            tags=exception.tags or tags,
-            extra=exception.extra or extra,
+            tags=tags,
+            extra=extra,
             exception=exception if exception.extract_exc_info else None,
         )
     else:

{qena_shared_lib-0.1.8 → qena_shared_lib-0.1.9}/src/qena_shared_lib/http.py

@@ -10,7 +10,6 @@ from fastapi.types import IncEx
 
 __all__ = [
     "api_controller",
-    "ApiController",
     "ControllerBase",
     "delete",
     "get",
@@ -63,20 +62,19 @@ class RouteHandlerMeta:
     openapi_extra: dict[str, Any] | None = None
 
 
-class ApiController:
-    def __init__(
-        self,
-        prefix: str | None = None,
-        *,
-        tags: list[str | Enum] | None = None,
-        dependencies: Sequence[Depends] | None = None,
-        default_response_class: type[Response] = JSONResponse,
-        responses: dict[int | str, dict[str, Any]] | None = None,
-        redirect_slashes: bool = True,
-        deprecated: bool | None = None,
-        include_in_schema: bool = True,
-    ):
-        self._api_router = APIRouter(
+def api_controller(
+    prefix: str | None = None,
+    *,
+    tags: list[str | Enum] | None = None,
+    dependencies: Sequence[Depends] | None = None,
+    default_response_class: type[Response] = JSONResponse,
+    responses: dict[int | str, dict[str, Any]] | None = None,
+    redirect_slashes: bool = True,
+    deprecated: bool | None = None,
+    include_in_schema: bool = True,
+) -> Callable[["ControllerBase"], "ControllerBase"]:
+    def annotate_class(api_controller_class: ControllerBase):
+        router = APIRouter(
             prefix=prefix or "",
             tags=tags,
             dependencies=dependencies,
@@ -87,33 +85,11 @@ class ApiController:
             include_in_schema=include_in_schema,
         )
 
-    def __call__(self, controller: type[AC]) -> type[AC]:
-        setattr(controller, API_CONTROLLER_ATTRIBUTE, self._api_router)
-
-        return controller
+        setattr(api_controller_class, API_CONTROLLER_ATTRIBUTE, router)
 
+        return api_controller_class
 
-def api_controller(
-    prefix: str | None = None,
-    *,
-    tags: list[str | Enum] | None = None,
-    dependencies: Sequence[Depends] | None = None,
-    default_response_class: type[Response] = JSONResponse,
-    responses: dict[int | str, dict[str, Any]] | None = None,
-    redirect_slashes: bool = True,
-    deprecated: bool | None = None,
-    include_in_schema: bool = True,
-) -> ApiController:
-    return ApiController(
-        prefix=prefix,
-        tags=tags,
-        dependencies=dependencies,
-        default_response_class=default_response_class,
-        responses=responses,
-        redirect_slashes=redirect_slashes,
-        deprecated=deprecated,
-        include_in_schema=include_in_schema,
-    )
+    return annotate_class
 
 
 def get(

{qena_shared_lib-0.1.8 → qena_shared_lib-0.1.9}/src/qena_shared_lib/rabbitmq/_exception_handlers.py

@@ -87,8 +87,8 @@ def handle_rabbit_mq_service_exception(
     if exception.logstash_logging:
         logstash_logger_method(
             message=exception.message,
-            tags=exception.tags or tags,
-            extra=exception.extra or extra,
+            tags=tags,
+            extra=extra,
             exception=exception if exception.extract_exc_info else None,
         )
     else: