profiles

profiles 简介

Conan profiles 允许用户在一个文件中为 settings、options、环境变量（用于构建时和运行时上下文）、工具需求 和 配置变量 设置完整的配置集。

它们具有以下结构

[settings]
arch=x86_64
build_type=Release
os=Macos

[options]
mylib/*:shared=True

[tool_requires]
tool1/0.1@user/channel
*: tool4/0.1@user/channel

[buildenv]
VAR1=value

[runenv]
EnvironmentVar1=My Value

[conf]
tools.build:jobs=2

[replace_requires]
zlib/1.2.12: zlib/[*]

[replace_tool_requires]
7zip/*: 7zip/system

[platform_requires]
dlib/1.3.22

[platform_tool_requires]
cmake/3.24.2

Profiles 可以使用 conan profile 命令中的 detect 选项创建，并在之后进行编辑。如果您不指定 name，该命令将创建 default profile

创建 Conan 默认 profile
$ conan profile detect
apple-clang>=13, using the major as version
Detected profile:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos

WARN: This profile is a guess of your environment, please check it.
WARN: Defaulted to cppstd='gnu17' for apple-clang.
WARN: The output of this command is not guaranteed to be stable and can change in future Conan versions.
WARN: Use your own profile files for stability.
Saving detected profile to [CONAN_HOME]/profiles/default

注意

关于 Conan 检测到的 C++ 标准的说明

Conan 始终将默认 C++ 标准设置为检测到的编译器版本默认使用的标准，但使用 apple-clang 的 macOS 除外。在这种情况下，对于 apple-clang>=11，它会设置 compiler.cppstd=gnu17。如果您想使用不同的 C++ 标准，您可以直接编辑默认 profile 文件。

创建另一个 profile: myprofile
$ conan profile detect --name myprofile
Found apple-clang 14.0
apple-clang>=13, using the major as version
Detected profile:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos

WARN: This profile is a guess of your environment, please check it.
WARN: Defaulted to cppstd='gnu17' for apple-clang.
WARN: The output of this command is not guaranteed to be stable and can change in future Conan versions.
WARN: Use your own profile files for stability.
Saving detected profile to [CONAN_HOME]/profiles/myprofile

Profile 文件可以与许多命令中的 -pr/--profile 选项一起使用，例如 conan install 或 conan create 命令。如果您完全不指定任何 profile，则将始终使用 default profile

使用 default profile
$ conan create .
使用 myprofile profile
$ conan create . -pr=myprofile

使用 profiles

Profiles 可以位于不同的文件夹中

$ conan install . -pr /abs/path/to/myprofile   # abs path
$ conan install . -pr ./relpath/to/myprofile   # resolved to current dir
$ conan install . -pr ../relpath/to/myprofile  # resolved to relative dir
$ conan install . -pr myprofile  # resolved to [CONAN_HOME]/profiles/myprofile

列出 profiles 文件夹中现有的 profiles 可以这样做

$ conan profile list
Profiles found in the cache:
default
myprofile1
myprofile2
...

您还可以按上下文显示 profile 的内容

$ conan profile show -pr myprofile
Host profile:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos

Build profile:
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos

另请参阅

Profile sections

以下是 profiles 中可用的 section

[settings]

来自 settings.yml 的可用 settings 列表

myprofile
[settings]
arch=x86_64
build_type=Release
compiler=apple-clang
compiler.cppstd=gnu17
compiler.libcxx=libc++
compiler.version=14
os=Macos

[options]

来自您的 recipe 及其依赖项的可用 options 列表

myprofile
[options]
mypkg/*:my_pkg_option=True
*:shared=True

[tool_requires]

您的 recipe 或其依赖项所需的 tool_requires 列表

myprofile
[tool_requires]
cmake/3.25.2

另请参阅

在此 section 中阅读有关 tool requires 的更多信息： 将构建工具用作 Conan 包。

[system_tools] (已弃用)

注意

此 section 已弃用，并已被 [platform_requires] 和 [platform_tool_requires] section 替换。

[buildenv]

每次调用 ConanFile run(cmd, env="conanbuild") 方法时，将注入到环境中的环境变量列表（构建时上下文由 VirtualBuildEnv 自动运行）。

除此之外，当您组合 profiles 甚至本地变量时，它还能够对声明的每个变量应用一些额外的运算符

  • += == append: 在现有值的末尾追加值。

  • =+ == prepend: 将值放在现有值的开头。

  • =! == unset: 删除任何变量值。

另一个需要提及的要点是可以将变量定义为 PATH 变量，只需将 (path) 作为变量的前缀即可。这对于在不同系统（Windows 使用 ; 作为分隔符，UNIX 使用 :）中自动获取 PATH 的追加/前置非常有用。

myprofile
[buildenv]
# Define a variable "MyVar1"
MyVar1=My Value; other

# Append another value to "MyVar1"
MyVar1+=MyValue12

# Define a PATH variable "MyPath1"
MyPath1=(path)/some/path11

# Prepend another PATH to "MyPath1"
MyPath1=+(path)/other path/path12

# Unset the variable "MyPath1"
MyPath1=!

然后，应用此 profile 的结果是

  • MyVar1: My Value; other MyValue12

  • MyPath1:

    • Unix: /other path/path12:/some/path11

    • Windows: /other path/path12;/some/path11

  • mypkg*:PATH: None

警告

请注意，[buildenv] 和 [runenv] 环境变量定义保留值中的用户空格。MYVAR = MyValue 将产生一个 " MyValue" 值，这将与 MYVAR=MyValue 产生的 "MyValue" 不同。避免在 profiles 中在 = 周围使用额外的空格，请使用上面显示的语法。

[runenv]

每次调用 ConanFile run(cmd, env="conanrun") 方法时，将注入到环境中的环境变量列表（运行时上下文由 VirtualRunEnv 自动运行）。

为 [buildenv] 解释的所有运算符/模式都以相同的方式应用于此 section

myprofile
[runenv]
MyVar1=My Value; other
MyVar1+=MyValue12
MyPath1=(path)/some/path11
MyPath1=+(path)/other path/path12
MyPath1=!

[conf]

注意

建议事先阅读 global.conf section。

用户/工具配置列表

myprofile
[conf]
tools.build:verbosity=verbose
tools.microsoft.msbuild:max_cpu_count=2
tools.microsoft.msbuild:vs_version = 16
tools.build:jobs=10
# User conf variable
user.confvar:something=False

回顾一些关于配置范围和命名的提示

  • core.xxx 配置只能在 global.conf 文件中定义，而不能在 profiles 中定义

  • tools.yyy 和 user.zzz 可以在 global.conf 中定义，它们将影响 “build” 和 “host” 上下文。但是，在 profile [conf] 中定义的配置将仅影响 profile 的各自的 “build” 或 “host” 上下文，而不是两者。

它们也可以在 global.conf 中使用，但 profiles 值将优先于 global.conf 中全局定义的值，因此让我们看一个稍微复杂的示例，尝试来自 global.conf 和另一个 profile myprofile 的不同配置

global.conf
# Defining several lists
user.myconf.build:ldflags=["--flag1 value1"]
user.myconf.build:cflags=["--flag1 value1"]
myprofile
[settings]
...

[conf]
# Appending values into the existing list
user.myconf.build:ldflags+=["--flag2 value2"]

# Unsetting the existing value (it'd be like we define it as an empty value)
user.myconf.build:cflags=!

# Prepending values into the existing list
user.myconf.build:ldflags=+["--prefix prefix-value"]

例如，运行 conan install . -pr myprofile，配置输出将类似于

...
Configuration:
[settings]
[options]
[tool_requires]
[conf]
user.myconf.build:cflags=!
user.myconf.build:ldflags=['--prefix prefix-value', '--flag1 value1', '--flag2 value2']
...

[replace_requires]

警告

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

此 section 允许用户重新定义 recipes 的 requires。当一个包可以被类似的包替换时，例如 zlib 和 zlibng，这可能很有用。它也可用于解决冲突，或将某些依赖项替换为封装在另一个 Conan 包 recipe 中的系统替代方案。

在此 section 下列出的引用作为 recipes 中 requires 的字面替换，并且在 recipe 需求的任何其他处理之前作为第一步完成，而无需处理它们或检查冲突。

例如，我们可以将 zlibng 定义为典型 zlib 的替代品

myprofile
[replace_requires]
zlib/*: zlibng/*

对 zlibng 引用使用 * 模式意味着 zlib 将被完全相同版本的 zlibng 替换。

其他示例包括

myprofile
[replace_requires]
dep/*: dep/1.1               # To override dep/[>=1.0 <2] in recipes to a specific version dep/1.1)
dep/*: dep/*@system          # To override a dep/1.3 in recipes to dep/1.3@system
dep/*: dep/[>=1 <2]          # To override every dep requirement in recipes to a specific version range
dep/*@*/*: dep/*@system/*    # To override "dep/1.3@comp/stable" in recipes to the same version with other user but same channel
dep/1.1: dep/1.1@system      # To replace exact reference in recipes by the same one in the system
dep/1.1@*: dep/1.1@*/stable  # To replace dep/[>=1.0 <2]@comp version range in recipes by 1.1 version in stable chanel

