属性¶

包引用 ¶

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

name ¶

包的名称。有效名称必须全部小写，且

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

仅在将食谱 export 到本地缓存时才需要名称（export、export-pkg: 和 create 命令），如果它们未在命令行中通过 --name=<pkgname> 定义。

version ¶

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

仅在将食谱 export 到本地缓存时才严格需要版本（export、export-pkg 和 create 命令），如果它们未在命令行中通过 --version=<pkgversion> 定义。

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

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

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

channel ¶

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

通道可以在命令行中通过 --channel=<mychannel> 指定。如果指定了通道，则还必须指定用户，因此包引用始终是完整的，例如 pkg/version@user/channel。

元数据 ¶

可选元数据，如许可证、描述、作者等。在大多数情况下并非必需，但有时会很有用。

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 本身。可以包含多个逗号分隔的许可证。它是一个文本字符串，因此可以包含任何文本，但强烈建议开源项目的食谱使用 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 ¶

正在打包的库的主页。

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

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 ¶

build_requires 在 Conan 2 中用于提供与 Conan 1.X 语法的兼容性，但其在 Conan 2 中不建议使用，并将在未来的 2.X 版本中弃用。请在您的 Conan 2 食谱中改用 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 ¶

此class属性定义了一个或多个类，这些类将在运行时作为食谱类的基类被注入。每个类的语法应为字符串，如 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模式，以使食谱正常工作：食谱将导入的其他 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"), ".")

另请参阅

检查 exports_sources() conanfile.py 方法.

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依赖。
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_build.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 ¶

字典，其中包含仅影响当前食谱的特性，键是选项名称，值是选项可以采用的不同值的列表。默认情况下，选项中的任何值更改都会更改 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"，结果为 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 定义了选项的默认值，包括当前食谱和任何依赖项。此属性应定义为 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"

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

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

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

info ¶

专门用于 package_id() 方法的对象

包的唯一 ID 的 :ref:package_id 方法<reference_conanfile_methods_package_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 是可以在食谱中定义的类属性，用于定义它们作为 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 配置。食谱中的属性定义对于定义与默认设置不同的行为很有用。

可能的值（遵循 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 之外的完整引用。
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）与 folders.source（如果在 layout() 方法中声明）的值构建。

请注意，在缓存中运行时，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）与 folders.build 的值（如果在 layout() 方法中声明）连接起来构建的。

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 ¶

存储食谱 *conanfile.py* 的文件夹，无论是在本地文件夹还是在缓存中。这对于访问与食谱一起导出的文件，或在 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() 方法，以保存或复制**食谱**元数据文件。有关更多信息，请参阅元数据部分。

package_metadata_folder ¶

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

no_copy_source ¶

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

如果您激活 no_copy_source=True，则**强制要求**源代码不得被配置或构建脚本修改，因为源代码将在所有构建之间共享。

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

另请参阅

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

test_package_folder ¶

test_package_folder 类属性允许在食谱中为 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 ¶

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 食谱，并且我们希望将该食谱置于“可编辑”模式，则有必要在创建包之前知道 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 ¶

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

重要

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

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

另请参阅

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

runenv_info ¶

对于依赖食谱，声明的环境变量将在运行时存在。应仅在 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 ¶

要传递给依赖食谱的配置变量。应仅在 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() 方法中填写，默认为 None。

另请参阅

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

deprecated ¶

此属性声明食谱已弃用，导致在使用时发出用户友好的警告消息

例如，以下代码

from conan import ConanFile

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

可能会发出 risk 警告，例如

Deprecated
    cpp-taskflow/1.0

WARN: risk: There are deprecated packages in the graph

（可选）该属性可以指定建议的替代名称

from conan import ConanFile

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

这将发出一个 risk 警告，例如

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

WARN: risk: There are deprecated packages in the graph

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

provides ¶

此属性声明食谱提供与另一个食谱相同的功能。如果两个或更多库实现相同的 API 以防止链接时和运行时冲突（ODR 违规），则通常需要此属性。一个典型情况是分叉库。一些示例如下：

如果 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 的完整参考。

subgraph ¶

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

conf ¶

在 self.conf 属性中，我们可以找到配置文件 [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() 方法读取其值。

输出 ¶

输出内容 ¶

使用 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版本中不起作用

别名 ¶

警告

虽然别名在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)"
    ...

扩展属性 ¶

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}

注意

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