conan.tools.build¶
构建¶
conan.tools.build.build_jobs()¶
- build_jobs(conanfile)¶
返回可用于并行构建的 CPU 数量。如果配置值
tools.build:jobs存在，则返回该值；否则，默认使用辅助函数_cpu_count()。_cpu_count()读取 cgroup 以检测配置的 CPU 数量。目前，cgroup 有两个版本可用。对于 cgroup v1，如果 cgroup 中的数据无效，则会启用处理器检测。当处理器检测未启用时，
build_jobs()将安全地返回 1。对于 cgroup v2，如果未设置限制，则使用处理器检测。当设置了限制时，行为与 cgroup v1 中描述的相同。
- 参数:
conanfile – 当前的配方对象。始终使用
self。- 返回:
int类型的作业数量
conan.tools.build.cross_building()¶
- cross_building(conanfile=None, skip_x64_x86=False)¶
通过比较构建（build）和主机（host）设置来检查是否正在进行交叉构建。如果正在进行交叉构建，则返回
True。- 参数:
conanfile – 当前的配方对象。始终使用
self。skip_x64_x86 – 当从 64 位构建到 32 位时（例如从 x86_64 到 x86，从 sparcv9 到 sparc 或从 ppc64 到 ppc32），不视为交叉构建
- 返回:
如果存在
tools.build.cross_building:cross_build的bool值，则返回该值；否则，如果正在交叉构建，返回True，否则返回False。
conan.tools.build.can_run()¶
- can_run(conanfile)¶
验证是否可以在同一架构上运行非原生应用程序。这对于您的架构可以运行多个目标的情况是一个有用的功能。例如，Mac M1 机器可以同时运行 armv8 和 x86_64。
- 参数:
conanfile – 当前的配方对象。始终使用
self。- 返回:
如果存在
tools.build.cross_building:can_run的bool值，则返回该值；否则，如果正在交叉构建，返回False，否则返回True。
Cppstd¶
conan.tools.build.check_min_cppstd()¶
- check_min_cppstd(conanfile, cppstd, gnu_extensions=False)¶
检查当前 cppstd 是否符合所需的最小版本。
如果当前 cppstd 不符合 cppstd 所需的最小版本，将引发 ConanInvalidConfiguration 异常。
必须定义 settings.compiler.cppstd，否则将引发 ConanInvalidConfiguration 异常。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cppstd – 所需的最小 cppstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)
conan.tools.build.check_max_cppstd()¶
- check_max_cppstd(conanfile, cppstd, gnu_extensions=False)¶
检查当前 cppstd 是否符合所需的最大版本。
如果当前 cppstd 不符合 cppstd 所需的最大版本，将引发 ConanInvalidConfiguration 异常。
必须定义 settings.compiler.cppstd，否则将引发 ConanInvalidConfiguration 异常。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cppstd – 所需的最大 cppstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)
conan.tools.build.valid_min_cppstd()¶
- valid_min_cppstd(conanfile, cppstd, gnu_extensions=False)¶
验证当前 cppstd 是否符合所需的最小版本。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cppstd – 所需的最小 cppstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)。此选项仅在 Linux 上有效。
- 返回:
如果当前 cppstd 与所需的 cppstd 版本匹配，则为 True。否则为 False。
conan.tools.build.valid_max_cppstd()¶
- valid_max_cppstd(conanfile, cppstd, gnu_extensions=False)¶
验证当前 cppstd 是否符合所需的最大版本。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cppstd – 所需的最大 cppstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)。此选项仅在 Linux 上有效。
- 返回:
如果当前 cppstd 与所需的 cppstd 版本匹配，则为 True。否则为 False。
conan.tools.build.default_cppstd()¶
- default_cppstd(conanfile, compiler=None, compiler_version=None)¶
获取“conanfile.settings.compiler”和“conanfile settings.compiler_version”的默认
compiler.cppstd，如果指定了“compiler”和“compiler_version”参数，则获取它们的默认值。- 参数:
conanfile – 当前的配方对象。始终使用
self。compiler – 编译器名称，例如 gcc
compiler_version – 编译器版本，例如 12
- 返回:
指定编译器的默认
compiler.cppstd
conan.tools.build.supported_cppstd()¶
- supported_cppstd(conanfile, compiler=None, compiler_version=None)¶
获取“conanfile.settings.compiler”和“conanfile.settings.compiler_version”支持的
compiler.cppstd列表，如果指定了“compiler”和“compiler_version”参数，则获取它们支持的列表。- 参数:
conanfile – 当前的配方对象。始终使用
self。compiler – 编译器名称，例如：gcc
compiler_version – 编译器版本，例如：12
- 返回:
支持的
cppstd值列表。
conan.tools.build.cppstd_flag()¶
- cppstd_flag(conanfile) str¶
根据
conanfile.settings.compiler、conanfile.settings.compiler.version和conanfile.settings.compiler.cppstd返回特定于 C++ 标准的标志。它还考虑了在
settings.compiler.cppstd中使用 GNU 扩展的情况，并将其反映在编译器标志中。目前，它支持 GCC、Clang、AppleClang、MSVC、Intel、MCST-LCC。如果配置文件中没有
settings.compiler或settings.cppstd，结果将是空字符串。- 参数:
conanfile – 当前的配方对象。始终使用
self。- 返回:
str类型，包含编译器使用的标准 C++ 标志，例如 “-std=c++11”, “/std:c++latest”
cstd¶
警告
此功能处于实验阶段，可能会发生重大更改。有关更多信息，请参阅 Conan 稳定性 部分。
conan.tools.build.check_min_cstd()¶
- check_min_cstd(conanfile, cstd, gnu_extensions=False)¶
检查当前 cstd 是否符合所需的最小版本。
如果当前 cstd 不符合 cstd 所需的最小版本，将引发 ConanInvalidConfiguration 异常。
如果定义了 settings.compiler.cstd，则工具将使用 settings.compiler.cstd 进行比较。
如果未定义 settings.compiler.cstd，则工具将使用编译器进行比较（读取 cstd_default 中的默认值）。
如果不存在 settings.compiler（未在设置中声明），则会引发异常，因为无法比较。
如果无法检测到 settings.compiler 的默认 cstd，将引发异常。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cstd – 所需的最小 cstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)
conan.tools.build.check_max_cstd()¶
- check_max_cstd(conanfile, cstd, gnu_extensions=False)¶
检查当前 cstd 是否符合所需的最大版本。
如果当前 cstd 不符合 cstd 所需的最大版本，将引发 ConanInvalidConfiguration 异常。
如果定义了 settings.compiler.cstd，则工具将使用 settings.compiler.cstd 进行比较。
如果未定义 settings.compiler.cstd，则工具将使用编译器进行比较（读取 cstd_default 中的默认值）。
如果不存在 settings.compiler（未在设置中声明），则会引发异常，因为无法比较。
如果无法检测到 settings.compiler 的默认 cstd，将引发异常。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cstd – 所需的最大 cstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)
conan.tools.build.valid_min_cstd()¶
- valid_min_cstd(conanfile, cstd, gnu_extensions=False)¶
验证当前 cstd 是否符合所需的最小版本。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cstd – 所需的最小 cstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)。此选项仅在 Linux 上有效。
- 返回:
如果当前 cstd 与所需的 cstd 版本匹配，则为 True。否则为 False。
conan.tools.build.valid_max_cstd()¶
- valid_max_cstd(conanfile, cstd, gnu_extensions=False)¶
验证当前 cstd 是否符合所需的最大版本。
- 参数:
conanfile – 当前的配方对象。始终使用
self。cstd – 所需的最大 cstd 版本
gnu_extensions – 是否需要 GNU 扩展 (例如 gnu17)。此选项仅在 Linux 上有效。
- 返回:
如果当前 cstd 与所需的 cstd 版本匹配，则为 True。否则为 False。
conan.tools.build.default_cstd()¶
- default_cstd(conanfile, compiler=None, compiler_version=None)¶
获取“conanfile.settings.compiler”和“conanfile settings.compiler_version”的默认
compiler.cstd，如果指定了“compiler”和“compiler_version”参数，则获取它们的默认值。- 参数:
conanfile – 当前的配方对象。始终使用
self。compiler – 编译器名称，例如 gcc
compiler_version – 编译器版本，例如 12
- 返回:
指定编译器的默认
compiler.cstd
conan.tools.build.supported_cstd()¶
- supported_cstd(conanfile, compiler=None, compiler_version=None)¶
获取“conanfile.settings.compiler”和“conanfile.settings.compiler_version”支持的
compiler.cstd列表，如果指定了“compiler”和“compiler_version”参数，则获取它们支持的列表。- 参数:
conanfile – 当前的配方对象。始终使用
self。compiler – 编译器名称，例如：gcc
compiler_version – 编译器版本，例如：12
- 返回:
支持的
cstd值列表。