属性¶

包引用 ¶

可定义主要 pkg/version@user/channel 包引用的 Recipe 属性。

name ¶

包的名称。有效名称均为小写，且具有

最少 2 个、最多 101 个字符（建议使用较短的名称）。
匹配以下正则表达式 ^[a-z0-9_][a-z0-9_+.-]{1,100}$：以字母数字或 _ 开头，
然后是 1 到 100 个字符，可以是字母数字、_、+、. 或 -。

只有将 Recipe export 到本地缓存（export、export-pkg: 以及 create 命令）时才需要名称，除非它们已在命令行中通过 --name=<pkgname> 定义。

version ¶

包的版本。有效版本遵循与 name 属性相同的规则。如果版本遵循语义版本控制形式 X.Y.Z-pre1+build2，则该值可用于通过版本范围而不是精确版本来引用此包。

只有将 Recipe export 到本地缓存（export、export-pkg 和 create 命令）时才严格需要版本，除非它们已在命令行中通过 --version=<pkgversion> 定义。

version 可以在命令行中动态定义，也可以在 recipe 中通过 set_version() 方法以编程方式定义。

user 字段的有效字符串遵循与 name 属性相同的规则。这是一个可选属性。它可以用于使用 pkg/version@user/channel 来标识您自己的包，其中 user 可以是您的团队、组织或公司的名称。ConanCenter 的 recipes 没有 user/channel，因此它们仅采用 pkg/version 的形式。您也可以在不使用 user 和 channel 的情况下命名您的包，或者仅使用 user 作为 pkg/version@user。

用户可以在命令行中通过 --user=<myuser> 指定。

channel ¶

channel 字段的有效字符串遵循与 name 属性相同的规则。这是一个可选属性。它有时用于标识包的成熟度（“stable”、“testing”……），但通常这并非必需，包的成熟度最好通过将其放入不同的服务器仓库中来管理。

通道可以在命令行中通过 --channel=<mychannel> 指定。

元数据 ¶

可选的元数据，例如许可证、描述、作者等。在大多数情况下并非必需，但拥有这些信息可能很有用。

description ¶

这是一个可选但推荐的文本字段，包含包的描述以及对消费者可能任何有用的信息。第一行可以用作包的简短描述。

class HelloConan(ConanFile):
    name = "hello"
    version = "0.1"
    description = """This is a Hello World library.
                    A fully featured, portable, C++ library to say Hello World in the stdout,
                    with incredible iostreams performance"""

license ¶

目标源代码和二进制文件的许可证，即正在打包的代码，而不是 conanfile.py 本身。可以包含多个以逗号分隔的许可证。它是一个文本字符串，因此可以包含任何文本，但强烈建议开源项目的 recipes 使用来自 SPDX 许可证列表的 SPDX 标识符。

这将有助于那些希望自动化许可证兼容性检查的人，例如您包的消费者，或者如果您的包有开源依赖，则对您自己也有帮助。

class Pkg(ConanFile):
    license = "MIT"

author ¶

包的主要维护者/负责人，任何格式。这是一个可选属性。

class HelloConan(ConanFile):
    author = "John J. Smith (john.smith@company.com)"

topics ¶

用于将相关包组合在一起并描述代码内容的标签。在 ConanCenter 中用作搜索过滤器。可选属性。它应该是一个字符串元组。

class ProtocInstallerConan(ConanFile):
    name = "protoc_installer"
    version = "0.1"
    topics = ("protocol-buffers", "protocol-compiler", "serialization", "rpc")

homepage ¶

正在打包的库的主网页。

用于将 recipe 链接到库本身的进一步解释，例如其功能概述、文档、常见问题解答以及其他相关信息。

class EigenConan(ConanFile):
    name = "eigen"
    version = "3.3.4"
    homepage = "http://eigen.tuxfamily.org"

url ¶

包仓库的 URL，即不一定是原始源代码的 URL。推荐，但不是强制属性。

class HelloConan(ConanFile):
    name = "hello"
    version = "0.1"
    url = "https://github.com/conan-io/libhello.git"

依赖 ¶

依赖项简单声明的属性形式，例如 requires、tool_requires。要以更高级的方式定义依赖项，请改用 requirements()、build_requirements() 方法。

requires ¶

用于主机上下文中常规依赖项的字符串列表或元组，例如库。

class MyLibConan(ConanFile):
    requires = "hello/1.0", "otherlib/2.1@otheruser/testing"

您可以指定版本范围，语法使用括号

class HelloConan(ConanFile):
    requires = "pkg/[>1.0 <1.8]"

可接受的表达式包括

表达式	范围内的版本	范围外的版本
[>=1.0 <2]	1.0.0, 1.0.1, 1.1, 1.2.3	0.2, 2.0, 2.1, 3.0
[<3.2.1]	0.1, 1.2, 2.4, 3.1.1	3.2.2
[>2.0]	2.1, 2.2, 3.1, 14.2	1.1, 1.2, 2.0

如果预发布版本已激活，例如定义配置 core.version_ranges:resolve_prereleases=True

表达式	范围内的版本	范围外的版本
[>=1.0 <2]	1.0.0-pre.1, 1.0.0, 1.0.1, 1.1, 1.2.3	0.2, 2.0-pre.1, 2.0, 2.1, 3.0
[<3.2.1]	0.1, 1.2, 1.8-beta.1, 2.0-alpha.2, 2.4, 3.1.1	3.2.1-pre.1, 3.2.1, 3.2.2, 3.3
[>2.0]	2.1-pre.1, 2.1, 2.2, 3.1, 14.2	1.1, 1.2, 2.0-pre.1, 2.0

另请参阅

查看范围表达式 version_ranges 教程部分
查看 requirements() 方法文档

tool_requires ¶

用于依赖项的字符串列表或元组。代表一个构建工具，例如“cmake”。如果当前包存在预编译二进制文件，则不会检索 tool_require 的二进制文件。它们不能冲突。

class MyPkg(ConanFile):
    tool_requires = "tool_a/0.2", "tool_b/0.2@user/testing"

这是添加 tool_requires 的声明式方法。查看 tool_requires() conanfile.py 方法以了解更灵活的添加方式。

