qena-shared-lib 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

{qena_shared_lib-0.1.7.dist-info → qena_shared_lib-0.1.9.dist-info}/METADATA

@@ -1,18 +1,17 @@
 Metadata-Version: 2.4
 Name: qena-shared-lib
-Version: 0.1.7
+Version: 0.1.9
 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
+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
@@ -41,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()
@@ -64,6 +66,11 @@ $ uvicorn --factory main:main
 ### Lifespan
 
 ``` py
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+
+
 @asynccontextmanager
 def lifespan(app: FastAPI):
     ...
@@ -84,6 +91,16 @@ def main() -> FastAPI:
 ### Dependencies
 
 ``` py
+class EmailService:
+    def __init__(self):
+        ...
+
+
+class Database:
+    def __init__(self):
+        ...
+
+
 def main() -> FastAPI:
     ...
 
@@ -96,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):
@@ -113,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")
 
 
@@ -154,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)
@@ -204,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)
@@ -215,7 +248,7 @@ async def lifespan(app: FastAPI):
     rabbitmq.disconnect()
 
 
-@Consumer("UserQueue")
+@consumer("UserQueue")
 class UserConsumer(ListenerBase):
 
     def __init__(self, db: Database):
@@ -250,7 +283,7 @@ def main() -> FastAPI:
 async def store_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user: User,
 )
@@ -267,7 +300,7 @@ async def store_user(
 async def get_user(
     rabbitmq: Annotated[
         RabbitMqManager,
-        DependsOne(RabbitMqManager)
+        DependsOn(RabbitMqManager)
     ],
     user_id: str,
 )
@@ -282,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()
@@ -300,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()
@@ -312,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)
@@ -327,7 +448,7 @@ async def lifespan(app: FastAPI):
     schedule_manager.stop()
 
 
-@Scheduler()
+@scheduler()
 class TaskScheduler(SchedulerBase):
 
     def __init__(self, db: Database)
@@ -368,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)
@@ -411,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):
@@ -440,6 +567,9 @@ def main() -> FastAPI:
 ### JWT
 
 ``` py
+from qena_shared_lib.security import JwtAdapter
+
+
 @ApiController("/users")
 class UserController(ControllerBase):
 
@@ -479,7 +609,10 @@ def main() -> FastAPI:
 ### ACL
 
 ``` py
-@ApiController("/users")
+from qena_shared_lib.security import Authorization
+
+
+@api_controller("/users")
 class UserController(ControllerBase):
 
     @post()
