conan.tools.system.package_manager

在 conan.tools.system.package_manager 下的工具是对一些最流行的跨平台系统包管理器的封装。您可以使用它们在配方中调用系统包管理器，并执行最典型的操作，例如安装包、更新包管理器数据库或检查包是否已安装。默认情况下，当您调用它们时，它们不会尝试在系统上安装任何东西，要更改此行为，您可以设置 tools.system.package_manager:mode 的 配置 值。

您可以在配方的 system_requirements() 方法中使用这些工具，例如

conanfile.py

from conan.tools.system.package_manager import Apt, Yum, PacMan, Zypper

def system_requirements(self):
    # depending on the platform or the tools.system.package_manager:tool configuration
    # only one of these will be executed
    Apt(self).install(["libgl-dev"])
    Yum(self).install(["libglvnd-devel"])
    PacMan(self).install(["libglvnd"])
    Zypper(self).install(["Mesa-libGL-devel"])

Conan 会通过查看操作系统名称自动选择要使用的包管理器。在上面的示例中，如果我们正在 Ubuntu Linux 上运行，Conan 将忽略所有调用，除了 Apt() 调用，并且只会尝试使用 apt-get 工具安装包。Conan 默认使用以下映射

• Apt 适用于发行版名称为 ubuntu, debian, raspbian 或 linuxmint 的 Linux

• Yum 适用于发行版名称为 pidora, scientific, xenserver, amazon, oracle, amzn, almalinux 或 rocky 的 Linux

• Dnf 适用于发行版名称为 fedora, rhel, centos, mageia 的 Linux

• Apk 适用于发行版名称为 alpine 的 Linux

• Brew 适用于 macOS

• PacMan 适用于发行版名称为 arch, manjaro 的 Linux，以及在使用 msys2 的 Windows

• Chocolatey 适用于 Windows

• Zypper 适用于发行版名称为 opensuse, sles 的 Linux

• Pkg 适用于 FreeBSD

• PkgUtil 适用于 Solaris

您可以通过默认设置配置属性 tools.system.package_manager:tool 来覆盖此默认映射并设置您想要使用的包管理器工具。

系统包管理器工具可用的方法

所有这些封装都共享三个方法，代表了系统包管理器最常见的操作。除了 Apt 之外，所有包管理器的方法形式都相同，Apt 还接受 install 方法 的 recommends 参数。

• install(self, packages, update=False, check=True, host_package=True): 尝试安装作为参数传递的包列表。如果参数 check 为 True，它将在安装之前检查这些包是否已安装。如果参数 update 为 True，它将在检查和安装之前尝试更新包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。如果参数 host_package 为 True，它将为宿主机架构（运行软件的机器）安装包，这在交叉构建时会产生影响。此方法将返回执行命令的返回码。

• install_substitutes(packages_substitutes, update=False, check=True): 尝试安装作为参数传递的替代包列表之一，例如 install_substitutes(["pkg1", "pkg2"], ["pkg3"])。如果其中一个替代列表完全安装成功，则会成功，因此它适用于您有不同发行版的不同包的情况。在此示例中，它将首先尝试安装 pkg1 和 pkg2，如果两者都安装成功，它将停止。如果失败，它将继续下一个列表并尝试安装 pkg3。在内部，它调用了前面的 install(packages, update=update, check=check) 方法，因此 update 和 check 具有与上述相同的目的。

• update() 更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

• check(packages) 检查作为参数传递的包列表是否已安装。它将返回一个包含缺失包的列表。

影响系统包管理器调用方式的配置属性

如上所述，有几个 [conf] 影响这些工具的调用方式

• tools.system.package_manager:tool: 用于选择您要默认使用的包管理器工具："apk"、"apt-get"、"yum"、"dnf"、"brew"、"pacman"、"choco"、"zypper"、"pkg" 或 "pkgutil"

• tools.system.package_manager:mode: 调用包管理器工具时使用的模式。有两个可能的值

  • "check": 它最多只会检查缺失的包，并且在任何情况下都不会尝试更新包管理器数据库或安装任何包。如果系统上未安装所需的包，它将引发错误。这是默认值。

  • "report": 仅捕获 .install() 调用以捕获包，但不检查也不安装它们。从不引发错误。主要用于 conan graph info 命令。

  • "report-installed": 报告哪些包是必需的，但不会失败（与 report 相同），并检查其中哪些包实际已安装在当前系统中。

  • "install": 它将允许 Conan 执行更新或安装操作。

• tools.system.package_manager:sudo: 在 Linux 中调用包管理器工具时使用 sudo（默认为 False）

• tools.system.package_manager:sudo_askpass: 如果在 Linux 中使用 sudo 调用系统包管理器，则使用 -A 参数（默认为 False）

这些工具都有一些特定的参数。以下是完整的参考资料

conan.tools.system.package_manager.Apk

将调用 apk 命令。默认情况下，适用于发行版名称为 alpine 的 Linux。

参考

class Apk(conanfile, _arch_names=None)

构造函数方法。请注意，Apk 不支持架构名称，因为 Alpine Linux 不支持多架构。因此，arch_names 参数将被忽略。

参数:

conanfile – 当前的配方对象。始终使用 self。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

Alpine Linux 不支持在同一个仓库中存在多种架构，因此没有从 Conan 架构到 Alpine 架构的映射。

conan.tools.system.package_manager.Apt

将调用 apt-get 命令。默认情况下，适用于发行版名称为 ubuntu, debian, raspbian 和 linuxmint 的 Linux。

参考

class Apt(conanfile, arch_names=None)

参数:

• conanfile – 当前的配方对象。始终使用 self。

