algo-backend-framework 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

algo_backend/exception/error_code_manage.py

@@ -8,21 +8,21 @@ from . import status_code
 from .status_code import BasicApiId, BasicApiInnerErrorCode, BasicStatusCode
 
 
+def set_error_code_prefix_env(prefix: Optional[int] = None):
+    """
+    服务启动时执行这个函数
+    也可以启动服务时通过环境变量ERROR_CODE_SERVICE_PREFIX指定服务前缀
+    如果输入的prefix code不符合规则，则忽略，保持原来的6位
+    """
+    if prefix and 1 <= prefix <= 99:
+        ErrorCodeConfig.SERVICE_PREFIX = prefix
+
+
 class ApiErrorCodeManage:
     """
     构建”5aaabb“错误码，aaa接口id，bb表示接口内部错误码
     """
 
-    @classmethod
-    def set_error_code_prefix_env(cls, prefix: Optional[int] = None):
-        """
-        服务启动时执行这个函数
-        也可以启动服务时通过环境变量ERROR_CODE_SERVICE_PREFIX指定服务前缀
-        如果输入的prefix code不符合规则，则忽略，保持原来的6位
-        """
-        if prefix and 1 <= prefix <= 99:
-            ErrorCodeConfig.SERVICE_PREFIX = prefix
-
     @classmethod
     def scan_module_and_summary(cls, *list_module) -> list:
         """扫描模块中的ApiId和错误码枚举类"""

algo_backend/handler/__init__.py

@@ -1,3 +1,4 @@
 from .simple_handler import timing_and_exception_handler
+from .sse_handler import sse_timing_and_exception_handler
 
-__all__ = ["timing_and_exception_handler"]
+__all__ = ["timing_and_exception_handler", "sse_timing_and_exception_handler"]

algo_backend/handler/simple_handler.py

@@ -1,3 +1,4 @@
+import inspect
 import logging
 import time
 import traceback
@@ -9,7 +10,8 @@ from algo_backend.exception import (
     DefaultApiErrorCode,
 )
 from algo_backend.metrics import PrometheusTimeCostMetricSetting
-from algo_backend.schema import AbstractRespVo
+from algo_backend.schema import AbstractRespVo, BaseRespVo
+
 from .exception_to_vo import gen_vo_from_exception
 
 logger = logging.getLogger(__name__)