build_requires ¶

在 Conan 2 中使用 build_requires 是为了提供与 Conan 1.X 语法的兼容性，但在 Conan 2 中不鼓励使用它们，并将在未来的 2.X 版本中弃用。请在您的 Conan 2 recipes 中使用 tool_requires 而不是 build_requires。

test_requires ¶

仅用于主机上下文中的依赖项的字符串列表或元组。代表一个测试工具，例如“gtest”。当当前包从源代码构建时使用。它们不会向下游消费者传播信息。如果当前包存在预编译二进制文件，则不会检索 test_require 的二进制文件。它们不能冲突。

class MyPkg(ConanFile):
    test_requires = "gtest/1.11.0", "other_test_tool/0.2@user/testing"

这是添加 test_requires 的声明式方法。查看 test_requires() 方法以了解更灵活的添加方式。

python_requires ¶

此类属性允许定义对另一个 Conan Recipe 的依赖并重用其代码。其基本语法是

from conan import ConanFile

class Pkg(ConanFile):
    python_requires = "pyreq/0.1@user/channel"  # recipe to reuse code from

    def build(self):
        self.python_requires["pyreq"].module # access to the whole conanfile.py module
        self.python_requires["pyreq"].module.myvar  # access to a variable
        self.python_requires["pyreq"].module.myfunct()  # access to a global function
        self.python_requires["pyreq"].path # access to the folder where the reused file is

在 Python requires 中阅读有关此属性的更多信息。

python_requires_extend ¶

此类属性定义一个或多个类，这些类将在运行时作为 Recipe 类的基类注入。每个这些类的语法应该是一个字符串，例如 pyreq.MyConanfileBase，其中 pyreq 是 python_requires 的名称，MyConanfileBase 是要使用的类的名称。

from conan import ConanFile

class Pkg(ConanFile):
    python_requires = "pyreq/0.1@user/channel", "utils/0.1@user/channel"
    python_requires_extend = "pyreq.MyConanfileBase", "utils.UtilsBase"  # class/es to inject

源文件 ¶

exports ¶

一个字符串列表或元组，包含应与 conanfile.py 文件并排导出和存储的文件名或 fnmatch 模式，以使 Recipe 工作：Recipe 将导入的其他 Python 文件，一些包含要读取数据的文件等。

例如，如果我们有一些希望 Recipe 在 helpers.py 文件中使用的 Python 代码，并且有一个文本文件 info.txt 我们希望在 Recipe 评估期间读取和显示，我们会这样做：

exports = "helpers.py", "info.txt"

也可以使用 ! 前缀排除模式。

exports = "*.py", "!*tmp.py"

另请参阅

检查 export() conanfile.py 方法.

exports_sources ¶

一个字符串列表或元组，包含应导出并可用于生成包的文件名或 fnmatch 模式。与 exports 属性不同，这些文件不应由 conanfile.py Python 代码使用，而是用于编译库或生成最终包。并且，由于其目的，这些文件只有在请求的二进制文件不可用或用户强制 Conan 从源代码编译时才会被检索。

这是通过 source() 方法获取源代码的替代方案。当我们不打包第三方库并且同时拥有 Recipe 和 C/C++ 项目时使用。

exports_sources = "include*", "src*"

也可以使用 ! 前缀排除模式。

exports_sources = "include*", "src*", "!src/build/*"

请注意，如果 Recipe 定义了 layout() 方法并指定了 self.folders.source = "src"，它不会影响文件（来自 exports_sources）的复制位置。它们将被复制到基本源文件夹。因此，如果您想替换进入 source() 方法的某个文件，您需要明确地从父文件夹复制它，或者更好的是，从 self.export_sources_folder 复制。

import os, shutil
from conan import ConanFile
from conan.tools.files import save, load

class Pkg(ConanFile):
    ...
    exports_sources = "CMakeLists.txt"

    def layout(self):
        self.folders.source = "src"
        self.folders.build = "build"

    def source(self):
        # emulate a download from web site
        save(self, "CMakeLists.txt", "MISTAKE: Very old CMakeLists to be replaced")
        # Now I fix it with one of the exported files
        shutil.copy("../CMakeLists.txt", ".")
        shutil.copy(os.path.join(self.export_sources_folder, "CMakeLists.txt"), ".")

另请参阅

检查 export_sources() conanfile.py 方法.

conan_data ¶

只读属性，包含一个字典，其键和值来自放置在 conanfile.py 旁边的 conandata.yml 文件格式。此 YAML 文件会自动随 Recipe 导出并自动加载。

您可以在 conandata.yml 文件中声明信息，然后在 Recipe 的任何方法中访问它。例如，一个包含源代码信息的 conandata.yml 看起来像这样：

sources:
  "1.1.0":
    url: "https://www.url.org/source/mylib-1.0.0.tar.gz"
    sha256: "8c48baf3babe0d505d16cfc0cf272589c66d3624264098213db0fb00034728e9"
  "1.1.1":
    url: "https://www.url.org/source/mylib-1.0.1.tar.gz"
    sha256: "15b6393c20030aab02c8e2fe0243cb1d1d18062f6c095d67bca91871dc7f324a"

def source(self):
    get(self, **self.conan_data["sources"][self.version])

source_buildenv ¶

布尔属性，用于在运行 source() 方法时选择注入 VirtualBuildEnv 生成的环境。

将此属性设置为 True（默认值为 False）将在执行 source() 方法时，从工具依赖项中注入 VirtualBuildEnv 生成的环境。

 class MyConan:
    name = "mylib"
    version = "1.0.0"
    source_buildenv = True
    tool_requires = "7zip/1.2.0"

    def source(self):
        get(self, **self.conan_data["sources"][self.version])
        self.run("7z x *.zip -o*")  ## Can run 7z in the source method

二进制模型 ¶

定义包二进制模型的重要属性，例如哪些设置、选项、包类型等会影响最终打包的二进制文件。

package_type ¶

可选。声明 package_type 将有助于 Conan

更好地选择每个依赖项的默认 package_id_mode，即依赖项的更改应如何影响当前包的 package_id。
依赖项中的哪些信息应该传播给消费者，例如头文件、库、运行时信息。请参阅此处，了解根据 package_type 信息传播了哪些特性。

