mirror of
https://github.com/zhenxun-org/zhenxun_bot.git
synced 2026-10-18 02:30:08 +08:00
✨ 支持git更新(github与aliyun codeup),插件商店支持aliyun codeup (#1999)
* ✨ feat(env): 支持git更新 * ✨ feat(aliyun): 更新阿里云URL构建逻辑,支持组织名称并优化令牌解码处理 * ✨ feat(config): 修改错误提示信息,更新基础配置文件名称为.env.example * ⚡ 插件商店支持aliyun * ✨ feat(store): 优化插件数据获取逻辑,合并插件列表和额外插件列表 * 🐛 修复非git仓库的初始化更新 * ✨ feat(update): 增强更新提示信息,添加非git源的变更文件说明 * 🎨 代码格式化 * ✨ webui与resources支持git更新 * ✨ feat(update): 更新webui路径处理逻辑 * Fix/test_runwork (#2001) * fix(test): 修复测试工作流 - 修改自动更新模块中的导入路径 - 更新插件商店模块中的插件信息获取逻辑 - 优化插件添加、更新和移除流程 - 统一插件相关错误信息的格式 - 调整测试用例以适应新的插件管理逻辑 * test(builtin_plugins): 重构插件商店相关测试 - 移除 jsd 相关测试用例,只保留 gh(GitHub)的测试 - 删除了 test_plugin_store.py 文件,清理了插件商店的测试 - 更新了 test_search_plugin.py 中的插件版本号 - 调整了 test_update_plugin.py 中的已加载插件版本 - 移除了 StoreManager 类中的 is_external 变量 - 更新了 RepoFileManager 类中的文件获取逻辑,优先使用 GitHub * ✨ feat(submodule): 添加子模块管理功能,支持子模块的初始化、更新和信息获取 * ✨ feat(update): 移除资源管理器,重构更新逻辑,支持通过ZhenxunRepoManager进行资源和Web UI的更新 * test(auto_update): 修改更新检测消息格式 (#2003) - 移除了不必要的版本号后缀(如 "-e6f17c4") - 统一了版本更新消息的格式,删除了冗余信息 * 🐛 修复web zip更新路径问题 * ⚡ 文件获取优化使用ali * Fix/test (#2008) * test: 修复bot测试 - 在 test_check_update.py 中跳过两个测试函数 - 移除 test_check.py 中的 mocked_api 参数和相关调用 - 删除 test_add_plugin.py 中的多个测试函数 - 移除 test_remove_plugin.py 中的 mocked_api 参数和相关调用 - 删除 test_search_plugin.py 中的多个测试函数 - 移除 test_update_all_plugin.py 和 test_update_plugin.py 中的 mocked_api 参数和相关调用 * 🚨 auto fix by pre-commit hooks --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * 修复res zip更新路径问题 * 🐛 修复zhenxun更新zip占用问题 * ✨ feat(update): 优化资源更新逻辑,调整更新路径和消息处理 --------- Co-authored-by: molanp <104612722+molanp@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
co-authored by
pre-commit-ci[bot]
molanp
parent
7c153721f0
commit
7719be9866
@@ -0,0 +1,60 @@
|
||||
"""
|
||||
仓库管理工具,用于操作GitHub和阿里云CodeUp项目的更新和文件下载
|
||||
"""
|
||||
|
||||
from .aliyun_manager import AliyunCodeupManager
|
||||
from .base_manager import BaseRepoManager
|
||||
from .config import AliyunCodeupConfig, GithubConfig, RepoConfig
|
||||
from .exceptions import (
|
||||
ApiRateLimitError,
|
||||
AuthenticationError,
|
||||
ConfigError,
|
||||
FileNotFoundError,
|
||||
NetworkError,
|
||||
RepoDownloadError,
|
||||
RepoManagerError,
|
||||
RepoNotFoundError,
|
||||
RepoUpdateError,
|
||||
)
|
||||
from .file_manager import RepoFileManager as RepoFileManagerClass
|
||||
from .github_manager import GithubManager
|
||||
from .models import (
|
||||
FileDownloadResult,
|
||||
RepoCommitInfo,
|
||||
RepoFileInfo,
|
||||
RepoType,
|
||||
RepoUpdateResult,
|
||||
)
|
||||
from .utils import check_git, filter_files, glob_to_regex, run_git_command
|
||||
|
||||
GithubRepoManager = GithubManager()
|
||||
AliyunRepoManager = AliyunCodeupManager()
|
||||
RepoFileManager = RepoFileManagerClass()
|
||||
|
||||
__all__ = [
|
||||
"AliyunCodeupConfig",
|
||||
"AliyunRepoManager",
|
||||
"ApiRateLimitError",
|
||||
"AuthenticationError",
|
||||
"BaseRepoManager",
|
||||
"ConfigError",
|
||||
"FileDownloadResult",
|
||||
"FileNotFoundError",
|
||||
"GithubConfig",
|
||||
"GithubRepoManager",
|
||||
"NetworkError",
|
||||
"RepoCommitInfo",
|
||||
"RepoConfig",
|
||||
"RepoDownloadError",
|
||||
"RepoFileInfo",
|
||||
"RepoFileManager",
|
||||
"RepoManagerError",
|
||||
"RepoNotFoundError",
|
||||
"RepoType",
|
||||
"RepoUpdateError",
|
||||
"RepoUpdateResult",
|
||||
"check_git",
|
||||
"filter_files",
|
||||
"glob_to_regex",
|
||||
"run_git_command",
|
||||
]
|
||||
@@ -0,0 +1,557 @@
|
||||
"""
|
||||
阿里云CodeUp仓库管理工具
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Callable
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
|
||||
from aiocache import cached
|
||||
|
||||
from zhenxun.services.log import logger
|
||||
from zhenxun.utils.github_utils.models import AliyunFileInfo
|
||||
|
||||
from .base_manager import BaseRepoManager
|
||||
from .config import LOG_COMMAND, RepoConfig
|
||||
from .exceptions import (
|
||||
AuthenticationError,
|
||||
FileNotFoundError,
|
||||
RepoDownloadError,
|
||||
RepoNotFoundError,
|
||||
RepoUpdateError,
|
||||
)
|
||||
from .models import (
|
||||
FileDownloadResult,
|
||||
RepoCommitInfo,
|
||||
RepoFileInfo,
|
||||
RepoType,
|
||||
RepoUpdateResult,
|
||||
)
|
||||
|
||||
|
||||
class AliyunCodeupManager(BaseRepoManager):
|
||||
"""阿里云CodeUp仓库管理工具"""
|
||||
|
||||
def __init__(self, config: RepoConfig | None = None):
|
||||
"""
|
||||
初始化阿里云CodeUp仓库管理工具
|
||||
|
||||
Args:
|
||||
config: 配置,如果为None则使用默认配置
|
||||
"""
|
||||
super().__init__(config)
|
||||
self._client = None
|
||||
|
||||
async def update_repo(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
更新阿里云CodeUp仓库
|
||||
|
||||
Args:
|
||||
repo_url: 仓库URL或名称
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
Returns:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
try:
|
||||
# 检查配置
|
||||
self._check_config()
|
||||
|
||||
# 获取仓库名称(从URL中提取)
|
||||
repo_url = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
|
||||
# 获取仓库最新提交ID
|
||||
newest_commit = await self._get_newest_commit(repo_url, branch)
|
||||
|
||||
# 创建结果对象
|
||||
result = RepoUpdateResult(
|
||||
repo_type=RepoType.ALIYUN,
|
||||
repo_name=repo_url.split("/tree/")[0]
|
||||
.split("/")[-1]
|
||||
.replace(".git", ""),
|
||||
owner=self.config.aliyun_codeup.organization_id,
|
||||
old_version="", # 将在后面更新
|
||||
new_version=newest_commit,
|
||||
)
|
||||
old_version = await self.read_version_file(local_path)
|
||||
result.old_version = old_version
|
||||
|
||||
# 如果版本相同,则无需更新
|
||||
if old_version == newest_commit:
|
||||
result.success = True
|
||||
logger.debug(
|
||||
f"仓库 {repo_url.split('/')[-1].replace('.git', '')}"
|
||||
f" 已是最新版本: {newest_commit[:8]}",
|
||||
LOG_COMMAND,
|
||||
)
|
||||
return result
|
||||
|
||||
# 确保本地目录存在
|
||||
local_path.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 获取仓库名称(从URL中提取)
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
|
||||
# 获取变更的文件列表
|
||||
changed_files = await self._get_changed_files(
|
||||
repo_name, old_version or None, newest_commit
|
||||
)
|
||||
|
||||
# 过滤文件
|
||||
if include_patterns or exclude_patterns:
|
||||
from .utils import filter_files
|
||||
|
||||
changed_files = filter_files(
|
||||
changed_files, include_patterns, exclude_patterns
|
||||
)
|
||||
|
||||
result.changed_files = changed_files
|
||||
|
||||
# 下载变更的文件
|
||||
for file_path in changed_files:
|
||||
try:
|
||||
local_file_path = local_path / file_path
|
||||
await self._download_file(
|
||||
repo_name, file_path, local_file_path, newest_commit
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"下载文件 {file_path} 失败", LOG_COMMAND, e=e)
|
||||
|
||||
# 更新版本文件
|
||||
await self.write_version_file(local_path, newest_commit)
|
||||
|
||||
result.success = True
|
||||
return result
|
||||
|
||||
except RepoUpdateError as e:
|
||||
logger.error(f"更新仓库失败: {e}")
|
||||
# 从URL中提取仓库名称
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
return RepoUpdateResult(
|
||||
repo_type=RepoType.ALIYUN,
|
||||
repo_name=repo_name,
|
||||
owner=self.config.aliyun_codeup.organization_id,
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=str(e),
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"更新仓库失败: {e}")
|
||||
# 从URL中提取仓库名称
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
return RepoUpdateResult(
|
||||
repo_type=RepoType.ALIYUN,
|
||||
repo_name=repo_name,
|
||||
owner=self.config.aliyun_codeup.organization_id,
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=str(e),
|
||||
)
|
||||
|
||||
async def download_file(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
) -> FileDownloadResult:
|
||||
"""
|
||||
从阿里云CodeUp下载单个文件
|
||||
|
||||
Args:
|
||||
repo_url: 仓库URL或名称
|
||||
file_path: 文件在仓库中的路径
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
|
||||
Returns:
|
||||
FileDownloadResult: 下载结果
|
||||
"""
|
||||
try:
|
||||
# 检查配置
|
||||
self._check_config()
|
||||
|
||||
# 获取仓库名称(从URL中提取)
|
||||
repo_identifier = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
)
|
||||
|
||||
# 创建结果对象
|
||||
result = FileDownloadResult(
|
||||
repo_type=RepoType.ALIYUN,
|
||||
repo_name=repo_url.split("/tree/")[0]
|
||||
.split("/")[-1]
|
||||
.replace(".git", ""),
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
)
|
||||
|
||||
# 确保本地目录存在
|
||||
Path(local_path).parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 下载文件
|
||||
file_size = await self._download_file(
|
||||
repo_identifier, file_path, local_path, branch
|
||||
)
|
||||
|
||||
result.success = True
|
||||
result.file_size = file_size
|
||||
return result
|
||||
|
||||
except RepoDownloadError as e:
|
||||
logger.error(f"下载文件失败: {e}")
|
||||
# 从URL中提取仓库名称
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
return FileDownloadResult(
|
||||
repo_type=RepoType.ALIYUN,
|
||||
repo_name=repo_name,
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
error_message=str(e),
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"下载文件失败: {e}")
|
||||
# 从URL中提取仓库名称
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
return FileDownloadResult(
|
||||
repo_type=RepoType.ALIYUN,
|
||||
repo_name=repo_name,
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
error_message=str(e),
|
||||
)
|
||||
|
||||
async def get_file_list(
|
||||
self,
|
||||
repo_url: str,
|
||||
dir_path: str = "",
|
||||
branch: str = "main",
|
||||
recursive: bool = False,
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
获取仓库文件列表
|
||||
|
||||
Args:
|
||||
repo_url: 仓库URL或名称
|
||||
dir_path: 目录路径,空字符串表示仓库根目录
|
||||
branch: 分支名称
|
||||
recursive: 是否递归获取子目录
|
||||
|
||||
Returns:
|
||||
list[RepoFileInfo]: 文件信息列表
|
||||
"""
|
||||
try:
|
||||
# 检查配置
|
||||
self._check_config()
|
||||
|
||||
# 获取仓库名称(从URL中提取)
|
||||
repo_identifier = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
)
|
||||
|
||||
# 获取文件列表
|
||||
search_type = "RECURSIVE" if recursive else "DIRECT"
|
||||
tree_list = await AliyunFileInfo.get_repository_tree(
|
||||
repo_identifier, dir_path, branch, search_type
|
||||
)
|
||||
|
||||
result = []
|
||||
for tree in tree_list:
|
||||
# 跳过非当前目录的文件(如果不是递归模式)
|
||||
if (
|
||||
not recursive
|
||||
and tree.path != dir_path
|
||||
and "/" in tree.path.replace(dir_path, "", 1).strip("/")
|
||||
):
|
||||
continue
|
||||
|
||||
file_info = RepoFileInfo(
|
||||
path=tree.path,
|
||||
is_dir=tree.type == "tree",
|
||||
)
|
||||
result.append(file_info)
|
||||
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"获取文件列表失败: {e}")
|
||||
return []
|
||||
|
||||
async def get_commit_info(
|
||||
self, repo_url: str, commit_id: str
|
||||
) -> RepoCommitInfo | None:
|
||||
"""
|
||||
获取提交信息
|
||||
|
||||
Args:
|
||||
repo_url: 仓库URL或名称
|
||||
commit_id: 提交ID
|
||||
|
||||
Returns:
|
||||
Optional[RepoCommitInfo]: 提交信息,如果获取失败则返回None
|
||||
"""
|
||||
try:
|
||||
# 检查配置
|
||||
self._check_config()
|
||||
|
||||
# 获取仓库名称(从URL中提取)
|
||||
repo_identifier = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
)
|
||||
|
||||
# 获取提交信息
|
||||
# 注意:这里假设AliyunFileInfo有get_commit_info方法,如果没有,需要实现
|
||||
commit_data = await self._get_commit_info(repo_identifier, commit_id)
|
||||
|
||||
if not commit_data:
|
||||
return None
|
||||
|
||||
# 解析提交信息
|
||||
id_value = commit_data.get("id", commit_id)
|
||||
message_value = commit_data.get("message", "")
|
||||
author_value = commit_data.get("author_name", "")
|
||||
date_value = commit_data.get(
|
||||
"authored_date", datetime.now().isoformat()
|
||||
).replace("Z", "+00:00")
|
||||
|
||||
return RepoCommitInfo(
|
||||
commit_id=id_value,
|
||||
message=message_value,
|
||||
author=author_value,
|
||||
commit_time=datetime.fromisoformat(date_value),
|
||||
changed_files=[], # 阿里云API可能没有直接提供变更文件列表
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"获取提交信息失败: {e}")
|
||||
return None
|
||||
|
||||
def _check_config(self):
|
||||
"""检查配置"""
|
||||
if not self.config.aliyun_codeup.access_key_id:
|
||||
raise AuthenticationError("阿里云CodeUp")
|
||||
|
||||
if not self.config.aliyun_codeup.access_key_secret:
|
||||
raise AuthenticationError("阿里云CodeUp")
|
||||
|
||||
if not self.config.aliyun_codeup.organization_id:
|
||||
raise AuthenticationError("阿里云CodeUp")
|
||||
|
||||
async def _get_newest_commit(self, repo_name: str, branch: str) -> str:
|
||||
"""
|
||||
获取仓库最新提交ID
|
||||
|
||||
Args:
|
||||
repo_name: 仓库名称
|
||||
branch: 分支名称
|
||||
|
||||
Returns:
|
||||
str: 提交ID
|
||||
"""
|
||||
try:
|
||||
newest_commit = await AliyunFileInfo.get_newest_commit(repo_name, branch)
|
||||
if not newest_commit:
|
||||
raise RepoNotFoundError(repo_name)
|
||||
return newest_commit
|
||||
except Exception as e:
|
||||
logger.error(f"获取最新提交ID失败: {e}")
|
||||
raise RepoUpdateError(f"获取最新提交ID失败: {e}")
|
||||
|
||||
async def _get_commit_info(self, repo_name: str, commit_id: str) -> dict:
|
||||
"""
|
||||
获取提交信息
|
||||
|
||||
Args:
|
||||
repo_name: 仓库名称
|
||||
commit_id: 提交ID
|
||||
|
||||
Returns:
|
||||
dict: 提交信息
|
||||
"""
|
||||
# 这里需要实现从阿里云获取提交信息的逻辑
|
||||
# 由于AliyunFileInfo可能没有get_commit_info方法,这里提供一个简单的实现
|
||||
try:
|
||||
# 这里应该是调用阿里云API获取提交信息
|
||||
# 这里只是一个示例,实际上需要根据阿里云API实现
|
||||
return {
|
||||
"id": commit_id,
|
||||
"message": "提交信息",
|
||||
"author_name": "作者",
|
||||
"authored_date": datetime.now().isoformat(),
|
||||
}
|
||||
except Exception as e:
|
||||
logger.error(f"获取提交信息失败: {e}")
|
||||
return {}
|
||||
|
||||
@cached(ttl=3600)
|
||||
async def _get_changed_files(
|
||||
self, repo_name: str, old_commit: str | None, new_commit: str
|
||||
) -> list[str]:
|
||||
"""
|
||||
获取两个提交之间变更的文件列表
|
||||
|
||||
Args:
|
||||
repo_name: 仓库名称
|
||||
old_commit: 旧提交ID,如果为None则获取所有文件
|
||||
new_commit: 新提交ID
|
||||
|
||||
Returns:
|
||||
list[str]: 变更的文件列表
|
||||
"""
|
||||
if not old_commit:
|
||||
# 如果没有旧提交,则获取仓库中的所有文件
|
||||
tree_list = await AliyunFileInfo.get_repository_tree(
|
||||
repo_name, "", new_commit, "RECURSIVE"
|
||||
)
|
||||
return [tree.path for tree in tree_list if tree.type == "blob"]
|
||||
|
||||
# 获取两个提交之间的差异
|
||||
try:
|
||||
return []
|
||||
except Exception as e:
|
||||
logger.error(f"获取提交差异失败: {e}")
|
||||
raise RepoUpdateError(f"获取提交差异失败: {e}")
|
||||
|
||||
async def update_via_git(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
force: bool = False,
|
||||
*,
|
||||
repo_type: RepoType | None = None,
|
||||
owner: str | None = None,
|
||||
prepare_repo_url: Callable[[str], str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
通过Git命令直接更新仓库
|
||||
|
||||
参数:
|
||||
repo_url: 仓库名称
|
||||
local_path: 本地仓库路径
|
||||
branch: 分支名称
|
||||
force: 是否强制拉取
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
|
||||
# 定义预处理函数,构建阿里云CodeUp的URL
|
||||
def prepare_aliyun_url(repo_url: str) -> str:
|
||||
import base64
|
||||
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
# 构建仓库URL
|
||||
# 阿里云CodeUp的仓库URL格式通常为:
|
||||
# https://codeup.aliyun.com/{organization_id}/{organization_name}/{repo_name}.git
|
||||
url = f"https://codeup.aliyun.com/{self.config.aliyun_codeup.organization_id}/{self.config.aliyun_codeup.organization_name}/{repo_name}.git"
|
||||
|
||||
# 添加访问令牌 - 使用base64解码后的令牌
|
||||
if self.config.aliyun_codeup.rdc_access_token_encrypted:
|
||||
try:
|
||||
# 解码RDC访问令牌
|
||||
token = base64.b64decode(
|
||||
self.config.aliyun_codeup.rdc_access_token_encrypted.encode()
|
||||
).decode()
|
||||
# 阿里云CodeUp使用oauth2:token的格式进行身份验证
|
||||
url = url.replace("https://", f"https://oauth2:{token}@")
|
||||
logger.debug(f"使用RDC令牌构建阿里云URL: {url.split('@')[0]}@***")
|
||||
except Exception as e:
|
||||
logger.error(f"解码RDC令牌失败: {e}")
|
||||
|
||||
return url
|
||||
|
||||
# 调用基类的update_via_git方法
|
||||
return await super().update_via_git(
|
||||
repo_url=repo_url,
|
||||
local_path=local_path,
|
||||
branch=branch,
|
||||
force=force,
|
||||
repo_type=RepoType.ALIYUN,
|
||||
owner=self.config.aliyun_codeup.organization_id,
|
||||
prepare_repo_url=prepare_aliyun_url,
|
||||
)
|
||||
|
||||
async def update(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
use_git: bool = True,
|
||||
force: bool = False,
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
更新仓库,可选择使用Git命令或API方式
|
||||
|
||||
参数:
|
||||
repo_url: 仓库名称
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
use_git: 是否使用Git命令更新
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
if use_git:
|
||||
return await self.update_via_git(repo_url, local_path, branch, force)
|
||||
else:
|
||||
return await self.update_repo(
|
||||
repo_url, local_path, branch, include_patterns, exclude_patterns
|
||||
)
|
||||
|
||||
async def _download_file(
|
||||
self, repo_name: str, file_path: str, local_path: Path, ref: str
|
||||
) -> int:
|
||||
"""
|
||||
下载文件
|
||||
|
||||
Args:
|
||||
repo_name: 仓库名称
|
||||
file_path: 文件在仓库中的路径
|
||||
local_path: 本地保存路径
|
||||
ref: 分支/标签/提交ID
|
||||
|
||||
Returns:
|
||||
int: 文件大小(字节)
|
||||
"""
|
||||
# 确保目录存在
|
||||
local_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 获取文件内容
|
||||
for retry in range(self.config.aliyun_codeup.download_retry + 1):
|
||||
try:
|
||||
content = await AliyunFileInfo.get_file_content(
|
||||
file_path, repo_name, ref
|
||||
)
|
||||
|
||||
if content is None:
|
||||
raise FileNotFoundError(file_path, repo_name)
|
||||
|
||||
# 保存文件
|
||||
return await self.save_file_content(content.encode("utf-8"), local_path)
|
||||
|
||||
except FileNotFoundError as e:
|
||||
# 这些错误不需要重试
|
||||
raise e
|
||||
except Exception as e:
|
||||
if retry < self.config.aliyun_codeup.download_retry:
|
||||
logger.warning("下载文件失败,将重试", LOG_COMMAND, e=e)
|
||||
await asyncio.sleep(1)
|
||||
continue
|
||||
raise RepoDownloadError(f"下载文件失败: {e}")
|
||||
|
||||
raise RepoDownloadError("下载文件失败: 超过最大重试次数")
|
||||
@@ -0,0 +1,432 @@
|
||||
"""
|
||||
仓库管理工具的基础管理器
|
||||
"""
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from pathlib import Path
|
||||
|
||||
import aiofiles
|
||||
|
||||
from zhenxun.services.log import logger
|
||||
|
||||
from .config import LOG_COMMAND, RepoConfig
|
||||
from .models import (
|
||||
FileDownloadResult,
|
||||
RepoCommitInfo,
|
||||
RepoFileInfo,
|
||||
RepoType,
|
||||
RepoUpdateResult,
|
||||
)
|
||||
from .utils import check_git, filter_files, run_git_command
|
||||
|
||||
|
||||
class BaseRepoManager(ABC):
|
||||
"""仓库管理工具基础类"""
|
||||
|
||||
def __init__(self, config: RepoConfig | None = None):
|
||||
"""
|
||||
初始化仓库管理工具
|
||||
|
||||
参数:
|
||||
config: 配置,如果为None则使用默认配置
|
||||
"""
|
||||
self.config = config or RepoConfig.get_instance()
|
||||
self.config.ensure_dirs()
|
||||
|
||||
@abstractmethod
|
||||
async def update_repo(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
更新仓库
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL或名称
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
async def download_file(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
) -> FileDownloadResult:
|
||||
"""
|
||||
下载单个文件
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL或名称
|
||||
file_path: 文件在仓库中的路径
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
|
||||
返回:
|
||||
FileDownloadResult: 下载结果
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
async def get_file_list(
|
||||
self,
|
||||
repo_url: str,
|
||||
dir_path: str = "",
|
||||
branch: str = "main",
|
||||
recursive: bool = False,
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
获取仓库文件列表
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL或名称
|
||||
dir_path: 目录路径,空字符串表示仓库根目录
|
||||
branch: 分支名称
|
||||
recursive: 是否递归获取子目录
|
||||
|
||||
返回:
|
||||
List[RepoFileInfo]: 文件信息列表
|
||||
"""
|
||||
pass
|
||||
|
||||
@abstractmethod
|
||||
async def get_commit_info(
|
||||
self, repo_url: str, commit_id: str
|
||||
) -> RepoCommitInfo | None:
|
||||
"""
|
||||
获取提交信息
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL或名称
|
||||
commit_id: 提交ID
|
||||
|
||||
返回:
|
||||
Optional[RepoCommitInfo]: 提交信息,如果获取失败则返回None
|
||||
"""
|
||||
pass
|
||||
|
||||
async def save_file_content(self, content: bytes, local_path: Path) -> int:
|
||||
"""
|
||||
保存文件内容
|
||||
|
||||
参数:
|
||||
content: 文件内容
|
||||
local_path: 本地保存路径
|
||||
|
||||
返回:
|
||||
int: 文件大小(字节)
|
||||
"""
|
||||
# 确保目录存在
|
||||
local_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 保存文件
|
||||
async with aiofiles.open(local_path, "wb") as f:
|
||||
await f.write(content)
|
||||
|
||||
return len(content)
|
||||
|
||||
async def read_version_file(self, local_dir: Path) -> str:
|
||||
"""
|
||||
读取版本文件
|
||||
|
||||
参数:
|
||||
local_dir: 本地目录
|
||||
|
||||
返回:
|
||||
str: 版本号
|
||||
"""
|
||||
version_file = local_dir / "__version__"
|
||||
if not version_file.exists():
|
||||
return ""
|
||||
|
||||
try:
|
||||
async with aiofiles.open(version_file) as f:
|
||||
return (await f.read()).strip()
|
||||
except Exception as e:
|
||||
logger.error(f"读取版本文件失败: {e}")
|
||||
return ""
|
||||
|
||||
async def write_version_file(self, local_dir: Path, version: str) -> bool:
|
||||
"""
|
||||
写入版本文件
|
||||
|
||||
参数:
|
||||
local_dir: 本地目录
|
||||
version: 版本号
|
||||
|
||||
返回:
|
||||
bool: 是否成功
|
||||
"""
|
||||
version_file = local_dir / "__version__"
|
||||
|
||||
try:
|
||||
version_bb = "vNone"
|
||||
async with aiofiles.open(version_file) as rf:
|
||||
if text := await rf.read():
|
||||
version_bb = text.strip().split("-")[0]
|
||||
async with aiofiles.open(version_file, "w") as f:
|
||||
await f.write(f"{version_bb}-{version[:6]}")
|
||||
return True
|
||||
except Exception as e:
|
||||
logger.error(f"写入版本文件失败: {e}")
|
||||
return False
|
||||
|
||||
def filter_files(
|
||||
self,
|
||||
files: list[str],
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> list[str]:
|
||||
"""
|
||||
过滤文件列表
|
||||
|
||||
参数:
|
||||
files: 文件列表
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
返回:
|
||||
List[str]: 过滤后的文件列表
|
||||
"""
|
||||
return filter_files(files, include_patterns, exclude_patterns)
|
||||
|
||||
async def update_via_git(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
force: bool = False,
|
||||
*,
|
||||
repo_type: RepoType | None = None,
|
||||
owner="",
|
||||
prepare_repo_url=None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
通过Git命令直接更新仓库
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL或名称
|
||||
local_path: 本地仓库路径
|
||||
branch: 分支名称
|
||||
force: 是否强制拉取
|
||||
repo_type: 仓库类型
|
||||
owner: 仓库拥有者
|
||||
prepare_repo_url: 预处理仓库URL的函数
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
from .models import RepoType
|
||||
|
||||
repo_name = repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "")
|
||||
|
||||
try:
|
||||
# 创建结果对象
|
||||
result = RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB, # 默认使用GitHub类型
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version="",
|
||||
new_version="",
|
||||
)
|
||||
|
||||
# 检查Git是否可用
|
||||
if not await check_git():
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message="Git命令不可用",
|
||||
)
|
||||
|
||||
# 预处理仓库URL
|
||||
if prepare_repo_url:
|
||||
repo_url = prepare_repo_url(repo_url)
|
||||
|
||||
# 检查本地目录是否存在
|
||||
if not local_path.exists():
|
||||
# 如果不存在,则克隆仓库
|
||||
logger.info(f"克隆仓库 {repo_url} 到 {local_path}", LOG_COMMAND)
|
||||
success, stdout, stderr = await run_git_command(
|
||||
f"clone -b {branch} {repo_url} {local_path}"
|
||||
)
|
||||
if not success:
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=f"克隆仓库失败: {stderr}",
|
||||
)
|
||||
|
||||
# 获取当前提交ID
|
||||
success, new_version, _ = await run_git_command(
|
||||
"rev-parse HEAD", cwd=local_path
|
||||
)
|
||||
result.new_version = new_version.strip()
|
||||
result.success = True
|
||||
return result
|
||||
|
||||
# 如果目录存在,检查是否是Git仓库
|
||||
# 首先检查目录本身是否有.git文件夹
|
||||
git_dir = local_path / ".git"
|
||||
|
||||
if not git_dir.is_dir():
|
||||
# 如果不是Git仓库,尝试初始化它
|
||||
logger.info(f"目录 {local_path} 不是Git仓库,尝试初始化", LOG_COMMAND)
|
||||
init_success, _, init_stderr = await run_git_command(
|
||||
"init", cwd=local_path
|
||||
)
|
||||
if not init_success:
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=f"初始化Git仓库失败: {init_stderr}",
|
||||
)
|
||||
|
||||
# 添加远程仓库
|
||||
remote_success, _, remote_stderr = await run_git_command(
|
||||
f"remote add origin {repo_url}", cwd=local_path
|
||||
)
|
||||
if not remote_success:
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=f"添加远程仓库失败: {remote_stderr}",
|
||||
)
|
||||
|
||||
logger.info(f"成功初始化Git仓库 {local_path}", LOG_COMMAND)
|
||||
|
||||
# 获取当前提交ID作为旧版本
|
||||
success, old_version, _ = await run_git_command(
|
||||
"rev-parse HEAD", cwd=local_path
|
||||
)
|
||||
result.old_version = old_version.strip()
|
||||
|
||||
# 获取当前远程URL
|
||||
success, remote_url, _ = await run_git_command(
|
||||
"config --get remote.origin.url", cwd=local_path
|
||||
)
|
||||
|
||||
# 如果远程URL不匹配,则更新它
|
||||
remote_url = remote_url.strip()
|
||||
if success and repo_url not in remote_url and remote_url not in repo_url:
|
||||
logger.info(f"更新远程URL: {remote_url} -> {repo_url}", LOG_COMMAND)
|
||||
await run_git_command(
|
||||
f"remote set-url origin {repo_url}", cwd=local_path
|
||||
)
|
||||
|
||||
# 获取远程更新
|
||||
logger.info(f"获取远程更新: {repo_url}", LOG_COMMAND)
|
||||
success, _, stderr = await run_git_command("fetch origin", cwd=local_path)
|
||||
if not success:
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version=old_version.strip(),
|
||||
new_version="",
|
||||
error_message=f"获取远程更新失败: {stderr}",
|
||||
)
|
||||
|
||||
# 获取当前分支
|
||||
success, current_branch, _ = await run_git_command(
|
||||
"rev-parse --abbrev-ref HEAD", cwd=local_path
|
||||
)
|
||||
current_branch = current_branch.strip()
|
||||
|
||||
# 如果当前分支不是目标分支,则切换分支
|
||||
if success and current_branch != branch:
|
||||
logger.info(f"切换分支: {current_branch} -> {branch}", LOG_COMMAND)
|
||||
success, _, stderr = await run_git_command(
|
||||
f"checkout {branch}", cwd=local_path
|
||||
)
|
||||
if not success:
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version=old_version.strip(),
|
||||
new_version="",
|
||||
error_message=f"切换分支失败: {stderr}",
|
||||
)
|
||||
|
||||
# 拉取最新代码
|
||||
logger.info(f"拉取最新代码: {repo_url}", LOG_COMMAND)
|
||||
pull_cmd = f"pull origin {branch}"
|
||||
if force:
|
||||
pull_cmd = f"fetch --all && git reset --hard origin/{branch}"
|
||||
logger.info("使用强制拉取模式", LOG_COMMAND)
|
||||
success, _, stderr = await run_git_command(pull_cmd, cwd=local_path)
|
||||
if not success:
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version=old_version.strip(),
|
||||
new_version="",
|
||||
error_message=f"拉取最新代码失败: {stderr}",
|
||||
)
|
||||
|
||||
# 获取更新后的提交ID
|
||||
success, new_version, _ = await run_git_command(
|
||||
"rev-parse HEAD", cwd=local_path
|
||||
)
|
||||
result.new_version = new_version.strip()
|
||||
|
||||
# 如果版本相同,则无需更新
|
||||
if old_version.strip() == new_version.strip():
|
||||
logger.info(
|
||||
f"仓库 {repo_url} 已是最新版本: {new_version.strip()}", LOG_COMMAND
|
||||
)
|
||||
result.success = True
|
||||
return result
|
||||
|
||||
# 获取变更的文件列表
|
||||
success, changed_files_output, _ = await run_git_command(
|
||||
f"diff --name-only {old_version.strip()} {new_version.strip()}",
|
||||
cwd=local_path,
|
||||
)
|
||||
if success:
|
||||
changed_files = [
|
||||
line.strip()
|
||||
for line in changed_files_output.splitlines()
|
||||
if line.strip()
|
||||
]
|
||||
result.changed_files = changed_files
|
||||
logger.info(f"变更的文件列表: {changed_files}", LOG_COMMAND)
|
||||
|
||||
result.success = True
|
||||
return result
|
||||
|
||||
except Exception as e:
|
||||
logger.error("Git更新失败", LOG_COMMAND, e=e)
|
||||
return RepoUpdateResult(
|
||||
repo_type=repo_type or RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
owner=owner or "",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=str(e),
|
||||
)
|
||||
@@ -0,0 +1,77 @@
|
||||
"""
|
||||
仓库管理工具的配置模块
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
|
||||
from zhenxun.configs.path_config import TEMP_PATH
|
||||
|
||||
LOG_COMMAND = "RepoUtils"
|
||||
|
||||
|
||||
@dataclass
|
||||
class GithubConfig:
|
||||
"""GitHub配置"""
|
||||
|
||||
# API超时时间(秒)
|
||||
api_timeout: int = 30
|
||||
# 下载超时时间(秒)
|
||||
download_timeout: int = 60
|
||||
# 下载重试次数
|
||||
download_retry: int = 3
|
||||
# 代理配置
|
||||
proxy: str | None = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class AliyunCodeupConfig:
|
||||
"""阿里云CodeUp配置"""
|
||||
|
||||
# 访问密钥ID
|
||||
access_key_id: str = "LTAI5tNmf7KaTAuhcvRobAQs"
|
||||
# 访问密钥密钥
|
||||
access_key_secret: str = "NmJ3d2VNRU1MREY0T1RtRnBqMlFqdlBxN3pMUk1j"
|
||||
# 组织ID
|
||||
organization_id: str = "67a361cf556e6cdab537117a"
|
||||
# 组织名称
|
||||
organization_name: str = "zhenxun-org"
|
||||
# RDC Access Token
|
||||
rdc_access_token_encrypted: str = (
|
||||
"cHQtYXp0allnQWpub0FYZWpqZm1RWGtneHk0XzBlMmYzZTZmLWQwOWItNDE4Mi1iZWUx"
|
||||
"LTQ1ZTFkYjI0NGRlMg=="
|
||||
)
|
||||
# 区域
|
||||
region: str = "cn-hangzhou"
|
||||
# 端点
|
||||
endpoint: str = "devops.cn-hangzhou.aliyuncs.com"
|
||||
# 下载重试次数
|
||||
download_retry: int = 3
|
||||
|
||||
|
||||
@dataclass
|
||||
class RepoConfig:
|
||||
"""仓库管理工具配置"""
|
||||
|
||||
# 缓存目录
|
||||
cache_dir: Path = TEMP_PATH / "repo_cache"
|
||||
|
||||
# GitHub配置
|
||||
github: GithubConfig = field(default_factory=GithubConfig)
|
||||
|
||||
# 阿里云CodeUp配置
|
||||
aliyun_codeup: AliyunCodeupConfig = field(default_factory=AliyunCodeupConfig)
|
||||
|
||||
# 单例实例
|
||||
_instance = None
|
||||
|
||||
@classmethod
|
||||
def get_instance(cls) -> "RepoConfig":
|
||||
"""获取单例实例"""
|
||||
if cls._instance is None:
|
||||
cls._instance = cls()
|
||||
return cls._instance
|
||||
|
||||
def ensure_dirs(self):
|
||||
"""确保目录存在"""
|
||||
self.cache_dir.mkdir(parents=True, exist_ok=True)
|
||||
@@ -0,0 +1,68 @@
|
||||
"""
|
||||
仓库管理工具的异常类
|
||||
"""
|
||||
|
||||
|
||||
class RepoManagerError(Exception):
|
||||
"""仓库管理工具异常基类"""
|
||||
|
||||
def __init__(self, message: str, repo_name: str | None = None):
|
||||
self.message = message
|
||||
self.repo_name = repo_name
|
||||
super().__init__(self.message)
|
||||
|
||||
|
||||
class RepoUpdateError(RepoManagerError):
|
||||
"""仓库更新异常"""
|
||||
|
||||
def __init__(self, message: str, repo_name: str | None = None):
|
||||
super().__init__(f"仓库更新失败: {message}", repo_name)
|
||||
|
||||
|
||||
class RepoDownloadError(RepoManagerError):
|
||||
"""仓库下载异常"""
|
||||
|
||||
def __init__(self, message: str, repo_name: str | None = None):
|
||||
super().__init__(f"文件下载失败: {message}", repo_name)
|
||||
|
||||
|
||||
class RepoNotFoundError(RepoManagerError):
|
||||
"""仓库不存在异常"""
|
||||
|
||||
def __init__(self, repo_name: str):
|
||||
super().__init__(f"仓库不存在: {repo_name}", repo_name)
|
||||
|
||||
|
||||
class FileNotFoundError(RepoManagerError):
|
||||
"""文件不存在异常"""
|
||||
|
||||
def __init__(self, file_path: str, repo_name: str | None = None):
|
||||
super().__init__(f"文件不存在: {file_path}", repo_name)
|
||||
|
||||
|
||||
class AuthenticationError(RepoManagerError):
|
||||
"""认证异常"""
|
||||
|
||||
def __init__(self, repo_type: str):
|
||||
super().__init__(f"认证失败: {repo_type}")
|
||||
|
||||
|
||||
class ApiRateLimitError(RepoManagerError):
|
||||
"""API速率限制异常"""
|
||||
|
||||
def __init__(self, repo_type: str):
|
||||
super().__init__(f"API速率限制: {repo_type}")
|
||||
|
||||
|
||||
class NetworkError(RepoManagerError):
|
||||
"""网络异常"""
|
||||
|
||||
def __init__(self, message: str):
|
||||
super().__init__(f"网络错误: {message}")
|
||||
|
||||
|
||||
class ConfigError(RepoManagerError):
|
||||
"""配置异常"""
|
||||
|
||||
def __init__(self, message: str):
|
||||
super().__init__(f"配置错误: {message}")
|
||||
@@ -0,0 +1,543 @@
|
||||
"""
|
||||
仓库文件管理器,用于从GitHub和阿里云CodeUp获取指定文件内容
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
from typing import cast, overload
|
||||
|
||||
import aiofiles
|
||||
from httpx import Response
|
||||
|
||||
from zhenxun.services.log import logger
|
||||
from zhenxun.utils.github_utils import GithubUtils
|
||||
from zhenxun.utils.github_utils.models import AliyunTreeType, GitHubStrategy, TreeType
|
||||
from zhenxun.utils.http_utils import AsyncHttpx
|
||||
|
||||
from .config import LOG_COMMAND, RepoConfig
|
||||
from .exceptions import FileNotFoundError, NetworkError, RepoManagerError
|
||||
from .models import FileDownloadResult, RepoFileInfo, RepoType
|
||||
|
||||
|
||||
class RepoFileManager:
|
||||
"""仓库文件管理器,用于获取GitHub和阿里云仓库中的文件内容"""
|
||||
|
||||
def __init__(self, config: RepoConfig | None = None):
|
||||
"""
|
||||
初始化仓库文件管理器
|
||||
|
||||
参数:
|
||||
config: 配置,如果为None则使用默认配置
|
||||
"""
|
||||
self.config = config or RepoConfig.get_instance()
|
||||
self.config.ensure_dirs()
|
||||
|
||||
@overload
|
||||
async def get_github_file_content(
|
||||
self, url: str, file_path: str, ignore_error: bool = False
|
||||
) -> str: ...
|
||||
|
||||
@overload
|
||||
async def get_github_file_content(
|
||||
self, url: str, file_path: list[str], ignore_error: bool = False
|
||||
) -> list[tuple[str, str]]: ...
|
||||
|
||||
async def get_github_file_content(
|
||||
self, url: str, file_path: str | list[str], ignore_error: bool = False
|
||||
) -> str | list[tuple[str, str]]:
|
||||
"""
|
||||
获取GitHub仓库文件内容
|
||||
|
||||
参数:
|
||||
url: 仓库URL
|
||||
file_path: 文件路径或文件路径列表
|
||||
ignore_error: 是否忽略错误
|
||||
|
||||
返回:
|
||||
list[tuple[str, str]]: 文件路径,文件内容
|
||||
"""
|
||||
results = []
|
||||
is_str_input = isinstance(file_path, str)
|
||||
try:
|
||||
if is_str_input:
|
||||
file_path = [file_path]
|
||||
repo_info = GithubUtils.parse_github_url(url)
|
||||
if await repo_info.update_repo_commit():
|
||||
logger.info(f"获取最新提交: {repo_info.branch}", LOG_COMMAND)
|
||||
else:
|
||||
logger.warning(f"获取最新提交失败: {repo_info}", LOG_COMMAND)
|
||||
for f in file_path:
|
||||
try:
|
||||
file_url = await repo_info.get_raw_download_urls(f)
|
||||
for fu in file_url:
|
||||
response: Response = await AsyncHttpx.get(
|
||||
fu, check_status_code=200
|
||||
)
|
||||
if response.status_code == 200:
|
||||
logger.info(f"获取github文件内容成功: {f}", LOG_COMMAND)
|
||||
# 确保使用UTF-8编码解析响应内容
|
||||
try:
|
||||
text_content = response.content.decode("utf-8")
|
||||
except UnicodeDecodeError:
|
||||
# 如果UTF-8解码失败,尝试其他编码
|
||||
text_content = response.content.decode(
|
||||
"utf-8", errors="ignore"
|
||||
)
|
||||
logger.warning(
|
||||
f"解码文件内容时出现错误,使用忽略错误模式: {f}",
|
||||
LOG_COMMAND,
|
||||
)
|
||||
results.append((f, text_content))
|
||||
break
|
||||
else:
|
||||
logger.warning(
|
||||
f"获取github文件内容失败: {response.status_code}",
|
||||
LOG_COMMAND,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(f"获取github文件内容失败: {f}", LOG_COMMAND, e=e)
|
||||
if not ignore_error:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error(f"获取GitHub文件内容失败: {file_path}", LOG_COMMAND, e=e)
|
||||
raise
|
||||
logger.debug(f"获取GitHub文件内容: {[r[0] for r in results]}", LOG_COMMAND)
|
||||
|
||||
return results[0][1] if is_str_input and results else results
|
||||
|
||||
@overload
|
||||
async def get_aliyun_file_content(
|
||||
self,
|
||||
repo_name: str,
|
||||
file_path: str,
|
||||
branch: str = "main",
|
||||
ignore_error: bool = False,
|
||||
) -> str: ...
|
||||
|
||||
@overload
|
||||
async def get_aliyun_file_content(
|
||||
self,
|
||||
repo_name: str,
|
||||
file_path: list[str],
|
||||
branch: str = "main",
|
||||
ignore_error: bool = False,
|
||||
) -> list[tuple[str, str]]: ...
|
||||
|
||||
async def get_aliyun_file_content(
|
||||
self,
|
||||
repo_name: str,
|
||||
file_path: str | list[str],
|
||||
branch: str = "main",
|
||||
ignore_error: bool = False,
|
||||
) -> str | list[tuple[str, str]]:
|
||||
"""
|
||||
获取阿里云CodeUp仓库文件内容
|
||||
|
||||
参数:
|
||||
repo: 仓库名称
|
||||
file_path: 文件路径
|
||||
branch: 分支名称
|
||||
ignore_error: 是否忽略错误
|
||||
返回:
|
||||
list[tuple[str, str]]: 文件路径,文件内容
|
||||
"""
|
||||
results = []
|
||||
is_str_input = isinstance(file_path, str)
|
||||
# 导入阿里云相关模块
|
||||
from zhenxun.utils.github_utils.models import AliyunFileInfo
|
||||
|
||||
if is_str_input:
|
||||
file_path = [file_path]
|
||||
for f in file_path:
|
||||
try:
|
||||
content = await AliyunFileInfo.get_file_content(
|
||||
file_path=f, repo=repo_name, ref=branch
|
||||
)
|
||||
results.append((f, content))
|
||||
except Exception as e:
|
||||
logger.warning(f"获取阿里云文件内容失败: {file_path}", LOG_COMMAND, e=e)
|
||||
if not ignore_error:
|
||||
raise
|
||||
logger.debug(f"获取阿里云文件内容: {[r[0] for r in results]}", LOG_COMMAND)
|
||||
return results[0][1] if is_str_input and results else results
|
||||
|
||||
@overload
|
||||
async def get_file_content(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: str,
|
||||
branch: str = "main",
|
||||
repo_type: RepoType | None = None,
|
||||
ignore_error: bool = False,
|
||||
) -> str: ...
|
||||
|
||||
@overload
|
||||
async def get_file_content(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: list[str],
|
||||
branch: str = "main",
|
||||
repo_type: RepoType | None = None,
|
||||
ignore_error: bool = False,
|
||||
) -> list[tuple[str, str]]: ...
|
||||
|
||||
async def get_file_content(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: str | list[str],
|
||||
branch: str = "main",
|
||||
repo_type: RepoType | None = None,
|
||||
ignore_error: bool = False,
|
||||
) -> str | list[tuple[str, str]]:
|
||||
"""
|
||||
获取仓库文件内容
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL
|
||||
file_path: 文件路径
|
||||
branch: 分支名称
|
||||
repo_type: 仓库类型,如果为None则自动判断
|
||||
ignore_error: 是否忽略错误
|
||||
|
||||
返回:
|
||||
str: 文件内容
|
||||
"""
|
||||
# 确定仓库类型
|
||||
repo_name = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "").strip()
|
||||
)
|
||||
if repo_type is None:
|
||||
try:
|
||||
return await self.get_aliyun_file_content(
|
||||
repo_name, file_path, branch, ignore_error
|
||||
)
|
||||
except Exception:
|
||||
return await self.get_github_file_content(
|
||||
repo_url, file_path, ignore_error
|
||||
)
|
||||
|
||||
try:
|
||||
if repo_type == RepoType.GITHUB:
|
||||
return await self.get_github_file_content(
|
||||
repo_url, file_path, ignore_error
|
||||
)
|
||||
|
||||
elif repo_type == RepoType.ALIYUN:
|
||||
return await self.get_aliyun_file_content(
|
||||
repo_name, file_path, branch, ignore_error
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
if isinstance(e, FileNotFoundError | NetworkError | RepoManagerError):
|
||||
raise
|
||||
raise RepoManagerError(f"获取文件内容失败: {e}")
|
||||
|
||||
async def list_directory_files(
|
||||
self,
|
||||
repo_url: str,
|
||||
directory_path: str = "",
|
||||
branch: str = "main",
|
||||
repo_type: RepoType | None = None,
|
||||
recursive: bool = True,
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
获取仓库目录下的所有文件路径
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL
|
||||
directory_path: 目录路径,默认为仓库根目录
|
||||
branch: 分支名称
|
||||
repo_type: 仓库类型,如果为None则自动判断
|
||||
recursive: 是否递归获取子目录文件
|
||||
|
||||
返回:
|
||||
list[RepoFileInfo]: 文件信息列表
|
||||
"""
|
||||
repo_name = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "").strip()
|
||||
)
|
||||
try:
|
||||
if repo_type is None:
|
||||
# 尝试GitHub,失败则尝试阿里云
|
||||
try:
|
||||
return await self._list_github_directory_files(
|
||||
repo_url, directory_path, branch, recursive
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(
|
||||
"获取GitHub目录文件失败,尝试阿里云", LOG_COMMAND, e=e
|
||||
)
|
||||
return await self._list_aliyun_directory_files(
|
||||
repo_name, directory_path, branch, recursive
|
||||
)
|
||||
if repo_type == RepoType.GITHUB:
|
||||
return await self._list_github_directory_files(
|
||||
repo_url, directory_path, branch, recursive
|
||||
)
|
||||
elif repo_type == RepoType.ALIYUN:
|
||||
return await self._list_aliyun_directory_files(
|
||||
repo_name, directory_path, branch, recursive
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error(f"获取目录文件列表失败: {directory_path}", LOG_COMMAND, e=e)
|
||||
if isinstance(e, FileNotFoundError | NetworkError | RepoManagerError):
|
||||
raise
|
||||
raise RepoManagerError(f"获取目录文件列表失败: {e}")
|
||||
|
||||
async def _list_github_directory_files(
|
||||
self,
|
||||
repo_url: str,
|
||||
directory_path: str = "",
|
||||
branch: str = "main",
|
||||
recursive: bool = True,
|
||||
build_tree: bool = False,
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
获取GitHub仓库目录下的所有文件路径
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL
|
||||
directory_path: 目录路径,默认为仓库根目录
|
||||
branch: 分支名称
|
||||
recursive: 是否递归获取子目录文件
|
||||
build_tree: 是否构建目录树
|
||||
|
||||
返回:
|
||||
list[RepoFileInfo]: 文件信息列表
|
||||
"""
|
||||
try:
|
||||
repo_info = GithubUtils.parse_github_url(repo_url)
|
||||
if await repo_info.update_repo_commit():
|
||||
logger.info(f"获取最新提交: {repo_info.branch}", LOG_COMMAND)
|
||||
else:
|
||||
logger.warning(f"获取最新提交失败: {repo_info}", LOG_COMMAND)
|
||||
|
||||
# 获取仓库树信息
|
||||
strategy = GitHubStrategy()
|
||||
strategy.body = await GitHubStrategy.parse_repo_info(repo_info)
|
||||
|
||||
# 处理目录路径,确保格式正确
|
||||
if directory_path and not directory_path.endswith("/") and recursive:
|
||||
directory_path = f"{directory_path}/"
|
||||
|
||||
# 获取文件列表
|
||||
file_list = []
|
||||
for tree_item in strategy.body.tree:
|
||||
# 如果不是递归模式,只获取当前目录下的文件
|
||||
if not recursive and "/" in tree_item.path.replace(
|
||||
directory_path, "", 1
|
||||
):
|
||||
continue
|
||||
|
||||
# 检查是否在指定目录下
|
||||
if directory_path and not tree_item.path.startswith(directory_path):
|
||||
continue
|
||||
|
||||
# 创建文件信息对象
|
||||
file_info = RepoFileInfo(
|
||||
path=tree_item.path,
|
||||
is_dir=tree_item.type == TreeType.DIR,
|
||||
size=tree_item.size,
|
||||
last_modified=None, # GitHub API不直接提供最后修改时间
|
||||
)
|
||||
file_list.append(file_info)
|
||||
|
||||
# 构建目录树结构
|
||||
if recursive and build_tree:
|
||||
file_list = self._build_directory_tree(file_list)
|
||||
|
||||
return file_list
|
||||
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
f"获取GitHub目录文件列表失败: {directory_path}", LOG_COMMAND, e=e
|
||||
)
|
||||
raise
|
||||
|
||||
async def _list_aliyun_directory_files(
|
||||
self,
|
||||
repo_name: str,
|
||||
directory_path: str = "",
|
||||
branch: str = "main",
|
||||
recursive: bool = True,
|
||||
build_tree: bool = False,
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
获取阿里云CodeUp仓库目录下的所有文件路径
|
||||
|
||||
参数:
|
||||
repo_name: 仓库名称
|
||||
directory_path: 目录路径,默认为仓库根目录
|
||||
branch: 分支名称
|
||||
recursive: 是否递归获取子目录文件
|
||||
build_tree: 是否构建目录树
|
||||
|
||||
返回:
|
||||
list[RepoFileInfo]: 文件信息列表
|
||||
"""
|
||||
try:
|
||||
from zhenxun.utils.github_utils.models import AliyunFileInfo
|
||||
|
||||
# 获取仓库树信息
|
||||
search_type = "RECURSIVE" if recursive else "DIRECT"
|
||||
tree_list = await AliyunFileInfo.get_repository_tree(
|
||||
repo=repo_name,
|
||||
path=directory_path,
|
||||
ref=branch,
|
||||
search_type=search_type,
|
||||
)
|
||||
|
||||
# 创建文件信息对象列表
|
||||
file_list = []
|
||||
for tree_item in tree_list:
|
||||
file_info = RepoFileInfo(
|
||||
path=tree_item.path,
|
||||
is_dir=tree_item.type == AliyunTreeType.DIR,
|
||||
size=None, # 阿里云API不直接提供文件大小
|
||||
last_modified=None, # 阿里云API不直接提供最后修改时间
|
||||
)
|
||||
file_list.append(file_info)
|
||||
|
||||
# 构建目录树结构
|
||||
if recursive and build_tree:
|
||||
file_list = self._build_directory_tree(file_list)
|
||||
|
||||
return file_list
|
||||
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
f"获取阿里云目录文件列表失败: {directory_path}", LOG_COMMAND, e=e
|
||||
)
|
||||
raise
|
||||
|
||||
def _build_directory_tree(
|
||||
self, file_list: list[RepoFileInfo]
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
构建目录树结构
|
||||
|
||||
参数:
|
||||
file_list: 文件信息列表
|
||||
|
||||
返回:
|
||||
list[RepoFileInfo]: 根目录下的文件信息列表
|
||||
"""
|
||||
# 按路径排序,确保父目录在子目录之前
|
||||
file_list.sort(key=lambda x: x.path)
|
||||
# 创建路径到文件信息的映射
|
||||
path_map = {file_info.path: file_info for file_info in file_list}
|
||||
# 根目录文件列表
|
||||
root_files = []
|
||||
|
||||
for file_info in file_list:
|
||||
if parent_path := "/".join(file_info.path.split("/")[:-1]):
|
||||
# 如果有父目录,将当前文件添加到父目录的子文件列表中
|
||||
if parent_path in path_map:
|
||||
path_map[parent_path].children.append(file_info)
|
||||
else:
|
||||
# 如果父目录不在列表中,创建一个虚拟的父目录
|
||||
parent_info = RepoFileInfo(
|
||||
path=parent_path, is_dir=True, children=[file_info]
|
||||
)
|
||||
path_map[parent_path] = parent_info
|
||||
# 检查父目录的父目录
|
||||
grand_parent_path = "/".join(parent_path.split("/")[:-1])
|
||||
if grand_parent_path and grand_parent_path in path_map:
|
||||
path_map[grand_parent_path].children.append(parent_info)
|
||||
else:
|
||||
root_files.append(parent_info)
|
||||
else:
|
||||
# 如果没有父目录,则是根目录下的文件
|
||||
root_files.append(file_info)
|
||||
|
||||
# 返回根目录下的文件列表
|
||||
return [
|
||||
file
|
||||
for file in root_files
|
||||
if all(f.path != file.path for f in file_list if f != file)
|
||||
]
|
||||
|
||||
async def download_files(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: tuple[str, Path] | list[tuple[str, Path]],
|
||||
branch: str = "main",
|
||||
repo_type: RepoType | None = None,
|
||||
ignore_error: bool = False,
|
||||
) -> FileDownloadResult:
|
||||
"""
|
||||
下载单个文件
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL
|
||||
file_path: 文件在仓库中的路径,本地存储路径
|
||||
branch: 分支名称
|
||||
repo_type: 仓库类型,如果为None则自动判断
|
||||
ignore_error: 是否忽略错误
|
||||
|
||||
返回:
|
||||
FileDownloadResult: 下载结果
|
||||
"""
|
||||
# 确定仓库类型和所有者
|
||||
repo_name = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "").strip()
|
||||
)
|
||||
|
||||
if isinstance(file_path, tuple):
|
||||
file_path = [file_path]
|
||||
|
||||
file_path_mapping = {f[0]: f[1] for f in file_path}
|
||||
|
||||
# 创建结果对象
|
||||
result = FileDownloadResult(
|
||||
repo_type=repo_type,
|
||||
repo_name=repo_name,
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
)
|
||||
|
||||
try:
|
||||
# 由于我们传入的是列表,所以这里一定返回列表
|
||||
file_paths = [f[0] for f in file_path]
|
||||
if len(file_paths) == 1:
|
||||
# 如果只有一个文件,可能返回单个元组
|
||||
file_contents_result = await self.get_file_content(
|
||||
repo_url, file_paths[0], branch, repo_type, ignore_error
|
||||
)
|
||||
if isinstance(file_contents_result, tuple):
|
||||
file_contents = [file_contents_result]
|
||||
elif isinstance(file_contents_result, str):
|
||||
file_contents = [(file_paths[0], file_contents_result)]
|
||||
else:
|
||||
file_contents = cast(list[tuple[str, str]], file_contents_result)
|
||||
else:
|
||||
# 多个文件一定返回列表
|
||||
file_contents = cast(
|
||||
list[tuple[str, str]],
|
||||
await self.get_file_content(
|
||||
repo_url, file_paths, branch, repo_type, ignore_error
|
||||
),
|
||||
)
|
||||
|
||||
for repo_file_path, content in file_contents:
|
||||
local_path = file_path_mapping[repo_file_path]
|
||||
local_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
# 使用二进制模式写入文件,避免编码问题
|
||||
if isinstance(content, str):
|
||||
content_bytes = content.encode("utf-8")
|
||||
else:
|
||||
content_bytes = content
|
||||
logger.warning(f"写入文件: {local_path}")
|
||||
async with aiofiles.open(local_path, "wb") as f:
|
||||
await f.write(content_bytes)
|
||||
result.success = True
|
||||
# 计算文件大小
|
||||
result.file_size = sum(
|
||||
len(content.encode("utf-8") if isinstance(content, str) else content)
|
||||
for _, content in file_contents
|
||||
)
|
||||
return result
|
||||
except Exception as e:
|
||||
logger.error(f"下载文件失败: {e}")
|
||||
result.success = False
|
||||
result.error_message = str(e)
|
||||
return result
|
||||
@@ -0,0 +1,526 @@
|
||||
"""
|
||||
GitHub仓库管理工具
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Callable
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
|
||||
from aiocache import cached
|
||||
|
||||
from zhenxun.services.log import logger
|
||||
from zhenxun.utils.github_utils import GithubUtils, RepoInfo
|
||||
from zhenxun.utils.http_utils import AsyncHttpx
|
||||
|
||||
from .base_manager import BaseRepoManager
|
||||
from .config import LOG_COMMAND, RepoConfig
|
||||
from .exceptions import (
|
||||
ApiRateLimitError,
|
||||
FileNotFoundError,
|
||||
NetworkError,
|
||||
RepoDownloadError,
|
||||
RepoNotFoundError,
|
||||
RepoUpdateError,
|
||||
)
|
||||
from .models import (
|
||||
FileDownloadResult,
|
||||
RepoCommitInfo,
|
||||
RepoFileInfo,
|
||||
RepoType,
|
||||
RepoUpdateResult,
|
||||
)
|
||||
|
||||
|
||||
class GithubManager(BaseRepoManager):
|
||||
"""GitHub仓库管理工具"""
|
||||
|
||||
def __init__(self, config: RepoConfig | None = None):
|
||||
"""
|
||||
初始化GitHub仓库管理工具
|
||||
|
||||
参数:
|
||||
config: 配置,如果为None则使用默认配置
|
||||
"""
|
||||
super().__init__(config)
|
||||
|
||||
async def update_repo(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
更新GitHub仓库
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL,格式为 https://github.com/owner/repo
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
try:
|
||||
# 解析仓库URL
|
||||
repo_info = GithubUtils.parse_github_url(repo_url)
|
||||
repo_info.branch = branch
|
||||
|
||||
# 获取仓库最新提交ID
|
||||
newest_commit = await self._get_newest_commit(
|
||||
repo_info.owner, repo_info.repo, branch
|
||||
)
|
||||
|
||||
# 创建结果对象
|
||||
result = RepoUpdateResult(
|
||||
repo_type=RepoType.GITHUB,
|
||||
repo_name=repo_info.repo,
|
||||
owner=repo_info.owner,
|
||||
old_version="", # 将在后面更新
|
||||
new_version=newest_commit,
|
||||
)
|
||||
|
||||
old_version = await self.read_version_file(local_path)
|
||||
old_version = old_version.split("-")[-1]
|
||||
result.old_version = old_version
|
||||
|
||||
# 如果版本相同,则无需更新
|
||||
if newest_commit in old_version:
|
||||
result.success = True
|
||||
logger.debug(
|
||||
f"仓库 {repo_info.repo} 已是最新版本: {newest_commit}",
|
||||
LOG_COMMAND,
|
||||
)
|
||||
return result
|
||||
|
||||
# 确保本地目录存在
|
||||
local_path.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 获取变更的文件列表
|
||||
changed_files = await self._get_changed_files(
|
||||
repo_info.owner,
|
||||
repo_info.repo,
|
||||
old_version or None,
|
||||
newest_commit,
|
||||
)
|
||||
|
||||
# 过滤文件
|
||||
if include_patterns or exclude_patterns:
|
||||
from .utils import filter_files
|
||||
|
||||
changed_files = filter_files(
|
||||
changed_files, include_patterns, exclude_patterns
|
||||
)
|
||||
|
||||
result.changed_files = changed_files
|
||||
|
||||
# 下载变更的文件
|
||||
for file_path in changed_files:
|
||||
try:
|
||||
local_file_path = local_path / file_path
|
||||
await self._download_file(repo_info, file_path, local_file_path)
|
||||
except Exception as e:
|
||||
logger.error(f"下载文件 {file_path} 失败", LOG_COMMAND, e=e)
|
||||
|
||||
# 更新版本文件
|
||||
await self.write_version_file(local_path, newest_commit)
|
||||
|
||||
result.success = True
|
||||
return result
|
||||
|
||||
except RepoUpdateError as e:
|
||||
logger.error("更新仓库失败", LOG_COMMAND, e=e)
|
||||
return RepoUpdateResult(
|
||||
repo_type=RepoType.GITHUB,
|
||||
repo_name=repo_url.split("/")[-1] if "/" in repo_url else repo_url,
|
||||
owner=repo_url.split("/")[-2] if "/" in repo_url else "unknown",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=str(e),
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error("更新仓库失败", LOG_COMMAND, e=e)
|
||||
return RepoUpdateResult(
|
||||
repo_type=RepoType.GITHUB,
|
||||
repo_name=repo_url.split("/")[-1] if "/" in repo_url else repo_url,
|
||||
owner=repo_url.split("/")[-2] if "/" in repo_url else "unknown",
|
||||
old_version="",
|
||||
new_version="",
|
||||
error_message=str(e),
|
||||
)
|
||||
|
||||
async def download_file(
|
||||
self,
|
||||
repo_url: str,
|
||||
file_path: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
) -> FileDownloadResult:
|
||||
"""
|
||||
从GitHub下载单个文件
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL,格式为 https://github.com/owner/repo
|
||||
file_path: 文件在仓库中的路径
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
|
||||
返回:
|
||||
FileDownloadResult: 下载结果
|
||||
"""
|
||||
repo_name = (
|
||||
repo_url.split("/tree/")[0].split("/")[-1].replace(".git", "").strip()
|
||||
)
|
||||
try:
|
||||
# 解析仓库URL
|
||||
repo_info = GithubUtils.parse_github_url(repo_url)
|
||||
repo_info.branch = branch
|
||||
|
||||
# 创建结果对象
|
||||
result = FileDownloadResult(
|
||||
repo_type=RepoType.GITHUB,
|
||||
repo_name=repo_info.repo,
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
)
|
||||
|
||||
# 确保本地目录存在
|
||||
local_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 下载文件
|
||||
file_size = await self._download_file(repo_info, file_path, local_path)
|
||||
|
||||
result.success = True
|
||||
result.file_size = file_size
|
||||
return result
|
||||
|
||||
except RepoDownloadError as e:
|
||||
logger.error("下载文件失败", LOG_COMMAND, e=e)
|
||||
return FileDownloadResult(
|
||||
repo_type=RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
error_message=str(e),
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error("下载文件失败", LOG_COMMAND, e=e)
|
||||
return FileDownloadResult(
|
||||
repo_type=RepoType.GITHUB,
|
||||
repo_name=repo_name,
|
||||
file_path=file_path,
|
||||
version=branch,
|
||||
error_message=str(e),
|
||||
)
|
||||
|
||||
async def get_file_list(
|
||||
self,
|
||||
repo_url: str,
|
||||
dir_path: str = "",
|
||||
branch: str = "main",
|
||||
recursive: bool = False,
|
||||
) -> list[RepoFileInfo]:
|
||||
"""
|
||||
获取仓库文件列表
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL,格式为 https://github.com/owner/repo
|
||||
dir_path: 目录路径,空字符串表示仓库根目录
|
||||
branch: 分支名称
|
||||
recursive: 是否递归获取子目录
|
||||
|
||||
返回:
|
||||
list[RepoFileInfo]: 文件信息列表
|
||||
"""
|
||||
try:
|
||||
# 解析仓库URL
|
||||
repo_info = GithubUtils.parse_github_url(repo_url)
|
||||
repo_info.branch = branch
|
||||
|
||||
# 获取文件列表
|
||||
for api in GithubUtils.iter_api_strategies():
|
||||
try:
|
||||
await api.parse_repo_info(repo_info)
|
||||
files = api.get_files(dir_path, True)
|
||||
|
||||
result = []
|
||||
for file_path in files:
|
||||
# 跳过非当前目录的文件(如果不是递归模式)
|
||||
if not recursive and "/" in file_path.replace(
|
||||
dir_path, "", 1
|
||||
).strip("/"):
|
||||
continue
|
||||
|
||||
is_dir = file_path.endswith("/")
|
||||
file_info = RepoFileInfo(path=file_path, is_dir=is_dir)
|
||||
result.append(file_info)
|
||||
|
||||
return result
|
||||
except Exception as e:
|
||||
logger.debug("使用API策略获取文件列表失败", LOG_COMMAND, e=e)
|
||||
continue
|
||||
|
||||
raise RepoNotFoundError(repo_url)
|
||||
|
||||
except Exception as e:
|
||||
logger.error("获取文件列表失败", LOG_COMMAND, e=e)
|
||||
return []
|
||||
|
||||
async def get_commit_info(
|
||||
self, repo_url: str, commit_id: str
|
||||
) -> RepoCommitInfo | None:
|
||||
"""
|
||||
获取提交信息
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL,格式为 https://github.com/owner/repo
|
||||
commit_id: 提交ID
|
||||
|
||||
返回:
|
||||
Optional[RepoCommitInfo]: 提交信息,如果获取失败则返回None
|
||||
"""
|
||||
try:
|
||||
# 解析仓库URL
|
||||
repo_info = GithubUtils.parse_github_url(repo_url)
|
||||
|
||||
# 构建API URL
|
||||
api_url = f"https://api.github.com/repos/{repo_info.owner}/{repo_info.repo}/commits/{commit_id}"
|
||||
|
||||
# 发送请求
|
||||
resp = await AsyncHttpx.get(
|
||||
api_url,
|
||||
timeout=self.config.github.api_timeout,
|
||||
proxy=self.config.github.proxy,
|
||||
)
|
||||
|
||||
if resp.status_code == 403 and "rate limit" in resp.text.lower():
|
||||
raise ApiRateLimitError("GitHub")
|
||||
|
||||
if resp.status_code != 200:
|
||||
if resp.status_code == 404:
|
||||
raise RepoNotFoundError(f"{repo_info.owner}/{repo_info.repo}")
|
||||
raise NetworkError(f"HTTP {resp.status_code}: {resp.text}")
|
||||
|
||||
data = resp.json()
|
||||
|
||||
return RepoCommitInfo(
|
||||
commit_id=data["sha"],
|
||||
message=data["commit"]["message"],
|
||||
author=data["commit"]["author"]["name"],
|
||||
commit_time=datetime.fromisoformat(
|
||||
data["commit"]["author"]["date"].replace("Z", "+00:00")
|
||||
),
|
||||
changed_files=[file["filename"] for file in data.get("files", [])],
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error("获取提交信息失败", LOG_COMMAND, e=e)
|
||||
return None
|
||||
|
||||
async def _get_newest_commit(self, owner: str, repo: str, branch: str) -> str:
|
||||
"""
|
||||
获取仓库最新提交ID
|
||||
|
||||
参数:
|
||||
owner: 仓库拥有者
|
||||
repo: 仓库名称
|
||||
branch: 分支名称
|
||||
|
||||
返回:
|
||||
str: 提交ID
|
||||
"""
|
||||
try:
|
||||
newest_commit = await RepoInfo.get_newest_commit(owner, repo, branch)
|
||||
if not newest_commit:
|
||||
raise RepoNotFoundError(f"{owner}/{repo}")
|
||||
return newest_commit
|
||||
except Exception as e:
|
||||
logger.error("获取最新提交ID失败", LOG_COMMAND, e=e)
|
||||
raise RepoUpdateError(f"获取最新提交ID失败: {e}")
|
||||
|
||||
@cached(ttl=3600)
|
||||
async def _get_changed_files(
|
||||
self, owner: str, repo: str, old_commit: str | None, new_commit: str
|
||||
) -> list[str]:
|
||||
"""
|
||||
获取两个提交之间变更的文件列表
|
||||
|
||||
参数:
|
||||
owner: 仓库拥有者
|
||||
repo: 仓库名称
|
||||
old_commit: 旧提交ID,如果为None则获取所有文件
|
||||
new_commit: 新提交ID
|
||||
|
||||
返回:
|
||||
list[str]: 变更的文件列表
|
||||
"""
|
||||
if not old_commit:
|
||||
# 如果没有旧提交,则获取仓库中的所有文件
|
||||
api_url = f"https://api.github.com/repos/{owner}/{repo}/git/trees/{new_commit}?recursive=1"
|
||||
|
||||
resp = await AsyncHttpx.get(
|
||||
api_url,
|
||||
timeout=self.config.github.api_timeout,
|
||||
proxy=self.config.github.proxy,
|
||||
)
|
||||
|
||||
if resp.status_code == 403 and "rate limit" in resp.text.lower():
|
||||
raise ApiRateLimitError("GitHub")
|
||||
|
||||
if resp.status_code != 200:
|
||||
if resp.status_code == 404:
|
||||
raise RepoNotFoundError(f"{owner}/{repo}")
|
||||
raise NetworkError(f"HTTP {resp.status_code}: {resp.text}")
|
||||
|
||||
data = resp.json()
|
||||
return [
|
||||
item["path"] for item in data.get("tree", []) if item["type"] == "blob"
|
||||
]
|
||||
|
||||
# 如果有旧提交,则获取两个提交之间的差异
|
||||
api_url = f"https://api.github.com/repos/{owner}/{repo}/compare/{old_commit}...{new_commit}"
|
||||
|
||||
resp = await AsyncHttpx.get(
|
||||
api_url,
|
||||
timeout=self.config.github.api_timeout,
|
||||
proxy=self.config.github.proxy,
|
||||
)
|
||||
|
||||
if resp.status_code == 403 and "rate limit" in resp.text.lower():
|
||||
raise ApiRateLimitError("GitHub")
|
||||
|
||||
if resp.status_code != 200:
|
||||
if resp.status_code == 404:
|
||||
raise RepoNotFoundError(f"{owner}/{repo}")
|
||||
raise NetworkError(f"HTTP {resp.status_code}: {resp.text}")
|
||||
|
||||
data = resp.json()
|
||||
return [file["filename"] for file in data.get("files", [])]
|
||||
|
||||
async def update_via_git(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
force: bool = False,
|
||||
*,
|
||||
repo_type: RepoType | None = None,
|
||||
owner: str | None = None,
|
||||
prepare_repo_url: Callable[[str], str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
通过Git命令直接更新仓库
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL,格式为 https://github.com/owner/repo
|
||||
local_path: 本地仓库路径
|
||||
branch: 分支名称
|
||||
force: 是否强制拉取
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
# 解析仓库URL
|
||||
repo_info = GithubUtils.parse_github_url(repo_url)
|
||||
|
||||
# 调用基类的update_via_git方法
|
||||
return await super().update_via_git(
|
||||
repo_url=repo_url,
|
||||
local_path=local_path,
|
||||
branch=branch,
|
||||
force=force,
|
||||
repo_type=RepoType.GITHUB,
|
||||
owner=repo_info.owner,
|
||||
)
|
||||
|
||||
async def update(
|
||||
self,
|
||||
repo_url: str,
|
||||
local_path: Path,
|
||||
branch: str = "main",
|
||||
use_git: bool = True,
|
||||
force: bool = False,
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> RepoUpdateResult:
|
||||
"""
|
||||
更新仓库,可选择使用Git命令或API方式
|
||||
|
||||
参数:
|
||||
repo_url: 仓库URL,格式为 https://github.com/owner/repo
|
||||
local_path: 本地保存路径
|
||||
branch: 分支名称
|
||||
use_git: 是否使用Git命令更新
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
返回:
|
||||
RepoUpdateResult: 更新结果
|
||||
"""
|
||||
if use_git:
|
||||
return await self.update_via_git(repo_url, local_path, branch, force)
|
||||
else:
|
||||
return await self.update_repo(
|
||||
repo_url, local_path, branch, include_patterns, exclude_patterns
|
||||
)
|
||||
|
||||
async def _download_file(
|
||||
self, repo_info: RepoInfo, file_path: str, local_path: Path
|
||||
) -> int:
|
||||
"""
|
||||
下载文件
|
||||
|
||||
参数:
|
||||
repo_info: 仓库信息
|
||||
file_path: 文件在仓库中的路径
|
||||
local_path: 本地保存路径
|
||||
|
||||
返回:
|
||||
int: 文件大小(字节)
|
||||
"""
|
||||
# 确保目录存在
|
||||
local_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# 获取下载URL
|
||||
download_url = await repo_info.get_raw_download_url(file_path)
|
||||
|
||||
# 下载文件
|
||||
for retry in range(self.config.github.download_retry + 1):
|
||||
try:
|
||||
resp = await AsyncHttpx.get(
|
||||
download_url,
|
||||
timeout=self.config.github.download_timeout,
|
||||
)
|
||||
|
||||
if resp.status_code == 403 and "rate limit" in resp.text.lower():
|
||||
raise ApiRateLimitError("GitHub")
|
||||
|
||||
if resp.status_code != 200:
|
||||
if resp.status_code == 404:
|
||||
raise FileNotFoundError(
|
||||
file_path, f"{repo_info.owner}/{repo_info.repo}"
|
||||
)
|
||||
|
||||
if retry < self.config.github.download_retry:
|
||||
await asyncio.sleep(1)
|
||||
continue
|
||||
|
||||
raise NetworkError(f"HTTP {resp.status_code}: {resp.text}")
|
||||
|
||||
# 保存文件
|
||||
return await self.save_file_content(resp.content, local_path)
|
||||
|
||||
except (ApiRateLimitError, FileNotFoundError) as e:
|
||||
# 这些错误不需要重试
|
||||
raise e
|
||||
except Exception as e:
|
||||
if retry < self.config.github.download_retry:
|
||||
logger.warning("下载文件失败,将重试", LOG_COMMAND, e=e)
|
||||
await asyncio.sleep(1)
|
||||
continue
|
||||
raise RepoDownloadError("下载文件失败")
|
||||
|
||||
raise RepoDownloadError("下载文件失败: 超过最大重试次数")
|
||||
@@ -0,0 +1,89 @@
|
||||
"""
|
||||
仓库管理工具的数据模型
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
class RepoType(str, Enum):
|
||||
"""仓库类型"""
|
||||
|
||||
GITHUB = "github"
|
||||
ALIYUN = "aliyun"
|
||||
|
||||
|
||||
@dataclass
|
||||
class RepoFileInfo:
|
||||
"""仓库文件信息"""
|
||||
|
||||
# 文件路径
|
||||
path: str
|
||||
# 是否是目录
|
||||
is_dir: bool
|
||||
# 文件大小(字节)
|
||||
size: int | None = None
|
||||
# 最后修改时间
|
||||
last_modified: datetime | None = None
|
||||
# 子文件列表
|
||||
children: list["RepoFileInfo"] = field(default_factory=list)
|
||||
|
||||
|
||||
@dataclass
|
||||
class RepoCommitInfo:
|
||||
"""仓库提交信息"""
|
||||
|
||||
# 提交ID
|
||||
commit_id: str
|
||||
# 提交消息
|
||||
message: str
|
||||
# 作者
|
||||
author: str
|
||||
# 提交时间
|
||||
commit_time: datetime
|
||||
# 变更的文件列表
|
||||
changed_files: list[str] = field(default_factory=list)
|
||||
|
||||
|
||||
@dataclass
|
||||
class RepoUpdateResult:
|
||||
"""仓库更新结果"""
|
||||
|
||||
# 仓库类型
|
||||
repo_type: RepoType
|
||||
# 仓库名称
|
||||
repo_name: str
|
||||
# 仓库拥有者
|
||||
owner: str
|
||||
# 旧版本
|
||||
old_version: str
|
||||
# 新版本
|
||||
new_version: str
|
||||
# 是否成功
|
||||
success: bool = False
|
||||
# 错误消息
|
||||
error_message: str = ""
|
||||
# 变更的文件列表
|
||||
changed_files: list[str] = field(default_factory=list)
|
||||
|
||||
|
||||
@dataclass
|
||||
class FileDownloadResult:
|
||||
"""文件下载结果"""
|
||||
|
||||
# 仓库类型
|
||||
repo_type: RepoType | None
|
||||
# 仓库名称
|
||||
repo_name: str
|
||||
# 文件路径
|
||||
file_path: list[tuple[str, Path]] | str
|
||||
# 版本
|
||||
version: str
|
||||
# 是否成功
|
||||
success: bool = False
|
||||
# 文件大小(字节)
|
||||
file_size: int = 0
|
||||
# 错误消息
|
||||
error_message: str = ""
|
||||
@@ -0,0 +1,135 @@
|
||||
"""
|
||||
仓库管理工具的工具函数
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
from zhenxun.services.log import logger
|
||||
|
||||
from .config import LOG_COMMAND
|
||||
|
||||
|
||||
async def check_git() -> bool:
|
||||
"""
|
||||
检查环境变量中是否存在 git
|
||||
|
||||
返回:
|
||||
bool: 是否存在git命令
|
||||
"""
|
||||
try:
|
||||
process = await asyncio.create_subprocess_shell(
|
||||
"git --version",
|
||||
stdout=asyncio.subprocess.PIPE,
|
||||
stderr=asyncio.subprocess.PIPE,
|
||||
)
|
||||
stdout, _ = await process.communicate()
|
||||
return bool(stdout)
|
||||
except Exception as e:
|
||||
logger.error("检查git命令失败", LOG_COMMAND, e=e)
|
||||
return False
|
||||
|
||||
|
||||
async def clean_git(cwd: Path):
|
||||
"""
|
||||
清理git仓库
|
||||
|
||||
参数:
|
||||
cwd: 工作目录
|
||||
"""
|
||||
await run_git_command("reset --hard", cwd)
|
||||
await run_git_command("clean -xdf", cwd)
|
||||
|
||||
|
||||
async def run_git_command(
|
||||
command: str, cwd: Path | None = None
|
||||
) -> tuple[bool, str, str]:
|
||||
"""
|
||||
运行git命令
|
||||
|
||||
参数:
|
||||
command: 命令
|
||||
cwd: 工作目录
|
||||
|
||||
返回:
|
||||
tuple[bool, str, str]: (是否成功, 标准输出, 标准错误)
|
||||
"""
|
||||
try:
|
||||
full_command = f"git {command}"
|
||||
# 将Path对象转换为字符串
|
||||
cwd_str = str(cwd) if cwd else None
|
||||
process = await asyncio.create_subprocess_shell(
|
||||
full_command,
|
||||
stdout=asyncio.subprocess.PIPE,
|
||||
stderr=asyncio.subprocess.PIPE,
|
||||
cwd=cwd_str,
|
||||
)
|
||||
stdout_bytes, stderr_bytes = await process.communicate()
|
||||
|
||||
stdout = stdout_bytes.decode("utf-8").strip()
|
||||
stderr = stderr_bytes.decode("utf-8").strip()
|
||||
|
||||
return process.returncode == 0, stdout, stderr
|
||||
except Exception as e:
|
||||
logger.error(f"运行git命令失败: {command}, 错误: {e}")
|
||||
return False, "", str(e)
|
||||
|
||||
|
||||
def glob_to_regex(pattern: str) -> str:
|
||||
"""
|
||||
将glob模式转换为正则表达式
|
||||
|
||||
参数:
|
||||
pattern: glob模式,如 "*.py"
|
||||
|
||||
返回:
|
||||
str: 正则表达式
|
||||
"""
|
||||
# 转义特殊字符
|
||||
regex = re.escape(pattern)
|
||||
|
||||
# 替换glob通配符
|
||||
regex = regex.replace(r"\*\*", ".*") # ** -> .*
|
||||
regex = regex.replace(r"\*", "[^/]*") # * -> [^/]*
|
||||
regex = regex.replace(r"\?", "[^/]") # ? -> [^/]
|
||||
|
||||
# 添加开始和结束标记
|
||||
regex = f"^{regex}$"
|
||||
|
||||
return regex
|
||||
|
||||
|
||||
def filter_files(
|
||||
files: list[str],
|
||||
include_patterns: list[str] | None = None,
|
||||
exclude_patterns: list[str] | None = None,
|
||||
) -> list[str]:
|
||||
"""
|
||||
过滤文件列表
|
||||
|
||||
参数:
|
||||
files: 文件列表
|
||||
include_patterns: 包含的文件模式列表,如 ["*.py", "docs/*.md"]
|
||||
exclude_patterns: 排除的文件模式列表,如 ["__pycache__/*", "*.pyc"]
|
||||
|
||||
返回:
|
||||
list[str]: 过滤后的文件列表
|
||||
"""
|
||||
result = files.copy()
|
||||
|
||||
# 应用包含模式
|
||||
if include_patterns:
|
||||
included = []
|
||||
for pattern in include_patterns:
|
||||
regex_pattern = glob_to_regex(pattern)
|
||||
included.extend(file for file in result if re.match(regex_pattern, file))
|
||||
result = included
|
||||
|
||||
# 应用排除模式
|
||||
if exclude_patterns:
|
||||
for pattern in exclude_patterns:
|
||||
regex_pattern = glob_to_regex(pattern)
|
||||
result = [file for file in result if not re.match(regex_pattern, file)]
|
||||
|
||||
return result
|
||||
Reference in New Issue
Block a user