meta_package_manager.managers.apk module

class meta_package_manager.managers.apk.APK

Bases: PackageManager

Alpine Package Keeper (apk) used by Alpine Linux.

Documentation: Alpine Package Keeper.

Note

The version floor is 2.10.0, the release introducing the list applet that outdated() parses and installed() falls back on. Where query_requirement is met, installed reads the structured query applet instead. Progress output is disabled on every call to keep the parsed lines stable.

Caution

outdated reads the local repository cache rather than the remote, so sync must run first for an accurate upgrade list.

Warning

orphans is deliberately not implemented, and apk query --orphaned must not be mapped onto it. The two words name different sets: mpm’s orphan is a package installed as a dependency that nothing requires any more, where apk’s is one no configured repository provides any more. Measured on Alpine 3.24.1 with apk-tools 3.0.8: pointing apk at no repository (--repositories-file /dev/null) reports all 86 installed packages as orphaned, and the stock repositories report none, while a package dropped from apk-world(5) and required by nothing is never reported at all. Wiring that selector to cleanup --orphans would delete a working system whenever its mirrors were unreachable.

Initialize cli_errors list.

name: str = 'Alpine apk'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://gitlab.alpinelinux.org/alpine/apk-tools'

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

logo: str | None = 'alpinelinux'

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, ...] = ('alpine', 'alpine linux')

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.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({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='debian', name='Debian'), Platform(id='endeavouros', name='EndeavourOS'), Platform(id='exherbo', name='Exherbo Linux'), Platform(id='fedora', name='Fedora'), Platform(id='generic_linux', name='Generic Linux'), Platform(id='gentoo', name='Gentoo Linux'), Platform(id='guix', name='Guix System'), Platform(id='ibm_powerkvm', name='IBM PowerKVM'), 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='nixos', name='NixOS'), Platform(id='nobara', name='Nobara'), Platform(id='nutyx', name='NuTyX'), Platform(id='opensuse', name='openSUSE'), Platform(id='openwrt', name='OpenWrt'), Platform(id='oracle', name='Oracle Linux'), 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='solus', name='Solus'), Platform(id='sourcemage', name='Source Mage GNU/Linux'), 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 = '>=2.10.0'

The list applet, used by installed() and outdated(), was introduced in version 2.10.0.

query_requirement = '>=3.0.0'

Minimum apk version answering the query applet.

apk-tools 3 added query, which reports the same inventory as list does but in json or yaml, so installed() reads names and versions outright instead of recovering them from a line’s shape.

Kept apart from requirement (>=2.10.0), following Yay.cooldown_requirement, so an apk-tools 2 host keeps every operation through the list applet. Alpine 3.22 and older still ship 2.14, and their support windows run into 2027.

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

Suppress progress indicators so log lines are stable when parsing.

Source: apk(8) global options.

version_regexes: tuple[str, ...] = ('apk-tools\\s+(?P<version>[^\\s,]+)',)

$ apk --version
apk-tools 2.14.10, compiled for x86_64.

property installed: Iterator[Package]

Fetch installed packages.

apk-tools 3 answers the query applet, whose json payload names and versions each package outright, so nothing has to be recovered from a line’s shape. The pattern is mandatory, an empty selection matching nothing rather than everything.

$ apk --no-progress query --installed --fields name,version --format json '*'
[
  {
    "name": "alpine-base",
    "version": "3.24.1-r0"
  }, {
    "name": "apk-tools",
    "version": "3.0.8-r0"
  }, {
    "name": "busybox",
    "version": "1.37.0-r31"
  }
]

apk-tools 2 has no query, and gets the list applet instead:

$ apk --no-progress list --installed
acl-2.2.53-r0 x86_64 {acl} (LGPL-2.1-or-later AND GPL-2.0-or-later) [installed]
alpine-baselayout-3.4.3-r1 x86_64 {alpine-baselayout} (GPL-2.0-only) [installed]
apk-tools-2.14.0-r5 x86_64 {apk-tools} (GPL-2.0-only) [installed]
busybox-1.36.1-r5 x86_64 {busybox} (GPL-2.0-only) [installed]
python3-3.11.6-r0 x86_64 {python3} (PSF-2.0) [installed]

Which dialect to ask for is decided by _has_query_applet, but both are parsed whatever the host, keyed on the payload being JSON. That is what lets each documented block above stand as a fixture, and it keeps the reading of an answer independent of the guess that produced it.

property outdated: Iterator[Package]

Fetch outdated packages.

Caution

Reads from the local repository cache. Run sync() first to refresh the index.

$ apk --no-progress list --upgradable
acl-2.3.1-r0 x86_64 {acl} (LGPL-2.1-or-later) [upgradable from: acl-2.2.53-r0]
python3-3.11.7-r0 x86_64 {python3} (PSF-2.0) [upgradable from: python3-3.11.6-r0]

search(query, extended, exact)

Fetch matching packages.

Caution

apk search matches package names with case-insensitive substring globbing. Exact matching is not supported and is handled by meta_package_manager.manager.PackageManager.refiltered_search(). Extended search adds the --description flag so the query is also matched against package descriptions.

apk-tools 2 prints the bare name and version:

$ apk --no-progress search --verbose firefox
firefox-120.0-r0
firefox-esr-115.5.0-r0
firefox-langpack-de-120.0-r0

$ apk --no-progress search --verbose --description ntp
chrony-4.4-r1
ntp-4.2.8_p17-r0
openntpd-6.8_p1-r1

apk-tools 3 appends each package’s description, so only the first whitespace-delimited token is the name and version:

$ apk --no-progress search --verbose curl
curl-8.21.0-r0 - URL retrieval utility and library
curl-dev-8.21.0-r0 - URL retrieval utility and library (development files)
curl-doc-8.21.0-r0 - URL retrieval utility and library (documentation)

Return type:

Iterator[Package]

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

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

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.

$ sudo apk --no-progress add firefox

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.

upgrade_all_cli()

Generates the CLI to upgrade all packages.

$ sudo apk --no-progress upgrade

Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)

Generates the CLI to upgrade one package.

$ sudo apk --no-progress upgrade firefox

Return type:

tuple[str, ...]

remove(package_id)

Remove one package.

$ sudo apk --no-progress del firefox

Return type:

str

sync()

Synchronize the local package index from remote repositories.

$ sudo apk --no-progress update

Return type:

None

cleanup_cache()

Drop the local package cache.

$ sudo apk --no-progress cache clean

Return type:

None