如何用Python读取Git暂存区（staged）中的文件版本？

要解决预提交钩子误判的问题，核心是直接读取暂存区中的文件版本，而非本地磁盘已保存的版本。可以通过Git命令结合Python的subprocess模块实现：

核心思路 #

使用Git内置命令 git show :<文件路径>，该命令会直接从Git的对象数据库中提取指定文件在暂存区的内容，完全不受本地文件修改的影响。

Python实现代码 #

import subprocess

def get_staged_content(file_path):
    try:
        # 调用git show获取暂存区文件内容
        proc = subprocess.run(
            ["git", "show", f":{file_path}"],
            capture_output=True,
            text=True,
            check=True
        )
        return proc.stdout
    except subprocess.CalledProcessError:
        # 处理文件未被暂存或不存在的情况
        return None

# 调用示例
staged_text = get_staged_content("target-file.txt")
if staged_text:
    # 在这里执行你的内容检查逻辑
    if "required-content" not in staged_text:
        print("错误：暂存的文件缺少指定内容！")
        exit(1)  # 非零退出码会阻止提交

关键说明 #

• git show :<file_path> 中的冒号是语法要求，用来指定读取暂存区的版本。
• subprocess.run 的check=True会在Git命令执行失败时抛出异常，比如文件未被暂存。
• 如果需要处理二进制文件，将text=True改为text=False，返回字节流后自行处理。
• 确保脚本在Git仓库根目录执行，或使用相对于仓库根的文件路径。

内容的提问来源于stack exchange，提问作者Rufus