@@ -487,7 +620,7 @@ class UserController(ControllerBase):
         self,
         user: Annotated[
             UserInfo,
-            EndpointACL(
+            Authorization(
                 user_type="ADMIN",
                 persmission=[
                     "READ"
@@ -502,7 +635,7 @@ class UserController(ControllerBase):
 async def get_users(
     user: Annotated[
         UserInfo,
-        EndpointACL("ADMIN")
+        Authorization("ADMIN")
     ]
 )
     ...

qena_shared_lib-0.1.9.dist-info/RECORD

@@ -0,0 +1,29 @@
+qena_shared_lib/__init__.py,sha256=WokKEFaMNow6h2ZY_fyB-tiYnic-Ed6K6kyzKgg3Rlw,371
+qena_shared_lib/application.py,sha256=LyMgCrp1wqUfHsQktybWW-fZG-XugxZ6_Bafhp3gRls,5472
+qena_shared_lib/background.py,sha256=upWeJ747-4S4xsBOR-P2_oNar1YiaxCpnLhEDvnArmQ,3097
+qena_shared_lib/exception_handlers.py,sha256=qAXb8yE06yJRO2Qe9tfTu9D2DJhqgvX5wsc1_OPOjX4,6188
+qena_shared_lib/exceptions.py,sha256=GEGcSNaNMhFCdgCl6crNrrw-tmzPD-2Jz6MnpMvqXIU,9419
+qena_shared_lib/http.py,sha256=ZWbCV0C4SOKasfGhMLDcqZpZgIUUA_rEPAooeBkKieo,23846
+qena_shared_lib/logging.py,sha256=JL6bAmkK1BJA84rZNpvDEmrec3dogQRpSug4fj1Omkw,1618
+qena_shared_lib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qena_shared_lib/scheduler.py,sha256=wVLgHM0cCBZhqSmOAgEa5McEJSSTHfoMAEIrFGI0tT0,11946
+qena_shared_lib/security.py,sha256=MAq2Qf8FVYiUp8Iht82cVIPlyJGHReZC4LYKBF6N6cw,6076
+qena_shared_lib/utils.py,sha256=y60AKFknK-vus4i-nesgL00BWuAXJyd8Qx79Gi7lRq4,1272
+qena_shared_lib/dependencies/__init__.py,sha256=W12RgJbhqZ9GiSV1nLlHmpwPzvQv8t7f4JEoazM_WYg,350
+qena_shared_lib/dependencies/http.py,sha256=3KopQjq05qbYROMPZjji2Zz7qQLU6_2u3qKisLrjLks,1469
+qena_shared_lib/dependencies/miscellaneous.py,sha256=iGwAjatXb_JVSF13n1vdTRAgSKv19VtHo9ZbjjbkIco,753
+qena_shared_lib/logstash/__init__.py,sha256=KlWFXqwPGwKM3yWnz0lTmeZymkobxFPPNeOgyfdGu4g,315
+qena_shared_lib/logstash/_base.py,sha256=SRTcAwMOWk-sDxuu12-VGgbBts5HBmL3f6OJtQBvr18,15768
+qena_shared_lib/logstash/_http_sender.py,sha256=Sq3bJOXuOafqloROGblnmyUd0RuU3zF0QLpQDYjiy-g,1765
+qena_shared_lib/logstash/_tcp_sender.py,sha256=ncvc3wYxOJPkB7c_0W8vboaxMRJ_1UYGdA8LN2NXUpo,2306
+qena_shared_lib/rabbitmq/__init__.py,sha256=HKGd-CfbqNkTMDzF9dd-ZQlj5fQfnO5S9qzMcILy8xk,1151
+qena_shared_lib/rabbitmq/_base.py,sha256=S7jo4NbtAO8rzr7mBwhxRJrSmzrypOalrJChfrQ6-6I,23098
+qena_shared_lib/rabbitmq/_channel.py,sha256=R0xzZvLkeE4YWsyLhx8bPDramsTFDZIcCgfsDyFmSB4,5429
+qena_shared_lib/rabbitmq/_exception_handlers.py,sha256=gLkPFxQUW9faL8RApPT-Bqmn-fQ134q1ZvKInfRKjuo,4529
+qena_shared_lib/rabbitmq/_listener.py,sha256=1w5JAgwYy0xIU4kEZwL_KHyudfUWeqMWSXX5UdZ-p7M,46210
+qena_shared_lib/rabbitmq/_pool.py,sha256=MGubA-nYxxjgsZRF1yK4UBkzUy65t-suh0W1jZDk5q8,1952
+qena_shared_lib/rabbitmq/_publisher.py,sha256=Dr2u1IELCboCbozjTRsRtyQh7TRaJvujPsp74TF7utA,2434
+qena_shared_lib/rabbitmq/_rpc_client.py,sha256=eNzKpU_BvfDTR3udiSNtjJ4MaJqHrIOxMItKHA8aJbo,8909
+qena_shared_lib-0.1.9.dist-info/METADATA,sha256=DJuWOWR6IvgDxREbIXdIK3TQJUNfcAtFPOmQdooaZO4,11232
+qena_shared_lib-0.1.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+qena_shared_lib-0.1.9.dist-info/RECORD,,

qena_shared_lib/rabbitmq/_exceptions.py

@@ -1,46 +0,0 @@
-class RabbitMQException(Exception):
-    def __init__(
-        self,
-        code: int,
-        message: str,
-        tags: list[str] | None = None,
-        extra: dict[str, str] | None = None,
-        logstash_logging: bool = True,
-        extract_exc_info: bool = True,
-    ):
-        self._code = code
-        self._message = message
-        self._tags = tags
-        self._extra = extra
-        self._logstash_logging = logstash_logging
-        self._extract_exc_info = extract_exc_info
-
-    @property
-    def code(self) -> int:
-        return self._code
-
-    @property
-    def message(self) -> str:
-        return self._message
-
-    @property
-    def tags(self) -> list[str] | None:
-        return self._tags
-
-    @property
-    def extra(self) -> dict[str, str] | None:
-        return self._extra
-
-    @property
-    def logstash_logging(self) -> bool:
-        return self._logstash_logging
-
-    @property
-    def extract_exc_info(self) -> bool:
-        return self._extract_exc_info
-
-    def __str__(self) -> str:
-        return f"message `{self.message}`, code `{self.code}`"
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__} ( message: `{self._message}`, code: {self._code} )"

qena_shared_lib-0.1.7.dist-info/RECORD

@@ -1,30 +0,0 @@
-qena_shared_lib/__init__.py,sha256=WokKEFaMNow6h2ZY_fyB-tiYnic-Ed6K6kyzKgg3Rlw,371
-qena_shared_lib/application.py,sha256=2bpoEHW9FXRjNgBUuij2djfTLbhk01zymqp6kwasRq0,5470
-qena_shared_lib/background.py,sha256=upWeJ747-4S4xsBOR-P2_oNar1YiaxCpnLhEDvnArmQ,3097
-qena_shared_lib/exception_handlers.py,sha256=GclZUv8_QuJtbVSkzux8hxNbZNG7DWI2u0oGXgaEMD4,5143
-qena_shared_lib/exceptions.py,sha256=cNeksC8ZavKgoqKLBik1NR-lCcdLZzITHMXww5deY5Y,6789
-qena_shared_lib/http.py,sha256=90bmDfs522KxKBj2o0vO-MgmDqa3EZOfaNUFp1DuUdQ,23864
-qena_shared_lib/logging.py,sha256=JL6bAmkK1BJA84rZNpvDEmrec3dogQRpSug4fj1Omkw,1618
-qena_shared_lib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qena_shared_lib/scheduler.py,sha256=qxM3zdKJnAKUWw8i_I2M5o3uL_fEOTaBzYUBL-HvUzg,11874
-qena_shared_lib/security.py,sha256=n872UE3eQfezo1lkHwz5hcAngO0VekA_qDQ9LsZ8JZ8,6072
-qena_shared_lib/utils.py,sha256=y60AKFknK-vus4i-nesgL00BWuAXJyd8Qx79Gi7lRq4,1272
-qena_shared_lib/dependencies/__init__.py,sha256=W12RgJbhqZ9GiSV1nLlHmpwPzvQv8t7f4JEoazM_WYg,350
-qena_shared_lib/dependencies/http.py,sha256=3KopQjq05qbYROMPZjji2Zz7qQLU6_2u3qKisLrjLks,1469
-qena_shared_lib/dependencies/miscellaneous.py,sha256=iGwAjatXb_JVSF13n1vdTRAgSKv19VtHo9ZbjjbkIco,753
-qena_shared_lib/logstash/__init__.py,sha256=KlWFXqwPGwKM3yWnz0lTmeZymkobxFPPNeOgyfdGu4g,315
-qena_shared_lib/logstash/_base.py,sha256=sX0FLr9R4mkYL3KJO6ADlZaqjn3KbGOLyVTfK_ZTbSo,15722
-qena_shared_lib/logstash/_http_sender.py,sha256=Sq3bJOXuOafqloROGblnmyUd0RuU3zF0QLpQDYjiy-g,1765
-qena_shared_lib/logstash/_tcp_sender.py,sha256=ncvc3wYxOJPkB7c_0W8vboaxMRJ_1UYGdA8LN2NXUpo,2306
-qena_shared_lib/rabbitmq/__init__.py,sha256=WKAcKpRXXX9kqfHVEkyX6p2yIWzB07TMsBBWbV8nrKA,1209
-qena_shared_lib/rabbitmq/_base.py,sha256=IKWwi7B82dhkIPwvY12l4ko1cjdmedklBxYkUQVQVL0,23069
-qena_shared_lib/rabbitmq/_channel.py,sha256=R0xzZvLkeE4YWsyLhx8bPDramsTFDZIcCgfsDyFmSB4,5429
-qena_shared_lib/rabbitmq/_exception_handlers.py,sha256=7-WguEUqUSIdbvCIWn10f2CRaWPCM3MDZ6sxSATCCYA,4762
-qena_shared_lib/rabbitmq/_exceptions.py,sha256=Mg56Uk4eBEwTnWC91_WPS3_8d-yaqNkbb_32IpX_R-c,1208
-qena_shared_lib/rabbitmq/_listener.py,sha256=eYrlaptPoc72y7UMRyo_Lnn_OE0HGVlBJIh5UEptnww,44134
-qena_shared_lib/rabbitmq/_pool.py,sha256=MGubA-nYxxjgsZRF1yK4UBkzUy65t-suh0W1jZDk5q8,1952
-qena_shared_lib/rabbitmq/_publisher.py,sha256=48JdpvNzFaw3Bw5LhunFxcjm3qNWz3AXKyXtcpzcohQ,2380
-qena_shared_lib/rabbitmq/_rpc_client.py,sha256=5hA8IWvydRufYdv0zViIsi6_W2tWkHcmZotgCV2yjfc,8705
-qena_shared_lib-0.1.7.dist-info/METADATA,sha256=f6AHqMQrm79vJ1H0n_O5t14CnKvFec8zq1xJZi54H-Q,8520
-qena_shared_lib-0.1.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-qena_shared_lib-0.1.7.dist-info/RECORD,,