devlake-mcp 0.4.1__py3-none-any.whl

devlake_mcp/config.py

@@ -0,0 +1,204 @@
+"""
+DevLake 配置管理
+
+统一管理 DevLake 的所有配置：
+- MCP 服务器配置（DevLakeConfig）
+- Hooks 环境配置（init_hooks_env）
+- Git 信息缓存机制
+"""
+
+import os
+import sys
+from dataclasses import dataclass
+from typing import Optional, Dict
+
+# 导入常量配置
+from .constants import (
+    DEFAULT_API_BASE_URL,
+    API_REQUEST_TIMEOUT,
+)
+
+
+@dataclass
+class DevLakeConfig:
+    """DevLake 配置类（用于 MCP 服务器和 Hooks）"""
+
+    # API 基础 URL
+    base_url: str
+
+    # API Token（如果需要认证）
+    api_token: Optional[str] = None
+
+    # 超时设置（秒）
+    timeout: int = 30
+
+    # 是否启用 SSL 验证
+    verify_ssl: bool = True
+
+    # Git 配置（用于 Hooks）
+    git_repo_path: Optional[str] = None
+    git_email: Optional[str] = None
+    git_author: Optional[str] = None
+
+    @classmethod
+    def from_env(cls, include_git: bool = False) -> "DevLakeConfig":
+        """
+        从环境变量加载配置
+
+        Args:
+            include_git: 是否包含 Git 配置（Hooks 使用）
+
+        环境变量：
+        - DEVLAKE_BASE_URL: DevLake API 地址（默认：http://devlake.test.chinawayltd.com）
+        - DEVLAKE_API_TOKEN: API Token（可选）
+        - DEVLAKE_TIMEOUT: 请求超时时间（默认：5 秒）
+        - DEVLAKE_VERIFY_SSL: 是否验证 SSL（默认：true）
+
+        Git 环境变量（include_git=True 时）：
+        - GIT_REPO_PATH: Git仓库路径
+        - GIT_EMAIL: Git邮箱
+        - GIT_AUTHOR: Git用户名
+
+        Returns:
+            DevLakeConfig: 配置实例
+        """
+        # API 配置
+        base_url = os.getenv('DEVLAKE_BASE_URL', DEFAULT_API_BASE_URL)
+        api_token = os.getenv('DEVLAKE_API_TOKEN')
+        timeout = int(os.getenv('DEVLAKE_TIMEOUT', str(API_REQUEST_TIMEOUT)))
+        verify_ssl = os.getenv('DEVLAKE_VERIFY_SSL', "true").lower() == "true"
+
+        config = cls(
+            base_url=base_url.rstrip("/"),
+            api_token=api_token,
+            timeout=timeout,
+            verify_ssl=verify_ssl
+        )
+
+        # 加载 Git 配置（Hooks 专用）
+        if include_git:
+            config._load_git_config()
+
+        return config
+
+    def _load_git_config(self) -> None:
+        """加载 Git 配置并同步到环境变量（内部方法）"""
+        self.git_repo_path = os.getenv('GIT_REPO_PATH')
+        self.git_email = os.getenv('GIT_EMAIL')
+        self.git_author = os.getenv('GIT_AUTHOR')
+
+        # 如果环境变量未设置，尝试从 Git 配置读取
+        if not self.git_repo_path or not self.git_email:
+            try:
+                from .git_utils import get_git_repo_path, get_git_info
+
+                cwd = os.getcwd()
+
+                if not self.git_repo_path:
+                    self.git_repo_path = get_git_repo_path(cwd)
+                    os.environ['GIT_REPO_PATH'] = self.git_repo_path
+
+                if not self.git_email or not self.git_author:
+                    git_info = get_git_info(cwd, include_user_info=True)
+                    if not self.git_email:
+                        self.git_email = git_info.get('git_email', 'unknown')
+                        os.environ['GIT_EMAIL'] = self.git_email
+                    if not self.git_author:
+                        self.git_author = git_info.get('git_author', 'unknown')
+                        os.environ['GIT_AUTHOR'] = self.git_author
+
+            except Exception as e:
+                print(f"\n⚠️  警告：获取 Git 配置失败：{str(e)}", file=sys.stderr)
+                if not self.git_repo_path:
+                    self.git_repo_path = 'unknown'
+                    os.environ['GIT_REPO_PATH'] = 'unknown'
+                if not self.git_email:
+                    self.git_email = 'unknown'
+                    os.environ['GIT_EMAIL'] = 'unknown'
+                if not self.git_author:
+                    self.git_author = 'unknown'
+                    os.environ['GIT_AUTHOR'] = 'unknown'
+
+        # 验证必需的 Git 配置
+        self._validate_git_config()
+
+    def _validate_git_config(self):
+        """验证 Git 配置（内部方法）"""
+        missing_configs = []
+
+        if not self.git_repo_path or self.git_repo_path == 'unknown' or self.git_repo_path.startswith('local/'):
+            missing_configs.append('remote.origin.url')
+
+        if not self.git_email or self.git_email == 'unknown':
+            missing_configs.append('user.email')
+
+        if missing_configs:
+            print("\n" + "="*60, file=sys.stderr)
+            print("❌ 错误：缺少必需的 Git 配置", file=sys.stderr)
+            print("="*60, file=sys.stderr)
+            print("\n📝 请按照以下步骤配置 Git：\n", file=sys.stderr)
+
+            if 'remote.origin.url' in missing_configs:
+                print("1️⃣  配置 Git 远程仓库：", file=sys.stderr)
+                print("   git remote add origin <repository-url>", file=sys.stderr)
+                print("", file=sys.stderr)
+
+            if 'user.email' in missing_configs:
+                print("2️⃣  配置 Git 用户邮箱：", file=sys.stderr)
+                print("   git config user.email 'your-email@example.com'", file=sys.stderr)
+                print("", file=sys.stderr)
+
+            print("💡 提示：配置完成后，请重新运行命令。", file=sys.stderr)
+            print("="*60 + "\n", file=sys.stderr)
+            sys.exit(2)
+
+    def get_headers(self) -> Dict[str, str]:
+        """
+        获取请求头
+
+        Returns:
+            dict: 请求头字典
+        """
+        headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+        }
+
+        if self.api_token:
+            headers["Authorization"] = f"Bearer {self.api_token}"
+
+        return headers
+
+    @classmethod
+    def initialize_for_hooks(cls) -> "DevLakeConfig":
+        """
+        为 Hooks 环境初始化配置
+
+        这个方法会：
+        1. 从环境变量加载 API 配置
+        2. 获取静态 Git 信息（author, email, repo_path）并缓存到环境变量
+        3. 验证配置完整性
+
+        注意：
+        - 只缓存静态信息（author, email, repo_path）
+        - 动态信息（branch, commit）每次都重新获取，确保最新值
+
+        Returns:
+            DevLakeConfig: 已初始化的配置实例
+
+        使用示例：
+            # 在 hooks 启动脚本中调用一次
+            config = DevLakeConfig.initialize_for_hooks()
+
+            # 静态信息从环境变量读取（已缓存）
+            git_author = os.getenv('GIT_AUTHOR')
+            git_email = os.getenv('GIT_EMAIL')
+
+            # 动态信息每次获取最新值
+            git_info = get_git_info(cwd, include_user_info=False)
+            git_branch = git_info.get('git_branch')
+        """
+        # 加载配置并获取静态 Git 信息（会自动缓存到环境变量）
+        config = cls.from_env(include_git=True)
+
+        return config

