如何使用Python下载完整GitHub仓库并覆盖本地现有文件

你现有代码存在两个核心问题：

• 硬编码固定时间比对的逻辑无法实现更新检测，实际应该将接口返回的最新更新时间和本地留存的上次同步时间做对比
• 直接请求仓库网页地址无法获取完整代码包，需要请求对应分支的zip归档接口

实现步骤 #

• 第一步：调用GitHub仓库API获取最新的更新时间，和本地存储的上次同步时间比对，判断是否需要更新
• 第二步：确认有更新后，下载对应分支的zip压缩包到本地临时目录
• 第三步：解压压缩包，覆盖本地指定目录的所有文件
• 第四步：更新本地记录的同步时间，供下次检测使用

完整代码示例 #

import requests
import zipfile
import os
from io import BytesIO

# 配置项，根据实际情况修改
GITHUB_USER = "你的GitHub用户名"
GITHUB_REPO = "目标仓库名"
BRANCH = "master" # 要同步的分支名
LOCAL_DIR = "./本地要覆盖的目录路径"
# 私有仓库需要填你的个人访问令牌，公开仓库留空即可
GITHUB_TOKEN = ""

# 本地存储上次更新时间的文件
LAST_UPDATE_FILE = "./last_update_time.txt"

def check_and_update_repo():
    # 构造API请求头
    headers = {}
    if GITHUB_TOKEN:
        headers["Authorization"] = f"token {GITHUB_TOKEN}"
    
    # 1. 获取仓库最新更新时间
    api_url = f"https://api.github.com/repos/{GITHUB_USER}/{GITHUB_REPO}"
    resp = requests.get(api_url, headers=headers)
    resp.raise_for_status()
    repo_info = resp.json()
    latest_update = repo_info["updated_at"]

    # 2. 比对更新时间
    last_update = ""
    if os.path.exists(LAST_UPDATE_FILE):
        with open(LAST_UPDATE_FILE, "r", encoding="utf-8") as f:
            last_update = f.read().strip()
    
    if latest_update == last_update:
        # 无更新直接返回
        return
    
    # 3. 有更新，下载仓库zip包
    zip_url = f"https://github.com/{GITHUB_USER}/{GITHUB_REPO}/archive/refs/heads/{BRANCH}.zip"
    zip_resp = requests.get(zip_url, headers=headers)
    zip_resp.raise_for_status()

    # 4. 解压覆盖本地目录
    with zipfile.ZipFile(BytesIO(zip_resp.content)) as zf:
        # 压缩包根目录一般是 仓库名-分支名，需要去掉这层前缀再解压
        prefix = f"{GITHUB_REPO}-{BRANCH}/"
        for file_info in zf.infolist():
            if file_info.is_dir():
                continue
            # 去掉前缀得到相对路径
            relative_path = file_info.filename[len(prefix):]
            local_path = os.path.join(LOCAL_DIR, relative_path)
            # 确保本地目录存在
            os.makedirs(os.path.dirname(local_path), exist_ok=True)
            # 写入文件覆盖
            with zf.open(file_info) as src, open(local_path, "wb") as dst:
                dst.write(src.read())
    
    # 5. 更新本地记录的上次更新时间
    with open(LAST_UPDATE_FILE, "w", encoding="utf-8") as f:
        f.write(latest_update)

if __name__ == "__main__":
    check_and_update_repo()

注意事项 #

• 如果是同步私有仓库，需要先在GitHub后台生成拥有仓库读取权限的个人访问令牌，填入代码对应配置项即可
• 覆盖文件前建议先备份本地的自定义配置文件，避免被远程仓库的同名文件覆盖丢失
• 如果有不需要覆盖的本地文件，可以在解压逻辑中添加过滤规则，跳过对应文件的写入

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