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 主目录中的 “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 对象列表(即使它们已被启用)
- 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 – 新名称