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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sycommon-python-lib
-Version: 0.1.9
+Version: 0.1.11
 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.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sycommon-python-lib"
-version = "0.1.9"
+version = "0.1.11"
 description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -23,3 +23,6 @@ dependencies = [
 
 [tool.setuptools]
 packages = {find = {where = ["src"]}}
+
+[project.scripts]
+sycommon = "command.cli:main"

sycommon_python_lib-0.1.11/src/command/cli.py

@@ -0,0 +1,167 @@
+import argparse
+import os
+import datetime
+import re
+from pathlib import Path
+from importlib.resources import files
+
+
+def get_all_files_in_directory(directory: Path) -> list[tuple[Path, str]]:
+    """
+    获取目录下所有文件的相对路径（忽略__pycache__目录）
+    返回值: 元组列表 (模板文件路径, 相对目标路径)
+    """
+    file_mappings = []
+    if not directory.exists() or not directory.is_dir():
+        return file_mappings
+
+    # 遍历目录下所有文件
+    for root, _, files in os.walk(directory):
+        # 跳过包含__pycache__的目录
+        if "__pycache__" in root:
+            continue
+
+        for file in files:
+            # 获取文件的绝对路径
+            file_path = Path(root) / file
+            # 计算相对模板目录的路径
+            rel_path = file_path.relative_to(directory)
+            # 添加到映射列表
+            file_mappings.append((file_path, str(rel_path)))
+
+    return file_mappings
+
+
+def init_project(project_name: str, project_type: str) -> None:
+    """
+    初始化项目，自动读取模板文件并替换占位符
+    """
+    project_path = Path(os.getcwd()) / project_name
+    if project_path.exists():
+        print(f"❌ 错误：工程 '{project_path}' 已存在")
+        return
+
+    template_root = files("command.templates")
+    if not template_root.is_dir():
+        print("❌ 错误：未找到模板文件目录（command/templates）")
+        return
+
+    # 处理项目名称
+    short_project_name = project_name.replace("shengye-platform-", "")
+    short_project_name_upper = short_project_name.upper()
+
+    # 定义模板变量
+    context = {
+        "__cli__.project_name": project_name,
+        "__cli__.short_project_name": short_project_name,
+        "__cli__.short_project_name_upper": short_project_name_upper,
+        "__cli__.project_type": project_type,
+        "__cli__.create_time": datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+        "__cli__.author": os.getlogin(),
+        "__cli__.default_port": 8080
+    }
+
+    # 自动获取基础模板文件和特定类型模板文件
+    base_dir = template_root / "base"
+    type_dir = template_root / project_type
+
+    base_files = get_all_files_in_directory(base_dir)
+    type_specific_files = get_all_files_in_directory(type_dir)
+
+    # 合并所有文件映射
+    file_mappings = base_files + type_specific_files
+    copied_files = 0
+
+    # 处理每个文件
+    for template_file, target_rel_path in file_mappings:
+        try:
+            # 1. 读取模板内容
+            template_content = template_file.read_text(encoding="utf-8")
+
+            # 2. 替换所有占位符（包含花括号）
+            rendered_content = template_content
+            for key, value in context.items():
+                # 精确匹配带有花括号的占位符
+                pattern = re.compile(rf'{{\s*{re.escape(key)}\s*}}')
+                rendered_content = pattern.sub(str(value), rendered_content)
+
+            # 3. 清理引号（针对YAML键值对格式）
+            rendered_content = re.sub(
+                r'(\w+)\s*:\s*["\']([^"\']+)["\']',
+                r'\1: \2',
+                rendered_content
+            )
+
+            # 4. 最后检查并移除任何残留的花括号
+            for value in context.values():
+                rendered_content = re.sub(
+                    rf'{{+{re.escape(str(value))}+}}',
+                    str(value),
+                    rendered_content
+                )
+
+            # 5. 处理文件后缀：直接移除.tpl后缀
+            if target_rel_path.endswith('.tpl'):
+                target_rel_path = target_rel_path[:-4]
+
+            # 6. 写入文件
+            target_file = project_path / target_rel_path
+            target_file.parent.mkdir(parents=True, exist_ok=True)
+            target_file.write_text(rendered_content, encoding="utf-8")
+
+            copied_files += 1
+        except Exception as e:
+            print(f"❌ 处理模板 {template_file} 失败: {str(e)}")
+
+    if copied_files > 0:
+        print(f"✅ 模板{project_type}工程 {project_name} 创建完成！")
+        print(f"📁 工程路径：{project_path}")
+        print(f"📊 共创建 {copied_files} 个文件")
+    else:
+        print(f"\n⚠️  未创建任何文件，可能是缺少模板文件或模板路径配置错误")
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        prog="sycommon",
+        description="sycommon 工具集 - 项目初始化工具",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    subparsers = parser.add_subparsers(
+        dest="command", required=True, help="子命令（当前支持：init）"
+    )
+
+    init_parser = subparsers.add_parser(
+        "init",
+        help="创建Web/Agent类型项目模板",
+        formatter_class=argparse.RawTextHelpFormatter,
+        epilog="示例:\n"
+               "  sycommon init web   my_project  # 创建Web类型项目\n"
+               "  sycommon init agent my_project  # 创建AI Agent类型项目"
+    )
+    init_parser.add_argument(
+        "project_type",
+        choices=["web", "agent"],
+        help="项目类型：web - Web服务项目；agent - AI Agent服务项目"
+    )
+    init_parser.add_argument(
+        "project_name",
+        help="工程名称（如 my_web_project，将创建同名根目录）"
+    )
+
+    try:
+        args = parser.parse_args()
+        if args.command == "init":
+            init_project(args.project_name, args.project_type)
+    except argparse.ArgumentError as e:
+        print(f"❌ 错误：{e}\n")
+        print(
+            f"请使用 {parser.prog} {args.command if 'args' in locals() else ''} -h 查看帮助")
+    except SystemExit:
+        pass
+
+
+if __name__ == "__main__":
+    # uv pip install -e .
+    # sycommon init web my_project
+    main()

sycommon_python_lib-0.1.11/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.11}/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.11}/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.11}/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, message: str = None) -> JSONResponse:
+    """快捷创建成功响应（code=0, success=True）"""
+    return create_response(data=data, code=code, message=message)
 
 
 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)