依赖于具有不同选项的同一 tool-require 版本

注意

这是一个高级用例。在绝大多数情况下,它不应该是必要的。

在一般情况下,尝试做这样的事情

def build_requirements(self):
    self.tool_requires("gcc/1.0")
    self.tool_requires("gcc/1.0")

将生成“冲突”,显示类似 Duplicated requirement 的错误。

然而,在某些特殊情况下,我们可能需要依赖于同一 tool_requires 版本,但使用该 tool_requires 的不同二进制文件。这可以通过将不同的 options 传递给这些 tool_requires 来实现。请先克隆源代码以重新创建此项目。您可以在 GitHub 上的 examples2 仓库中找到它们

git clone https://github.com/conan-io/examples2.git
cd examples2/examples/graph/tool_requires/different_options

在那里我们有一个带有 gcc 的伪造 recipe

class Pkg(ConanFile):
    name = "gcc"
    version = "1.0"
    options = {"myoption": [1, 2]}

    def package(self):
        # This fake compiler will print something different based on the option
        echo = f"@echo off\necho MYGCC={self.options.myoption}!!"
        save(self, os.path.join(self.package_folder, "bin", f"mygcc{self.options.myoption}.bat"), echo)
        save(self, os.path.join(self.package_folder, "bin", f"mygcc{self.options.myoption}.sh"), echo)
        os.chmod(os.path.join(self.package_folder, "bin", f"mygcc{self.options.myoption}.sh"), 0o777)

这不是一个真正的编译器,它使用 shell 或 bat 脚本来伪造它,当执行时,该脚本会打印 MYGCC=current-option。请注意,二进制文件本身被称为 mygcc1mygcc2,也就是说,它在可执行文件名本身中包含选项。

我们可以为 gcc/1.0 创建 2 个不同的二进制文件,使用

$ conan create gcc -o myoption=1
$ conan create gcc -o myoption=2

现在,在 wine 文件夹中,有一个像这样的 conanfile.py

class Pkg(ConanFile):
    name = "wine"
    version = "1.0"

    def build_requirements(self):
        self.tool_requires("gcc/1.0", run=False, options={"myoption": 1})
        self.tool_requires("gcc/1.0", run=False, options={"myoption": 2})

    def generate(self):
        gcc1 = self.dependencies.build.get("gcc", options={"myoption": 1})
        assert gcc1.options.myoption == "1"
        gcc2 = self.dependencies.build.get("gcc", options={"myoption": 2})
        assert gcc2.options.myoption == "2"

    def build(self):
        ext = "bat" if platform.system() == "Windows" else "sh"
        self.run(f"mygcc1.{ext}")
        self.run(f"mygcc2.{ext}")

第一个重点是 build_requirements() 方法,它对两个二进制文件都执行 tool_requires(),但定义了 run=Falseoptions={"myoption": value} 特性。这非常重要:我们告诉 Conan,我们实际上不需要从这些软件包中运行任何东西。由于 tool_requires 是不可见的,它们不定义头文件或库,并且它们定义了不同的 options,因此没有任何东西能使 Conan 将这两个 tool_requires 识别为冲突。因此,可以构建依赖关系图而不会出错,并且 wine/1.0 软件包将包含对 gcc/1.0 的两个不同的 tool-requires,分别带有 myoption=1myoption=2

当然,说我们不会从这些 tool_requires 中运行任何东西是不真实的,但现在 Conan 并不知道这一点,并且完全由用户负责管理它。

警告

使用 run=False 会使 tool_requires() 完全不可见,这意味着 profile [tool_requires] 将无法覆盖其版本,但它会创建一个额外的 tool-require 依赖项,其版本是从 profile 注入的。您可能希望使用类似 !wine/*: gcc/3.0 的内容排除特定软件包。

recipe 仍然可以在 generate() 方法中访问每个不同的 tool_require 版本,只需为我们想要的依赖项提供选项值 self.dependencies.build.get("gcc", options={"myoption": 1}) 即可。

最后,最重要的是,这些工具的使用完全由用户负责。包含可执行文件的两个 tool_requiresbin 文件夹将位于路径中,这要归功于默认更新 PATH 环境变量的 VirtualBuildEnv 生成器。在这种情况下,可执行文件是不同的,例如 mygcc1.sh```和 ``mygcc2.sh,所以这不是问题,并且每个都将在其软件包中找到。

但是,如果可执行文件完全相同,例如 gcc.exe,那么就有必要使用类似 self.dependencies.build.get("gcc", options={"myoption": 1}).cpp_info.bindir 的东西来获取完整文件夹(通常在 generate() 方法中),并使用完整路径来消除歧义。

让我们看看它是如何工作的。如果我们执行

$ conan create wine
...
wine/1.0: RUN: mygcc1.bat
MYGCC=1!!

wine/1.0: RUN: mygcc2.bat
MYGCC=2!!