meta_package_manager.managers.pmerge module

class meta_package_manager.managers.pmerge.Pmerge

Bases: PackageManager

pkgcore’s pmerge, an alternative package manager for Gentoo.

pkgcore reads the same ebuild repositories as Portage and records into the same database of installed packages. On a host that carries both, this manager and emerge list the same packages, and each one sees what the other installed.

The queries run through pquery, the inventory and search tool of pkgcore, and the maintenance through pmaint and pclean. All four ship together.

A fresh stage3 ships /var/cache/distfiles owned by root with mode 0755, and every pmerge fetch then fails with Permission denied. Give the directory to the portage user first: chown portage:portage /var/cache/distfiles.

Caution

Installs and upgrades compile from source, so their duration comes from the package rather than from the network. A small program finishes well inside the 500 second ceiling mpm puts on a state-changing command, where a compiler or a browser does not. Raise the ceiling for this manager alone, in the configuration file:

[mpm.overrides.pmerge]
timeout = 14400

Initialize cli_errors list.

name: str = 'pkgcore pmerge'

Return package manager’s common name.

Default value is based on class name.

documentation_url: str | None = 'https://pkgcore.github.io/pkgcore/man/pmerge.html'

Entry point of the project’s own documentation, or None when it has none.

The manual, the documentation site, or the man page of the CLI mpm drives: whichever page a user reads to learn the commands this manager wraps. Listed between homepage_url and repository_url in the links of the manager’s page, so a reader reaching for the tool’s reference finds it in the box of facts rather than in the prose below it.

Left unset where a link would state a fact twice or invent one: a tool documenting itself in its repository alone, whose README repository_url already reaches. A page about the ecosystem rather than the tool does not qualify either.

Where a project’s only site is its manual, that address belongs here and homepage_url stays unset: the slot names what the page is, and a reader reaching for the reference looks under the documentation link.

Never inherited, like every other link: the AUR helpers extending pacman each document themselves.

repository_url: str | None = 'https://github.com/pkgcore/pkgcore'

Repository holding the project’s code, or None when it has no public one.

Linked from the manager’s documentation page. Also what the weekly metrics sample reads: docs/docs_update.py writes it into the [tool.repomatic.metrics] subjects of pyproject.toml when its forge answers the sampler, through a mirror for a forge that does not.

Never inherited, for the same reason as wikipedia_url: the AUR helpers extending pacman each live in a repository of their own.

logo: str | None = 'gentoo'

Slug of the brand mark standing for this manager in the documentation.

Names an SVG vendored under docs/assets/managers/, whose provenance and license are recorded in docs/assets/managers/logos.yaml. Inlined at the top of the manager’s page by meta_package_manager._docs; a manager leaving it unset keeps the page’s default package glyph.

Several managers legitimately share one slug, either because they wrap the same upstream (brew and cask) or because the tool has no mark of its own and its ecosystem’s stands in (apt under Debian’s swirl, cargo under Rust’s gear). Documentation-only, like homepage_url: no CLI output reads it.

keywords: tuple[str, ...] = ('pkgcore',)

Well-known names for this manager that its id does not already carry.

Merged into the PyPI keywords of pyproject.toml by update_keywords() of docs/docs_update.py, alongside every manager ID and the globally curated KEYWORDS_EXTRAS. Declare an alias here rather than in that tuple whenever it names this manager: an alias living beside the class it describes cannot outlive it, where a central entry silently rots once the manager is renamed or dropped.

Reserve KEYWORDS_EXTRAS for terms belonging to no manager in particular, like cyclonedx or package manager. Documentation-only: no CLI output reads it.

