GitPython 中高效获取当前分支相对于 master 的所有变更文件列表-Python教程

本文介绍如何使用 gitpython 库以原生、可维护的方式获取当前分支（含未提交变更）相对于 `master` 分支的所有新增或修改文件路径，替代依赖 shell 命令的 `repo.git.diff()` 调用。

在 GitPython 中，repo.head.commit.diff(‘master’) 仅比较两个已提交快照（即当前 HEAD 提交与 master 分支最新提交），因此会遗漏工作区（unstaged）、暂存区（staged）中尚未提交的变更——这正是用户遇到的核心问题：命令行 git diff –name-only master 默认包含工作区与暂存区的差异，而 commit.diff() 不包含。

要真正复现 git diff –name-only master 的行为，需分三步获取完整变更集合：

1. 暂存区 vs master（staged changes）：repo.index.diff(‘master’)
2. 工作区 vs 暂存区（unstaged changes）：repo.index.diff(None)
3. 合并去重：统一提取 a_path（对新增/修改文件，a_path 即目标路径；删除时 b_path 有效，但本例暂不处理）

✅ 推荐的 Pythonic 实现如下：

import git

repo = git.Repo("path/to/your/repo")

# 获取所有变更路径（去重）
changed_files = set()

# 1. 已暂存的变更（staged）：暂存区 vs master
for diff in repo.index.diff('master'):
    if diff.a_path:
        changed_files.add(diff.a_path)
    if diff.b_path and diff.change_type == 'D':  # 删除文件也计入（可选）
        changed_files.add(diff.b_path)

# 2. 未暂存的变更（unstaged）：工作区 vs 暂存区
for diff in repo.index.diff(None):
    if diff.a_path:
        changed_files.add(diff.a_path)

# 转为排序列表，便于阅读与后续处理
result = sorted(changed_files)
print("\n".join(result))

⚠️ 注意事项：