依赖于同一个工具依赖的不同版本¶
注意
这是一个高级用例。在绝大多数情况下,它是不必要的。
通常情况下,尝试这样做
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
recipe
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.0
和 mygcc2.0
,也就是说,可执行文件名本身就包含了版本信息。
我们可以为 gcc/1.0
和 gcc/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
包将包含两个指向 gcc/1.0
和 gcc/2.0
的不同工具依赖。
当然,我们不会运行这些 tool_requires
中的任何东西并不是真的,但现在 Conan 并不知道这一点,完全由用户负责管理它。
警告
使用 run=False
会使 tool_requires()
完全不可见,这意味着 profile 的 [tool_requires]
将无法覆盖其版本,但会创建一个带有 profile 注入版本的额外工具依赖。你可能希望使用 !wine/*: gcc/3.0
之类的配置来排除特定包。
recipe 在 generate()
方法中仍然可以访问每个不同的 tool_require
版本,只需提供完整的引用,例如 self.dependencies.build["gcc/1.0"]
。
最后,最重要的部分是,这些工具的使用完全由用户负责。包含可执行文件的两个 tool_requires
的 bin
文件夹将因为默认更新 PATH 环境变量的 VirtualBuildEnv
生成器而位于 PATH 中。在这种情况下,可执行文件是不同的,例如 mygcc1.0.sh
和 mygcc2.0.sh
,所以这不是问题,并且每个文件都会在其自己的包中被找到。
但是如果可执行文件完全相同,例如 gcc.exe
,那么就有必要获取完整的文件夹路径(通常在 generate()
方法中),使用类似 self.dependencies.build["gcc/1.0"].cpp_info.bindir
的方式,并使用完整路径来消除歧义。
让我们看看它是如何工作的。如果我们执行
$ conan create wine
...
wine/1.0: RUN: mygcc1.0.bat
MYGCC=1.0!!
wine/1.0: RUN: mygcc2.0.bat
MYGCC=2.0!!