devlake_mcp/constants.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+DevLake MCP 常量配置
+
+集中管理所有魔法值，提高代码可维护性。
+"""
+
+from typing import Set
+
+# ============================================================================
+# Git 配置
+# ============================================================================
+
+# Git 命令超时时间（秒）
+GIT_COMMAND_TIMEOUT: int = 1
+
+
+# ============================================================================
+# 文件过滤配置
+# ============================================================================
+
+# 敏感文件模式（包含这些关键词的文件不采集）
+SENSITIVE_FILE_PATTERNS: list[str] = [
+    '.env',
+    '.env.',           # .env.local, .env.production 等
+    '.secret',
+    '.secrets',
+    '.key',
+    '.pem',
+    '.crt',
+    '.p12',
+    '.pfx',
+    'credentials',
+    'password',
+    '.npmrc',          # npm 配置
+    '.pypirc',         # PyPI 配置
+    'id_rsa',          # SSH 私钥
+    'id_dsa',
+    'id_ecdsa',
+    'id_ed25519',
+]
+
+# 敏感目录（这些目录下的文件不采集）
+SENSITIVE_DIRS: list[str] = [
+    '.ssh',
+    '.gnupg',
+    '.aws',
+    '.azure',
+    '.config',
+    'node_modules',    # 前端依赖
+    '.venv',           # Python 虚拟环境
+    'venv',
+    '__pycache__',
+    '.git',            # Git 元数据
+]
+
+# 二进制文件扩展名（这些文件不采集）
+BINARY_FILE_EXTENSIONS: Set[str] = {
+    # 图片
+    '.png', '.jpg', '.jpeg', '.gif', '.bmp', '.ico', '.svg', '.webp',
+    # 压缩包
+    '.zip', '.tar', '.gz', '.bz2', '.rar', '.7z', '.xz',
+    # 文档
+    '.pdf', '.doc', '.docx', '.xls', '.xlsx', '.ppt', '.pptx',
+    # 可执行文件
+    '.exe', '.dll', '.so', '.dylib', '.app', '.dmg',
+    # 编译产物
+    '.class', '.pyc', '.pyo', '.o', '.a', '.jar',
+    # 音视频
+    '.mp3', '.mp4', '.avi', '.mov', '.wav', '.flac',
+    # 字体
+    '.ttf', '.otf', '.woff', '.woff2', '.eot',
+}
+
+
+# ============================================================================
+# API 配置
+# ============================================================================
+
+# API 请求超时时间（秒）
+API_REQUEST_TIMEOUT: int = 5
+
+# API 默认基础 URL
+DEFAULT_API_BASE_URL: str = "http://devlake.test.chinawayltd.com"
+
+# 最大内容大小（字节）- 10MB
+MAX_CONTENT_SIZE: int = 10 * 1024 * 1024
+
+
+# ============================================================================
+# 临时文件配置
+# ============================================================================
+
+# 临时文件最大保留时间（小时）
+TEMP_FILE_MAX_AGE_HOURS: int = 24
+
+# 临时目录默认名称
+TEMP_DIR_NAME: str = 'devlake_mcp'
+
+
+# ============================================================================
+# Hooks 配置
+# ============================================================================
+
+# Hook 执行超时时间（秒）
+HOOK_EXECUTION_TIMEOUT: int = 5
+
+# Hook 日志目录（默认为项目目录）
+HOOK_LOG_DIR: str = '.claude/logs'  # Claude Code hooks 日志目录（项目）
+CURSOR_HOOK_LOG_DIR: str = '.cursor/logs'  # Cursor hooks 日志目录（项目）
+
+# 全局日志目录（当使用全局配置时）
+GLOBAL_HOOK_LOG_DIR: str = None  # 运行时动态设置为 ~/.claude/logs
+GLOBAL_CURSOR_HOOK_LOG_DIR: str = None  # 运行时动态设置为 ~/.cursor/logs
+
+# 默认 IDE 类型
+DEFAULT_IDE_TYPE: str = 'claude_code'
+
+# 默认模型名称
+DEFAULT_MODEL_NAME: str = 'claude-sonnet-4-5'
+
+
+# ============================================================================
+# Generation 配置
+# ============================================================================
+
+# Generation 状态文件名
+GENERATION_STATE_FILE_NAME: str = 'generation_state.json'
+
+# Generation 状态最大保留时间（小时）- 超过此时间的状态可以被清理
+GENERATION_STATE_MAX_AGE_HOURS: int = 24
+
+
+# ============================================================================
+# Transcript 压缩配置
+# ============================================================================
+
+# Transcript 压缩阈值（字节）- 超过此大小才进行压缩
+# 1MB = 1 * 1024 * 1024 bytes * 0.5
+TRANSCRIPT_COMPRESSION_THRESHOLD: int = 1 * 1024 * 1024 * 0.5
+
+# Transcript 压缩算法
+TRANSCRIPT_COMPRESSION_ALGORITHM: str = 'gzip'
+
+
+# ============================================================================
+# 日志配置
+# ============================================================================
+
+# 日志级别映射（字符串 -> logging 常量）
+VALID_LOG_LEVELS: dict[str, int] = {
+    'DEBUG': 10,     # logging.DEBUG
+    'INFO': 20,      # logging.INFO
+    'WARNING': 30,   # logging.WARNING
+    'ERROR': 40,     # logging.ERROR
+    'CRITICAL': 50,  # logging.CRITICAL
+}
+
+# 默认日志级别
+DEFAULT_LOG_LEVEL: str = 'INFO'

devlake_mcp/enums.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+枚举类型定义模块
+
+提供项目中使用的所有枚举类型
+"""
+
+from enum import Enum
+
+
+class IDEType(str, Enum):
+    """
+    支持的 IDE 类型枚举
+
+    继承 str 以便：
+    1. 直接用于字符串比较和拼接
+    2. JSON 序列化时自动转换为字符串
+    3. 向后兼容现有字符串参数
+
+    使用示例：
+        # 作为参数
+        start_generation(session_id, ide_type=IDEType.CLAUDE_CODE)
+
+        # 字符串比较
+        if ide_type == IDEType.CLAUDE_CODE:
+            ...
+
+        # 获取字符串值
+        ide_type.value  # 'claude_code'
+
+        # 从字符串创建
+        IDEType('claude_code')  # IDEType.CLAUDE_CODE
+    """
+    CLAUDE_CODE = 'claude_code'  # Anthropic Claude Code
+    CURSOR = 'cursor'            # Cursor AI IDE
+    QODER = 'qoder'              # Qoder IDE (未来支持)
+    UNKNOWN = 'unknown'          # 未知或不支持的 IDE
+
+    @classmethod
+    def from_string(cls, value: str) -> 'IDEType':
+        """
+        从字符串创建枚举（安全转换）
+
+        Args:
+            value: IDE 类型字符串
+
+        Returns:
+            对应的 IDEType 枚举值，无效值返回 UNKNOWN
+
+        示例：
+            IDEType.from_string('claude_code')  # IDEType.CLAUDE_CODE
+            IDEType.from_string('invalid')      # IDEType.UNKNOWN
+        """
+        try:
+            return cls(value.lower())
+        except (ValueError, AttributeError):
+            return cls.UNKNOWN