有效值为

application: 该包是一个应用程序。
library: 该包是一个通用库。它将尝试通过读取 self.options.shared（如果已声明）和 self.options.header_only 来确定库的类型（从 shared-library、static-library、header-library 中）。
shared-library: 该包是一个共享库。
static-library: 该包是一个静态库。
header-library: 该包是一个仅头文件库。
build-scripts: 该包只包含构建脚本。
python-require: 该包是一个 Python 依赖项。
unknown: 包的类型未知。

settings ¶

字符串列表，包含 Recipe 需要的第一级设置（来自 settings.yml），因为：- 它们用于构建（例如：if self.settings.compiler == “gcc”）- 它们会影响 package_id。如果声明的设置值发生变化，package_id 必须不同。

最常见的是声明

settings = "os", "compiler", "build_type", "arch"

一旦 Conan 加载了 Recipe，settings 就会被处理，并且可以在 Recipe 中读取它们以及子设置。

settings = "os", "arch"

def build(self):
    if self.settings.compiler == "gcc":
        if self.settings.compiler.cppstd == "gnu20":
            # do some special build commands

如果您尝试访问不存在的设置，例如 msvc 设置的 self.settings.compiler.libcxx，Conan 将会报错，提示该编译器不存在 libcxx。

如果您想安全地检查设置值，可以使用 get_safe() 方法。

def build(self):
    # Will be None if doesn't exist (not declared)
    arch = self.settings.get_safe("arch")
    # Will be None if doesn't exist (doesn't exist for the current compiler)
    compiler_version = self.settings.get_safe("compiler.version")
    # Will be the default version if the return is None
    build_type = self.settings.get_safe("build_type", default="Release")

如果该设置或子设置不存在且未分配默认值，则 get_safe() 方法返回 None。

也可以使用 possible_values() 方法检查 settings.yml 中定义的可能值。

def generate(self):
    # Print if Android exists as OS in the whole settings.yml
    is_android = "Android" in self.settings.possible_values()["os"]
    self.output.info(f"Android in settings.yml: {is_android}")
    # Print the available versions for the compiler used by the HOST profile
    compiler_versions = self.settings.compiler.version.possible_values()
    self.output.info(f"[HOST] Versions for {str(self.settings.compiler)}:  {', '.join(compiler_versions)}")
    # Print the available versions for the compiler used by the BUILD profile
    compiler_versions = self.settings_build.compiler.version.possible_values()
    self.output.info(f"[BUILD] Versions for {str(self.settings.compiler)}:  {', '.join(compiler_versions)}")

如您所见，执行 self.settings.possible_values() 会将整个 settings.yml 作为 Python 字典类对象返回，而例如执行 self.settings.compiler.version.possible_values() 则会返回消费者使用的编译器的可用版本。

如果您想安全地删除设置，可以使用 rm_safe() 方法。例如，在 configure() 方法中，C 库的典型模式是：

def configure(self):
    self.settings.rm_safe("compiler.libcxx")
    self.settings.rm_safe("compiler.cppstd")

另请参阅

options ¶

字典，包含仅影响当前 Recipe 的特性，其中键是选项名称，值是选项可以采用的不同值的列表。默认情况下，选项中的任何值更改都会更改 package_id。检查 default_options 和 default_build_options 字段以定义选项的默认值。

每个选项的值可以是类型化值或纯字符串（"value"、True、42 等）。

有两个特殊值：

None：允许选项具有 None 值（未指定）而不出错。
"ANY"：对于可以采用任何值的选项，不受集合限制。

class MyPkg(ConanFile):
    ...
    options = {
        "shared": [True, False],
        "option1": ["value1", "value2"],
        "option2": ["ANY"],
        "option3": [None, "value1", "value2"],
        "option4": [True, False, "value"],
}

一旦 Conan 加载了 Recipe，options 就会被处理，并且可以在 Recipe 中读取它们。您还可以使用 .get_safe() 方法（请参阅 settings 属性）来避免在选项不存在时 Conan 引发异常。

class MyPkg(ConanFile):
    options = {"shared": [True, False]}

    def build(self):
        if self.options.shared:
            # build the shared library
        if self.options.get_safe("foo", True):
            pass

在布尔表达式中，例如 if self.options.shared

对于 True、"True" 和 "true"，以及在 Python 代码中以相同方式评估的任何其他值，都等于 True。
对于 False、"False" 和 "false"，以及空字符串、0 和 "0"，都等于 False。

请注意，使用 is 进行比较始终为 False，因为由于它封装在 Python 类中，类型会不同。

如果您想安全地删除选项，可以使用 rm_safe() 方法。例如，在 config_options() 方法中，Windows 库的典型模式是：

def config_options(self):
    if self.settings.os == "Windows":
        self.options.rm_safe("fPIC")

另请参阅

default_options ¶

属性 default_options 定义选项的默认值，适用于当前 Recipe 和任何依赖项。此属性应定义为 Python 字典。

class MyPkg(ConanFile):
    ...
    requires = "zlib/1.2.8", "zwave/2.0"
    options = {"build_tests": [True, False],
                "option2": "ANY"}
    default_options = {"build_tests": True,
                        "option1": 42,
                        "z*:shared": True}

您还可以使用“<reference_pattern>: option_name”为依赖项的选项分配默认值，其中有效的 reference_pattern 是 name/version 或任何带有 * 的模式，如上例所示。

警告

在 recipes 中定义选项值没有强有力的保证，请查看此关于依赖项选项值的 FAQ。建议在配置文件中定义选项值。

您也可以使用 configure() 有条件地将选项设置为最终值，而不是使用 default_options。

