如何使用Python将本地文件推送至Azure DevOps仓库

核心思路 #

要实现需求，需结合GitPython处理本地Git操作，配合Azure DevOps认证完成推送。核心步骤为：自动转换本地文件路径、克隆远程仓库到本地临时目录、复制文件到对应结构、提交并推送变更。

路径自动转换 #

无需手动维护目标路径列表，可通过字符串处理或pathlib自动移除前缀：

import os
from pathlib import Path

original_paths = [
    "c:/user/dir1/filename1.txt",
    "c:/user/dir2/filename1.py",
    "c:/user/dir2/filenamex.json"
]

prefix_to_remove = "c:/user/"
# 方式1：字符串替换
data_to_push = [path.replace(prefix_to_remove, "", 1) for path in original_paths]
# 方式2：pathlib相对路径处理（更优雅）
data_to_push = [str(Path(path).relative_to(Path(prefix_to_remove))) for path in original_paths]

完整实现代码 #

以下是包含仓库克隆、文件复制、提交推送的完整逻辑：

import os
import tempfile
from pathlib import Path
from git import Repo
from azure.devops.connection import Connection
from msrest.authentication import BasicAuthentication

def push_to_azure_devops():
    # Azure DevOps配置
    organization_url = "https://dev.azure.com/your-org-name"
    project_name = "ProjectName"
    repo_id = "RepoID"
    pat_token = "q578w645746748w5zt"  # 此处使用Azure DevOps个人访问令牌（PAT）
    
    # 本地文件配置
    original_paths = [
        "c:/user/dir1/filename1.txt",
        "c:/user/dir2/filename1.py",
        "c:/user/dir2/filenamex.json"
    ]
    prefix_to_remove = "c:/user/"

    # 1. 自动生成目标路径
    data_to_push = [path.replace(prefix_to_remove, "", 1) for path in original_paths]

    # 2. 创建临时目录克隆仓库（自动清理）
    with tempfile.TemporaryDirectory() as temp_dir:
        repo_url = f"{organization_url}/{project_name}/_git/{repo_id}"
        # 拼接带认证的仓库地址
        auth_repo_url = repo_url.replace("https://", f"https://:{pat_token}@")
        
        # 克隆远程仓库到临时目录
        repo = Repo.clone_from(auth_repo_url, temp_dir)
        origin = repo.remote(name="origin")

        # 3. 复制文件到对应目录结构
        for local_path, target_path in zip(original_paths, data_to_push):
            target_full_path = Path(temp_dir) / target_path
            # 创建目标父目录（不存在则自动创建）
            target_full_path.parent.mkdir(parents=True, exist_ok=True)
            # 复制本地文件到目标路径
            Path(local_path).copy(target_full_path)

        # 4. 提交变更
        repo.index.add([str(Path(target_path)) for target_path in data_to_push])
        repo.index.commit("Add files with specified directory structure")

        # 5. 推送到远程仓库
        origin.push()

if __name__ == "__main__":
    push_to_azure_devops()

关键说明 #

• 认证方式：使用Azure DevOps个人访问令牌（PAT），需确保令牌拥有仓库读写权限。
• 临时目录：借助tempfile.TemporaryDirectory自动清理临时文件，避免本地残留仓库数据。
• 路径兼容性：通过pathlib处理路径，适配Windows/Linux不同系统的路径格式。
• Git操作：用GitPython的Repo类完成克隆、提交、推送，比直接调用Azure DevOps SDK的create_push更直观，适合文件推送场景。

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