Remotes API

警告

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

RemotesAPI(conan_api, api_helpers)

RemotesAPI 管理远程仓库的定义，这些定义包含在 Conan 主目录的 “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 对象。