Each keyword also becomes a content rule of the issue labeller, so its precision bar applies here: see generate_content_rules(). A subclass inherits the terms of its parent without claiming them, since test_manager_keywords_have_one_owner reads what a class declares itself.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({Platform(id='aix', name='IBM AIX'), Platform(id='almalinux', name='AlmaLinux'), Platform(id='alpine', name='Alpine Linux'), Platform(id='altlinux', name='ALT Linux'), Platform(id='amzn', name='Amazon Linux'), Platform(id='android', name='Android'), Platform(id='arch', name='Arch Linux'), Platform(id='artix', name='Artix Linux'), Platform(id='buildroot', name='Buildroot'), Platform(id='cachyos', name='CachyOS'), Platform(id='centos', name='CentOS'), Platform(id='chromeos', name='ChromeOS'), Platform(id='clearlinux', name='Clear Linux OS'), Platform(id='cloudlinux', name='CloudLinux OS'), Platform(id='crux', name='CRUX'), Platform(id='cygwin', name='Cygwin'), Platform(id='debian', name='Debian'), Platform(id='dragonfly_bsd', name='DragonFly BSD'), Platform(id='endeavouros', name='EndeavourOS'), Platform(id='exherbo', name='Exherbo Linux'), Platform(id='fedora', name='Fedora'), Platform(id='freebsd', name='FreeBSD'), Platform(id='generic_linux', name='Generic Linux'), Platform(id='gentoo', name='Gentoo Linux'), Platform(id='guix', name='Guix System'), Platform(id='haiku', name='Haiku'), Platform(id='hurd', name='GNU/Hurd'), Platform(id='ibm_powerkvm', name='IBM PowerKVM'), Platform(id='illumos', name='illumos'), Platform(id='kali', name='Kali Linux'), Platform(id='kvmibm', name='KVM for IBM z Systems'), Platform(id='linuxmint', name='Linux Mint'), Platform(id='mageia', name='Mageia'), Platform(id='mandriva', name='Mandriva Linux'), Platform(id='manjaro', name='Manjaro Linux'), Platform(id='midnightbsd', name='MidnightBSD'), Platform(id='netbsd', name='NetBSD'), Platform(id='nixos', name='NixOS'), Platform(id='nobara', name='Nobara'), Platform(id='nutyx', name='NuTyX'), Platform(id='openbsd', name='OpenBSD'), Platform(id='opensuse', name='openSUSE'), Platform(id='openwrt', name='OpenWrt'), Platform(id='oracle', name='Oracle Linux'), Platform(id='os400', name='IBM i'), Platform(id='parallels', name='Parallels'), Platform(id='pidora', name='Pidora'), Platform(id='pikaos', name='PikaOS'), Platform(id='raspbian', name='Raspbian'), Platform(id='rhel', name='RedHat Enterprise Linux'), Platform(id='rocky', name='Rocky Linux'), Platform(id='scientific', name='Scientific Linux'), Platform(id='slackware', name='Slackware'), Platform(id='sles', name='SUSE Linux Enterprise Server'), Platform(id='slitaz', name='SliTaz GNU/Linux'), Platform(id='solaris', name='Solaris'), Platform(id='solus', name='Solus'), Platform(id='sourcemage', name='Source Mage GNU/Linux'), Platform(id='sunos', name='SunOS'), Platform(id='tuxedo', name='Tuxedo OS'), Platform(id='ubuntu', name='Ubuntu'), Platform(id='ultramarine', name='Ultramarine'), Platform(id='void', name='Void Linux'), Platform(id='wsl1', name='Windows Subsystem for Linux v1'), Platform(id='wsl2', name='Windows Subsystem for Linux v2'), Platform(id='xenserver', name='XenServer')})

List of platforms supported by the manager.

Allows for a mishmash of platforms and groups of platforms. Will be normalized into a frozenset of Platform instances at instantiation.

default_sudo: bool = True

Built-in escalation default, used when sudo is None.

False on the base: most managers install into user-writable trees and never need root. The system package managers whose privileged operations require root (apt, dnf, pacman, zypper, …) set this to True so their build_cli(..., sudo=True) operations escalate out of the box, while staying switchable off through sudo (--no-sudo or config) for rootless setups.

privileged_operations: ClassVar[frozenset[str]] = frozenset({'cleanup', 'install', 'remove', 'sync', 'upgrade', 'upgrade_all'})

Operations with at least one command this manager marks privileged.