@@ -20,10 +22,14 @@ def timing_and_exception_handler(
     *,
     api_id: BasicApiId = DefaultApiErrorCode.DEFAULT_ERROR,
     api_name: str = "",
+    vo_class_type: type(AbstractRespVo) = BaseRespVo,
 ):
     """
     装饰器：用于统计函数执行时间并捕获异常
     函数中需要包含参数reqid或者request_id
+    : param api_id: 错误码
+    : param api_name: api名称
+    : param vo_class_type: 返回值类型，优先从被装饰的函数typehint中获取，如果获取类型非AbstractRespVo的实现类，则从装饰器vo_class_type中获取，默认BaseRespVo
     """
 
     def decorator(
@@ -59,9 +65,10 @@ def timing_and_exception_handler(
                     f"Traceback:\n{traceback.format_exc()}"
                 )
 
-                vo_cls: type(AbstractRespVo) = get_type_hints(func).get(
-                    "return"
-                )  # 这里可能会失败，因为无法强制用户的类型
+                vo_cls = get_type_hints(func).get("return")
+                if inspect.isclass(vo_cls) and issubclass(vo_cls, AbstractRespVo):
+                    vo_cls = vo_class_type
+
                 return gen_vo_from_exception(
                     vo_cls, e, api_name=_name, request_id=request_id, api_id=api_id
                 )

algo_backend/handler/sse_handler.py

@@ -0,0 +1,84 @@
+import logging
+import time
+import traceback
+from functools import wraps
+from typing import AsyncIterable, Callable, TypeVar
+
+from pydantic import BaseModel
+
+from algo_backend.exception import (
+    BasicApiId,
+    BasicException,
+    DefaultApiErrorCode,
+    transfer_exception,
+)
+from algo_backend.metrics import PrometheusTimeCostMetricSetting
+from algo_backend.schema import SseVoGenerator
+
+logger = logging.getLogger(__name__)
+
+
+D = TypeVar("D", bound=BaseModel)
+
+
+def sse_timing_and_exception_handler(
+    transfer_obj_cls=type(SseVoGenerator),
+    *,
+    api_id: BasicApiId = DefaultApiErrorCode.DEFAULT_ERROR,
+    api_name: str = ""
+):
+    def decorator(
+        func: Callable[..., AsyncIterable[D]],
+    ) -> Callable[..., AsyncIterable[D]]:
+        @wraps(func)
+        async def wrapper(*args, **kwargs):
+            request_id = kwargs.get("request_id", None) or kwargs.get("reqid", None)
+            _name = func.__name__ or api_name
+
+            transfer_obj: SseVoGenerator = transfer_obj_cls(request_id=request_id)
+            # 提供额外参数，方便丰富上下文
+            transfer_obj.extract_info(*args, **kwargs)
+
+            start_time = time.perf_counter()
+            # 执行原函数
+            logger.info(f"ReqId: {request_id} | Function: {_name} | Start")
+
+            try:
+                start_event = transfer_obj.start()
+                if start_event:
+                    yield start_event
+
+                async for item in func(*args, **kwargs):
+                    yield transfer_obj.generate(item)
+
+                elapsed_time = time.perf_counter() - start_time
+
+                logger.info(
+                    f"ReqId: {request_id} | Function: {_name} | COST:{elapsed_time:.4f}s"
+                )
+                PrometheusTimeCostMetricSetting.api_metrics_instance().add(
+                    _name, elapsed_time
+                )
+
+                end_event = transfer_obj.done()
+                if end_event:
+                    yield end_event
+
+            except Exception as e:
+                # 计算耗时
+                elapsed_time = time.perf_counter() - start_time
+                PrometheusTimeCostMetricSetting.api_metrics_instance().add_error(_name)
+                # 记录异常信息和完整堆栈
+                logger.error(
+                    f"ReqId: {request_id} | Function: {_name} | COST:{elapsed_time:.4f}s | Exception: {str(e)}\n"
+                    f"Traceback:\n{traceback.format_exc()}"
+                )
+
+                basic_exception: BasicException = transfer_exception(
+                    e, api_name=_name, api_id=api_id, request_id=request_id
+                )
+                yield transfer_obj.error(basic_exception)
+
+        return wrapper
+
+    return decorator

algo_backend/metrics/time_cost_metrics.py

@@ -2,7 +2,8 @@ import logging
 import os
 import time
 from functools import wraps
-from typing import Awaitable, Callable, List, Optional
+from typing import List, Optional
+import inspect
 
 from prometheus_client import Counter, Histogram
 
@@ -120,27 +121,60 @@ class PrometheusTimeCostMetricSetting:
     def client_metrics_instance(cls) -> BasicTimeCostMetrics:
         return cls.get_metrics("client")
 
+    @classmethod
+    def _create_async_gen_wrapper(cls, func, metrics_cls_name: str, key: str):
+        """
+        创建异步生成器包装器
+        """
+
+        @wraps(func)
+        async def async_gen_wrapper(*args, **kwargs):
+            metrics = cls.get_metrics(metrics_cls_name)
+            start = time.perf_counter()
+            try:
+                async for item in func(*args, **kwargs):
+                    yield item
+                cost = time.perf_counter() - start
+                metrics.add(key, cost)
+            except Exception as e:
+                metrics.add_error(key)
+                raise e
+
+        return async_gen_wrapper
+
+    @classmethod
+    def _create_async_func_wrapper(cls, func, metrics_cls_name: str, key: str):
+        """
+        创建普通异步函数包装器
+        """
+
+        @wraps(func)
+        async def async_func_wrapper(*args, **kwargs):
+            metrics = cls.get_metrics(metrics_cls_name)
+            start = time.perf_counter()
+            try:
+                result = await func(*args, **kwargs)
+                metrics.add(key, time.perf_counter() - start)
+                return result
+            except Exception as e:
+                metrics.add_error(key)
+                raise e
+
+        return async_func_wrapper
+
     @classmethod
     def metrics_handler(cls, key: str, metrics_cls_name: str):
         """
         装饰器只会初始化一次，因此要使用动态方式获取指标类，否则初始化装饰器时，指标类还没有被初始化
         """
 
-        def decorator(func: Callable[..., Awaitable]) -> Callable[..., Awaitable]:
-            @wraps(func)
-            async def wrapper(*args, **kwargs):
-                metrics = cls.get_metrics(metrics_cls_name)
-                try:
-                    start = time.perf_counter()
-                    result = await func(*args, **kwargs)
-                    cost = time.perf_counter() - start
-                    metrics.add(key, cost)
-                    return result
-                except Exception as e:
-                    metrics.add_error(key)
-                    raise e
-
-            return wrapper
+        def decorator(func):
+            if inspect.isasyncgenfunction(func):
+                return cls._create_async_gen_wrapper(func, metrics_cls_name, key)
+            elif inspect.iscoroutinefunction(func):
+                return cls._create_async_func_wrapper(func, metrics_cls_name, key)
+            else:
+                raise ValueError(f"{func.__name__} is not a async function or async generator")
 
         return decorator
 

algo_backend/schema/__init__.py

@@ -1,3 +1,4 @@
 from .vo import AbstractRespVo, BaseRespVo
+from .sse import SseVoGenerator
 
-__all__ = ["BaseRespVo", "AbstractRespVo"]
+__all__ = ["BaseRespVo", "AbstractRespVo", "SseVoGenerator"]

algo_backend/schema/sse.py

@@ -0,0 +1,40 @@
+from abc import ABC, abstractmethod
+from typing import TypeVar, Optional
+
+from pydantic import BaseModel
+
+from algo_backend.exception import BasicException
+
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class SseVoGenerator(ABC):
+    def __init__(self, request_id: str=None):
+        self.request_id = request_id
+
+    @abstractmethod
+    def extract_info(self, *args, **kwargs):
+        """额外获取信息"""
+        ...
+
+    @abstractmethod
+    def start(self) -> Optional[T]:
+        """
+        返回None时，sse_timing_and_exception_handler会忽略这一步
+        """
+        ...
+
+    @abstractmethod
+    def generate(self, content: BaseModel) -> T: ...
+
+    @abstractmethod
+    def done(self) -> T:
+        """
+        返回None时，sse_timing_and_exception_handler会忽略这一步
+        """
+        ...
+
+    @abstractmethod
+    def error(self, exception: BasicException) -> T:
+        ...

algo_backend/starter/default_app_generator.py

@@ -6,7 +6,7 @@ from fastapi import FastAPI
 from fastapi.exceptions import RequestValidationError, StarletteHTTPException
 from starlette.middleware import Middleware
 
-from algo_backend.exception import ApiErrorCodeManage
+from algo_backend.exception.error_code_manage import set_error_code_prefix_env
 from algo_backend.intercept import (
     BasicExceptionInterceptor,
     HTTPExceptionInterceptor,
@@ -55,7 +55,7 @@ class DefaultAlgoAppGenerator:
         :param client_time_cost_buckets: 客户端耗时统计的桶,None表示使用默认的,空列表表示不启用这个指标
         """
         # 注册8位错误码前缀
-        ApiErrorCodeManage.set_error_code_prefix_env(app_error_code_prefix)
+        set_error_code_prefix_env(app_error_code_prefix)
         self.service_name = service_name
 
         self.__app: Optional[FastAPI] = FastAPI()

{algo_backend_framework-0.0.4.dist-info → algo_backend_framework-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: algo-backend-framework
-Version: 0.0.4
+Version: 0.0.5
 Summary: Ctcdn algorithm backend framework
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{algo_backend_framework-0.0.4.dist-info → algo_backend_framework-0.0.5.dist-info}/RECORD

@@ -3,12 +3,13 @@ algo_backend/config/__init__.py,sha256=MLAvcvodxXiaVsSJaVvQcNjFWIFusBQ0i9OrWJv3z
 algo_backend/config/basic_config.py,sha256=RSRf8lgc8KfA_FHNjchaghSLNnJy7ejn2ux57SBSakg,292
 algo_backend/config/loguru_config.py,sha256=WovghKcMqeysPuf8vlKFhbNug8Z7zPqxkjlwVYKjZWw,513
 algo_backend/exception/__init__.py,sha256=tHC3p8DyCrFHW4WvLEOuPKP5t4yVqhc1flcWQRtz5AY,653
-algo_backend/exception/error_code_manage.py,sha256=d29aMgelf93RUqlvLTjQDxBiSH9ZVFYbW66rzTWDKM4,4391
+algo_backend/exception/error_code_manage.py,sha256=7aBGvwepAmZe1VgW87-2_JbBD6eJrmZD6tmsgdczk1k,4338
 algo_backend/exception/exception.py,sha256=Gz5LDsqRct8LON1Aq43TdqQQjyC4_Uy9yeUlO7XtPnM,1962
 algo_backend/exception/status_code.py,sha256=s5lXXR-oSALk3gtI4KcPKHstvnRFArQL1SEgQFIeSxU,2707
-algo_backend/handler/__init__.py,sha256=QUWn5MmDUzqbq_gcoSpMZtPMgfzrkLnlwDbLksXwQVE,104
+algo_backend/handler/__init__.py,sha256=DBUeFrDVm8qhFPahiva93HeYuViPIFL2ZCHg26iupFU,199
 algo_backend/handler/exception_to_vo.py,sha256=uX3JZaPP5Zt1RgJunFfumxpSfWHwcWtKLZ21dIXDraQ,687
-algo_backend/handler/simple_handler.py,sha256=7ffsgjj1EZ_d3x_jx9krju_uwCmwfjXHJ_9KZ8SrpOw,2654
+algo_backend/handler/simple_handler.py,sha256=1Pqpgt-ZKY2ytSAlAXOEqI55C5yein-XSePPD6F8zH4,3010
+algo_backend/handler/sse_handler.py,sha256=NR0RiqYYmNAo57J3qvlbKkIGme3zSq7x2L8enT6sIVs,2844
 algo_backend/intercept/__init__.py,sha256=FoNHCzUc3ceLo85ECN3L7HzW6KmLqcG5sgMh_qULLdw,265
 algo_backend/intercept/common.py,sha256=T50_IAeY0HQ8TbupjYvMHMObg3j9I4lQnqZMiWNzuQw,1445
 algo_backend/intercept/http.py,sha256=C_N2nyErFhdOZ1LPQ6iU_JCy4fFYEucDwhWJb-qBnbc,1381
@@ -24,7 +25,7 @@ algo_backend/log/nblog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 algo_backend/metrics/__init__.py,sha256=20CPEFgi0yJ2Fy-LTcFQ3aqlXHhLPtgPFboqOMBhl34,640
 algo_backend/metrics/http_metrics.py,sha256=3GYNhKJoS6oJ8L7FXnVkPZ_wa-SKj_444KLdBeGkbs4,1944
 algo_backend/metrics/prometheus_context.py,sha256=GqemLccNbTx_5DBijOyzySzWydbpWYfnhWh17rujjwE,1910
-algo_backend/metrics/time_cost_metrics.py,sha256=wXSv3yN6_Eq55KduGy9tIX7sZWsdHI9YBnWoSsT9sZE,4895
+algo_backend/metrics/time_cost_metrics.py,sha256=8a2GgFzeAmf0x4c203C2R5xliza4UIsWE_BwZ8ug3tI,6011
 algo_backend/metrics/collector/__init__.py,sha256=t5Csl-Z9qpik-isEUVYDYBWYgf7xdM49548YfJr4X64,413
 algo_backend/metrics/collector/common.py,sha256=yeiZp9ufbYSW7N-R6ytk74UF0dCqJ8r338lL64TmA4g,475
 algo_backend/metrics/collector/gc_metrics.py,sha256=s2ariKimji9LC71eAQFlrFkpcF3hkSy5IBC6D8LFePc,2510
@@ -33,16 +34,17 @@ algo_backend/metrics/collector/system_metrics.py,sha256=SxOswHKGKLDB5wMsKjd7rkQt
 algo_backend/middleware/__init__.py,sha256=KfSRT3TZ89BzY__Rrbu-9HkjO1LToD5sXyl_J4Po7Q4,173
 algo_backend/middleware/cors.py,sha256=kKdPeZMS38IVvOueJz34lQX1t1hH5OOz068IdIAR-Kc,271
 algo_backend/middleware/metrics.py,sha256=XwZGipQwKp20naZglx41Wc79rXud81Y4AIfswUJj3jM,385
-algo_backend/schema/__init__.py,sha256=STf9SdNuP5dzMDehdGjJGHQ7Pq-qO4jw-5CWsayvx5g,90
+algo_backend/schema/__init__.py,sha256=WhbHgUnPG3B69qJlo-lAmtRhu_LfSwjkBbByLASNcFY,141
+algo_backend/schema/sse.py,sha256=OfVldmgIISvf9xeTurmDp8HDwAN12WrQtZ81JYYA0JI,938
 algo_backend/schema/vo.py,sha256=CSYNHpJx2YNCZ5-4GjjSs6BNKiJEyl31gnplnxGvXfY,2211
 algo_backend/starter/__init__.py,sha256=2AfidtR7PmlhVPz65tt_t3QdIYqpp0mVg8M-lbJE2F4,194
-algo_backend/starter/default_app_generator.py,sha256=fdNPiCyhEQiGCO7NQf9s4urvUXr-iqBcJp1deX9Xu2E,6209
+algo_backend/starter/default_app_generator.py,sha256=KEKVzzb7duZlEkwYsCqum4OmL9p6BfgXK28kt1C8F7k,6215
 algo_backend/starter/default_service_starter.py,sha256=QHVDAS4css7tYCH7Fd_is2uWX8fxV1GD7LAugx904B8,2017
 algo_backend/starter/event_list.py,sha256=vQHzQIpW8LZmQ93YyET-1gX6pQGVE5A6I_pLoYTFOH0,824
 algo_backend/utils/__init__.py,sha256=oX6OyL-28jzc94u4fyH1TtntCzQySkfZ8jibMk1KPU8,168
 algo_backend/utils/meta_class.py,sha256=hcZPGF7EIHvJOXXR82_7Gah_AWbqkcSxUc473I_6maY,1850
 algo_backend/utils/utils.py,sha256=q3bxBrivndLRggWsLryloSpu-_Ecbj4mhZL8oYdiDTo,481
-algo_backend_framework-0.0.4.dist-info/METADATA,sha256=dX_eOI1tqlVzXmJjDu9S6J7h8EtEtWyOeFAysoSp5CI,2196
-algo_backend_framework-0.0.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-algo_backend_framework-0.0.4.dist-info/top_level.txt,sha256=zLsbLTRV1tO2hQfazqiBLO73VnjSAhJSUpMMBmQaLfw,13
-algo_backend_framework-0.0.4.dist-info/RECORD,,
+algo_backend_framework-0.0.5.dist-info/METADATA,sha256=VVoWXuVfk-ZnviGbsLKhdM5Iyk2hh5V9wP39vLp-mU0,2196
+algo_backend_framework-0.0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+algo_backend_framework-0.0.5.dist-info/top_level.txt,sha256=zLsbLTRV1tO2hQfazqiBLO73VnjSAhJSUpMMBmQaLfw,13
+algo_backend_framework-0.0.5.dist-info/RECORD,,