依赖于具有不同选项的同一版本工具要求

注意

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

通常情况下，尝试这样做会

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

生成一个“冲突”，显示像 Duplicated requirement 这样的错误。

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

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

那里有一个假的 gcc 配方，其内容为

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。请注意，二进制文件本身名为 mygcc1 和 mygcc2，也就是说，它的可执行文件名中包含了选项。

我们可以为 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=False 和 options={"myoption": value} 特性。这非常重要：我们告诉 Conan 实际上我们不需要从这些包中运行任何东西。由于 tool_requires 是不可见的，它们不定义头文件或库，并且它们定义了不同的 options，因此没有任何东西能让 Conan 将这两个 tool_requires 识别为冲突。所以依赖图可以无错误地构建，并且 wine/1.0 包将包含对 gcc/1.0 的两个不同的工具要求，一个使用 myoption=1，另一个使用 myoption=2。

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

警告

使用 run=False 会使 tool_requires() 完全不可见，这意味着配置文件 [tool_requires] 将无法覆盖其版本，但它将创建一个带有从配置文件注入的版本而来的额外工具要求依赖项。您可能希望使用 !wine/*: gcc/3.0 之类的来排除特定包。

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

最后，最重要的一点是，这些工具的使用完全由用户负责。VirtualBuildEnv 生成器默认会更新 PATH 环境变量，因此包含可执行文件的两个 tool_requires 的 bin 文件夹将位于路径中。在这种情况下，可执行文件是不同的，如 mygcc1.sh 和 mygcc2.sh，因此这不是问题，每个都将在其包内找到。

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

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

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

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