Keyed by the Operations member name, like operation_notes. An operation belongs here when a method implementing it passes sudo=True to run_cli() or build_cli(), with the method-to-operation map of METHOD_OPERATIONS. Those commands are the only ones the escalation policy (sudo, else default_sudo) wraps in the escalator. A definition derives the set from the operations it marks sudo = true.

prime_sudo() reads it to prompt only for the managers that escalate a command of the current run. With [mpm.overrides.gem] sudo = true, mpm sync asks for no password: the gem sources --update command of sync carries no marker. test_privileged_operations holds the set to the markers in the method bodies.

requirement: str | None = '>=0.12.29'

Version requirement specifier.

Supports a comma-separated range of constraints (e.g. ">=1.20.0,<2.0.0"). A bare version string like "1.20.0" is treated as >=1.20.0.

Parsed by meta_package_manager.version.VersionRange.

Defaults to None, which deactivates version check entirely.

pre_args: tuple[str, ...] = ('--color', 'no')

version_regexes: tuple[str, ...] = ('pkgcore\\s+(?P<version>\\S+)',)

$ pmerge --version
pkgcore 0.12.48

property installed: Iterator[Package]

Fetch installed packages.

A package installed in several slots is listed once per slot.

$ pquery --color no --installed --format {category}/{package}={fullver}
app-text/build-docbook-catalog=2.4
app-text/docbook-xml-dtd=4.1.2-r7
app-text/docbook-xml-dtd=4.2-r3
app-text/docbook-xml-dtd=4.5-r2
app-text/docbook-xsl-ns-stylesheets=1.79.1
app-text/docbook-xsl-stylesheets=1.79.1-r4
app-text/manpager=1

property outdated: Iterator[Package]

Fetch outdated packages.

pquery --upgrade prints the best version of each slot that has a newer one than the version installed in it, but not the installed version. The inventory supplies it, joined on the package and its slot.

$ pquery --color no --installed --format {category}/{package}:{slot}={fullver}
app-arch/libarchive:0=3.8.10
app-arch/tar:0=1.35-r1
app-arch/unzip:0=6.0_p31
app-arch/xz-utils:0=5.8.3
app-arch/zstd:0=1.5.7-r1
app-crypt/gnupg:0=2.5.24-r2
app-crypt/gpgme:1=2.2.0
app-crypt/libb2:0=0.98.1-r3
app-crypt/libmd:0=1.2.0

$ pquery --color no --upgrade --format {category}/{package}:{slot}={fullver}
app-arch/libarchive:0=3.8.11
app-arch/xz-utils:0=5.8.4
app-crypt/libmd:0=1.3.0

property orphans: Iterator[Package]

Fetch packages that neither the @world nor the @system set needs.

--pretend turns the --clean sweep into a read-only report. With an empty @world, as on a fresh stage3, everything outside @system and its dependencies is reported.

$ pmerge --color no --pretend --clean
 * Packages to be removed:
Remove installed pkg: app-alternatives/lex-0-r1::vdb, source repo 'gentoo'
Remove installed pkg: app-alternatives/ninja-1::vdb, source repo 'gentoo'
Remove installed pkg: app-alternatives/yacc-1-r2::vdb, source repo 'gentoo'
Remove installed pkg: app-arch/unzip-6.0_p31::vdb, source repo 'gentoo'

search(query, extended, exact)

Fetch matching packages.

A query matches package names, and is a glob around the query unless the search is exact. A query no package name can hold, like one with a space, skips that call. An extended search adds a second call, matching the query against descriptions: it reads the metadata of the whole repository, and is the slow part.

$ pquery --color no --max --format {category}/{package}={fullver}={description} nyancat
games-misc/nyancat=1.5.2=Nyancat in your terminal, rendered through ANSI escape sequences

$ pquery --color no --max --format {category}/{package}={fullver}={description} *cowsay*
games-misc/cowsay=3.7.0=Configurable talking ASCII cow (and other characters)
games-misc/xcowsay=1.6=Displays a cute cow and message on your desktop