• arch_names – 此参数将 Conan 架构设置映射到包管理器工具的架构名称。它默认为 None，这意味着它将使用最常见架构的默认映射。例如，如果您正在使用 x86_64 Conan 架构设置，它会将此值映射为 Apt 的 amd64，并尝试安装 <package_name>:amd64 包。

install(packages, update=False, check=True, recommends=False, host_package=True)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

• host_package – 为宿主机架构（运行软件的机器）安装包，这在交叉构建时会产生影响。

• recommends – 如果参数 recommends 为 False，它将把 '--no-install-recommends' 参数添加到 apt-get 命令调用中。

返回:

执行的 apt 命令的返回码。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

您可以传入 arch_names 参数来覆盖默认的 Conan 映射，例如

conanfile.py

...
def system_requirements(self):
    apt = Apt(self, arch_names={"<conan_arch_setting>": "apt_arch_setting"})
    apt.install(["libgl-dev"])

Conan 用于 APT 包架构的默认映射是

self._arch_names = {"x86_64": "amd64",
                    "x86": "i386",
                    "ppc32": "powerpc",
                    "ppc64le": "ppc64el",
                    "armv7": "arm",
                    "armv7hf": "armhf",
                    "armv8": "arm64",
                    "s390x": "s390x"} if arch_names is None else arch_names

conan.tools.system.package_manager.Yum

将调用 yum 命令。默认情况下，适用于发行版名称为 pidora, scientific, xenserver, amazon, oracle, amzn 和 almalinux 的 Linux。

参考

class Yum(conanfile, arch_names=None)

参数:

• conanfile – 当前的配方对象。始终使用 self。

• arch_names – 此参数将 Conan 架构设置映射到包管理器工具的架构名称。它默认为 None，这意味着它将使用最常见架构的默认映射。例如，如果您正在使用 x86 Conan 架构设置，它会将此值映射为 Yum 的 i?86，并尝试安装 <package_name>.i?86 包。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

Conan 用于 Yum 包架构的默认映射是

self._arch_names = {"x86_64": "x86_64",
                    "x86": "i?86",
                    "ppc32": "powerpc",
                    "ppc64le": "ppc64le",
                    "armv7": "armv7",
                    "armv7hf": "armv7hl",
                    "armv8": "aarch64",
                    "s390x": "s390x"} if arch_names is None else arch_names

conan.tools.system.package_manager.Dnf

将调用 dnf 命令。默认情况下，适用于发行版名称为 fedora, rhel, centos 和 mageia 的 Linux。此工具具有与 Yum 工具完全相同的默认值、构造函数和方法。

conan.tools.system.package_manager.PacMan

将调用 pacman 命令。默认情况下，适用于发行版名称为 arch, manjaro 的 Linux，以及在使用 msys2 的 Windows

参考

class PacMan(conanfile, arch_names=None)

参数:

• conanfile – 当前的配方对象。始终使用 self。

• arch_names – 此参数将 Conan 架构设置映射到包管理器工具的架构名称。它默认为 None，这意味着它将使用最常见架构的默认映射。如果您正在使用 x86 Conan 架构设置，它会将此值映射为 PacMan 的 lib32，并尝试安装 <package_name>-lib32 包。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

Conan 用于 PacMan 包架构的默认映射是

self._arch_names = {"x86": "lib32"} if arch_names is None else arch_names

conan.tools.system.package_manager.Zypper

将调用 zypper 命令。默认情况下，适用于发行版名称为 opensuse, sles 的 Linux。

参考

class Zypper(conanfile)

参数:

conanfile – 当前的配方对象。始终使用 self。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

conan.tools.system.package_manager.Brew

将调用 brew 命令。默认情况下，适用于 macOS。

参考

class Brew(conanfile)

参数:

conanfile – 当前的配方对象。始终使用 self。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

conan.tools.system.package_manager.Pkg

将调用 pkg 命令。默认情况下，适用于发行版名称为 freebsd 的 Linux。

参考

class Pkg(conanfile)

参数:

conanfile – 当前的配方对象。始终使用 self。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

conan.tools.system.package_manager.PkgUtil

将调用 pkgutil 命令。默认情况下，适用于 Solaris。

参考

class PkgUtil(conanfile)

参数:

conanfile – 当前的配方对象。始终使用 self。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。

conan.tools.system.package_manager.Chocolatey

将调用 choco 命令。默认情况下，适用于 Windows。

参考

class Chocolatey(conanfile)

参数:

conanfile – 当前的配方对象。始终使用 self。

check(*args, **kwargs)

检查作为参数传递的包列表是否已安装。

参数:

packages – 要检查的包列表。

返回:

从 packages 参数中获取的、未安装在系统中的包列表。

install(*args, **kwargs)

将尝试安装作为参数传递的包列表。其行为受 tools.system.package_manager:mode 配置 值的影响。

参数:

• packages – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

install_substitutes(*args, **kwargs)

将尝试调用 install() 方法，传入多个包列表作为可变数量的参数。这在例如包名称在不同发行版或发行版版本之间有所不同时非常有用。例如，Apt 的 libxcb 在 Ubuntu >= 15.0 中名为 libxcb-util-dev，在其他版本中名为 libxcb-util0-dev。您可以调用

# will install the first list of packages that succeeds in the installation
Apt.install_substitutes(["libxcb-util-dev"], ["libxcb-util0-dev"])

参数:

• packages_alternatives – 尝试安装作为参数传递的包列表。

• update – 在检查和安装之前尝试更新包管理器数据库。

• check – 在安装包之前检查它们是否已安装。

返回:

执行的包管理器命令的返回码。

update(*args, **kwargs)

更新系统包管理器数据库。其行为受 tools.system.package_manager:mode 配置 值的影响。

返回:

执行的包管理器更新命令的返回码。