Config API

警告

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

class ConfigAPI(conan_api, helpers)

此 API 提供用于管理 Conan 主文件夹中 Conan 配置的方法。它允许从各种来源安装配置、检索全局配置值以及列出可用配置。它还提供了清理 Conan 主文件夹以恢复到干净状态的方法。

home()

返回当前 Conan 主文件夹，其中包含 remotes、settings、profiles 和 packages cache 等配置文件。它提供给调试使用。请注意，不允许在 packages cache 中写入、修改或删除包，并且为了自动化使用 cache 中包的任务，Conan 提供了 deployers 或 custom commands 等机制。

install(path_or_url, verify_ssl, config_type=None, args=None, source_folder=None, target_folder=None)

从 git 仓库、http 服务器上的 zip 文件或本地文件夹安装 Conan 配置

install_pkg(ref, lockfile=None, force=False, remotes=None, profile=None) → PkgReference

安装存储在 Conan 包内的配置。配置的安装将重新初始化整个 ConanAPI。

get(name, default=None, check_type=None)

获取 global.conf 条目的值

show(pattern) → dict

获取与模式匹配的 global.conf 的值

static conf_list()

列出所有可用的内置配置

clean()

将 Conan 主文件夹重置为干净状态，删除所有用户自定义配置、自定义文件并重置修改过的文件