属性

包引用

可以定义主 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 可以在命令行中动态定义，也可以使用 set_version() 方法 在 recipe 中以编程方式定义。

user

user 字段的有效字符串遵循与 name 属性相同的规则。这是一个可选属性。它可用于通过 pkg/version@user/channel 标识您自己的包，其中 user 可以是您的团队、组织或公司的名称。ConanCenter recipe 没有 user/channel，因此它们仅采用 pkg/version 的形式。您也可以命名您的包，而不使用用户和通道，或仅使用用户，如 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 本身。可以包含多个以逗号分隔的许可证。它是一个文本字符串，因此可以包含任何文本，但强烈建议开源项目的 recipe 使用来自 SPDX 的标识符，该标识符来自 SPDX 许可证列表。

这将有助于希望自动执行许可证兼容性检查的人员，例如您的包的消费者，或者如果您的包具有开源依赖项，则帮助您。

class Pkg(ConanFile):
    license = "MIT"

author

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

class HelloConan(ConanFile):
    author = "John J. Smith ([email protected])"

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 教程部分

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

build_requires 在 Conan 2 中用于提供与 Conan 1.X 语法的兼容性，但不鼓励在 Conan 2 中使用它们，并且在未来的 2.X 版本中将会被弃用。请在您的 Conan 2 recipe 中使用 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 配方的依赖关系并重用其代码。其基本语法是

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

此类属性定义一个或多个类，这些类将在运行时作为配方类的基类注入。这些类的语法应类似于 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

Sources

exports

带有 文件名 或 fnmatch 模式的字符串列表或元组，这些模式应与 *conanfile.py* 文件一起导出和存储，以使配方能够正常工作：配方将导入的其他 python 文件，一些包含要读取的数据的文本文件，等等。

例如，如果我们有一些希望配方在 helpers.py 文件中使用的 python 代码，并且有一些希望在配方评估期间读取和显示的文本文件 *info.txt*，我们将执行以下操作

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

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

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

另请参阅

• 请查看 export() conanfile.py 方法.

exports_sources

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

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

exports_sources = "include*", "src*"

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

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

请注意，如果配方定义了 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", "."))

conan_data

只读属性，带有一个字典，其中包含放置在 *conanfile.py* 旁边的 conandata.yml 文件格式中提供的键和值。此 YAML 文件会自动与配方一起导出，并自动加载到配方中。

您可以在 *conandata.yml* 文件中声明信息，然后在配方的任何方法中访问该信息。例如，具有类似于以下源代码信息的 *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 require。

• unknown：软件包的类型未知。

settings

字符串列表，其中包含配方需要的（来自 settings.yml 的）一级设置，因为：- 它们是为构建而读取的（例如：if self.settings.compiler == “gcc”）- 它们影响 package_id。如果声明的设置的值发生更改，则 package_id 必须不同。

最常见的是声明

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

一旦 Conan 加载了配方，就会处理 settings，并且可以在配方中读取它们，也可以读取子设置

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() 会以 Python 类似字典的对象形式返回整个 settings.yml，例如，执行 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")

另请参阅

• settings.yml.

• 在 package_id() 方法中删除设置.

• 使用 CMakeToolchain 创建通用二进制文件.

options

字典，包含仅影响当前配方的特征，其中键是选项名称，值是该选项可以采用的不同值列表。默认情况下，选项中的任何值更改都会更改 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 加载了配方，就会处理 options，并且可以在配方中读取它们。您还可以使用 .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"，equals 的结果均为 False，正如预期的那样。

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

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

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

另请参阅

• 阅读 入门指南，创建包 以了解如何声明选项以及如何为选项定义值。

• 在 package_id() 方法中删除选项。<缺失页面>

• 关于 package_type 以及声明 shared 选项时它的作用。<缺失页面>

default_options

default_options 属性定义了当前配方和任何依赖项的选项的默认值。此属性应定义为 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 或任何带有 * 的模式，如上面的示例所示。

警告

在配方中定义选项值没有很强的保证，请查看 关于依赖项选项值的常见问题解答。推荐的定义选项值的方式是在配置文件中。

您还可以使用 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() 方法.

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

• 当前配方的任何其他下游用户如果为 mypkg 定义了相同的选项，则将具有优先权，覆盖当前配方的 123 值。配置文件或命令行中的任何定义也将具有优先权。配方的 default_options 具有最低的优先级。如果配方在某些依赖项选项下根本无法工作，那么配方可以检查并相应地引发 ConanInvalidConfiguration 错误。

• 依赖于 mypkg 的任何同级包也将定义其选项，并且只有该选项会被考虑在内。换句话说，任何其他包第一次需要 mypkg 时，都会“冻结”其当前分配的选项值。任何其他稍后依赖于 mypkg 的包，都会关闭依赖关系图中的菱形结构，而不会对 mypkg 选项产生任何影响。只有第一个需要它的包才会产生影响。

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

警告

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

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

但有两种情况下仍然无法定义依赖项的最终值。

• 如果任何下游配方、命令行或配置文件也使用了 myoption! 语法，则该语法也将具有优先权并覆盖上游值。

• 如果还有其他包首先需要 mypkg，则此时定义的值仍将具有优先权。

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

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 配方属性 languages 来定义此包中涉及的编程语言。目前，可能的语言值是 C 和 C++。例如，纯 C 包会定义如下内容

class ZLib(ConanFile):
    languages = "C"

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

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

