如何用GitPython实现类似git diff --name-only master的功能?
Pythonic方式获取分支相对于Master的所有变更文件(含历史提交与未提交)
要实现和git diff --name-only master相同的效果,同时用纯GitPython API替代命令行调用,可以分两步获取变更文件:已提交的历史分支差异,以及未提交的本地修改,最后合并去重。
实现步骤
- 初始化仓库对象
from git import Repo # 替换为你的仓库路径 repo = Repo("/your/repo/path")
- 获取当前分支相对于Master的所有已提交变更文件
这一步会获取从Master分支分叉后,当前分支所有历史提交中修改过的文件:
# 对比master分支与当前HEAD的所有提交差异 committed_diff = repo.diff("master", "HEAD", create_patch=False) committed_files = set() for change in committed_diff: # 添加变更的文件路径 committed_files.add(change.a_path) # 如果是重命名文件,同时添加新路径 if change.renamed: committed_files.add(change.b_path)
如果只需要特定类型的变更(比如仅修改/新增),可以用iter_change_type过滤:
# 仅获取修改(M)和新增(A)的文件 for change in committed_diff.iter_change_type("M", "A"): committed_files.add(change.a_path) if change.renamed: committed_files.add(change.b_path)
- 获取未提交的本地变更文件(暂存区+工作区)
这一步获取还没提交到仓库的修改,包括已暂存和未暂存的文件:
# 对比HEAD与本地工作区+暂存区的差异 uncommitted_diff = repo.diff("HEAD") uncommitted_files = set() for change in uncommitted_diff: uncommitted_files.add(change.a_path) if change.renamed: uncommitted_files.add(change.b_path)
- 合并去重得到最终文件列表
all_changed_files = list(committed_files.union(uncommitted_files))
为什么之前的代码无法满足需求
你之前使用commit.diff(master)仅对比了当前HEAD提交与Master最新提交的单次差异,只能拿到最后一次提交的修改文件。而repo.diff("master", "HEAD")会遍历两个分支之间的所有提交差异,覆盖从分叉点到当前HEAD的所有历史变更;加上repo.diff("HEAD")则补充了本地未提交的修改,两者结合就完全等价于git diff --name-only master的效果。
内容的提问来源于stack exchange,提问作者Mark Hammack
相关产品推荐
相关产品推荐

