Python检测Git分支是否存在的方法及GitLab场景代码示例

前置依赖 #

需要先安装GitPython库：
pip install gitpython

原有代码问题说明 #

你当前的代码存在两处明显问题：

• git branch --all返回的结果会包含当前分支标记*、空格、以及远程分支前缀remotes/origin/，直接split后的列表无法直接匹配纯分支名
• 未做环境变量为空的兜底判断，环境变量不存在时会出现None和字符串匹配的逻辑错误

完整可运行代码示例 #

import os
import git

def check_branch_exist(repo_path: str = ".") -> bool:
    # 读取GitLab预设变量
    target_branch = os.environ.get("GitLabVariable")
    if not target_branch:
        print("未获取到GitLabVariable变量，跳过分支校验")
        return False
    
    # 初始化仓库对象
    repo = git.Git(repo_path)
    # 拉取全部分支信息（适配GitLab CI浅克隆场景）
    repo.fetch("--all")
    
    # 格式化分支列表，去除冗余字符和前缀
    exist_branches = set()
    for branch in repo.branch("--all").splitlines():
        # 去掉当前分支标记*和前后空格
        clean_branch = branch.strip("* ").strip()
        # 去掉远程分支前缀，只保留纯分支名
        if clean_branch.startswith("remotes/origin/"):
            clean_branch = clean_branch.replace("remotes/origin/", "", 1)
        exist_branches.add(clean_branch)
    
    return target_branch in exist_branches

# 调用示例
if __name__ == "__main__":
    if check_branch_exist():
        print(f"目标分支存在，执行后续逻辑")
        # 此处添加分支存在时的业务逻辑
    else:
        print(f"目标分支不存在，终止流程或执行兜底逻辑")

运行注意事项 #

• 本地测试时可以提前手动设置环境变量：export GitLabVariable=你要检测的分支名
• 如果是在GitLab CI Runner中执行该代码，需要在.gitlab-ci.yml中配置克隆深度为0，避免浅克隆导致分支列表不全：

your_job_name:
  variables:
    GIT_DEPTH: 0
  script:
    - pip install gitpython
    - python your_script_name.py

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