meta_package_manager.managers.emerge module

class meta_package_manager.managers.emerge.Emerge[source]

Bases: PackageManager

Portage’s emerge, Gentoo’s source-based package manager.

Documentation: emerge(1) man page.

Command equivalences with other managers are listed in Pacman/Rosetta.

The outdated listing and the whole-system upgrade operate against the @world set. The progress spinner and ANSI coloring are disabled on every call, leaving output the regexes can parse.

Note

Two operations lean on companion Portage tools rather than emerge itself: installed reads the package list through qlist and cleanup trims distfiles through eclean. Neither is resolved through cli_path the way the reference emerge binary is; both are expected on the PATH.

Warning

cleanup forces a full @world upgrade before running --depclean: Portage refuses to remove packages until every dependency is resolved, so depcleaning a partially-upgraded system could drop still-needed packages.

Initialize cli_errors list.

name: str = 'Gentoo emerge'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://wiki.gentoo.org/wiki/Portage#emerge'

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

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, ...] = ('gentoo', 'portage')

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

Merged into the PyPI keywords of pyproject.toml by docs_update.update_keywords(), 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.

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='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.

requirement: str | None = '>=3.0.0'

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, ...] = ('--quiet', '--color', 'n', '--nospinner')
version_regexes: tuple[str, ...] = ('Portage\\s+(?P<version>\\S+)',)
$ emerge --version
Portage 3.0.81.3 (python 3.14.7-final-0, default/linux/arm64/23.0, gcc-15, glibc-2.43-r2, 6.18.48-gentoo-dist-bin aarch64)
property installed: Iterator[Package]

Fetch installed packages.

Warning

This suppose the qlist binary is available and present on the system. We do not search for it or try to resolves its canonical path with cli_path, as we do for the reference emerge binary.

$ qlist --installed --verbose --nocolor
app-admin/sudo-1.9.17_p2
app-alternatives/awk-4
app-arch/unzip-6.0_p29-r2
app-misc/pax-utils-1.3.10
app-misc/tmux-3.5a
app-shells/bash-5.3_p15
dev-perl/Locale-gettext-1.70.0_p20181130
dev-perl/SGMLSpm-1.1-r2
property outdated: Iterator[Package]

Fetch outdated packages.

Runs without --quiet, which would drop the [ebuild   U  ] state prefix and unbracket the latest version. See _PARSED_PRE_ARGS.

$ emerge --color n --nospinner --update --deep --pretend --columns @world
[ebuild     U  ] sys-process/htop                                      [3.5.3]                      [3.5.1]
[binary    gU  ] app-editors/nano                                      [9.2-1]                      [9.1]
property orphans: Iterator[Package]

Fetch packages installed as dependencies that nothing requires anymore.

--pretend turns --depclean into a read-only report of the packages it would unmerge, summarized on its All selected packages: line as =<category/name>-<version> atoms. Runs without root, and without the pre-depclean world upgrade cleanup_orphan() performs before a real sweep.

$ emerge --quiet --color n --nospinner --depclean --pretend
app-misc/tmux: 3.5a none none
dev-libs/libevent: 2.1.13 none none

All selected packages: =app-misc/tmux-3.5a =dev-libs/libevent-2.1.13
Packages installed:   327
Packages in world:    8
Packages in system:   50
Required packages:    325
Number to remove:     2
search(query, extended, exact)[source]

Fetch matching packages.

Runs without --quiet, which would collapse each hit to a bare *  category/name line and strip the two fields _SEARCH_REGEXP reads. See _PARSED_PRE_ARGS.

$ emerge --color n --nospinner --search %^(htop|tmux)$
[ Results for search key : %^(htop|tmux)$ ]
Searching...

*  app-misc/tmux
      Latest version available: 3.5a
      Latest version installed: 3.5a
      Size of files: 699 KiB
      Homepage:      https://tmux.github.io/
      Description:   Terminal multiplexer
      License:       ISC

*  sys-process/htop
      Latest version available: 3.5.3
      Latest version installed: 3.5.1
      Size of files: 465 KiB
      Homepage:      https://htop.dev/ https://github.com/htop-dev/htop
      Description:   Interactive process viewer
      License:       GPL-2+

[ Applications found : 2 ]

$ emerge --color n --nospinner --search sed

$ emerge --color n --nospinner --searchdesc sed

$ emerge --color n --nospinner --searchdesc %^sed$
Return type:

Iterator[Package]

install(package_id, version=None)[source]

Install one package.

$ sudo emerge --quiet --color n --nospinner dev-vcs/git
Return type:

str

upgrade_all_cli()[source]

Generates the CLI to upgrade all outdated packages.

$ sudo emerge --quiet --color n --nospinner --update --newuse --deep @world
Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)[source]

Generates the CLI to upgrade the provided package.

$ sudo emerge --quiet --color n --nospinner --update dev-vcs/git
Return type:

tuple[str, ...]

remove(package_id)[source]

Remove one package.

$ sudo emerge --quiet --color n --nospinner --unmerge dev-vcs/git
Return type:

str

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

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).

id: str = 'emerge'

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.

sync()[source]

Sync package metadata.

$ sudo emerge --quiet --color n --nospinner --sync
Return type:

None

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.

cleanup_orphan()[source]

Remove every package not required by the world set anymore.

An update is forced before depcleaning, as pointed to by the emerge documentation:

> As a safety measure, depclean will not remove any packages unless all > required dependencies have been resolved. As a consequence, it is often > necessary to run emerge --update --newuse --deep @world prior to depclean.

$ sudo emerge --quiet --color n --nospinner --update --newuse --deep @world
$ sudo emerge --quiet --color n --nospinner --depclean
Return type:

None

cleanup_cache()[source]

Trim the source distfiles through eclean.

Warning

This suppose the eclean binary is available and present on the system. We do not search for it or try to resolves its canonical path with cli_path, as we do for the reference emerge binary.

$ sudo eclean distfiles
Return type:

None