class OtherPkg(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    options = {"some_option": [True, False]}
    # Do NOT declare 'default_options', use 'config_options()'

    def configure(self):
        if self.options.some_option == None:
            if self.settings.os == 'Android':
                self.options.some_option = True
            else:
                self.options.some_option = False

请注意，如果在 configure() 方法中分配了值，则无法覆盖。

另请参阅

config_options() 方法.

Recipe 可以尝试为其依赖项定义选项值，这有两种不同的方式。使用 default_options = {"mypkg/*:myoption", 123}，当前 Recipe 可以为依赖项 mypkg 的 myoption 定义值 123。这种为依赖项定义选项的方式有一些限制：

当前 Recipe 的任何其他下游用户如果为 mypkg 定义相同的选项，将具有优先权，覆盖当前 Recipe 的 123 值。配置文件或命令行中的任何定义也将具有优先权。Recipe 的 default_options 优先级最低。如果 Recipe 在某些依赖项选项下完全无法工作，则 Recipe 可以相应地检查并引发 ConanInvalidConfiguration 错误。
任何依赖于 mypkg 的同级包也将定义其选项，并且只有它会被考虑。换句话说，任何其他包第一次需要 mypkg 时，其当前分配的选项值将被“冻结”。任何其他稍后依赖 mypkg 的包，即使是封闭依赖图中的菱形结构，也不会对 mypkg 的选项产生任何影响。只有第一次引用它的包会生效。

定义选项值的第二种方式是将其定义为 important!。

警告

important! 语法是实验性的，随时可能更改或移除。

Recipe 可以使用语法 default_options = {"mypkg/*:myoption!", 123} 将其依赖项选项定义为 important!。这意味着 mypkg 的 myoption 将不会被其他下游包、配置文件或执行常规选项定义（如 -o *:myoption=234）的命令行覆盖。

但在以下两种情况下，这仍然不会定义依赖项的最终值：

如果任何下游 Recipe、命令行或配置文件也使用 myoption! 语法，则它们也将具有优先权并覆盖上游值。
如果存在任何其他包首先需要 mypkg，则当时定义的值仍将具有优先权。

通常，建议在 profile 文件中定义选项值，而不是在 recipes 中，因为在 Recipe 中定义可能会更复杂，特别是对于复杂的依赖图。

default_build_options ¶

属性 default_build_options 定义了构建上下文中选项的默认值，通常用于为 tool_requires 定义选项。

from conan import ConanFile
class Consumer(ConanFile):
    default_options = {"protobuf/*:shared": True}
    default_build_options = {"protobuf/*:shared": False}
    def requirements(self):
        self.requires("protobuf/1.0")
    def build_requirements(self):
        self.tool_requires("protobuf/1.0")

options_description ¶

options_description 属性是一个可选属性，可以定义为字典形式，其中键是选项名称，值是选项的文本描述。此属性对于提供每个选项的功能和目的的额外信息很有用，特别是当选项不是不言自明或具有复杂或特殊行为时。

每个字典条目的格式应为：

键：选项名称。必须是字符串，并且必须与 options 字典中的一个键匹配。
值：选项的描述。必须是字符串，长度可根据需要。

例如

class MyPkg(ConanFile):
    ...
    options = {"option1": [True, False],
               "option2": "ANY"}

    options_description = {
        "option1": "Describe the purpose and functionality of 'option1'. ",
        "option2": "Describe the purpose and functionality of 'option2'. ",
    }

languages ¶

警告

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

从 Conan 2.4 开始，conanfile.py Recipe 属性 languages 可用于定义此包中涉及的编程语言。目前，C 和 C++ 语言是可能的值。例如，一个纯 C 包会定义如下内容：

class ZLib(ConanFile):
    languages = "C"

可以定义多种语言，例如，当一个包由 C 和 C++ 源代码构建时，正确的定义是 languages = "C", "C++"。

关于 languages 定义，将发生以下情况：

如果未定义 languages 或 C 未声明为语言，则 compiler.cstd 子设置将在包 configure() 时自动移除（为实现向后兼容性）。
如果定义了 languages，但它不包含 C++，则 compiler.cppstd 和 compiler.libcxx 子设置将在包 configure() 时自动移除。

info ¶

仅在 package_id() 方法中使用的对象

:ref:package_id method<reference_conanfile_methods_package_id> 用于控制包的唯一 ID
def package_id(self): self.info.clear()

self.info.clear() 方法从 package_id 计算中移除所有设置、选项、依赖项（requires、tool_requires、python_requires）和配置（conf），因此 package_id 将始终生成相同的二进制文件，与所有这些因素无关。这通常是仅头文件库的情况，其中打包的工件（文件）始终是相同的。

package_id_{embed,non_embed,python,unknown}_mode, build_mode ¶

package_id_embed_mode, package_id_non_embed_mode, package_id_python_mode, package_id_unknown_mode 是类属性，可以在 recipes 中定义，以指定当它们作为 requires 被消费时，对消费者 package_id 的影响。

build_mode（实验性）是一个类属性，当包消费者将其用作 tool_requires 时，会影响这些消费者。可以声明为：

from conan import ConanFile

class Pkg(ConanFile):
    name = "pkg"
    version = "1.0.0"
    # They are not mandatory, and it is not necessary to define all
    package_id_embed_mode = "full_mode"
    package_id_non_embed_mode = "patch_mode"
    package_id_unknown_mode = "minor_mode"
    package_id_python_mode = "major_mode"
    build_mode = "patch_mode"  # (experimental) when used as tool_requires

一般来说，Conan 的默认设置是好的，并允许用户很好地控制何时需要从源代码重建消费者。此外，Conan 的默认设置可以在 global.conf 文件中全局更改（它们应该为所有用户、CI 等全局更改），通过 core.package_id:xxxx 配置。Recipe 中属性定义对于定义偏离默认值的行为很有用。

可能的值有（遵循 MAJOR.MINOR.PATCH 的语义版本定义）：

patch_mode: 包的新补丁、次版本和主版本发布将要求消费者有新的二进制文件（新的 package_id）。新的 Recipe 修订版将不要求消费者有新的二进制文件。例如，如果我们创建新版本 pkg/1.0.1，并且某个消费者有 requires = "pkg/[>=1.0 <2.0]"，则该消费者将针对这个特定的新 1.0.1 版本构建一个新的二进制文件。但是，如果只是更改 Recipe，生成新的 recipe_revision，消费者将不需要构建新的二进制文件。
minor_mode: 该包的新次版本和主版本发布将要求消费者有新的二进制文件。新的补丁和新的修订版将不要求消费者有新的二进制文件。这是“非嵌入模式”的默认设置，因为它允许用户精细控制何时重建。
major_mode: 只有新的主版本发布才需要新的二进制文件。任何其他修改和新版本将不要求消费者有新的二进制文件。
full_mode: 该包的完整标识符，包括 pkgname/version@user/channel#recipe_revision:package_id 将用于消费者的 package_id，因此该包的每次更改（因为源代码或配置的任何更改都会分别产生不同的 recipe_revision 或 package_id）都将要求构建消费者的新二进制文件。这是“嵌入模式”的默认设置。
unrelated_mode: 该包的任何更改都不会在消费者中产生新的二进制文件。
revision_mode: 在消费者的 package_id 中使用 pkgname/version@user/channel#recipe_revision，即除了依赖项的 package_id 之外的完整引用。
semver_mode: 如果版本是 >=1.0，则等同于 major_mode；如果版本是 <1.0，则等同于 patch_mode（或者如果版本有超过 3 位数字，则为完整版本）。

这 4 个不同属性是：

package_id_embed_mode: 定义“嵌入”情况的模式，即共享库链接静态库、应用程序链接静态库、应用程序或库链接仅头文件库。此模式的默认值为 full_mode。
package_id_non_embed_mode。定义“非嵌入”情况的模式，即共享库链接另一个共享库、静态库链接另一个静态库、应用程序可执行文件链接共享库。此模式的默认值为 minor_mode。
package_id_unknown_mode: 定义包之间关系未知时的模式。如果无法推断包类型，因为没有定义 shared 或 header_only 选项，或者因为未定义 package_type，则将使用此模式。此模式的默认值为 semver_mode（类似于 Conan 1.X 的行为）。
package_id_python_mode: 定义 python_requires 消费者的模式。默认情况下，它将是 minor_mode，强烈建议使用此默认值，而不是定义 package_id_python_mode。此属性是为了完整性和临时迁移等特殊情况而提供的。
build_mode:（实验性）定义将此依赖项用作 tool_requires 的消费者的模式。默认值为 None，这意味着 tool_requires 不直接影响其消费者的 package_id。启用此 build_mode 将引入对 tool_requires 的更强依赖，这在更多情况下将需要解析消费者的 package_id。

另请参阅

阅读二进制模型参考以全面了解 Conan 二进制模型。

构建 ¶

generators ¶

包含生成器名称的字符串列表或元组。

class MyLibConan(ConanFile):
    generators = "CMakeDeps", "CMakeToolchain"

生成器也可以在 generate() 方法中显式实例化。

from conan.tools.cmake import CMakeToolchain

class MyLibConan(ConanFile):
    ...

    def generate(self):
        tc = CMakeToolchain(self)
        tc.generate()

build_policy ¶

控制在 conan install 期间何时构建当前包。允许的值有：

"missing": 如果没有可用的二进制文件，Conan 将从源代码构建它。
"never": 此包不能从源代码构建，它始终通过 conan export-pkg 创建。
None（默认值）：除非在命令行中指定了策略（例如 --build=foo*），否则不会构建此包。
class PocoTimerConan(ConanFile): build_policy = "missing"

win_bash ¶

当为 True 时，启用 Windows 子系统 bash 中的新运行机制。

from conan import ConanFile

class FooRecipe(ConanFile):
    ...
    win_bash = True

它也可以根据任何条件声明为 property。

from conan import ConanFile

class FooRecipe(ConanFile):
    ...


    @property
    def win_bash(self):
        return self.settings.arch == "armv8"

win_bash_run ¶

当为 True 时，启用在 "run" 范围内运行命令，以便在 bash shell 中执行它们。

from conan import ConanFile

class FooRecipe(ConanFile):

    ...

    win_bash_run = True
    def build(self):
        self.run(cmd, scope="run")  # will run <cmd> inside bash

文件夹与布局 ¶

source_folder ¶

源代码所在的文件夹。路径由基本目录（在缓存中运行时为缓存目录，在本地运行时为 output folder）与 layout() 方法中声明的 folders.source 值连接而成。

请注意，在缓存中运行时，source_folder 的基本目录将指向构建的基本文件夹，除非 no_copy_source 设置为 True。但无论如何，它将始终指向源代码所在的正确文件夹。

export_sources_folder ¶

该值取决于您访问它的方法：

在 source(self) 中：指向基本源文件夹（即 self.source_folder，但不考虑 layout() 方法中声明的 folders.source）。声明的 exports_sources 始终复制到该基本源文件夹。
在 exports_sources(self) 中：指向缓存中必须复制导出源的文件夹。

另请参阅

build_folder ¶

用于构建源代码的文件夹。路径由基本目录（在缓存中运行时为缓存目录，在本地运行时为 output folder）与 layout() 方法中声明的 folders.build 值连接而成。

generators_folder ¶

在 generate() 方法中应生成文件的文件夹。路径是从布局的 self.folders.generators 属性构建的。

package_folder ¶

用于复制二进制包最终工件的文件夹。在本地缓存中，每个不同的包 ID 都会创建一个包文件夹。

self.package_folder 最常见的用法是在 package() 方法中 copy 文件。

import os
from conan import ConanFile
from conan.tools.files import copy

class MyRecipe(ConanFile):
    ...

    def package(self):
        copy(self, "*.so", self.build_folder, os.path.join(self.package_folder, "lib"))
        ...

recipe_folder ¶

Recipe conanfile.py 存储的文件夹，可以是在本地文件夹中，也可以是在缓存中。这对于访问随 Recipe 导出的文件，或在 export(self) 和 export_sources(self) 方法中导出文件时的源文件夹很有用。

self.recipe_folder 最常见的用法是在 export(self) 和 export_sources(self) 方法中，作为我们复制文件的源文件夹。

from conan import ConanFile
from conan.tools.files import copy

class MethodConan(ConanFile):
    exports = "file.txt"
    def export(self):
        copy(self, "LICENSE.md", self.recipe_folder, self.export_folder)

recipe_metadata_folder ¶

self.recipe_metadata_folder（实验性）可用于 export()、export_sources() 和 source() 方法中，用于保存或复制 recipe 元数据文件。有关更多信息，请参阅元数据部分。

package_metadata_folder ¶

self.package_metadata_folder（实验性）可用于 generate()、build() 和 package() 方法中，用于保存或复制包元数据文件。有关更多信息，请参阅元数据部分。

no_copy_source ¶

属性 no_copy_source 告知 Recipe 源代码不会从 source_folder 复制到 build_folder。这主要是针对具有大型源代码库或仅头文件的包进行优化，以避免额外的复制。

如果您激活 no_copy_source=True，则必须确保源代码不会被配置或构建脚本修改，因为源代码将在所有构建之间共享。

Recipes 应始终使用 self.source_folder 属性，当 no_copy_source=False 时，它将指向 build 文件夹；当 no_copy_source=True 时，它将指向 source 文件夹。

另请参阅

阅读仅头文件包部分，了解使用 no_copy_source 属性的示例。

test_package_folder ¶

test_package_folder 类属性允许在 Recipe 中为 conan create 命令定义一个不同的默认 test_package 文件夹。当 conan create 运行时，在包在缓存中创建后，它将查找 test_package 文件夹，或者 --test-folder=xxx 参数中指定的文件夹，并启动包测试。

此属性允许更改该默认名称。

import os
from conan import ConanFile

class Pkg(ConanFile):
    test_package_folder = "my/test/folder"

它允许定义任何文件夹，始终相对于 conanfile.py 的位置。

布局 ¶

`folders` 属性只能在 `layout()` 方法中设置。请查阅 layout() 方法文档以了解有关此属性的更多信息。

cpp ¶

存储包消费者所需所有信息的对象：包括目录、库名称、库路径等。适用于缓存中的可编辑包和常规包。它仅在 `layout()` 方法中可用。

self.cpp.package: 用于从 Conan 缓存中使用的常规包。与在 package_info() 方法中声明 self.cpp_info 相同。

self.cpp.source: 用于“可编辑”包，描述 self.source_folder 下的工件。
self.cpp.build: 用于“可编辑”包，描述 self.build_folder 下的工件。
cpp 属性只能在 layout() 方法中设置。请查阅 layout() 方法文档以了解有关此属性的更多信息。

layouts ¶

`layouts` 属性只能在 `layout()` 方法中设置。请查阅 layout() 方法文档以了解有关此属性的更多信息。

layouts 属性包含有关环境变量和 conf 的信息，这些信息是路径相关的，因此当包处于可编辑模式或在缓存中时，它将包含不同的值。layouts 的子属性是：

self.layouts.build: 与相对路径 self.folders.build 相关的信息。

self.layouts.source: 与相对路径 self.folders.source 相关的信息。
self.layouts.package: 与最终 package_folder 相关的信息。
它们每一个都将包含：

buildenv_info: 供消费者使用的环境变量构建信息（等同于 package_info() 中的 self.buildenv_info）。

runenv_info: 供消费者使用的环境变量运行信息（等同于 package_info() 中的 self.runenv_info）。
conf_info: 供消费者使用的配置信息（等同于 package_info() 中的 self.conf_info）。请注意，当此包是直接的 tool_require 时，此信息才会自动传播到消费者的 self.conf。
例如，如果我们有一个包含 AndroidNDK 的 androidndk Recipe，并且我们希望该 Recipe 处于“可编辑”模式，则在创建包之前，需要知道 androidndk 在本地的位置。

面向消费者的包信息 ¶

import os
from conan import ConanFile
from conan.tools.files import copy

class AndroidNDK(ConanFile):

    def layout(self):
        # When developing in user space it is in a "mybuild" folder (relative to current dir)
        self.layouts.build.conf_info.define_path("tools.android:ndk_path", "mybuild")
        # but when packaged it will be in a "mypkg" folder (inside the cache package folder)
        self.layouts.package.conf_info.define_path("tools.android:ndk_path", "mypkg")

    def package(self):
        copy(self, "*", src=os.path.join(self.build_folder, "mybuild"),
             dst=os.path.join(self.package_folder, "mypkg"))

cpp_info ¶

与在 `layout()` 方法中使用 `self.cpp.package` 相同。如果您需要读取 `package_folder` 来定位已定位的工件，请使用它。

CppInfo 模型。

另请参阅

重要

此属性仅在 package_info() 方法内部定义，在其他地方为 None。

buildenv_info ¶

对于依赖 Recipe，声明的环境变量将在构建过程中存在。应仅在 `package_info()` 方法中填充。

查看 Environment 对象的参考，了解如何填充 self.buildenv_info。

此属性仅在 package_info() 方法内部定义，在其他地方为 None。

buildenv_info ¶

def package_info(self):
    self.buildenv_info.append_path("PATH", self.package_folder)

另请参阅

runenv_info ¶

对于依赖 Recipe，声明的环境变量将在运行时存在。应仅在 `package_info()` 方法中填充。

查看 Environment 对象的参考，了解如何填充 self.runenv_info。

此属性仅在 package_info() 方法内部定义，在其他地方为 None。

buildenv_info ¶

def package_info(self):
    self.runenv_info.define_path("RUNTIME_VAR", "c:/path/to/exe")

另请参阅

conf_info ¶

要传递给依赖 Recipe 的配置变量。应仅在 `package_info()` 方法中填充。

在此处阅读 self.conf_info 的完整参考。

class Pkg(ConanFile):
    name = "pkg"

    def package_info(self):
        self.conf_info.define("tools.build:verbosity", "debug")
        self.conf_info.get("tools.build:verbosity")  # == "debug"
        self.conf_info.append("user.myconf.build:ldflags", "--flag3")  # == ["--flag1", "--flag2", "--flag3"]
        self.conf_info.update("tools.microsoft.msbuildtoolchain:compile_options", {"ExpandAttributedSource": "false"})
        self.conf_info.unset("tools.microsoft.msbuildtoolchain:compile_options")
        self.conf_info.remove("user.myconf.build:ldflags", "--flag1")  # == ["--flag0", "--flag2", "--flag3"]
        self.conf_info.pop("tools.system.package_manager:sudo")

另请参阅

generator_info ¶

要传递给依赖 Recipe 的生成器。应仅在 `package_info()` 方法中填充，默认为 `None`。

警告

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

在此处查看一个使用示例，并查看self.generator_info 的完整参考。

另请参阅

已弃用 ¶

此属性声明 Recipe 已弃用，每当使用它时，都会发出一个用户友好的警告消息。

例如，以下代码：

可能会发出类似如下的 risk 警告：

from conan import ConanFile

class Pkg(ConanFile):
    name = "cpp-taskflow"
    version = "1.0"
    deprecated = True

可选地，该属性可以指定建议替换的名称。

Deprecated
    cpp-taskflow/1.0

WARN: risk: There are deprecated packages in the graph

这将发出类似如下的 risk 警告：

from conan import ConanFile

class Pkg(ConanFile):
    name = "cpp-taskflow"
    version = "1.0"
    deprecated = "Not secure, use better taskflow>1.2.3"

如果属性的值评估为 False，则不打印警告。

Deprecated
    cpp-taskflow/1.0: Not secure, use better taskflow>1.2.3

WARN: risk: There are deprecated packages in the graph

provides ¶

此属性声明 Recipe 提供与其他 Recipe 相同的功能。如果两个或多个库实现相同的 API，通常需要此属性来防止链接时和运行时冲突（ODR 违规）。一种典型情况是分叉库。例如：

LibreSSL, BoringSSL 和 OpenSSL

libav 和 ffmpeg
MariaDB client 和 MySQL client
如果 Conan 在单个图中遇到两个或更多提供相同功能的库，它会引发错误。

属性值应为包含 Recipe 名称的字符串或此类 Recipe 名称的元组。

At least two recipes provides the same functionality:
- 'libjpeg' provided by 'libjpeg/9d', 'libjpeg-turbo/2.0.5'

例如，要声明 libjpeg-turbo Recipe 提供与 libjpeg Recipe 相同的功能，可以使用以下代码：

要声明一个 Recipe 同时提供多个不同 Recipe 的功能，可以使用以下代码：

from conan import ConanFile

class LibJpegTurbo(ConanFile):
    name = "libjpeg-turbo"
    version = "1.0"
    provides = "libjpeg"

如果省略该属性，则该属性的值假定等于当前包名称。因此，对于 libjpeg Recipe 来说，声明它提供了 libjpeg 是多余的，Conan 已隐式假定。

from conan import ConanFile

class OpenBLAS(ConanFile):
    name = "openblas"
    version = "1.0"
    provides = "cblas", "lapack"

其他 ¶

dependencies ¶

Conan Recipe 通过 `self.dependencies` 属性提供对其依赖项的访问。

在此处阅读 self.dependencies 的完整参考。

class Pkg(ConanFile):
    requires = "openssl/0.1"

    def generate(self):
        openssl = self.dependencies["openssl"]
        # access to members
        openssl.ref.version
        openssl.ref.revision # recipe revision
        openssl.options
        openssl.settings

另请参阅

subgraph ¶

（实验性）Recipe 的只读依赖图。`dependencies` 属性应用于访问 Recipe 的依赖项，因为此属性旨在传递给其他 Conan API，并用于高级用法，例如 SBOM 生成。

conf ¶

在 `self.conf` 属性中，我们可以找到 profiles 的 [conf] 部分中声明的所有 conf 条目，以及来自第一级工具依赖项的已声明 self.conf_info 条目。配置文件条目具有优先级。

注意

from conan import ConanFile

class MyConsumer(ConanFile):

  tool_requires = "my_android_ndk/1.0"

  def generate(self):
      # This is declared in the tool_requires
      self.output.info("NDK host: %s" % self.conf.get("tools.android:ndk_path"))
      # This is declared in the profile at [conf] section
      self.output.info("Custom var1: %s" % self.conf.get("user.custom.var1"))

conf 属性是一个只读属性。它只能在配置文件和命令行中定义，但绝不应由 recipes 设置。Recipes 只能通过 self.conf.get() 方法读取其值。

输出 ¶

输出内容 ¶

使用 `self.output` 将内容打印到输出。

还提供其他输出方法，您可以使用不同颜色生成不同的输出。有关可用输出方法的列表，请参阅输出文档。

self.output.success("This is good, should be green")
self.output.info("This is neutral, should be white")
self.output.warning("This is a warning, should be yellow")
self.output.error("Error, should be red")

revision_mode ¶

此属性允许每个 Recipe 声明如何计算 Recipe 本身的修订版本。它可以取三个不同的值：

"hash"（默认）：Conan 将使用 Recipe 清单的校验和哈希值来计算 Recipe 的修订版本。

"scm": 如果项目在 Git 仓库内，则将使用提交 ID 作为 Recipe 修订版本。如果没有仓库，它将引发错误。
"scm_folder": 此配置适用于您拥有单仓库项目但仍希望使用 scm 修订版本的情况。在这种情况下，导出的 conanfile.py 的修订版本将对应其所在文件夹的提交 ID。这种方法允许在同一个 Git 仓库中存在多个 conanfile.py 文件，每个文件都以其独特的修订版本导出。
当选择 scm 或 scm_folder 时，将使用 Git 提交，但默认情况下仓库必须是干净的，否则很可能存在未提交的更改，并且构建将无法重现。因此，如果存在脏文件，Conan 将引发错误。如果仓库中存在可以脏但完全不属于 Recipe 或包的文件，则可以使用 core.scm:excluded 配置将其从检查中排除，这是一个要排除的模式列表 (fnmatch)。

upload_policy ¶

控制当前包的构建二进制文件是否上传。

控制当前包构建的二进制文件是否上传。

"skip"：预编译的二进制文件不上传。这对于“安装程序”包非常有用，这些包只是下载并解压一些大型文件（例如android-ndk），并且与build_policy = "missing"一起使用时非常有用。
class Pkg(ConanFile): upload_policy = "skip"

required_conan_version ¶

配方（Recipes）可以定义模块级别的required_conan_version，它定义了可以加载和理解当前conanfile.py的有效Conan版本范围。语法如下：

from conan import ConanFile

required_conan_version = ">=2.0"

class Pkg(ConanFile):
    pass

允许使用requires中的版本范围。此外，在global.conf文件中有一个core:required_conan_version配置，可以定义运行Conan的全局最小、最大或精确版本，这对于维护开发团队和CI机器使用所需版本范围非常方便。

implements ¶

使用列表来定义一系列Conan将自动处理的选项配置。这对于避免在大多数配方中重复的样板代码特别方便。语法如下：

from conan import ConanFile

class Pkg(ConanFile):
    implements = ["auto_shared_fpic", "auto_header_only", ...]

目前，Conan提供了以下自动实现：

"auto_shared_fpic"：自动管理fPIC和shared选项。添加此实现将影响configure和config_options步骤，当这些方法未在配方中明确定义时。
"auto_header_only"：自动管理包ID清除设置。添加此实现将影响package_id步骤，当该方法未在配方中明确定义时。

警告

这是2.0版本专属功能，在1.X版本中不起作用。

alias ¶

警告

虽然别名在Conan 2中技术上仍可使用，但我们不推荐使用它们，并且它们可能在未来的版本中被完全移除。建议用户采用更新的版本控制功能，以获得更标准化和高效的包管理体验。

在Conan 2中，alias属性仍然是配方的一部分，允许用户为包版本定义别名。通常，您可以使用conan new命令配合alias模板创建别名，并通过conan export导出配方。

$ conan new alias -d name=mypkg -d version=latest -d target=1.0
$ conan export .

请注意，在要求别名时，您必须将版本放在括号()中，以明确声明将别名作为依赖项使用。

class Consumer(ConanFile):

    ...
    requires = "mypkg/(latest)"
    ...

extension_properties ¶

extensions_properties属性是一个字典，旨在定义和将信息从配方传递给Conan扩展。

目前，唯一定义的属性是compatibility_cppstd和compatibility_cstd，它们允许禁用默认的compatibility.py扩展的行为，该扩展认为使用不同compiler.cppstd和compiler.cstd值构建的二进制文件之间是ABI兼容的。要禁用当前包的此行为，可以使用：

class Pkg(ConanFile):
    extension_properties = {"compatibility_cppstd": False}

如果需要有条件地执行此操作，也可以在配方compatibility()方法中定义其值：

class Pkg(ConanFile):

    def compatibility(self):
        self.extension_properties = {"compatibility_cppstd": False}

conf 属性是一个只读属性。它只能在配置文件和命令行中定义，但绝不应由 recipes 设置。Recipes 只能通过 self.conf.get() 方法读取其值。

extension_properties的值默认不从依赖项传递给消费者，但可以通过迭代self.dependencies并检查其extension_properties的所需值来手动传播。

属性¶

folders 属性只能在 layout() 方法中设置。请查阅 layout() 方法文档 以了解有关此属性的更多信息。

存储包消费者所需所有信息的对象：包括目录、库名称、库路径等。适用于缓存中的可编辑包和常规包。它仅在 layout() 方法中可用。

layouts 属性只能在 layout() 方法中设置。请查阅 layout() 方法文档 以了解有关此属性的更多信息。

与在 layout() 方法中使用 self.cpp.package 相同。如果您需要读取 package_folder 来定位已定位的工件，请使用它。

对于依赖 Recipe，声明的环境变量将在构建过程中存在。应仅在 package_info() 方法中填充。

对于依赖 Recipe，声明的环境变量将在运行时存在。应仅在 package_info() 方法中填充。

要传递给依赖 Recipe 的配置变量。应仅在 package_info() 方法中填充。

要传递给依赖 Recipe 的生成器。应仅在 package_info() 方法中填充，默认为 None。

此属性声明 Recipe 已弃用，每当使用它时，都会发出一个用户友好的警告消息。

此属性声明 Recipe 提供与其他 Recipe 相同的功能。如果两个或多个库实现相同的 API，通常需要此属性来防止链接时和运行时冲突（ODR 违规）。一种典型情况是分叉库。例如：

Conan Recipe 通过 self.dependencies 属性提供对其依赖项的访问。

（实验性）Recipe 的只读依赖图。dependencies 属性应用于访问 Recipe 的依赖项，因为此属性旨在传递给其他 Conan API，并用于高级用法，例如 SBOM 生成。

在 self.conf 属性中，我们可以找到 profiles 的 [conf] 部分中声明的所有 conf 条目，以及来自第一级工具依赖项的已声明 self.conf_info 条目。配置文件条目具有优先级。

使用 self.output 将内容打印到输出。

此属性允许每个 Recipe 声明如何计算 Recipe 本身的修订版本。它可以取三个不同的值：

控制当前包的构建二进制文件是否上传。

`folders` 属性只能在 `layout()` 方法中设置。请查阅 layout() 方法文档以了解有关此属性的更多信息。

存储包消费者所需所有信息的对象：包括目录、库名称、库路径等。适用于缓存中的可编辑包和常规包。它仅在 `layout()` 方法中可用。

`layouts` 属性只能在 `layout()` 方法中设置。请查阅 layout() 方法文档以了解有关此属性的更多信息。

与在 `layout()` 方法中使用 `self.cpp.package` 相同。如果您需要读取 `package_folder` 来定位已定位的工件，请使用它。

对于依赖 Recipe，声明的环境变量将在构建过程中存在。应仅在 `package_info()` 方法中填充。

对于依赖 Recipe，声明的环境变量将在运行时存在。应仅在 `package_info()` 方法中填充。

要传递给依赖 Recipe 的配置变量。应仅在 `package_info()` 方法中填充。

要传递给依赖 Recipe 的生成器。应仅在 `package_info()` 方法中填充，默认为 `None`。

Conan Recipe 通过 `self.dependencies` 属性提供对其依赖项的访问。

（实验性）Recipe 的只读依赖图。`dependencies` 属性应用于访问 Recipe 的依赖项，因为此属性旨在传递给其他 Conan API，并用于高级用法，例如 SBOM 生成。

在 `self.conf` 属性中，我们可以找到 profiles 的 [conf] 部分中声明的所有 conf 条目，以及来自第一级工具依赖项的已声明 self.conf_info 条目。配置文件条目具有优先级。

使用 `self.output` 将内容打印到输出。