$ pquery --color no --max --format {category}/{package}={fullver}={description} --description 'ANSI escape'
app-misc/color=1.2-r3=Easily add ANSI colouring to shell scripts
app-text/aha=0.5.1=Converts ANSI escape sequences of a unix terminal to HTML code
app-vim/ansiesc=12=vim plugin: ansi escape sequences concealed, but highlighted as specified
dev-java/jansi=2.4.1=A java library for generating and interpreting ANSI escape sequences
dev-libs/libuv=1.52.1=Cross-platform asynchronous I/O
dev-perl/Term-ANSIScreen=1.500.0-r2=Terminal control using ANSI escape sequences
dev-python/colorama=0.4.6=ANSI escape character sequences for colored terminal text & cursor positioning
dev-ruby/term-ansicolor=1.11.3-r1=Small Ruby library that colors strings using ANSI escape sequences
games-misc/nyancat=1.5.2=Nyancat in your terminal, rendered through ANSI escape sequences

Return type:

Iterator[Package]

cli_names: tuple[str, ...] = ('pmerge',)

List of CLI names the package manager is known as.

This list of recognized CLI names is ordered by priority. That way we can influence the search of the right binary.

..hint::

This was helpful in the case of the Python transition from 2.x to 3.x, where multiple versions of the same executable were named python or python3.

By default, this property’s value is derived from the manager’s ID (see the MetaPackageManager.__init__ method above).

homepage_url: str | None = None

Home page of the project, only used in documentation for reference.

Left unset when the home page is the project’s repository, which repository_url names on its own, and when it is the project’s manual, which documentation_url names. Never inherited, like the other links.

id: str = 'pmerge'

Package manager’s ID.

Derived by defaults from the lower-cased class name in which underscores _ are replaced by dashes -.

This ID must be unique among all package manager definitions and lower-case, as they’re used as feature flags for the mpm CLI.

install(package_id, version=None)

Install one package, and record it in the @world set.

$ sudo pmerge --color no games-misc/nyancat

Return type:

str

virtual: bool = False

Should we expose the package manager to the user?

Virtual package manager are just skeleton classes used to factorize code among managers of the same family.

wikipedia_url: str | None = None

English Wikipedia article about the project, or None when it has none.

Listed last in the links of the manager’s documentation page. The article covers the project that home page names, or is a redirect Wikipedia keeps under the project’s name, landing on the part of a broader article that describes it: Cargo_(software) opens the Cargo section of the Rust article. An article that merely mentions the project does not count, nor does one about a related subject: lazy is a Neovim plugin manager, and the Neovim article is not about it.

Never inherited: the metaclass resets it to None on any class not declaring its own. A subclass often wraps a distinct project, like the six AUR helpers extending pacman, and would otherwise present pacman’s article as its own. Documentation-only, like homepage_url.

upgrade_all_cli()

Generates the CLI to upgrade all outdated packages.

The @system set rides along with @world: pmerge refuses an empty target list, and a fresh stage3 records nothing in @world.

$ sudo pmerge --color no --upgrade --deep --newuse @world @system

Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)

Generates the CLI to upgrade the provided package.

--upgrade leaves a package that is already current alone, and does not add it to the @world set.

$ sudo pmerge --color no --upgrade app-crypt/libmd

Return type:

tuple[str, ...]

remove(package_id)

Remove one package, and drop it from the @world set.

$ sudo pmerge --color no --unmerge games-misc/nyancat

Return type:

str

sync()

Sync every configured repository.

$ sudo pmaint --color no sync
*** syncing gentoo
*** synced gentoo

Return type:

None

cleanup_orphan()

Remove every package outside the @world and @system sets.

The sweep stops at the first removal that fails, and pmerge still exits 0. On a stage3 it removed app-text/build-docbook-catalog, then stopped on a DocBook package whose pkg_postrm calls that tool: seven of the hundred orphans went. mpm counts what the sweep removed, and mpm orphans lists what is left.

$ sudo pmerge --color no --clean

Return type:

None

cleanup_cache()

Remove the source distfiles no installed package uses.

$ sudo pclean --color no dist --installed

Return type:

None