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

{qena_shared_lib-0.1.7 → qena_shared_lib-0.1.9}/.pre-commit-config.yaml

@@ -5,9 +5,17 @@ repos:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+    -   id: check-toml
+    -   id: name-tests-test
+        args: [ --pytest-test-first ]
+    -   id: check-added-large-files
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.9.2
+  rev: v0.9.9
   hooks:
     - id: ruff
       args: [ --fix ]
     - id: ruff-format
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+    -   id: mypy

qena_shared_lib-0.1.7/README.md → qena_shared_lib-0.1.9/PKG-INFO

@@ -1,3 +1,19 @@
+Metadata-Version: 2.4
+Name: qena-shared-lib
+Version: 0.1.9
+Summary: A shared tools for other services
+Requires-Python: >=3.10
+Requires-Dist: cronsim==2.6
+Requires-Dist: fastapi[all]==0.115.6
+Requires-Dist: httpx==0.27.2
+Requires-Dist: jwt==1.3.1
+Requires-Dist: passlib[bcrypt]==1.7.4
+Requires-Dist: pika==1.3.2
+Requires-Dist: prometheus-client==0.21.1
+Requires-Dist: prometheus-fastapi-instrumentator==7.0.2
+Requires-Dist: punq==0.7.0
+Description-Content-Type: text/markdown
+
 # Qena shared lib
 
 A shared tools for other services. It includes.
@@ -24,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()
@@ -47,6 +66,11 @@ $ uvicorn --factory main:main
 ### Lifespan
 
 ``` py
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
 @asynccontextmanager
 def lifespan(app: FastAPI):
     ...
@@ -67,6 +91,16 @@ def main() -> FastAPI:
 ### Dependencies
 
 ``` py
+class EmailService:
+    def __init__(self):
+        ...
+
+
+class Database:
+    def __init__(self):
+        ...
+
+
 def main() -> FastAPI:
     ...
 
@@ -79,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):
@@ -96,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")
 
 
@@ -137,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)
@@ -187,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)
@@ -198,7 +248,7 @@ async def lifespan(app: FastAPI):
     rabbitmq.disconnect()
 
 
-@Consumer("UserQueue")
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     def __init__(self, db: Database):
@@ -233,7 +283,7 @@ def main() -> FastAPI:
 async def store_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user: User,
 )
@@ -250,7 +300,7 @@ async def store_user(
 async def get_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user_id: str,
 )
@@ -265,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()
@@ -283,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()
@@ -295,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)
@@ -310,7 +448,7 @@ async def lifespan(app: FastAPI):
     schedule_manager.stop()
 
 
-@Scheduler()
+@scheduler()
 class TaskScheduler(SchedulerBase):
 
     def __init__(self, db: Database)
@@ -351,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)
@@ -394,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):
@@ -423,6 +567,9 @@ def main() -> FastAPI:
 ### JWT
 
 ``` py
+from qena_shared_lib.security import JwtAdapter
+
+
 @ApiController("/users")
 class UserController(ControllerBase):
 
@@ -462,7 +609,10 @@ def main() -> FastAPI:
 ### ACL
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import Authorization
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     @post()
@@ -470,7 +620,7 @@ class UserController(ControllerBase):
         self,
         user: Annotated[
             UserInfo,
-            EndpointACL(
+            Authorization(
                 user_type="ADMIN",
                 persmission=[
                     "READ"
@@ -485,7 +635,7 @@ class UserController(ControllerBase):
 async def get_users(
     user: Annotated[
         UserInfo,
-        EndpointACL("ADMIN")
+        Authorization("ADMIN")
     ]
 )
     ...

qena_shared_lib-0.1.7/PKG-INFO → qena_shared_lib-0.1.9/README.md

@@ -1,20 +1,3 @@
-Metadata-Version: 2.4
-Name: qena-shared-lib
-Version: 0.1.7
-Summary: A shared tools for other services
-Requires-Python: >=3.10
-Requires-Dist: cronsim~=2.0
-Requires-Dist: fastapi[all]~=0.115.0
-Requires-Dist: httpx~=0.27.0
-Requires-Dist: jwt~=1.3.0
-Requires-Dist: passlib[bcrypt]~=1.7.0
-Requires-Dist: pika~=1.3.0
-Requires-Dist: prometheus-client~=0.21.0
-Requires-Dist: prometheus-fastapi-instrumentator~=7.0.0
-Requires-Dist: punq~=0.7.0
-Requires-Dist: pydantic~=2.10.0
-Description-Content-Type: text/markdown
-
 # Qena shared lib
 
 A shared tools for other services. It includes.
@@ -41,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()
@@ -64,6 +50,11 @@ $ uvicorn --factory main:main
 ### Lifespan
 
 ``` py
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
 @asynccontextmanager
 def lifespan(app: FastAPI):
     ...
