Python 实战：构建 Git 自动化助手
在多项目协作、企业级工程管理或开源社区维护中，经常面临需要同时管理数十甚至上百个 Git 仓库的场景：
多仓库需要统一
pull拉取更新定期向多个项目批量
commit和push自动备份 Git 项目
批量拉取私有仓库并管理密钥
为解决这类高频、重复、机械性工作，我们可以使用 Python 编写一个Git 自动化助手工具，实现：
批量 clone 多个远程 Git 仓库
批量执行 pull / commit / push
支持设置统一 commit message
支持命令行控制与配置文件管理
支持日志输出与失败重试
一、项目功能概览
| 功能模块 | 说明 |
|---|---|
| 仓库配置 | 支持 YAML / JSON 配置仓库 URL 和路径 |
| clone 批处理 | 支持跳过已存在目录，自动 clone 多仓库 |
| pull / commit / push 批量执行 | 一键同步所有项目代码 |
| commit message 统一 | 设定统一 commit 信息 |
| 支持 SSH 密钥 | 自动化处理私有仓库访问 |
| 日志记录 | 每次操作都记录详细日志，便于追踪 |
二、技术栈与依赖
| 技术 / 库 | 用途 |
|---|---|
GitPython | Git 操作封装库，简化命令行交互 |
PyYAML | 配置文件解析 |
os / subprocess | 补充执行 git 命令（部分特殊情况） |
logging | 日志记录 |
argparse | 命令行参数解析 |
安装依赖
bash
复制编辑
pip install GitPython PyYAML
三、项目结构设计
bash
复制编辑
git_helper/ ├── main.py # 启动入口 ├── core/ │ ├── manager.py # 批量管理核心逻辑 │ ├── config.py # 仓库配置解析 │ └── logger.py # 日志模块 ├── repos.yaml # 仓库配置清单 └── logs/ └── run.log # 自动记录操作日志
四、仓库配置文件 repos.yaml
使用 YAML 格式管理多仓库：
yaml
复制编辑
repos: - name: ProjectA url: git@github.com:yourorg/project-a.git path: ./workspace/project-a - name: ProjectB url: https://github.com/yourorg/project-b.git path: ./workspace/project-b
五、配置解析 core/config.py
python
复制编辑
import yaml def load_repos(config_file="repos.yaml"): with open(config_file, "r", encoding="utf-8") as f: data = yaml.safe_load(f) return data["repos"]
六、Git 操作核心模块 core/manager.py
python
复制编辑
from git import Repo, GitCommandError import os import logging class GitManager: def __init__(self, repos): self.repos = repos def clone_all(self): for repo in self.repos: path = repo["path"] if os.path.exists(path): logging.info(f"[跳过] {repo['name']} 已存在目录") continue try: Repo.clone_from(repo["url"], path) logging.info(f"[clone成功] {repo['name']}") except GitCommandError as e: logging.error(f"[clone失败] {repo['name']}: {e}") def pull_all(self): for repo in self.repos: try: r = Repo(repo["path"]) o = r.remotes.origin o.pull() logging.info(f"[pull成功] {repo['name']}") except Exception as e: logging.error(f"[pull失败] {repo['name']}: {e}") def commit_all(self, message): for repo in self.repos: try: r = Repo(repo["path"]) r.git.add(all=True) if r.is_dirty(): r.index.commit(message) logging.info(f"[commit成功] {repo['name']}") else: logging.info(f"[无修改] {repo['name']}") except Exception as e: logging.error(f"[commit失败] {repo['name']}: {e}") def push_all(self): for repo in self.repos: try: r = Repo(repo["path"]) r.remotes.origin.push() logging.info(f"[push成功] {repo['name']}") except Exception as e: logging.error(f"[push失败] {repo['name']}: {e}")
七、日志模块 core/logger.py
python
复制编辑
import logging import os def setup_logger(): os.makedirs("logs", exist_ok=True) logging.basicConfig( level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s", handlers=[ logging.FileHandler("logs/run.log", encoding="utf-8"), logging.StreamHandler() ] )
八、命令行入口 main.py
python
复制编辑
import argparse from core.config import load_repos from core.manager import GitManager from core.logger import setup_logger def main(): setup_logger() parser = argparse.ArgumentParser(description="Git 自动化助手") parser.add_argument("--clone", action="store_true", help="批量 clone 所有仓库") parser.add_argument("--pull", action="store_true", help="批量 pull 所有仓库") parser.add_argument("--commit", help="批量 commit 所有仓库，需指定 commit 信息") parser.add_argument("--push", action="store_true", help="批量 push 所有仓库") args = parser.parse_args() repos = load_repos() manager = GitManager(repos) if args.clone: manager.clone_all() if args.pull: manager.pull_all() if args.commit: manager.commit_all(args.commit) if args.push: manager.push_all() if __name__ == "__main__": main()