requirements()¶

The requirements() 方法用于指定包的依赖关系。

def requirements(self):
    self.requires("zlib/1.3.1")

对于简单的情况，可以使用属性语法，例如 requires = "zlib/1.3.1"。

依赖项特性¶

特性是 requires 子句的属性。它们决定了依赖项的各个部分如何被 Conan 处理和传播。特性的值通常由 Conan 根据依赖项的 package_type 计算得出，但也可以手动指定。

在 Advanced Dependencies Model in Conan 2.0 演示中对特性进行了很好的介绍。

在下面的示例中，headers 和 libs 是特性。

self.requires("math/1.0", headers=True, libs=True)

headers¶

表示在编译时将从该包中 #include 头文件。依赖项将处于 host 上下文中。

libs¶

该依赖项包含一些库或构件，将在消费者的链接时使用。对于直接的共享库和静态库，此特性通常为 True，但对于通过共享库使用的间接静态库，则可能为 False。依赖项将处于 host 上下文中。

build¶

此依赖项是一个构建工具、应用程序或可执行文件，例如 cmake，它仅在构建时使用。它不会被链接/嵌入到二进制文件中，并且将处于 build 上下文中。

警告

定义了 build=True 的构建时依赖项（tool_requires、build_requires）旨在与默认的 visible=False 一起使用，目前强烈建议将其保持为 visible=False。如果您认为可能有使用场景，最好先在 https://github.com/conan-io/conan/issues 上讨论并询问，而不是尝试启用 visible=True。

对于一些非常特殊的情况，对于同时定义了 build=True 和 visible=True 的构建/工具依赖项，存在 **实验性** 支持，但这仍是实验性的，并且在未来的 Conan 版本中可能会发生不兼容的更改。同时，它也已知且被设计为不传播所有特性，例如 headers/libs 将不会被传播，因为来自“build”上下文的头文件和库无法在 host 上下文中链接。

run¶

此依赖项包含一些可执行文件，可以是应用程序或共享库，它们需要可用才能执行（通常在 PATH 或其他系统环境变量中）。对于 build=False，此特性可以为 True，在这种情况下，包将包含一些可执行文件，这些可执行文件在安装时可以在 host 系统上运行，通常类似于最终用户应用程序。对于 build=True，此特性可以为 True，包将包含在 build 上下文中运行的可执行文件，通常在用于构建其他包时。

visible¶

此 require 将向下游传播，即使它不传播 headers、libs 或 run 特性。传播到下游的依赖项可能会导致版本冲突。通常情况下，此值为 True，因为在大多数情况下，在同一个依赖关系图中存在相同库的两个不同版本至少是复杂的，如果不是直接违反 ODR 或导致链接错误的话。在高级场景中，可以将其设置为 False，当我们想在构建期间使用同一包的不同版本时。

警告

当传递性依赖项对当前配方声明为 visible=False 的同一包具有 visible=True 的依赖关系时，visible 特性可能会产生冲突。在这些不同可见性规则到达同一包的情况下，将使用可见的传递性依赖项并向下游传播。

transitive_headers¶

如果为 True，则依赖项的头文件将向下游可见。有关此特性的更多信息，请参阅有关头文件传递性的教程。

transitive_libs¶

如果为 True，则链接依赖项所需的库将向下游可见。

test¶

此依赖项是一个测试库或框架，如 Catch2 或 gtest。它主要是一个需要包含和链接的库，但不会向下游传播。

package_id_mode¶

如果配方希望指定依赖项版本如何影响当前包的 package_id，可以在此处直接指定。

虽然也可以在 package_id() 方法中完成，但在 requires 中指定似乎更简单，并且可以避免一些歧义。

# We set the package_id_mode so it is part of the package_id
self.tool_requires("tool/1.1.1", package_id_mode="minor_mode")

这等效于

def package_id(self):
  self.info.requires["tool"].minor_mode()

force¶

此 requires 将强制其版本在依赖关系图中向上游传播，覆盖其他现有版本（包括传递性依赖项的版本），并解决潜在的现有冲突。下游消费者的 force 特性始终具有更高的优先级。

override¶

与 force 特性相同，但不会添加 direct 依赖项。如果没有要覆盖的传递性依赖项，则此 ``require`` 将被丢弃。此特性仅在定义 requires 时存在，但在图完全评估后，它不会作为实际的 requires 存在。

注意

最佳实践

不建议将 force 和 override 特性作为通用的版本控制解决方案来解决冲突，它们只是用于解决版本冲突的临时解决方法。应尽可能避免使用它们，并建议更新图中的版本或版本范围以避免冲突，而不是使用 override 和 force。
关键点是 override 特性不会从您的包创建直接依赖项，而 force 特性会。这意味着 override 特性仅在您想覆盖传递性依赖项的版本而又不添加直接依赖项时才有用。

direct¶

如果依赖项是直接依赖项（即，它已由当前配方显式声明），或者它是传递性依赖项。

options¶

可以为依赖项定义选项值作为特性。

self.requires("mydep/0.1", options={"dep_option": "value"})

警告

在配方中定义选项值没有严格的保证，请参阅关于依赖项选项值的 FAQ。定义选项值的推荐方法是在配置文件中。

no_skip¶

此特性是 Conan 2.16 中引入的 **实验性** 功能，可能会发生不兼容的更改。有关更多信息，请参阅 Conan 稳定性部分。

Conan 能够避免下载传递性依赖项的包二进制文件，当它们不需要时。例如，如果一个 package_type = "application" 的包（其中包含一个可执行文件）依赖于（requires）另一个 package_type = "static-library"（或普通库，但选项为 shared=False）的包，那么安装应用程序包的二进制文件不需要其静态库依赖项的二进制文件就能工作。然后 Conan 将“跳过”这些二进制文件的下载，节省下载和安装的时间和传输成本。这些二进制文件在 Conan 命令输出中被标记为“Skipped binaries”。

tools.graph:skip_binaries 配置可以更改默认行为，如果设置为 False，它将避免跳过二进制文件，这在某些场景下可能很有用。

no_skip=True 特性可以定义在依赖项中，例如

name = "mypkg"

def requirements(self):
  self.requires("mydep/0.1", no_skip=True)

这样，当 mypkg 的二进制文件需要时，将强制下载 mydep/0.1 的二进制文件。

注意

最佳实践

no_skip=True 的使用应该是例外的，对于非常有限和特殊的使用场景，默认的 Conan “跳过二进制文件”行为应该适用于绝大多数情况。通常，它本身没有意义，但如果与其他特性（如 visible=False）结合使用才有意义。除非绝对必要，否则请避免使用它，并且仅应在非常特定的配方中使用。如果在许多配方中使用，则很可能是滥用。

package_type 特性推断¶

一些特性会根据 package_type 的值自动推断，如果未被配方显式设置。

application: headers=False, libs=False, run=True

shared-library: run=True

static-library: run=False

header-library: headers=True, libs=False, run=False

build-scripts: headers=False, libs=False, run=True, visible=False

此外，根据依赖项的 package_type，还会推断出一些额外的特性。

header-library: transitive_headers=True, transitive_libs=True

每种 requires 的默认特性¶

每种 requires 除了上一节所述的特性外，还会默认设置一些额外的特性。它们是：

requires: build=False

build_requires: headers=False, libs=False, build=True, visible=False

tool_requires: headers=False, libs=False, build=True, run=True, visible=False

test_requires: headers=True, libs=True, build=False, visible=False, test=True