@@ -84,6 +75,16 @@ def main() -> FastAPI:
 ### Dependencies
 
 ``` py
+class EmailService:
+    def __init__(self):
+        ...
+
+
+class Database:
+    def __init__(self):
+        ...
+
+
 def main() -> FastAPI:
     ...
 
@@ -96,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):
@@ -113,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")
 
 
@@ -154,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)
@@ -204,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)
@@ -215,7 +232,7 @@ async def lifespan(app: FastAPI):
     rabbitmq.disconnect()
 
 
-@Consumer("UserQueue")
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     def __init__(self, db: Database):
@@ -250,7 +267,7 @@ def main() -> FastAPI:
 async def store_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user: User,
 )
@@ -267,7 +284,7 @@ async def store_user(
 async def get_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user_id: str,
 )
@@ -282,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()
@@ -300,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()
@@ -312,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)
@@ -327,7 +432,7 @@ async def lifespan(app: FastAPI):
     schedule_manager.stop()
 
 
-@Scheduler()
+@scheduler()
 class TaskScheduler(SchedulerBase):
 
     def __init__(self, db: Database)
@@ -368,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)
@@ -411,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):
@@ -440,6 +551,9 @@ def main() -> FastAPI:
 ### JWT
 
 ``` py
+from qena_shared_lib.security import JwtAdapter
+
+
 @ApiController("/users")
 class UserController(ControllerBase):
 
@@ -479,7 +593,10 @@ def main() -> FastAPI:
 ### ACL
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import Authorization
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     @post()
@@ -487,7 +604,7 @@ class UserController(ControllerBase):
         self,
         user: Annotated[
             UserInfo,
-            EndpointACL(
+            Authorization(
                 user_type="ADMIN",
                 persmission=[
                     "READ"
@@ -502,7 +619,7 @@ class UserController(ControllerBase):
 async def get_users(
     user: Annotated[
         UserInfo,
-        EndpointACL("ADMIN")
+        Authorization("ADMIN")
     ]
 )
     ...

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

@@ -1,20 +1,19 @@
 [project]
 name = "qena-shared-lib"
-version = "0.1.7"
+version = "0.1.9"
 description = "A shared tools for other services"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "cronsim~=2.0",
-    "fastapi[all]~=0.115.0",
-    "httpx~=0.27.0",
-    "jwt~=1.3.0",
-    "passlib[bcrypt]~=1.7.0",
-    "pika~=1.3.0",
-    "prometheus-client~=0.21.0",
-    "prometheus-fastapi-instrumentator~=7.0.0",
-    "punq~=0.7.0",
-    "pydantic~=2.10.0",
+    "cronsim==2.6",
+    "fastapi[all]==0.115.6",
+    "httpx==0.27.2",
+    "jwt==1.3.1",
+    "passlib[bcrypt]==1.7.4",
+    "pika==1.3.2",
+    "prometheus-client==0.21.1",
+    "prometheus-fastapi-instrumentator==7.0.2",
+    "punq==0.7.0",
 ]
 
 [build-system]
@@ -23,11 +22,11 @@ build-backend = "hatchling.build"
 
 [tool.uv]
 dev-dependencies = [
-    "pre-commit~=4.0.0",
-    "pytest-asyncio~=0.24.0",
-    "pytest~=8.3.0",
-    "testcontainers~=4.8.0",
-    "pytest-cov~=6.0.0",
+    "pre-commit==4.0.1",
+    "pytest-asyncio==0.24.0",
+    "pytest==8.3.3",
+    "testcontainers==4.8.2",
+    "pytest-cov==6.0.0",
 ]
 
 [tool.ruff]