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

{qena_shared_lib-0.1.7 → qena_shared_lib-0.1.8}/.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 → qena_shared_lib-0.1.8}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.4
 Name: qena-shared-lib
-Version: 0.1.7
+Version: 0.1.8
 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

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

@@ -1,20 +1,19 @@
 [project]
 name = "qena-shared-lib"
-version = "0.1.7"
+version = "0.1.8"
 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]

qena_shared_lib-0.1.8/requirements.txt

@@ -0,0 +1,55 @@
+# This file was autogenerated by uv via the following command:
+#    uv export --no-dev --no-hashes --format requirements-txt
+-e .
+annotated-types==0.7.0
+anyio==4.6.0
+bcrypt==4.2.1
+certifi==2024.8.30
+cffi==1.17.1 ; platform_python_implementation != 'PyPy'
+click==8.1.8
+colorama==0.4.6 ; sys_platform == 'win32'
+cronsim==2.6
+cryptography==44.0.0
+dnspython==2.7.0
+email-validator==2.2.0
+exceptiongroup==1.2.2 ; python_full_version < '3.11'
+fastapi==0.115.6
+fastapi-cli==0.0.7
+h11==0.14.0
+httpcore==1.0.6
+httptools==0.6.4
+httpx==0.27.2
+idna==3.10
+itsdangerous==2.2.0
+jinja2==3.1.5
+jwt==1.3.1
+markdown-it-py==3.0.0
+markupsafe==3.0.2
+mdurl==0.1.2
+orjson==3.10.12
+passlib==1.7.4
+pika==1.3.2
+prometheus-client==0.21.1
+prometheus-fastapi-instrumentator==7.0.2
+punq==0.7.0
+pycparser==2.22 ; platform_python_implementation != 'PyPy'
+pydantic==2.10.3
+pydantic-core==2.27.1
+pydantic-extra-types==2.10.1
+pydantic-settings==2.7.0
+pygments==2.18.0
+python-dotenv==1.0.1
+python-multipart==0.0.20
+pyyaml==6.0.2
+rich==13.9.4
+rich-toolkit==0.12.0
+shellingham==1.5.4
+sniffio==1.3.1
+starlette==0.41.3
+typer==0.15.1
+typing-extensions==4.12.2
+ujson==5.10.0
+uvicorn==0.34.0
+uvloop==0.21.0 ; platform_python_implementation != 'PyPy' and sys_platform != 'cygwin' and sys_platform != 'win32'
+watchfiles==1.0.3
+websockets==14.1

{qena_shared_lib-0.1.7 → qena_shared_lib-0.1.8}/src/qena_shared_lib/application.py

@@ -9,8 +9,8 @@ from starlette.types import Lifespan
 
 from .exception_handlers import (
     handle_general_http_exception,
+    handle_http_service_error,
     handle_request_validation_error,
-    handle_service_exception,
 )
 from .exceptions import ServiceException
 from .http import ControllerBase
@@ -153,7 +153,7 @@ class Builder:
         )
         app.state.container = self._container
 
-        app.exception_handler(ServiceException)(handle_service_exception)
+        app.exception_handler(ServiceException)(handle_http_service_error)
         app.exception_handler(RequestValidationError)(
             handle_request_validation_error
         )

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

@@ -7,18 +7,23 @@ from fastapi.responses import JSONResponse
 from pydantic_core import to_jsonable_python
 
 from .dependencies.http import get_service
-from .exceptions import ServiceException, Severity
+from .exceptions import (
+    HTTPServiceError,
+    RabbitMQServiceException,
+    ServiceException,
+    Severity,
+)
 from .logging import LoggerProvider
 from .logstash._base import BaseLogstashSender
 
 __all__ = [
-    "handle_service_exception",
+    "handle_http_service_error",
     "handle_request_validation_error",
     "handle_general_http_exception",
 ]
 
 
