如何使用Python加载并解析GitHub私有仓库中的YAML文件

前置依赖安装 #

首先安装YAML解析库：

pip install pyyaml

如果选择远程拉取方案，可按需安装GitHub SDK或网络请求库：

# 方案A：使用封装好的GitHub SDK
pip install PyGitHub
# 方案B：使用原生请求库，无需额外SDK
pip install requests

场景1：本地已克隆私有仓库 #

如果本地已经维护了仓库的克隆副本，直接读取本地文件即可，实现最简单：

import yaml

def load_local_yaml(file_path: str):
    with open(file_path, 'r', encoding='utf-8') as f:
        # 优先使用safe_load避免任意代码执行风险，禁止使用无参数的yaml.load
        return yaml.safe_load(f)

# 调用示例，替换为本地仓库内的YAML文件路径
yaml_data = load_local_yaml("./your_repo_path/config.yaml")

场景2：远程直接拉取（无需本地克隆） #

适合不需要维护本地仓库副本、需要拉取最新版本内容的自动化场景：

准备工作 #

先在GitHub个人账户设置中创建个人访问令牌（PAT），权限勾选repo范围，用于私有仓库访问认证。

实现代码（基于PyGitHub SDK） #

from github import Github
import yaml
import io

def load_remote_yaml(
    pat: str,
    repo_fullname: str, # 格式为「用户名/仓库名」，例：jack/my-private-repo
    file_path: str, # 仓库内YAML文件的路径，例：config/prod.yaml
    branch: str = "main"
):
    g = Github(pat)
    repo = g.get_repo(repo_fullname)
    file_content = repo.get_contents(file_path, ref=branch)
    return yaml.safe_load(io.BytesIO(file_content.content))

# 调用示例，PAT建议从环境变量读取，不要硬编码
import os
yaml_data = load_remote_yaml(
    pat=os.getenv("GITHUB_PAT"),
    repo_fullname="your_name/your_repo",
    file_path="config.yaml"
)

实现代码（基于requests，无额外SDK依赖） #

import requests
import yaml
import io
import os

def load_remote_yaml_with_requests(
    pat: str,
    repo_fullname: str,
    file_path: str,
    branch: str = "main"
):
    api_url = f"https://api.github.com/repos/{repo_fullname}/contents/{file_path}?ref={branch}"
    headers = {
        "Authorization": f"token {pat}",
        "Accept": "application/vnd.github.v3.raw" # 直接返回原始文件内容，无需额外解码base64
    }
    resp = requests.get(api_url, headers=headers)
    resp.raise_for_status() # 权限不足、文件不存在等异常会直接抛出
    return yaml.safe_load(io.BytesIO(resp.content))

# 调用示例
yaml_data = load_remote_yaml_with_requests(
    pat=os.getenv("GITHUB_PAT"),
    repo_fullname="your_name/your_repo",
    file_path="config.yaml"
)

注意事项 #

• 安全规范：禁止将PAT令牌硬编码到脚本中，建议通过环境变量、密钥管理服务存储读取，避免泄露仓库权限。
• 解析安全：必须使用yaml.safe_load()解析内容，不要使用原生yaml.load()，后者支持执行YAML中嵌入的Python代码，存在严重安全隐患。
• 性能优化：如果需要定期拉取最新内容，可通过GitHub API返回的ETag、最后修改时间判断内容是否更新，避免重复拉取减少API调用消耗。

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