sycommon-python-lib 0.1.9__tar.gz → 0.1.10__tar.gz

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sycommon-python-lib
-Version: 0.1.9
+Version: 0.1.10
 Summary: Add your description here
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sycommon-python-lib"
-version = "0.1.9"
+version = "0.1.10"
 description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.10"

sycommon_python_lib-0.1.10/src/sycommon/middleware/docs.py

@@ -0,0 +1,30 @@
+from fastapi import FastAPI, APIRouter
+from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
+
+
+def setup_docs_handler(app: FastAPI):
+    docs_router = APIRouter()
+
+    @docs_router.get("/docs", include_in_schema=False)
+    async def custom_swagger_ui_html():
+        return get_swagger_ui_html(
+            openapi_url=app.openapi_url,
+            title=f"{app.title}",
+            swagger_favicon_url="https://static.sytechnology.com/img/sylogopng.png",
+            swagger_js_url="https://cdn.bootcdn.net/ajax/libs/swagger-ui/5.27.1/swagger-ui-bundle.js",
+            swagger_css_url="https://cdn.bootcdn.net/ajax/libs/swagger-ui/5.27.1/swagger-ui.css",
+            swagger_ui_parameters={"defaultModelsExpandDepth": -1},
+        )
+
+    @docs_router.get("/redoc", include_in_schema=False)
+    async def custom_redoc_html():
+        return get_redoc_html(
+            openapi_url=app.openapi_url,
+            title=f"{app.title}",
+            redoc_favicon_url="https://static.sytechnology.com/img/sylogopng.png",
+            redoc_js_url="https://cdn.bootcdn.net/ajax/libs/redoc/2.1.5/redoc.standalone.js",
+        )
+
+    app.include_router(docs_router)
+
+    return app

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/src/sycommon/middleware/middleware.py

@@ -1,5 +1,6 @@
 from sycommon.health.ping import setup_ping_handler
 from sycommon.middleware.cors import setup_cors_handler
+from sycommon.middleware.docs import setup_docs_handler
 from sycommon.middleware.exception import setup_exception_handler
 from sycommon.middleware.monitor_memory import setup_monitor_memory_middleware
 from sycommon.middleware.mq import setup_mq_middleware
@@ -36,4 +37,7 @@ class Middleware:
         # 添加mq中间件
         # app = setup_mq_middleware(app)
 
+        # doc
+        # app = setup_docs_handler(app)
+
         return app

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/src/sycommon/middleware/traceid.py

@@ -78,13 +78,19 @@ def setup_trace_id_handler(app):
             response = await call_next(request)
 
             content_type = response.headers.get("Content-Type", "")
+
+            # 处理 SSE 响应 - 关键修复点
             if "text/event-stream" in content_type:
-                # 处理 SSE 响应
+                # 流式响应不能有Content-Length，移除它
+                if "Content-Length" in response.headers:
+                    del response.headers["Content-Length"]
                 response.headers["x-traceId-header"] = trace_id
                 return response
 
+            # 处理普通响应
             response_body = b""
             try:
+                # 收集所有响应块
                 async for chunk in response.body_iterator:
                     response_body += chunk
 
@@ -98,14 +104,36 @@ def setup_trace_id_handler(app):
                         data["traceId"] = trace_id
                         new_body = json.dumps(
                             data, ensure_ascii=False).encode()
+
+                        # 创建新响应，确保Content-Length正确
                         response = Response(
                             content=new_body,
                             status_code=response.status_code,
-                            headers=dict(response.headers)
+                            headers=dict(response.headers),
+                            media_type=response.media_type
                         )
+                        # 显式设置正确的Content-Length
                         response.headers["Content-Length"] = str(len(new_body))
                     except json.JSONDecodeError:
-                        pass
+                        # 如果不是JSON，恢复原始响应体并更新长度
+                        response = Response(
+                            content=response_body,
+                            status_code=response.status_code,
+                            headers=dict(response.headers),
+                            media_type=response.media_type
+                        )
+                        response.headers["Content-Length"] = str(
+                            len(response_body))
+                else:
+                    # 非JSON响应，恢复原始响应体
+                    response = Response(
+                        content=response_body,
+                        status_code=response.status_code,
+                        headers=dict(response.headers),
+                        media_type=response.media_type
+                    )
+                    response.headers["Content-Length"] = str(
+                        len(response_body))
             except StopAsyncIteration:
                 pass
 
