Config API

警告

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

class ConfigAPI(conan_api, helpers)

此 API 提供管理 Conan 主目录中 Conan 配置的方法。它允许从各种来源安装配置，检索全局配置值，以及列出可用配置。它还提供清理 Conan 主目录的方法，将其重置为干净状态。

home()

返回包含远程、设置、配置文件和包缓存等配置文件的当前 Conan 主目录。它出于调试目的提供。请记住，不允许在包缓存中写入、修改或删除包，并且为了自动化使用缓存中包的任务，Conan 提供了部署器或自定义命令等机制。

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 主目录重置为干净状态，删除所有用户自定义配置、自定义文件，并重置修改过的文件

property settings_yml

获取 settings.yml 和 user_settings.yml 文件的内容，这些文件定义了设置的可能值。

请注意，这与 conanfile 中存在的设置不同，后者代表特定包的实际值，而此属性代表每个设置的可能值。

返回:

一个只读对象，表示设置方案，具有一个 possible_values() 方法，该方法返回一个包含每个设置可能值的字典，以及一个 fields 属性，该属性返回每个设置字段的有序列表。请注意，可以使用属性访问来访问嵌套设置，例如 settings_yml.compiler.possible_values()。