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 工具安装包。

package_manager 工具允许您使用 <package-name>=<package-version> 格式指定要安装的系统包的版本，例如 Apt(self).install(["libgl-dev=0.0.1"])。支持版本的系统包管理器有 Apt、Yum、Dnf、Brew、Pkg、Chocolatey、Apk 和 Zypper。在不支持包版本的系统上，我们的例子中 PacMan 和 PkgUtil，提供的版本将被忽略。

Conan 默认使用以下映射

  • Apt 用于 Linux，其发行版名称为：ubuntu、debian、raspbian 或 linuxmint

  • Yum 用于 Linux，其发行版名称为：pidora、scientific、xenserver、amazon、oracle、amzn、almalinux 或 rocky

  • Dnf 用于 Linux，其发行版名称为：fedora、rhel、centos、mageia

  • Apk 用于 Linux，其发行版名称为：alpine

  • Brew 用于 macOS

  • PacMan 用于 Linux，其发行版名称为：arch、manjaro，以及在 Windows 上使用 msys2

  • Chocolatey 用于 Windows

  • Zypper 用于 Linux，其发行版名称为：opensuse、sles

  • 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：如果使用 sudo 在 Linux 中调用系统包管理器，则使用 -A 参数（默认值为 False）

这里是这些工具的完整参考

conan.tools.system.package_manager.Apk

将调用 apk 命令。默认情况下，为 Linux 启用，其发行版名称为：alpine。

参考

class Apk(conanfile, _arch_names=None)

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

参数:

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

check(*args, **kwargs)

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

参数:

packages – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 命令。默认情况下，为 Linux 启用，其发行版名称为：ubuntu、debian、raspbian 和 linuxmint。

参考

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，它将在 apt-get 命令调用中添加 '--no-install-recommends' 参数。

返回:

已执行 apt 命令的返回码。

check(*args, **kwargs)

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

参数:

packages – 要检查的包列表。

返回:

系统中未安装的包列表。

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 命令。默认情况下为具有以下发行版名称的 Linux 启用：pidora、scientific、xenserver、amazon、oracle、amzn 和 almalinux。

参考

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 – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 命令。默认情况下为具有以下发行版名称的 Linux 启用：fedora、rhel、centos 和 mageia。此工具具有与 Yum 工具完全相同的默认值、构造函数和方法。

conan.tools.system.package_manager.PacMan

将调用 pacman 命令。默认情况下为具有以下发行版名称的 Linux 启用：arch、manjaro，以及在 Windows 上使用 msys2 时启用。

参考

class PacMan(conanfile, arch_names=None)
参数:

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

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

check(*args, **kwargs)

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

参数:

packages – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 命令。默认情况下为具有以下发行版名称的 Linux 启用：opensuse、sles。

参考

class Zypper(conanfile)
参数:

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

check(*args, **kwargs)

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

参数:

packages – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 命令。默认情况下为具有以下发行版名称的 Linux 启用：freebsd。

参考

class Pkg(conanfile)
参数:

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

check(*args, **kwargs)

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

参数:

packages – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 – 要检查的包列表。

返回:

系统中未安装的包列表。

install(*args, **kwargs)

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

参数:

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

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

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

返回:

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

install_substitutes(*args, **kwargs)

将尝试使用作为变量数量的参数传递的多个包列表调用 install() 方法。如果例如，包的名称因发行版或发行版版本而异，这很有用。例如，libxcb 对于 Apt 在 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 配置 的影响。

返回:

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