依赖于相同版本的 tool-require 但带有不同选项

注意

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

在一般情况下，尝试执行如下操作

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 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。注意，二进制文件本身名为 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 的两个不同的 tool-requires，一个带有 myoption=1，另一个带有 myoption=2。

当然，说我们不会从这些 tool_requires 中运行任何东西是不真实的，但现在 Conan 意识不到这一点，完全由用户自己负责管理。

警告

使用 run=False 会使 tool_requires() 完全不可见，这意味着配置文件中的 [tool_requires] 将无法覆盖其版本，但它会创建一个带有从配置文件注入的版本的额外 tool-require 依赖。您可能需要排除特定的包，例如使用 !wine/*: gcc/3.0。

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

最后，最重要的一点是，这些工具的使用完全由用户自己负责。包含可执行文件的两个 tool_requires 的 bin 文件夹将通过 VirtualBuildEnv 生成器（默认更新 PATH 环境变量）添加到 PATH 中。在这种情况下，可执行文件是不同的，如 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!!