-def handle_service_exception(
+def handle_http_service_error(
     request: Request, exception: ServiceException
 ) -> Response:
     logstash = get_service(app=request.app, service_key=BaseLogstashSender)
@@ -32,20 +37,12 @@ def handle_service_exception(
         request.url.path,
         exception.__class__.__name__,
     ]
-
-    if exception.tags:
-        exception.tags.extend(tags)
-
     extra = {
         "serviceType": "HTTP",
         "method": request.method,
         "path": request.url.path,
         "exception": exception.__class__.__name__,
     }
-
-    if exception.extra:
-        exception.extra.update(extra)
-
     exc_info = (
         (type(exception), exception, exception.__traceback__)
         if exception.extract_exc_info
@@ -64,6 +61,63 @@ def handle_service_exception(
             logstash_logger_method = logstash.error
             logger_method = logger.error
 
+    content: dict[str, Any] = {
+        "severity": exception_severity.name,
+        "message": message,
+    }
+    status_code = _status_code_from_severity(exception.severity)
+    headers = None
+
+    match exception:
+        case HTTPServiceError() as http_service_error:
+            if http_service_error.body is not None:
+                extra_body = to_jsonable_python(http_service_error.body)
+                is_updated = False
+
+                try:
+                    if isinstance(extra_body, Iterable):
+                        content.update(extra_body)
+
+                        is_updated = True
+                except:
+                    pass
+
+                if not is_updated:
+                    content["data"] = extra_body
+
+            if http_service_error.response_code is not None:
+                content["code"] = http_service_error.response_code
+                str_response_code = str(http_service_error.response_code)
+                extra["responseCode"] = str_response_code
+
+                tags.append(str_response_code)
+
+            if http_service_error.corrective_action is not None:
+                content["correctiveAction"] = (
+                    http_service_error.corrective_action
+                )
+
+            if http_service_error.status_code is not None:
+                status_code = http_service_error.status_code
+                str_status_code = str(status_code)
+                extra["statusCode"] = str_status_code
+
+                tags.append(str_status_code)
+
+            if http_service_error.headers is not None:
+                headers = http_service_error.headers
+        case RabbitMQServiceException() as rabbitmq_service_exception:
+            str_error_code = str(rabbitmq_service_exception.code)
+            extra["code"] = str_error_code
+
+            tags.append(str_error_code)
+
+    if exception.tags:
+        tags.extend(exception.tags)
+
+    if exception.extra:
+        extra.update(exception.extra)
+
     if exception.logstash_logging:
         logstash_logger_method(
             message=exception.message,
@@ -80,39 +134,10 @@ def handle_service_exception(
             exc_info=exc_info,
         )
 
-    content: dict[str, Any] = {
-        "severity": exception_severity.name
-        if exception_severity
-        else Severity.LOW.name,
-        "message": message,
-    }
-
-    if exception.response_code is not None:
-        content["code"] = exception.response_code
-
-    if exception.corrective_action is not None:
-        content["correctiveAction"] = exception.corrective_action
-
-    if exception.body is not None:
-        extra_body = to_jsonable_python(exception.body)
-        is_updated = False
-
-        try:
-            if isinstance(extra_body, Iterable):
-                content.update(extra_body)
-
-                is_updated = True
-        except:
-            pass
-
-        if not is_updated:
-            content["data"] = extra_body
-
     return JSONResponse(
         content=content,
-        status_code=exception.status_code
-        or _status_code_from_severity(exception.severity),
-        headers=exception.headers,
+        status_code=status_code,
+        headers=headers,
     )
 
 

{qena_shared_lib-0.1.7 → qena_shared_lib-0.1.8}/src/qena_shared_lib/exceptions.py

@@ -2,50 +2,56 @@ from enum import Enum
 from typing import Any
 
 __all__ = [
-    "Severity",
-    "ServiceException",
-    "ClientError",
+    "BadGateway",
     "BadRequest",
-    "Unauthorized",
-    "PaymentRequired",
-    "Forbidden",
-    "NotFound",
-    "MethodNotAllowed",
-    "NotAcceptable",
-    "ProxyAuthenticationRequired",
-    "RequestTimeout",
+    "ClientError",
     "Conflict",
-    "Gone",
-    "LengthRequired",
-    "PreconditionFailed",
-    "PayloadTooLarge",
-    "URITooLong",
-    "UnsupportedMediaType",
-    "RangeNotSatisfiable",
     "ExpectationFailed",
+    "FailedDependency",
+    "Forbidden",
+    "GatewayTimeout",
+    "Gone",
+    "HTTPServiceError",
+    "HTTPVersionNotSupported",
     "IAmATeapot",
-    "MisdirectedRequest",
-    "UnprocessableEntity",
+    "InsufficientStorage",
+    "InternalServerError",
+    "LengthRequired",
     "Locked",
-    "FailedDependency",
-    "TooEarly",
-    "UpgradeRequired",
+    "LoopDetected",
+    "MethodNotAllowed",
+    "MisdirectedRequest",
+    "NetworkAuthenticationRequired",
+    "NotAcceptable",
+    "NotExtended",
+    "NotFound",
+    "NotImplemented",
+    "PayloadTooLarge",
+    "PaymentRequired",
+    "PreconditionFailed",
     "PreconditionRequired",
-    "TooManyRequests",
+    "ProxyAuthenticationRequired",
+    "RabbitMQBlockedError",
+    "RabbitMQConnectionUnhealthyError",
+    "RabbitMQRpcRequestPendingError",
+    "RabbitMQRpcRequestTimeoutError",
+    "RabbitMQServiceException",
+    "RangeNotSatisfiable",
     "RequestHeaderFieldsTooLarge",
-    "UnavailableForLegalReasons",
+    "RequestTimeout",
     "ServerError",
-    "InternalServerError",
-    "NotImplemented",
-    "BadGateway",
+    "ServiceException",
     "ServiceUnavailable",
-    "GatewayTimeout",
-    "HTTPVersionNotSupported",
+    "Severity",
+    "TooEarly",
+    "TooManyRequests",
+    "Unauthorized",
+    "UnavailableForLegalReasons",
+    "UnprocessableEntity",
+    "UnsupportedMediaType",
+    "UpgradeRequired",
+    "URITooLong",
     "VariantAlsoNegotiates",
-    "InsufficientStorage",
-    "LoopDetected",
-    "NotExtended",
-    "NetworkAuthenticationRequired",
 ]
 
 
@@ -56,100 +62,134 @@ class Severity(Enum):
 
 
 class ServiceException(Exception):
-    _GENERAL_EXTRACT_EXC_INFO = None
     _GENERAL_SEVERITY = None
-    _GENERAL_STATUS_CODE = None
+    _GENERAL_EXTRACT_EXC_INFO = None
 
     def __init__(
         self,
         message: str,
-        body: Any | None = None,
-        corrective_action: str | None = None,
         severity: Severity | None = None,
-        status_code: int | None = None,
-        response_code: int | None = None,
         tags: list[str] | None = None,
         extra: dict[str, str] | None = None,
-        headers: dict[str, str] | None = None,
-        logstash_logging: bool = True,
-        extract_exc_info: bool = True,
+        logstash_logging: bool | None = None,
+        extract_exc_info: bool | None = None,
     ):
         self._message = message
-        self._body = body
-        self._corrective_action = corrective_action
-        self._response_code = response_code
+
+        if severity is not None:
+            self._severity = severity
+        else:
+            self._severity = self._GENERAL_SEVERITY
+
         self._tags = tags
         self._extra = extra
-        self._headers = headers
-        self._logstash_logging = (
-            logstash_logging if logstash_logging is not None else True
-        )
-        self._extract_exc_info = (
-            extract_exc_info
-            if extract_exc_info is not None
-            else self._GENERAL_EXTRACT_EXC_INFO
-        )
-        self._severity = (
-            severity if severity is not None else self._GENERAL_SEVERITY
-        )
-        self._status_code = (
-            status_code
-            if status_code is not None
-            else self._GENERAL_STATUS_CODE
-        )
+
+        if logstash_logging is not None:
+            self._logstash_logging = logstash_logging
+        else:
+            self._logstash_logging = True
+
+        if extract_exc_info is not None:
+            self._extract_exc_info = extract_exc_info
+        else:
+            self._extract_exc_info = self._GENERAL_EXTRACT_EXC_INFO
 
     @property
     def message(self) -> str:
         return self._message
 
     @property
-    def body(self) -> Any | None:
-        return self._body
+    def severity(self) -> Severity | None:
+        return self._severity
 
     @property
-    def corrective_action(self) -> str | None:
-        return self._corrective_action
+    def tags(self) -> list[str] | None:
+        return self._tags
 
     @property
-    def severity(self) -> Severity | None:
-        return self._severity
+    def extra(self) -> dict[str, str] | None:
+        return self._extra
 
     @property
-    def status_code(self) -> int | None:
-        return self._status_code
+    def logstash_logging(self) -> bool | None:
+        return self._logstash_logging
 
     @property
-    def response_code(self) -> int | None:
-        return self._response_code
+    def extract_exc_info(self) -> bool | None:
+        return self._extract_exc_info
+
+    def __str__(self) -> str:
+        return f"message `{self._message}`, tags {self._tags or []}"
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__} ( message: `{self._message}`, tags: {self._tags or []}, extra: {self._extra or {}} )"
+
+
+class HTTPServiceError(ServiceException):
+    _GENERAL_STATUS_CODE = None
+
+    def __init__(
+        self,
+        message: str,
+        body: Any | None = None,
+        status_code: int | None = None,
+        headers: dict[str, str] | None = None,
+        response_code: int | None = None,
+        corrective_action: str | None = None,
+        severity: Severity | None = None,
+        tags: list[str] | None = None,
+        extra: dict[str, str] | None = None,
+        logstash_logging: bool = True,
+        extract_exc_info: bool = True,
+    ):
+        super().__init__(
+            message=message,
+            severity=severity,
+            tags=tags,
+            extra=extra,
+            logstash_logging=logstash_logging,
+            extract_exc_info=extract_exc_info,
+        )
+
+        self._body = body
+
+        if status_code is not None:
+            self._status_code = status_code
+        else:
+            self._status_code = self._GENERAL_STATUS_CODE
+
+        self._headers = headers
+        self._response_code = response_code
+        self._corrective_action = corrective_action
 
     @property
-    def tags(self) -> list[str] | None:
-        return self._tags
+    def body(self) -> Any | None:
+        return self._body
 
     @property
-    def extra(self) -> dict[str, str] | None:
-        return self._extra
+    def status_code(self) -> int | None:
+        return self._status_code
 
     @property
     def headers(self) -> dict[str, str] | None:
         return self._headers
 
     @property
-    def logstash_logging(self) -> bool | None:
-        return self._logstash_logging
+    def response_code(self) -> int | None:
+        return self._response_code
 
     @property
-    def extract_exc_info(self) -> bool | None:
-        return self._extract_exc_info
+    def corrective_action(self) -> str | None:
+        return self._corrective_action
 
     def __str__(self) -> str:
-        return f"message `{self._message}`, tags `{self._tags or []}`"
+        return f"message `{self._message}`, status_code {self._status_code or 500}, response_code {self._response_code or 0}"
 
     def __repr__(self) -> str:
-        return f"{self.__class__.__name__} ( message = `{self._message}`, tags = `{self._tags or []}`, extra = `{self._extra or {}}` )"
+        return f"{self.__class__.__name__} ( message: `{self._message}`, status_code: {self._status_code or 500}, response_code: {self._response_code or 0} )"
 
 
-class ClientError(ServiceException):
+class ClientError(HTTPServiceError):
     _GENERAL_EXTRACT_EXC_INFO = False
     _GENERAL_SEVERITY = Severity.MEDIUM
 
@@ -270,7 +310,7 @@ class UnavailableForLegalReasons(ClientError):
     _GENERAL_STATUS_CODE = 451
 
 
-class ServerError(ServiceException):
+class ServerError(HTTPServiceError):
     _GENERAL_EXTRACT_EXC_INFO = True
     _GENERAL_SEVERITY = Severity.HIGH
 
@@ -317,3 +357,65 @@ class NotExtended(ServerError):
 
 class NetworkAuthenticationRequired(ServerError):
     _GENERAL_STATUS_CODE = 511
+
+
+class RabbitMQServiceException(ServiceException):
+    _GENERAL_SEVERITY = Severity.HIGH
+    _GENERAL_CODE = None
+
+    def __init__(
+        self,
+        message: str,
+        code: int | None = None,
+        data: Any | None = None,
+        severity: Severity | None = None,
+        tags: list[str] | None = None,
+        extra: dict[str, str] | None = None,
+        logstash_logging: bool | None = None,
+        extract_exc_info: bool | None = None,
+    ):
+        super().__init__(
+            message=message,
+            severity=severity,
+            tags=tags,
+            extra=extra,
+            logstash_logging=logstash_logging,
+            extract_exc_info=extract_exc_info,
+        )
+
+        if code is not None:
+            self._code = code
+        else:
+            self._code = self._GENERAL_CODE or 0
+
+        self._data = data
+
+    @property
+    def code(self) -> int:
+        return self._code
+
+    @property
+    def data(self) -> Any | None:
+        return self._data
+
+    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} )"
+
+
+class RabbitMQBlockedError(Exception):
+    pass
+
+
+class RabbitMQRpcRequestTimeoutError(Exception):
+    pass
+
+
+class RabbitMQRpcRequestPendingError(Exception):
+    pass
+
+
+class RabbitMQConnectionUnhealthyError(Exception):
+    pass