如何用Python从内部Git仓库URL获取最新短格式Git提交ID

问题背景 #

原有Python函数仅能在本地项目存在.git目录时提取最新短格式Git提交ID，现需修改为直接从内部Git仓库URL中获取该ID，无需依赖本地仓库。

解决方案 #

利用Git的ls-remote命令可直接查询远程仓库的引用信息，无需克隆整个仓库。结合rev-parse --short可将完整提交ID转换为短格式，以下是修改后的Python实现：

from os.path import exists
from subprocess import Popen, PIPE, CalledProcessError

def get_remote_git_commit_id(repo_url: str, txt_file: str) -> str:
    """
    从远程Git仓库URL获取最新短格式提交ID，并写入指定文本文件
    参数:
    ==========
    :param repo_url: 远程Git仓库的URL
    :param txt_file: 用于存储提交ID的文本文件名
    Returns:
    ==========
    :return: 最新短格式Git提交ID，异常时返回"latest"
    """
    if not exists(txt_file):
        print(f"'{txt_file}' 不存在，将创建新文件")  # 日志输出
    
    full_commit_id = None
    # 第一步：获取远程HEAD对应的完整提交ID
    try:
        # 使用列表形式传递命令参数，避免Shell注入风险
        ls_remote_process = Popen(
            ["git", "ls-remote", repo_url, "HEAD"],
            stdout=PIPE,
            stderr=PIPE,
            text=True
        )
        stdout, stderr = ls_remote_process.communicate()
        
        if ls_remote_process.returncode != 0:
            raise CalledProcessError(ls_remote_process.returncode, "git ls-remote", stderr)
        
        # 解析输出：输出格式为 "<完整提交ID>\tHEAD"
        full_commit_id = stdout.strip().split("\t")[0]
    except Exception as error:
        print(f"无法获取远程仓库提交ID: {str(error)}")
        full_commit_id = "latest"
    
    # 第二步：将完整ID转换为短格式（若获取到有效完整ID）
    short_commit_id = full_commit_id
    if full_commit_id != "latest":
        try:
            rev_parse_process = Popen(
                ["git", "rev-parse", "--short", full_commit_id],
                stdout=PIPE,
                stderr=PIPE,
                text=True
            )
            stdout, stderr = rev_parse_process.communicate()
            
            if rev_parse_process.returncode == 0:
                short_commit_id = stdout.strip()
            else:
                print(f"转换短ID失败，将使用完整ID: {stderr}")
        except Exception as error:
            print(f"转换短ID时出错: {str(error)}")
    
    # 写入文件并返回结果
    with open(txt_file, "w", encoding="utf8") as file:
        file.write(short_commit_id)
    
    return short_commit_id

# 调用示例：替换为你的内部Git仓库URL
get_remote_git_commit_id("https://your-internal-git-repo-url.git", "git_commit_id.txt")

关键说明 #

• git ls-remote：无需克隆仓库，直接从远程获取HEAD对应的完整提交ID，输出格式为完整ID\tHEAD
• 避免Shell注入：使用列表形式传递命令参数，而非拼接字符串，提升安全性
• 异常处理：覆盖了远程仓库不可达、Git命令不存在、权限不足等异常场景，默认返回"latest"作为降级方案
• 短ID转换：利用git rev-parse --short生成符合Git规范的短提交ID，避免手动截取可能导致的ID冲突问题

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