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