sycommon-python-lib 0.2.0b11__tar.gz → 0.2.0b12__tar.gz

{sycommon_python_lib-0.2.0b11 → sycommon_python_lib-0.2.0b12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sycommon-python-lib
-Version: 0.2.0b11
+Version: 0.2.0b12
 Summary: Add your description here
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -10,6 +10,7 @@ Requires-Dist: aiomysql>=0.3.2
 Requires-Dist: anyio>=4.12.1
 Requires-Dist: decorator>=5.2.1
 Requires-Dist: fastapi>=0.133.1
+Requires-Dist: jinja2>=3.1.6
 Requires-Dist: kafka-python>=2.3.0
 Requires-Dist: langchain>=1.2.10
 Requires-Dist: langchain-core>=1.2.16

{sycommon_python_lib-0.2.0b11 → sycommon_python_lib-0.2.0b12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sycommon-python-lib"
-version = "0.2.0b11"
+version = "0.2.0b12"
 description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -11,6 +11,7 @@ dependencies = [
     "anyio>=4.12.1",
     "decorator>=5.2.1",
     "fastapi>=0.133.1",
+    "jinja2>=3.1.6",
     "kafka-python>=2.3.0",
     "langchain>=1.2.10",
     "langchain-core>=1.2.16",

sycommon_python_lib-0.2.0b12/src/command/__init__.py

@@ -0,0 +1,21 @@
+"""
+sycommon CLI 工具集
+"""
+from .models import FeatureOptions
+from .console import print_info, print_success, print_error, print_warning, Colors
+from .utils import get_all_files_in_directory
+from .project import init_project, interactive_feature_selection
+from .cli import main
+
+__all__ = [
+    "FeatureOptions",
+    "print_info",
+    "print_success",
+    "print_error",
+    "print_warning",
+    "Colors",
+    "get_all_files_in_directory",
+    "init_project",
+    "interactive_feature_selection",
+    "main",
+]

sycommon_python_lib-0.2.0b12/src/command/cli.py

@@ -0,0 +1,171 @@
+"""
+sycommon CLI 工具集
+
+Usage:
+    sycommon init web my_project              # 交互式创建Web项目
+    sycommon init agent my_project            # 交互式创建Agent项目
+    sycommon init web my_project --with-db    # 命令行指定功能
+    sycommon version                          # 显示版本
+"""
+import argparse
+import sys
+from importlib.metadata import version, PackageNotFoundError
+
+from .models import FeatureOptions
+from .project import init_project
+from .console import print_error, print_info
+
+
+def get_version() -> str:
+    """获取已安装的库版本"""
+    try:
+        return version("sycommon-python-lib")
+    except PackageNotFoundError:
+        return "unknown (未安装)"
+
+
+def create_init_parser(subparsers) -> None:
+    """创建 init 子命令解析器"""
+    init_parser = subparsers.add_parser(
+        "init",
+        help="创建Web/Agent类型项目模板",
+        formatter_class=argparse.RawTextHelpFormatter,
+        epilog="""
+示例: 
+  uv pip install -e .
+  sycommon init web my_project              # 交互式创建Web项目
+  sycommon init agent my_project            # 交互式创建Agent项目
+  sycommon init web my_project --dry-run    # 预览将要创建的文件
+  sycommon init web my_project --force      # 强制覆盖已存在的目录
+  sycommon init web my_project -q           # 静默模式（使用默认配置）
+  sycommon init web my_project --with-db --with-mq --with-redis
+
+项目类型说明:
+  web   - 标准 FastAPI Web 服务，适合 RESTful API 开发
+  agent - AI Agent 服务，基于 langgraph 实现状态图
+
+Agent 项目结构:
+  agent/           - Agent 核心 (main_agent, nodes, states, enums)
+  api/sse/         - SSE 流式接口
+  tools/           - 工具函数 (含 MQ 处理)
+  db/              - 数据库服务
+  model/           - 数据模型
+
+Web 项目结构:
+  api/             - API 接口 (含 SSE)
+  tools/           - 工具函数
+  model/           - 数据模型
+  client/          - 外部服务客户端
+"""
+    )
+
+    # 位置参数
+    init_parser.add_argument(
+        "project_type",
+        choices=["web", "agent"],
+        help="项目类型：web / agent"
+    )
+    init_parser.add_argument(
+        "project_name",
+        help="工程名称"
+    )
+
+    # 功能选项
+    feature_group = init_parser.add_argument_group("功能选项")
+    feature_group.add_argument("--with-db", action="store_true", help="启用数据库")
+    feature_group.add_argument(
+        "--with-mq", action="store_true", help="启用 RabbitMQ")
+    feature_group.add_argument(
+        "--with-sse", action="store_true", help="启用 SSE 流式")
+    feature_group.add_argument(
+        "--with-redis", action="store_true", help="启用 Redis")
+    feature_group.add_argument(
+        "--no-nacos", action="store_true", help="禁用 Nacos")
+    feature_group.add_argument(
+        "--no-kafka", action="store_true", help="禁用 Kafka 日志")
+    feature_group.add_argument("--no-llm", action="store_true", help="禁用 LLM")
+
+    # 行为选项
+    behavior_group = init_parser.add_argument_group("行为选项")
+    behavior_group.add_argument(
+        "-n", "--dry-run", action="store_true", help="仅预览")
+    behavior_group.add_argument(
+        "-f", "--force", action="store_true", help="强制覆盖")
+    behavior_group.add_argument(
+        "-q", "--quiet", action="store_true", help="静默模式")
+    behavior_group.add_argument(
+        "-v", "--verbose", action="store_true", help="详细输出")
+
+
+def handle_init_command(args) -> bool:
+    """处理 init 命令"""
+    # 判断是否使用命令行模式
+    use_cli_mode = any([
+        args.with_db, args.with_mq, args.with_sse, args.with_redis,
+        args.no_nacos, args.no_kafka, args.no_llm
+    ])
+
+    if use_cli_mode or args.quiet:
+        features = FeatureOptions(
+            database=args.with_db,
+            rabbitmq=args.with_mq,
+            nacos=not args.no_nacos,
+            kafka_log=not args.no_kafka,
+            sse=args.with_sse,
+            llm=not args.no_llm,
+            redis=args.with_redis,
+        )
+    else:
+        features = None  # 交互式选择
+
+    verbose = args.verbose or not args.quiet
+
+    return init_project(
+        project_name=args.project_name,
+        project_type=args.project_type,
+        features=features,
+        dry_run=args.dry_run,
+        force=args.force,
+        verbose=verbose
+    )
+
+
+def main() -> None:
+    """CLI 主入口"""
+    parser = argparse.ArgumentParser(
+        prog="sycommon",
+        description="sycommon 工具集 - 项目初始化工具",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    subparsers = parser.add_subparsers(
+        dest="command", required=True, help="子命令")
+
+    # 注册子命令
+    create_init_parser(subparsers)
+    subparsers.add_parser("version", help="显示版本信息")
+
+    try:
+        args = parser.parse_args()
+
+        if args.command == "version":
+            print(f"sycommon {get_version()}")
+            return
+
+        if args.command == "init":
+            success = handle_init_command(args)
+            if not success:
+                sys.exit(1)
+
+    except argparse.ArgumentError as e:
+        print_error(str(e))
+        cmd = args.command if 'args' in locals() and hasattr(args, 'command') else ''
+        print_info(f"使用 {parser.prog} {cmd} -h 查看帮助")
+        sys.exit(1)
+    except KeyboardInterrupt:
+        print("\n")
+        print_info("操作已取消")
+        sys.exit(130)
+
+
+if __name__ == "__main__":
+    main()

sycommon_python_lib-0.2.0b12/src/command/console.py

@@ -0,0 +1,36 @@
+"""
+控制台输出工具
+"""
+
+
+class Colors:
+    """颜色输出"""
+    HEADER = '\033[95m'
+    OKBLUE = '\033[94m'
+    OKCYAN = '\033[96m'
+    OKGREEN = '\033[92m'
+    WARNING = '\033[93m'
+    FAIL = '\033[91m'
+    ENDC = '\033[0m'
+    BOLD = '\033[1m'
+
+
+def print_info(msg: str, verbose: bool = True) -> None:
+    """打印信息"""
+    if verbose:
+        print(f"{Colors.OKCYAN}ℹ {msg}{Colors.ENDC}")
+
+
+def print_success(msg: str) -> None:
+    """打印成功"""
+    print(f"{Colors.OKGREEN}✅ {msg}{Colors.ENDC}")
+
+
+def print_error(msg: str) -> None:
+    """打印错误"""
+    print(f"{Colors.FAIL}❌ {msg}{Colors.ENDC}")
+
+
+def print_warning(msg: str) -> None:
+    """打印警告"""
+    print(f"{Colors.WARNING}⚠️  {msg}{Colors.ENDC}")

sycommon_python_lib-0.2.0b12/src/command/models.py

@@ -0,0 +1,28 @@
+"""
+CLI 数据模型
+"""
+from dataclasses import dataclass
+
+
+@dataclass
+class FeatureOptions:
+    """功能模块选项"""
+    database: bool = False
+    rabbitmq: bool = False
+    nacos: bool = True  # 默认开启
+    kafka_log: bool = True  # 默认开启
+    sse: bool = False
+    llm: bool = True  # 默认开启
+    redis: bool = False  # Redis 缓存
+
+    def to_template_vars(self) -> dict:
+        """转换为模板变量"""
+        return {
+            "feature_database": str(self.database).lower(),
+            "feature_rabbitmq": str(self.rabbitmq).lower(),
+            "feature_nacos": str(self.nacos).lower(),
+            "feature_kafka_log": str(self.kafka_log).lower(),
+            "feature_sse": str(self.sse).lower(),
+            "feature_llm": str(self.llm).lower(),
+            "feature_redis": str(self.redis).lower(),
+        }

sycommon_python_lib-0.2.0b12/src/command/project.py

@@ -0,0 +1,234 @@
+"""
+项目初始化逻辑
+"""
+import os
+import re
+import datetime
+from pathlib import Path
+from importlib.resources import files
+from typing import Optional
+
+from jinja2 import Environment, BaseLoader, TemplateSyntaxError
+
+from .models import FeatureOptions
+from .console import (
+    print_info, print_success, print_error, print_warning, Colors
+)
+from .utils import get_all_files_in_directory
+
+
+def interactive_feature_selection() -> FeatureOptions:
+    """交互式功能选择"""
+    print(f"\n{Colors.HEADER}🔧 功能模块配置{Colors.ENDC}")
+    print("-" * 40)
+
+    def ask_yes_no(question: str, default: bool = False) -> bool:
+        default_str = "Y/n" if default else "y/N"
+        while True:
+            response = input(f"  {question} [{default_str}]: ").strip().lower()
+            if not response:
+                return default
+            if response in ('y', 'yes', '是'):
+                return True
+            if response in ('n', 'no', '否'):
+                return False
+            print_warning("请输入 y/n")
+
+    return FeatureOptions(
+        database=ask_yes_no("启用数据库 (MySQL)?", default=False),
+        rabbitmq=ask_yes_no("启用 RabbitMQ 消息队列?", default=False),
+        nacos=ask_yes_no("启用 Nacos 服务注册?", default=True),
+        kafka_log=ask_yes_no("启用 Kafka 日志?", default=True),
+        sse=ask_yes_no("启用 SSE 流式响应?", default=False),
+        llm=ask_yes_no("启用 LLM 大模型支持?", default=True),
+        redis=ask_yes_no("启用 Redis 缓存?", default=False),
+    )
+
+
+def init_project(
+    project_name: str,
+    project_type: str,
+    features: Optional[FeatureOptions] = None,
+    dry_run: bool = False,
+    force: bool = False,
+    verbose: bool = True
+) -> bool:
+    """
+    初始化项目，自动读取模板文件并替换占位符
+
+    Args:
+        project_name: 项目名称
+        project_type: 项目类型 (web/agent)
+        features: 功能选项，为 None 时使用交互式选择
+        dry_run: 仅预览，不实际创建文件
+        force: 强制覆盖已存在的目录
+        verbose: 显示详细输出
+
+    Returns:
+        是否成功
+    """
+    project_path = Path(os.getcwd()) / project_name
+
+    # 检查目录是否存在
+    if project_path.exists():
+        if not force:
+            print_error(f"工程 '{project_path}' 已存在")
+            print_info("使用 --force 参数强制覆盖", verbose)
+            return False
+        elif dry_run:
+            print_warning(f"[DRY-RUN] 将覆盖已存在的目录: {project_path}")
+        else:
+            print_warning(f"将覆盖已存在的目录: {project_path}")
+
+    # 交互式功能选择
+    if features is None:
+        try:
+            features = interactive_feature_selection()
+        except KeyboardInterrupt:
+            print("\n")
+            print_info("操作已取消")
+            return False
+
+    # 模板目录检查
+    template_root = files("command.templates")
+    if not template_root.is_dir():
+        print_error("未找到模板文件目录（command/templates）")
+        return False
+
+    # 处理项目名称
+    short_project_name = project_name.replace("shengye-platform-", "")
+    short_project_name_upper = short_project_name.upper()
+
+    # 定义模板变量
+    context = {
+        "project_name": project_name,
+        "short_project_name": short_project_name,
+        "short_project_name_upper": short_project_name_upper,
+        "project_type": project_type,
+        "create_time": datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+        "author": os.getlogin(),
+        "default_port": 8080,
+    }
+    context.update(features.to_template_vars())
+
+    # 获取模板文件
+    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
+
+    # Dry run 模式
+    if dry_run:
+        return _dry_run(file_mappings, features, verbose)
+
+    # 创建目录
+    if not project_path.exists():
+        project_path.mkdir(parents=True)
+
+    # 渲染并写入文件
+    copied_files = _render_files(file_mappings, context, project_path, verbose)
+
+    if copied_files > 0:
+        _print_success_message(project_path, project_name, copied_files)
+        return True
+    else:
+        print_warning("未创建任何文件，可能是缺少模板文件或模板路径配置错误")
+        return False
+
+
+def _dry_run(
+    file_mappings: list,
+    features: FeatureOptions,
+    verbose: bool
+) -> bool:
+    """预览模式"""
+    print_info(f"\n📋 预览将要创建的文件 (共 {len(file_mappings)} 个):", verbose)
+    print("-" * 40)
+    for _, target_rel_path in file_mappings:
+        if target_rel_path.endswith('.tpl'):
+            target_rel_path = target_rel_path[:-4]
+        print(f"  📄 {target_rel_path}")
+    print("-" * 40)
+    print_info("功能配置:", verbose)
+    print(f"    数据库: {'✓' if features.database else '✗'}")
+    print(f"    RabbitMQ: {'✓' if features.rabbitmq else '✗'}")
+    print(f"    Nacos: {'✓' if features.nacos else '✗'}")
+    print(f"    Kafka日志: {'✓' if features.kafka_log else '✗'}")
+    print(f"    SSE流式: {'✓' if features.sse else '✗'}")
+    print(f"    LLM支持: {'✓' if features.llm else '✗'}")
+    print(f"    Redis缓存: {'✓' if features.redis else '✗'}")
+    return True
+
+
+def _render_files(
+    file_mappings: list,
+    context: dict,
+    project_path: Path,
+    verbose: bool
+) -> int:
+    """渲染并写入文件"""
+    jinja_env = Environment(
+        loader=BaseLoader(),
+        trim_blocks=True,
+        lstrip_blocks=True,
+    )
+
+    copied_files = 0
+
+    for template_file, target_rel_path in file_mappings:
+        try:
+            # 读取模板内容
+            template_content = template_file.read_text(encoding="utf-8")
+
+            # 使用 Jinja2 渲染
+            try:
+                jinja_template = jinja_env.from_string(template_content)
+                rendered_content = jinja_template.render(context)
+            except TemplateSyntaxError:
+                # 回退到简单替换
+                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)
+
+            # 清理引号
+            rendered_content = re.sub(
+                r'(\w+)\s*:\s*["\']([^"\']+)["\']',
+                r'\1: \2',
+                rendered_content
+            )
+
+            # 处理文件后缀
+            if target_rel_path.endswith('.tpl'):
+                target_rel_path = target_rel_path[:-4]
+
+            # 写入文件
+            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")
+
+            print_info(f"创建: {target_rel_path}", verbose)
+            copied_files += 1
+
+        except Exception as e:
+            print_error(f"处理模板 {template_file} 失败: {str(e)}")
+
+    return copied_files
+
+
+def _print_success_message(
+    project_path: Path,
+    project_name: str,
+    copied_files: int
+) -> None:
+    """打印成功信息"""
+    print_success(f"模板工程 {project_name} 创建完成！")
+    print(f"📁 工程路径：{project_path}")
+    print(f"📊 共创建 {copied_files} 个文件")
+    print()
+    print_info("下一步操作:")
+    print(f"  cd {project_name}")
+    print(f"  pip install -r requirements.txt")
+    print(f"  python app.py")

sycommon_python_lib-0.2.0b12/src/command/utils.py

@@ -0,0 +1,31 @@
+"""
+工具函数
+"""
+import os
+from pathlib import Path
+
+
+def get_all_files_in_directory(directory: Path) -> list[tuple[Path, str]]:
+    """
+    获取目录下所有文件的相对路径（忽略__pycache__目录）
+
+    Args:
+        directory: 目录路径
+
+    Returns:
+        元组列表 (模板文件路径, 相对目标路径)
+    """
+    file_mappings = []
+    if not directory.exists() or not directory.is_dir():
+        return file_mappings
+
+    for root, _, files in os.walk(directory):
+        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

{sycommon_python_lib-0.2.0b11 → sycommon_python_lib-0.2.0b12}/src/sycommon/llm/get_llm.py

@@ -3,7 +3,8 @@ from langchain.chat_models import init_chat_model
 from sycommon.config.LLMConfig import LLMConfig
 from sycommon.llm.sy_langfuse import LangfuseInitializer
 from sycommon.llm.usage_token import LLMWithAutoTokenUsage
-from typing import Any
+from typing import Any, Union
+from langchain_core.language_models import BaseChatModel
 
 
 def get_llm(
@@ -13,8 +14,9 @@ def get_llm(
     temperature: float = 0.1,
     timeout: float = 180,
     max_retries: int = 3,
+    wrap_structured: bool = True,
     **kwargs: Any
-) -> LLMWithAutoTokenUsage:
+) -> Union[LLMWithAutoTokenUsage, BaseChatModel]:
     """
     获取LLM实例
 
@@ -24,20 +26,29 @@ def get_llm(
         temperature: 温度参数
         timeout: 请求超时时间（秒），默认180秒
         max_retries: 最大重试次数，默认3次
+        wrap_structured: 是否包装为结构化输出实例，默认True
+            - True: 返回 LLMWithAutoTokenUsage，支持 with_structured_output()
+            - False: 返回原始 BaseChatModel，保留日志和 Langfuse 跟踪
         **kwargs: 其他透传参数，支持 langchain init_chat_model 所有参数
             - presence_penalty: 存在惩罚
             - extra_body: 额外请求体参数，如 {"top_k": 20, "chat_template_kwargs": {"enable_thinking": False}}
             - top_p: 核采样参数
             - frequency_penalty: 频率惩罚
             - model_kwargs: 模型特定参数
+            - summary_prompt: 结构化输出时的摘要提示词（仅 wrap_structured=True 时有效）
 
     Returns:
-        LLMWithAutoTokenUsage: 包装后的LLM实例
+        LLMWithAutoTokenUsage | BaseChatModel: 根据 wrap_structured 参数返回对应类型
 
     Example:
         ```python
-        # 基础用法
+        # 结构化输出（默认）
         llm = get_llm("Qwen2.5-72B")
+        chain = llm.with_structured_output(MyModel)
+
+        # 普通 LLM 调用，保留日志和 Langfuse
+        llm = get_llm("Qwen2.5-72B", wrap_structured=False)
+        response = await llm.ainvoke([HumanMessage(content="你好")])
 
         # 透传额外参数
         llm = get_llm(
@@ -82,6 +93,10 @@ def get_llm(
     if llm is None:
         raise Exception(f"初始化原始LLM实例失败：{model}")
 
+    # 如果不需要结构化输出包装，直接返回原始 LLM（仍保留日志和 Langfuse 跟踪）
+    if not wrap_structured:
+        return llm
+
     # 获取kwargs中summary_prompt参数
     summary_prompt: str = kwargs.get("summary_prompt")