build_requirements()

The build_requirements() 方法在功能上等同于 requirements() 方法，它在 requirements() 方法之后执行。从理论上讲，这两种方法中的所有内容都可以放在 requirements() 方法的末尾。尽管如此，build_requirements() 仍然适合定义 tool_requires 和 test_requires 的专用位置。

def build_requirements(self):
   self.tool_requires("cmake/3.23.5")
   self.test_requires("gtest/1.13.0")

对于简单的情况，属性语法就足够了，例如 tool_requires = "cmake/3.23.5" 和 test_requires = "gtest/1.13.0"。当需要条件或参数化需求时，可以使用方法形式。

The tool_requires 和 test_requires 方法只是具有一些预定义特征值的 requires 的特例。有关特征的更多信息，请参阅 requires() 参考。

有两个 实验性 confs 可用于避免这些类型需求的扩展

  • tools.graph:skip_build 允许完全跳过 tool_requires 依赖项。如果满足两个条件，则可以执行此操作：需要这些工具的包不需要从源代码构建，并且工具需求不会影响消费者的 package_id。如果发生这种情况，Conan 将引发错误。

  • tools.graph:skip_test 允许完全跳过 test_requires 依赖项。如果跳过这些依赖项，但随后需要从源代码构建某个包，并且未激活 tools.build:skip_test，则将无法找到 test_requires。因此，在大多数情况下，也应定义 tools.build:skip_test。

请注意，如果跳过工具和/或测试需求，它们将不会成为依赖关系图的一部分，也不会成为可能生成的 lockfile 或包列表的一部分，这可能会对未来的可重现性产生影响。此外，在大多数情况下，Conan 能够将工具和测试需求标记为不必要的 (Skip)，从而避免下载大型二进制文件，而只需下载通常非常快的配方。这意味着在大多数情况下，这些 confs 不是必需的，Conan 的默认设置很好，请在使用它们时了解权衡。

tool_requires()

The tool_requires 等同于具有以下特征的 requires()

  • build=True。此依赖项位于“构建”上下文中，在构建时是必需的，但在应用程序运行时不是必需的，并且将接收“构建”配置文件和配置。

  • visible=False。对工具需求的依赖项不会向下游传播。例如，一个包可以调用 tool_requires("cmake/3.23.5")，但这并不意味着消费包也使用 cmake，它们甚至可以使用不同的构建系统或不同版本，而不会造成冲突。

  • run=True。此依赖项具有需要在构建时运行的一些可执行文件或运行时。

  • headers=False 工具需求没有头文件。

  • libs=False：工具需求没有要由消费者链接的库（如果它有库，它们将位于“构建”上下文中，并且可能与消费包的“主机”上下文不兼容）。

请记住，tool_requires 仅用于依赖于 cmake 或 ninja 等工具，这些工具在“构建”上下文中运行，而不用于将被链接到二进制文件的库依赖项。对于库或类似库的依赖项，请使用 requires 或 test_requires。

<host_version>

警告

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

当您将相同的包配方用作 *requires* 和 *tool_requires*，并且希望避免如果任何用户决定覆盖 *host* 上下文中的原始 *requires* 版本而发生冲突时，此语法很有用，即用户最终可能在同一依赖项的 host 和 build 上下文中拥有两个不同的版本。

简而言之，<host_version> 规范器允许我们确保为 *tool_requires* 解析的版本始终与 host 需求的版本匹配。

例如，让我们展示一个使用 *protobuf* 的简单配方

from conan import ConanFile

class mylibRecipe(ConanFile):
    name = "mylib"
    version = "0.1"
    def requirements(self):
        self.requires("protobuf/3.18.1")
    def build_requirements(self):
        self.tool_requires("protobuf/<host_version>")

然后，如果任何用户想要使用 *mylib/0.1*，但使用另一个版本的 *protobuf*，则不应该有任何问题来覆盖它

from conan import ConanFile

class myappRecipe(ConanFile):
    name = "myapp"
    version = "0.1"
    def requirements(self):
        self.requires("mylib/0.1")
        self.requires("protobuf/3.21.9", override=True)

上游定义的 <host_version> 确保 host 和 build 上下文使用该需求的相同版本。

此外，可以使用语法 <host_version:mylib> 来指定要跟踪的包的名称，如果 *requires* 和 *tool_requires* 具有不同的名称。例如

from conan import ConanFile

class mylibRecipe(ConanFile):
    name = "mylib"
    version = "0.1"
    def requirements(self):
        self.requires("gettext/2.31")
    def build_requirements(self):
        self.tool_requires("libgettext/<host_version:gettext>")

另请参阅

test_requires

The test_requires 等同于具有以下特征的 requires()

  • test=True。此依赖项是“测试”依赖项，存在于“host”上下文中，但并非旨在成为最终产品的一部分。

  • visible=False。对测试需求的依赖项不会向下游传播。例如，一个包可以调用 self.test_requires("gtest/1.13.0")，但这并不意味着消费包也使用 gtest，它们甚至可以使用不同的测试框架，或使用不同版本的相同的 gtest，而不会造成冲突。

警告

由于 test_requires 定义了 visible=False 特征，因此必须小心避免在正常需求与在 test_requires 中使用的相同包之间存在传递依赖关系。这是因为具有直接 visible=False 需求可能会在传递依赖项具有对当前配方作为测试依赖项要求的相同包的 visible=True 需求时产生冲突。在不同的可见性规则到达同一包的情况下，可见的传递依赖项将被使用并向下游传播。

如果需要，可以进一步修改 tool_requires() 和 test_requires() 的各个特征，例如

def build_requirements(self):
   self.tool_requires("cmake/3.23.5", options={"shared": False})

The test_requires() 允许使用 force=True 特征，以防存在具有冲突版本的传递测试需求，同样 tool_requires() 支持 override=True 特征，用于覆盖直接工具需求的可能的传递依赖项。

注意

最佳实践

  • tool_requires 仅用于构建时 工具，不用于将被包含和链接到消费者包中的库。对于具有一些特殊特征的库，请使用具有自定义特征值的 requires()。

  • The self.test_requires() 和 self.tool_requires() 方法应仅在 build_requirements() 方法中使用，唯一的例外是 requirements() 方法。在任何其他方法中使用它们是被禁止的。在某些方法中需要访问有关依赖项的信息时，应使用 self.dependencies 属性。

另请参阅