@@ -129,7 +157,7 @@ def setup_trace_id_handler(app):
                 "uploaded_files": files_info if files_info else None
             }
             error_message_str = json.dumps(error_message, ensure_ascii=False)
-            SYLogger.error(error_message_str)  # 无需显式传递 trace_id
+            SYLogger.error(error_message_str)
             raise
         finally:
             # 清理上下文变量，防止泄漏

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/src/sycommon/models/base_http.py

@@ -3,14 +3,15 @@ from pydantic import BaseModel, Field
 from fastapi.responses import JSONResponse
 from fastapi import status
 
-# 修改泛型约束，支持任意类型（包括基础类型和BaseModel）
+# 支持任意类型的泛型约束
 T = TypeVar('T')
 
 
 class BaseResponseModel(BaseModel, Generic[T]):
-    """基础响应模型，支持多种数据类型（包括字符串、字典和Pydantic模型）"""
-    code: int = Field(default=0, description="业务响应码，成功0，失败非0")
-    message: str = Field(default="success", description="业务响应信息")
+    """基础响应模型，支持自定义状态码"""
+    code: int = Field(default=0, description="业务响应码，默认0成功，1失败，支持自定义")
+    message: str | None = Field(default=None, description="业务响应信息")
+    success: bool = Field(default=True, description="请求是否成功")
     data: T | None = Field(default=None, description="业务响应数据，支持任意类型")
     traceId: str | None = Field(default=None, description="请求链路追踪ID")
 
@@ -22,22 +23,22 @@ class BaseResponseModel(BaseModel, Generic[T]):
 def build_response_content(
     data: T | Any = None,
     code: int = 0,
-    message: str = "success"
+    message: str = None
 ) -> dict:
     """
-    只构建响应内容的字典部分
+    构建响应内容字典，自动根据code判断success
 
-    Args:
-        data: 响应数据（支持字符串、字典、Pydantic模型等）
-        code: 业务响应码
-        message: 响应信息
-
-    Returns:
-        响应内容字典，格式为{"code": int, "message": str, "data": Any}
+    规则：
+    - code为0时success=True（默认成功）
+    - 其他任何code值success=False（包括200等自定义状态码）
     """
+    # 成功状态仅当code为0时成立，其他任何code都视为失败
+    success = code == 0 or code == 200
+
     response = BaseResponseModel(
         code=code,
         message=message,
+        success=success,
         data=data
     )
 
