根据同一工具要求的不同版本

注意

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

在一般情况下,尝试执行类似以下操作

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

将生成“冲突”,显示诸如 Duplicated requirement 之类的错误。在大多数情况下这是正确的,因为很明显不可能使用同一编译器的两个版本来构建当前包。

然而,在某些特殊情况下,可能需要类似的操作。让我们重现潜在的场景。请先克隆源代码以重现此项目。您可以在 GitHub 上的 examples2 仓库中找到它们。

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

那里有一个 gcc 伪食谱,其中包含

class Pkg(ConanFile):
    name = "gcc"

    def package(self):
        echo = f"@echo off\necho MYGCC={self.version}!!"
        save(self, os.path.join(self.package_folder, "bin", f"mygcc{self.version}.bat"), echo)
        save(self, os.path.join(self.package_folder, "bin", f"mygcc{self.version}.sh"), echo)
        os.chmod(os.path.join(self.package_folder, "bin", f"mygcc{self.version}.sh"), 0o777)

这不是实际的编译器,它用一个 shell 或 bat 脚本伪造它,该脚本在执行时打印 MYGCC=current-version。请注意,二进制文件本身称为 mygcc1.0mygcc2.0,也就是说,它的可执行文件名称本身包含版本。

我们可以为 gcc/1.0gcc/2.0 创建两个不同版本,方法是

$ conan create gcc --version=1.0
$ conan create gcc --version=2.0

现在,在 wine 文件夹中有一个 conanfile.py,如下所示

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

    def build_requirements(self):
        # If we specify "run=False" they no longer conflict
        self.tool_requires("gcc/1.0", run=False)
        self.tool_requires("gcc/2.0", run=False)

    def generate(self):
        # It is possible to individually reference each one
        gcc1 = self.dependencies.build["gcc/1.0"]
        assert gcc1.ref.version == "1.0"
        gcc2 = self.dependencies.build["gcc/2.0"]
        assert gcc2.ref.version == "2.0"

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

第一个重要的点是 build_requirements() 方法,它对两个版本都执行 tool_requires(),但定义了 run=False这非常重要:我们告诉 Conan,我们实际上不需要从这些包中运行任何东西。由于 tool_requires 不可见,它们不定义头文件或库,因此没有什么可以让 Conan 将这两个 tool_requires 识别为冲突。因此,依赖图可以无错误地构建,并且 wine/1.0 包将包含两个不同的工具要求(tool-requires),分别指向 gcc/1.0gcc/2.0

当然,我们不会从这些 tool_requires 中运行任何东西,但现在 Conan 没有意识到这一点,并且完全由用户负责管理。

警告

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

该食谱仍然可以在 generate() 方法中访问每个不同的 tool_require 版本,只需提供完整引用,如 self.dependencies.build["gcc/1.0"]

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

但是如果可执行文件完全相同,例如 gcc.exe,那么就需要使用类似 self.dependencies.build["gcc/1.0"].cpp_info.bindir 的方法获取完整文件夹(通常在 generate() 方法中),并使用完整路径来消除歧义。

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

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

wine/1.0: RUN: mygcc2.0.bat
MYGCC=2.0!!