如何使用Python从Azure DevOps仓库中获取指定的单个资源项

你已经完成身份认证、仓库列表获取的前提下，直接调用Git客户端的get_item方法即可实现单个指定项的下载，不需要对接原生REST API。

可运行代码示例 #

假设你已经完成身份认证拿到了connection实例，替换对应参数后即可直接运行：

from azure.devops.v7_1.git.models import GitVersionDescriptor, GitVersionType

# 替换为你的实际参数
project_name = "你的项目名"
repository_id = "目标仓库ID或名称"
# 仓库内目标文件的绝对路径，必须以/开头，对应仓库根目录
target_file_path = "/src/db/init.sql"
# 可选：指定要拉取的分支/标签/提交哈希，不填则默认拉取默认分支内容
version_descriptor = GitVersionDescriptor(
    version="dev",
    version_type=GitVersionType.BRANCH
)

# 初始化Git客户端，你之前拉取仓库列表时应该已经用到该实例
git_client = connection.clients.get_git_client()

# 拉取文件内容，download参数必须设为True，否则只会返回文件元数据
file_stream = git_client.get_item(
    repository_id=repository_id,
    path=target_file_path,
    project=project_name,
    download=True,
    version_descriptor=version_descriptor
)

# 写入本地文件
with open("local_save_path.sql", "wb") as f:
    for chunk in file_stream:
        f.write(chunk)

常见注意事项 #

• 目标文件路径必须以/开头，大小写完全匹配仓库内的实际路径
• 如果需要下载整个文件夹，补充recursion_level="full"参数即可批量拉取文件夹下所有内容
• 如果你安装的azure-devops库版本不是7.1，只需调整导入路径中的版本号即可，方法名和参数逻辑全版本通用

• 查看库内置文档：在Python交互环境执行print(git_client.get_item.__doc__)即可查看该方法的完整参数说明、返回值定义，完全匹配你当前安装的库版本，不会出现网页文档和本地版本不匹配的问题
• 本地示例代码：azure-devops库安装完成后，在本地Python的site-packages目录下的azure/devops/samples文件夹中包含大量可直接运行的Git操作示例，覆盖绝大多数日常使用场景
• IDE补全提示：编写代码时IDE会自动提示各个方法的入参类型、可选值，配合断点调试查看返回值结构，效率远高于翻查官方网页文档

内容的提问来源于stack exchange，提问作者Tessier-Piart Charles