• 如果未定义 languages 或 C 不是声明的语言，则将在包的 configure() 时自动删除 compiler.cstd 子集（以实现向后兼容性）。

• 如果定义了 languages，但不包含 C++，则将在包的 configure() 时自动删除 compiler.cppstd 和 compiler.libcxx 子集。

info

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

• :ref:package_id 方法<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

package_id_embed_mode、package_id_non_embed_mode、package_id_python_mode、package_id_unknown_mode 是可以在配方中定义的类属性，用于定义它们对消费者的 package_id 的影响。可以声明为

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"

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

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

• patch_mode：软件包的新补丁、次要版本和主要版本将需要使用者的新二进制文件（新的 package_id）。新的配方修订版将不需要使用者的新二进制文件。例如，如果我们创建一个新的 pkg/1.0.1 版本，并且某个使用者具有 requires = "pkg/[>=1.0 <2.0]"，则该使用者将针对此特定的新 1.0.1 版本构建新的二进制文件。但是，如果我们只是更改配方，生成新的 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 之外的完整引用。

这 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。提供此属性是为了完整性和诸如临时迁移之类的特殊情况。

另请参阅

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

构建

生成器

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

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) 时：指向缓存中必须复制导出源的文件夹。

另请参阅

• 阅读关于 export_sources() 方法的内容。.

• 阅读关于 source() 方法的内容。.

build_folder

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

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() 方法中使用，用于保存或复制 package 元数据文件。有关详细信息，请参阅元数据部分。

no_copy_source

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

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

Recipe 应始终使用 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 属性只能在 layout() 方法中设置。请查看layout() 方法文档，了解有关此属性的更多信息。

layouts 属性包含有关环境变量和 conf 的信息，这些变量和 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() 方法中填写。

重要

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

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

另请参阅

请查看 Environment 对象的引用，了解如何填写 self.buildenv_info。

runenv_info

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

重要

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

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

另请参阅

请查看 Environment 对象的引用，了解如何填写 self.runenv_info。

conf_info

要传递给依赖 recipe 的配置变量。应仅在 package_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")

另请参阅

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

generator_info

警告

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

要传递给依赖配方的生成器。应该只在 package_info() 方法中填写。

另请参阅

请参阅此处的示例用法和self.generator_info 的完整参考。

deprecated

此属性声明该配方已弃用，每当使用它时都会发出用户友好的警告消息

例如，以下代码

from conan import ConanFile

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

可能会发出类似以下的警告

cpp-taskflow/1.0: WARN: Recipe 'cpp-taskflow/1.0' is deprecated. Please, consider changing your requirements.

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

from conan import ConanFile

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

这将发出类似以下的警告

cpp-taskflow/1.0: WARN: Recipe 'cpp-taskflow/1.0' is deprecated in favor of 'taskflow'. Please, consider changing your requirements.

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

provides

此属性声明配方提供的功能与其他配方相同。如果两个或多个库实现了相同的 API 以防止链接时和运行时冲突（ODR 违规），则通常需要此属性。一个典型的情况是派生的库。一些例子是

• LibreSSL, BoringSSL 和 OpenSSL

• libav 和 ffmpeg

• MariaDB 客户端 和 MySQL 客户端

如果 Conan 在单个图中遇到两个或多个提供相同功能的库，它会引发错误

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

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

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

from conan import ConanFile

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

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

from conan import ConanFile

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

如果省略该属性，则该属性的值被假定为等于当前包名称。因此，libjpeg 配方声明它提供 libjpeg 是多余的，Conan 已经隐式地假设了这一点。

其他

dependencies

Conan 配方通过 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

另请参阅

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

conf

在 self.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 属性是只读属性。它只能在配置文件和命令行中定义，但绝不能由配方设置。配方只能通过 self.conf.get() 方法读取其值。

Output

输出内容

使用 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

此属性允许每个配方声明应如何计算配方本身的修订。它可以采用三个不同的值

• "hash"（默认）：Conan 将使用配方清单的校验和哈希来计算配方的修订。

• "scm"：如果项目位于 Git 存储库中，则提交 ID 将用作配方修订。如果没有存储库，则会引发错误。

• "scm_folder"：当您有一个单存储库项目，但仍想使用 *scm* 修订时，此配置适用。在这种情况下，导出的 conanfile.py 的修订将与它所在的文件夹的提交 ID 相对应。此方法允许在同一 Git 存储库中存在多个 conanfile.py 文件，每个文件都以其不同的修订导出。

当选择 scm 或 scm_folder 时，将使用 Git 提交，但默认情况下，存储库必须是干净的，否则很可能会有未提交的更改，并且构建将无法重现。因此，如果有脏文件，Conan 将引发错误。如果存储库中有可能脏的文件，但这些文件根本不属于配方或包，则可以使用 core.scm:excluded 配置将其从检查中排除，该配置是要排除的模式（fnmatch）列表。

upload_policy

控制何时上传或不上传当前构建的包二进制文件

• "skip"：不上传预编译的二进制文件。这对于仅下载和解压缩一些重物（例如 android-ndk）的“安装程序”包很有用，并且与 build_policy = "missing" 一起使用很有用

  class Pkg(ConanFile):
      upload_policy = "skip"
  

required_conan_version

配方可以定义一个模块级 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 属性仍然是配方的一部分，允许用户为包版本定义别名。通常，您可以使用带有 alias 模板的 conan new 命令创建别名，并使用 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}

如果需要有条件地执行，也可以在 recipe 的 compatibility() 方法中定义它的值。

class Pkg(ConanFile):

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