@@ -45,6 +46,7 @@ def build_response_content(
         return {
             "code": response.code,
             "message": response.message,
+            "success": response.success,
             "data": response.data.model_dump()
         }
     else:
@@ -54,10 +56,10 @@ def build_response_content(
 def create_response(
     data: T | Any = None,
     code: int = 0,
-    message: str = "success",
+    message: str = None,
     status_code: int = status.HTTP_200_OK
 ) -> JSONResponse:
-    """创建完整的JSONResponse响应"""
+    """创建完整响应，支持自定义业务状态码"""
     content = build_response_content(data=data, code=code, message=message)
     return JSONResponse(
         content=content,
@@ -65,18 +67,18 @@ def create_response(
     )
 
 
-def success_response(data: T | Any = None, message: str = "success") -> JSONResponse:
-    """快捷创建成功响应"""
-    return create_response(data=data, message=message)
+def success_response(data: T | Any = None, code: int = 0) -> JSONResponse:
+    """快捷创建成功响应（code=0, success=True）"""
+    return create_response(data=data, code=code)
 
 
 def error_response(
-    message: str = "error",
+    message: str = None,
     code: int = 1,
     data: T | Any = None,
     status_code: int = status.HTTP_500_INTERNAL_SERVER_ERROR
 ) -> JSONResponse:
-    """快捷创建错误响应"""
+    """快捷创建错误响应，支持自定义错误码（如200）"""
     return create_response(
         data=data,
         code=code,
@@ -85,15 +87,15 @@ def error_response(
     )
 
 
-def success_content(data: T | Any = None, message: str = "success") -> dict:
-    """只构建成功响应的内容字典"""
-    return build_response_content(data=data, message=message)
+def success_content(data: T | Any = None) -> dict:
+    """构建成功响应内容字典"""
+    return build_response_content(data=data)
 
 
 def error_content(
-    message: str = "error",
+    message: str = None,
     code: int = 1,
     data: T | Any = None
 ) -> dict:
-    """只构建错误响应的内容字典"""
+    """构建错误响应内容字典，支持自定义错误码"""
     return build_response_content(data=data, code=code, message=message)

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/src/sycommon/services.py

@@ -2,12 +2,13 @@ from typing import Any, Callable, Dict, List, Tuple, Union, Optional, AsyncGener
 import asyncio
 import logging
 from contextlib import asynccontextmanager
-from fastapi import FastAPI
+from fastapi import FastAPI, applications
 from pydantic import BaseModel
 from sycommon.config.Config import SingletonMeta
 from sycommon.models.mqlistener_config import RabbitMQListenerConfig
 from sycommon.models.mqsend_config import RabbitMQSendConfig
 from sycommon.rabbitmq.rabbitmq_service import RabbitMQService
+from sycommon.tools.docs import custom_redoc_html, custom_swagger_ui_html
 
 
 class Services(metaclass=SingletonMeta):
@@ -53,6 +54,9 @@ class Services(metaclass=SingletonMeta):
         # 保存应用实例和配置
         cls._app = app
         cls._config = config
+        # 设置文档
+        applications.get_swagger_ui_html = custom_swagger_ui_html
+        applications.get_redoc_html = custom_redoc_html
 
         # 立即配置非异步服务（在应用启动前）
         if middleware:

sycommon_python_lib-0.1.10/src/sycommon/tools/docs.py

@@ -0,0 +1,42 @@
+from fastapi.openapi.docs import get_swagger_ui_html, get_redoc_html, swagger_ui_default_parameters
+
+
+def custom_swagger_ui_html(*args, **kwargs):
+    custom_params = {
+        "dom_id": "#swagger-ui",
+        "layout": "BaseLayout",
+        "deepLinking": True,
+        "showExtensions": True,
+        "showCommonExtensionsExtensions": True,
+        "defaultModelsExpandDepth": -1,
+        "persistAuthorization": True,
+        "displayRequestDuration": True
+    }
+
+    # 初始化合并参数为默认参数的副本
+    merged_params = swagger_ui_default_parameters.copy()
+
+    # 安全地合并kwargs中的参数（处理可能为None的情况）
+    if "swagger_ui_parameters" in kwargs and kwargs["swagger_ui_parameters"] is not None:
+        merged_params.update(kwargs["swagger_ui_parameters"])
+
+    # 最后应用自定义参数
+    merged_params.update(custom_params)
+    kwargs["swagger_ui_parameters"] = merged_params
+
+    return get_swagger_ui_html(
+        *args, ** kwargs,
+        swagger_favicon_url="https://static.sytechnology.com/img/sylogopng.png",
+        swagger_js_url="https://cdn.bootcdn.net/ajax/libs/swagger-ui/5.27.1/swagger-ui-bundle.js",
+        swagger_css_url="https://cdn.bootcdn.net/ajax/libs/swagger-ui/5.27.1/swagger-ui.css",
+    )
+
+
+def custom_redoc_html(*args, **kwargs):
+    return get_redoc_html(
+        *args,
+        **kwargs,
+        redoc_favicon_url='https://static.sytechnology.com/img/sylogopng.png',
+        # redoc_js_url="https://cdn.jsdelivr.net/npm/@stardustai/redoc@2.0.0-rc.66/bundles/redoc.browser.lib.min.js",
+        with_google_fonts=False,
+    )

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/src/sycommon_python_lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sycommon-python-lib
-Version: 0.1.9
+Version: 0.1.10
 Summary: Add your description here
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{sycommon_python_lib-0.1.9 → sycommon_python_lib-0.1.10}/src/sycommon_python_lib.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ src/sycommon/logging/logger_wrapper.py
 src/sycommon/middleware/__init__.py
 src/sycommon/middleware/context.py
 src/sycommon/middleware/cors.py
+src/sycommon/middleware/docs.py
 src/sycommon/middleware/exception.py
 src/sycommon/middleware/middleware.py
 src/sycommon/middleware/monitor_memory.py
@@ -39,6 +40,7 @@ src/sycommon/synacos/__init__.py
 src/sycommon/synacos/feign.py
 src/sycommon/synacos/nacos_service.py
 src/sycommon/tools/__init__.py
+src/sycommon/tools/docs.py
 src/sycommon/tools/snowflake.py
 src/sycommon/tools/timing.py
 src/sycommon_python_lib.egg-info/PKG-INFO