远程API

警告

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

class RemotesAPI(conan_api)

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 对象