如何通过GitPython直接获取Git远程仓库的master/main主分支

我已知可以遍历仓库的heads引用获取结果，示例代码如下：

repo = git.Repo('git-repo')
remote_refs = repo.remote().refs

for refs in remote_refs:
    print(refs)

该代码会输出远程端所有分支的头部引用，包含main/master主分支。请问有没有直接获取主分支的方法？

有两种常用的直接获取方法，不需要遍历全部分支引用：

方法1：通过远程HEAD引用直接获取 #

远程仓库的HEAD默认指向主分支，git-python可以直接读取该引用指向的分支：

import git

repo = git.Repo('git-repo')
# 直接获取远程默认主分支
main_branch = repo.remote().refs.HEAD.ref

print("远程主分支名称：", main_branch.name)
# 输出示例：main 或者 master

方法2：兼容异常场景的方案 #

如果本地缓存的远程引用没有同步，或者仓库没有设置默认HEAD，可以先拉取最新引用，再加异常捕获兜底：

import git

repo = git.Repo('git-repo')
remote = repo.remote()
# 先更新远程引用避免缓存过期
remote.fetch()

try:
    main_branch = remote.refs.HEAD.ref
    print("远程主分支：", main_branch.name)
except AttributeError:
    # 兜底逻辑：遍历查找main或master分支
    for ref in remote.refs:
        if ref.name in ('main', 'master'):
            main_branch = ref
            print("远程主分支：", main_branch.name)
            break

注意事项 #

• 上述代码默认读取的是名为origin的默认远程仓库，如果你的仓库配置了多个远程，需要指定远程名称，比如repo.remote('other-remote')
• 部分老版本Git仓库可能未显式设置远程HEAD，触发异常时走兜底遍历逻辑即可覆盖所有场景

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