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"
]
}
}
构建时系统需求¶
在某些情况下,某些系统需求可能仅在构建时需要。对于这些情况,有两种选择:
将安装构建时系统需求的逻辑添加到一个不同的方法中,例如
build()方法或generate()方法。将构建时系统要求的安装和逻辑包装在其自己的包配方中,并使用该配方作为
tool_requires。
在本节 中有关构建时系统需求的示例