system_requirements()¶
system_requirements()
方法可用于调用系统包管理器来在系统级别安装包。一般来说,应尽量减少此用法,系统包并非模型化依赖项,但有时自动化安装某些 Conan 包所需的系统包会很方便。例如,当创建打包 opencv
库的配方时,我们可能会意识到它在 Linux 中需要 gtk
库,但可能不希望为此创建包,因为我们希望确保使用的是系统自带的。我们可以编写
from conan import ConanFile
from conan.tools.system.package_manager import Apt
class OpenCV(ConanFile):
name = "opencv"
version = "4.0"
def system_requirements(self):
apt = Apt(self)
apt.install(["libgtk-3-dev"], update=True, check=True)
有关不同系统包管理器的内置助手的完整参考,请阅读 tools.system.package_manager 文档。
收集系统要求¶
当 system_requirements()
使用一些内置的 package_manager
助手时,可以收集有关已安装或所需系统要求的信息。如果我们有以下 conanfile.py
from conan import ConanFile
from conan.tools.system.package_manager import Apt
class MyPkg(ConanFile):
settings = "arch"
def system_requirements(self):
apt = Apt(self)
apt.install(["pkg1", "pkg2"])
可以通过以下命令显示已安装的系统包(使用默认的 tools.system.package_manager:mode
,要求将被检查,但不安装):
# Assuming apt is the default or using explicitly
# -c tools.system.package_manager:tool=apt-get
$ conan install . --format=json
"graph": {
"nodes": [
{
"ref": "",
"id": 0,
"settings": {
"arch": "x86_64"
},
"system_requires": {
"apt-get": {
"install": [
"pkg1",
"pkg2"
],
"missing": []
}
},
即使不安装二进制包,也可以获得类似的结果,我们可以使用 report
或 report-installed
模式。report
模式显示 install
包,这些是需要安装的包,无论它们是否实际安装。 report
模式不检查系统是否存在这些包,因此甚至可以在其他操作系统上运行
$ conan graph info . -c tools.system.package_manager:mode=report --format=json
...
"system_requires": {
"apt-get": {
"install": [
"pkg1",
"pkg2"
]
}
}
另一方面,report-installed
模式将检查包是否已安装在系统中,但如果未找到,则不会失败或引发任何错误
$ conan graph info . -c tools.system.package_manager:mode=report-installed --format=json
...
"system_requires": {
"apt-get": {
"install": [
"pkg1",
"pkg2"
],
"missing": [
"pkg1",
"pkg2"
]
}
}
构建时系统要求¶
在某些情况下,一些系统要求可能仅在构建时才必要。对于这些情况,有 2 种可能性
将安装构建时系统要求的逻辑添加到不同的方法中,例如
build()
方法或generate()
方法。将构建时系统要求的安装和逻辑封装在其自己的包配方中,并使用该配方作为
tool_requires
。