注意

最佳实践

  • 请合理使用此功能。它不是版本控制机制，也不打算替换 recipes 中的实际 requires。

  • 此功能的用法旨在临时解决冲突或在某些交叉构建场景中将特定依赖项替换为系统依赖项。

[replace_tool_requires]

警告

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

与 replace_requires section 的用法相同，但在这种情况下用于 tool_requires。

myprofile
[replace_tool_requires]
cmake/*: cmake/3.25.2

在这种情况下，无论 recipes 中声明的 cmake 版本如何，都将被引用 cmake/3.25.2 替换。

[platform_requires]

警告

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

此 section 允许用户重新定义 recipes 的 requires，并将其替换为平台提供的依赖项，这意味着 Conan 将不会尝试下载引用或在缓存中查找它，并且会假定它已安装在您的系统中并可以使用。

例如，如果 zlib 1.2.11 库已安装在您的系统中，或者它是您的构建工具链的一部分，并且您希望 Conan 使用它，您可以像这样指定

myprofile
[platform_requires]
zlib/1.2.11

[platform_tool_requires]

警告

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

与 platform_requires section 的用法相同，但在这种情况下用于 tool_requires，例如 cmake、meson 等。

例如，假设您已经在系统中安装了 cmake==3.24.2

$ cmake --version
cmake version 3.24.2

CMake suite maintained and supported by Kitware (kitware.com/cmake).

并且在你的 recipe（或传递依赖项）中声明了 tool_requires，例如如下所示的内容

conanfile.py
from conan import ConanFile

class PkgConan(ConanFile):
    name = "pkg"
    version = "2.0"
    # ....

    # Exact version
    def build_requirements(self):
        self.tool_requires("cmake/3.24.2")

    # Or even version ranges
    def build_requirements(self):
        self.tool_requires("cmake/[>=3.20.0]")

在这种情况下，你可能希望使用已安装的 CMake 版本，因此只需在你的 profile 中将其声明为 platform_tool_requires 即可

myprofile
...

[platform_tool_requires]
cmake/3.24.2

每当你想要创建 package 时，你会看到 build requirement 已经满足，因为 platform tool declaration 的缘故

$ conan create . -pr myprofile --build=missing
...
-------- Computing dependency graph --------
Graph root
    virtual
Requirements
    pkg/2.0#3488ec5c2829b44387152a6c4b013767 - Cache
Build requirements
    cmake/3.24.2 - Platform

-------- Computing necessary packages --------

-------- Computing necessary packages --------
pkg/2.0: Forced build from source
Requirements
    pkg/2.0#3488ec5c2829b44387152a6c4b013767:20496b332552131b67fb99bf425f95f64d0d0818 - Build
Build requirements
    cmake/3.24.2 - Platform

请注意，如果声明的 platform_tool_requires 与 tool_requires 的声明不完全匹配（版本或版本范围），那么 Conan 将会像往常一样尝试从远程或本地获取它们。

Profile 渲染

Profile 默认渲染为 jinja2 模板。当 Conan 加载 profile 时，它会立即解析和渲染模板，渲染结果必须是一个标准的文本 profile。

profile 模板的一些功能包括

  • 使用平台信息，例如获取当前的操作系统，这是可能的，因为 Python 的 platform 模块被添加到渲染上下文中

    profile_vars
    [settings]
os = {{ {"Darwin": "Macos"}.get(platform.system(), platform.system()) }}

  • 读取环境变量也是可以的，因为 Python 的 os 模块被添加到渲染上下文中

    profile_vars
    [settings]
build_type = {{ os.getenv("MY_BUILD_TYPE") }}

  • 定义你自己的变量并在 profile 中使用它们

    profile_vars
    {% set os = "FreeBSD" %}
{% set clang = "my/path/to/clang" %}

[settings]
os = {{ os }}

[conf]
tools.build:compiler_executables={'c': '{{ clang }}', 'cpp': '{{ clang + '++' }}' }

  • 连接和定义路径，包括引用当前的 profile 目录。例如，可以定义一个工具链，其文件位于 profile 旁边。除了 os Python 模块外，指向当前 profile 文件夹的变量 profile_dir 也被添加到上下文中。

    profile_vars
    [conf]
tools.cmake.cmaketoolchain:toolchain_file = {{ os.path.join(profile_dir, "toolchain.cmake") }}

  • 从文件名中获取设置，包括引用当前的 profile 名称。例如，定义一个通用 profile，它根据其文件名进行配置。指向当前 profile 文件名的变量 profile_name 被添加到上下文中。

    Linux-x86_64-gcc-12
    {% set os, arch, compiler, compiler_version = profile_name.split('-') %}
[settings]
os={{ os }}
arch={{ arch }}
compiler={{ compiler }}
compiler.version={{ compiler_version }}

  • 从 profiles 文件夹中包含或导入其他文件

    profile_vars
    {% set a = "Debug" %}
    myprofile
    {% import "profile_vars" as vars %}
[settings]
build_type = {{ vars.a }}

    当使用相对路径包含或导入其他文件时，Jinja 渲染器会将当前 profile 文件的基础路径作为首个查找位置。如果搜索失败，Jinja 渲染器也会开始在 Conan home profiles 文件夹（通常在 <userhome>/.conan2/profiles 中）中查找。

  • jinja2 支持的任何其他功能都是可能的：for 循环、if-else 等。这对于在大型依赖关系图中为多个 package 定义自定义的 per-package 设置或选项非常有用。

使用 ``detect_api`` 进行 Profile 渲染

警告

稳定性保证：detect_api，类似于 conan profile detect，不提供强稳定性保证。

使用建议：detect_api 不是一个常规的 API，不用于创建新命令或类似的功能。虽然自动检测可能很方便，但它不是所有场景都推荐的方法。这个 API 是 Conan 内部的，仅暴露用于 profile 和 global.conf 渲染。建议谨慎使用它。

Conan 还将 detect_api 注入到 jinja 渲染上下文中。有了它，就可以直接在 Jinja profile 模板中使用 Conan 的自动检测功能。这提供了一种基于环境动态确定某些设置的方法。

detect_api 可以在 profile 的 Jinja 模板中调用。例如，要检测操作系统和架构，你可以使用

[settings]
os={{detect_api.detect_os()}}
arch={{detect_api.detect_arch()}}

同样，对于更高级的检测，例如确定编译器、其版本以及相关的运行时，你可以使用

{% set compiler, version, compiler_exe = detect_api.detect_default_compiler() %}
{% set runtime, _ = detect_api.default_msvc_runtime(compiler) %}
[settings]
compiler={{compiler}}
compiler.version={{detect_api.default_compiler_version(compiler, version)}}
compiler.runtime={{runtime}}
compiler.cppstd={{detect_api.default_cppstd(compiler, version)}}
compiler.libcxx={{detect_api.detect_libcxx(compiler, version, compiler_exe)}}

detect_api 参考:

  • detect_os()：返回操作系统字符串（例如，“Windows”，“Macos”）。

  • detect_arch()：返回系统架构字符串（例如，“x86_64”，“armv8”）。

  • detect_libc(ldd="/usr/bin/ldd")：实验性功能 返回一个元组，包含 C 库的名称（例如，“gnu”，“musl”）和版本（例如，“2.39”，“1.2.4”）。

  • detect_libcxx(compiler, version, compiler_exe=None)：返回 C++ 标准库字符串（例如，“libstdc++”，“libc++”）。

  • default_msvc_runtime(compiler)：返回一个元组，包含运行时（例如，“dynamic”）及其版本（例如，“v143”）。

  • default_cppstd(compiler, compiler_version)：返回默认 C++ 标准字符串（例如，“gnu14”）。

  • detect_default_compiler()：返回一个元组，包含编译器名称（例如，“gcc”）、其版本和可执行文件路径。

  • detect_msvc_update(version)：返回 MSVC update 版本字符串（例如，VS 17.12.1 的 “12”）。请注意，在 Conan profiles 中，compiler.update 设置接受 0 到 10 的值。要将 detect_msvc_update 的结果转换为 profiles 所需的格式，你可以这样做

    示例

    ...
[settings]
compiler=msvc
compiler=194 # for msvc toolset starting in 14.40 (VS 17.10)
# If we are using VS 17.12 we convert 12 to 2 so it's 194 with update 2
compiler.update = "{{ (detect_api.detect_msvc_update(version) | int) % 10 }}"
...

  • default_msvc_ide_version(version)：返回 MSVC IDE 版本字符串（例如，“17”）。

  • default_compiler_version(compiler, version)：返回 Conan 在 profiles 中使用的默认版本，通常会删除一些不影响二进制兼容性的次要或补丁数字。

  • detect_gcc_compiler(compiler_exe="gcc")：为 gcc 返回元组（‘gcc’，版本，可执行文件）。

  • detect_intel_compiler(compiler_exe="icx")：为 intel-cc 返回元组（‘intel-cc’，版本，可执行文件）。

  • detect_suncc_compiler(compiler_exe="cc")：为 sun-cc 返回元组（‘sun-cc’，版本，可执行文件）。

  • detect_clang_compiler(compiler_exe="clang")：为 clang 或 apple-clang 返回元组（‘clang’|‘apple-clang’，版本，可执行文件）。

  • detect_msvc_compiler()：检测编译器（‘msvc’，版本，None），即最新安装的 VS IDE 的默认版本

  • detect_cl_compiler(compiler_exe="cl")：为 cl.exe 编译器检测编译器（‘msvc’，版本，可执行文件）

  • detect_sdk_version(sdk)：检测 Apple SDK 版本（对于非 Apple 平台为 None），针对给定的 sdk。等效于 xcrun -sdk {sdk} --show-sdk-version

Profile 模式

Profiles（以及定义 setting 或 option 的任何地方）也支持模式定义，因此你可以为某些特定的 package 重写一些 setting、配置变量等

zlib_clang_profile
[settings]
# Only for zlib
zlib/*:compiler=clang
zlib/*:compiler.version=3.5
zlib/*:compiler.libcxx=libstdc++11

# For the all the dependency tree
compiler=gcc
compiler.version=4.9
compiler.libcxx=libstdc++11

[options]
# shared=True option only for zlib package
zlib/*:shared=True

[buildenv]
# For the all the dependency tree
*:MYVAR=my_var

[conf]
# Only for zlib
zlib/*:tools.build:compiler_executables={'c': '/usr/bin/clang', 'cpp': '/usr/bin/clang++'}

你的构建工具将仅为 zlib package 查找 clang 编译器，而为依赖树的其余部分查找 gcc（默认编译器）。

重要提示

仅使用 zlib: 是已弃用的行为，并且不起作用，你必须始终放置类似模式的表达式，例如 zlib*:、zlib/*:、zlib/1.*: 等。

它们也接受模式，例如 -s *@myuser/*，这意味着用户名为 “myuser” 的 package 将使用 clang 3.5 作为编译器，否则使用 gcc

myprofile
[settings]
*@myuser/*:compiler=clang
*@myuser/*:compiler.version=3.5
*@myuser/*:compiler.libcxx=libstdc++11
compiler=gcc
compiler.version=4.9
compiler.libcxx=libstdc++11

也可以将 & 指定为 package 名称。它将仅应用于消费者 conanfile（.py 或 .txt）。这是一个特殊情况，因为消费者 conanfile 可能不会声明 name，因此无法引用它。

myprofile
[settings]
&:compiler=gcc
&:compiler.version=4.9
&:compiler.libcxx=libstdc++11

也支持部分匹配，因此你可以定义像 zlib* 这样的模式来匹配所有类似 zlib 的库，因此它将匹配以 zlib 开头的所有内容，例如 zlib、zlibng、zlib/1.2.8@user/channel 等。

myprofile
[settings]
zlib*:compiler=clang
zlib*:compiler.version=3.5
zlib*:compiler.libcxx=libstdc++11

Profile 包含

你可以使用 include() 语句包含其他 profile 文件。路径可以是相对于当前 profile 的相对路径、绝对路径，或者是本地缓存中默认 profile 位置的 profile 名称。

include() 语句必须位于 profile 文件的顶部

gcc_49
[settings]
compiler=gcc
compiler.version=4.9
compiler.libcxx=libstdc++11
myprofile
include(gcc_49)

[settings]
zlib/*:compiler=clang
zlib/*:compiler.version=3.5
zlib/*:compiler.libcxx=libstdc++11

使用 myprofile 的最终结果是

myprofile (虚拟结果)
[settings]
compiler=gcc
compiler.libcxx=libstdc++11
compiler.version=4.9
zlib/*:compiler=clang
zlib/*:compiler.libcxx=libstdc++11
zlib/*:compiler.version=3.5

另请参阅