Remotes API

警告

此功能为实验性功能，可能会发生重大更改。更多信息请参阅 Conan 稳定性 部分。

class Remote(name, url, verify_ssl=True, disabled=False, allowed_packages=None, remote_type=None)

Remote 类表示一个远程包注册表。它是一个只读的不透明对象，不应直接创建，而应通过相关 RemotesAPI 子 API 方法获取。

class RemotesAPI(conan_api)

RemotesAPI 管理远程仓库的定义，这些定义包含在 Conan home 目录下的 “remotes.json” 文件中，支持远程仓库的添加、删除、更新、重命名、启用和禁用。这些操作不联系服务器，也不检查它们是否存在。如果它们不可用，则在使用时会失败。

user_xxx 方法执行与身份验证相关的任务，其中一些方法会联系服务器执行此类身份验证。

list(pattern=None, only_enabled=True)

获取与模式匹配的 Remote 对象列表。

参数:

• pattern – None，单个 str 或 str 列表。如果为 None，则返回所有远程仓库（等同于 pattern="*"）。

• only_enabled – 布尔值，默认只返回启用的远程仓库。

返回:

一个 Remote 对象列表。

disable(pattern)

禁用所有与 pattern 匹配的远程仓库。

参数:

pattern – 单个 str 或 str 列表。如果模式是精确的名称，不带通配符如“*”，并且没有找到匹配该精确名称的远程仓库，它将引发错误。

返回:

被禁用的 Remote 对象列表（即使它们已经禁用）。

enable(pattern)

启用所有与 pattern 匹配的远程仓库。

参数:

pattern – 单个 str 或 str 列表。如果模式是精确的名称，不带通配符如“*”，并且没有找到匹配该精确名称的远程仓库，它将引发错误。

返回:

已启用的 Remote 对象列表（即使它们已经启用）。

get(remote_name)

获取一个 Remote 对象。

参数:

remote_name – 要返回的远程仓库的精确名称。

返回:

返回 Remote 对象，如果远程仓库不存在则引发异常。

add(remote: Remote, force=False, index=None)

向现有远程仓库中添加一个新的 Remote 对象。

参数:

• remote – 要添加的 Remote 对象。

• force – 如果远程仓库已存在，则不失败（默认情况下会失败）。

• index – 如果未定义，新远程仓库将是最后一个。传入一个整数以将远程仓库插入该位置而不是最后一个位置。

remove(pattern)

移除匹配 pattern 的远程仓库。

参数:

pattern – 单个 str 或 str 列表。如果模式是精确的名称，不带通配符如“*”，并且没有找到匹配该精确名称的远程仓库，它将引发错误。

返回:

被移除的 Remote 对象列表。

update(remote_name: str, url=None, secure=None, disabled=None, index=None, allowed_packages=None)

更新现有远程仓库。

参数:

• remote_name – 要更新的远程仓库名称，必须存在。

• url – 可选的要更新的 URL，如果未定义则不会更新。

• secure – 可选的要更新的 SSL 安全连接。

• disabled – 可选的禁用状态。

• index – 可选的整数，用于更改远程仓库的顺序。

• allowed_packages – 可选的允许从此远程仓库获取的包列表。

rename(remote_name: str, new_name: str)

更改现有远程仓库的名称。

参数:

• remote_name – 之前的现有名称。

• new_name – 新名称。

user_login(remote: Remote, username: str, password: str)

使用提供的用户名和密码对给定远程仓库执行用户身份验证。

参数:

• remote – 一个 Remote 对象。

• username – 用户登录名，str 类型。

• password – 密码，str 类型。

user_logout(remote: Remote)

从给定的 Remote 登出。

参数:

remote – 要登出的 Remote 对象。