meta_package_manager.managers.prt_get module

class meta_package_manager.managers.prt_get.PrtGet

Bases: PackageManager

The ports front-end of CRUX.

Documentation: prt-get(8) man page.

Caution

CRUX builds every port from source, so an install or an upgrade compiles. mpm caps a mutating operation at 500 seconds, which a large port outlasts by hours. Raise it for this manager with [mpm.overrides.prt-get] timeout.

Note

sync() runs the sibling ports binary rather than prt-get, that being the tool CRUX gives the ports tree. mpm resolves it from the same directory as cli_path.

Warning

prt-get listorphans is deliberately left unmapped. It lists “ports with no packages depending on them”, which on a stock CRUX install includes bash, binutils and coreutils: the base system is depended on by nothing, so feeding that list to an orphan sweep would remove the machine. That is a different question from the one orphans() asks, which is which packages were pulled in as dependencies and are no longer required.

Initialize cli_errors list.

id: str = 'prt-get'

The CLI name, which the PrtGet class name cannot spell: a hyphen is not valid in a Python identifier.

name: str = 'CRUX prt-get'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://crux.nu/Main/Prt-get'

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

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

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='crux', name='CRUX')})

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

The 5.19 series is what every supported CRUX ships: 5.19.6 on CRUX 3.7 and 5.19.9 on CRUX 3.8.

This is not a bisected minimum. Every operation below is far older than that: upstream’s own ChangeLog dates printf to 0.3.4, listinst to 0.3.1pre1, dsearch to 0.2.9 and sysup to 0.4.0alpha2, all of them predating the newest entry that file carries (5.16, 2008). So the floor records the series this wrapper was driven against rather than claiming compatibility with releases nobody runs.

cli_names: tuple[str, ...] = ('prt-get',)

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

version_cli_options: tuple[str, ...] = ('version',)

prt-get answers --version with prt-get: Unknown option: --version. The version is a subcommand instead.

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

$ prt-get version
prt-get 5.19.5 by Johannes Winkelmann, [email protected]

property installed: Iterator[Package]

Fetch installed packages.

The [Config error: can't access /usr/ports/<collection>] lines a host with an unsynced ports tree emits go to stderr, so they never reach this parser.

$ prt-get listinst -v
acl 2.3.2-1
attr 2.5.2-1
autoconf 2.72-1
automake 1.17-1
bash 5.2.37-1
bc 1.08.1-1

property outdated: Iterator[Package]

Fetch outdated packages.

Caution

Compares the installed packages against the local ports tree, so it reports what the last sync() fetched and not what CRUX publishes right now.

$ prt-get diff
Differences between installed packages and ports tree:

Port                Installed           Available in the ports tree

acl                 2.3.2-1             2.4.0-1
attr                2.5.2-1             2.6.0-1
autoconf            2.72-1              2.73-1
automake            1.17-1              1.18.1-1
bash                5.2.37-1            5.3.15-1

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.

search(query, extended, exact)

Fetch matching packages.

Lists the whole ports tree and lets meta_package_manager.manager.PackageManager.refiltered_search() narrow it. prt-get does own two search commands, but neither reports a version: search and dsearch both print bare port names, and only the printf projection carries the version and the description. The tree is local and small, so dumping it costs less than enriching each hit: 789 ports rendered in 34 ms on the host this was driven on.

The format string holds no space, so the command mpm discloses at --verbosity INFO can be pasted back into a shell unquoted.

$ prt-get printf %n|%v|%d\n
a2ps|4.15.8|ASCII to Postscript converter (Prettyprint)
abseil-cpp|20260817.0|Abseil Common Libraries (C++)
acl|2.4.0|Access Control Lists library
adwaita-icon-theme|50.0|Adwaita Icon Theme
alsa-lib|1.2.16.1|ALSA libraries
alsa-oss|1.1.8|ALSA OSS Emulation

Return type:

Iterator[Package]

install(package_id, version=None)

Install one package, and the ports it depends on.

depinst rather than install: the latter builds the named port alone and fails on the first missing dependency.

$ sudo prt-get depinst dosfstools
=======> Building '/usr/ports/opt/dosfstools/dosfstools#4.2-1.pkg.tar.gz' succeeded.
prt-get: installing dosfstools 4.2-1

-- Packages installed
dosfstools

prt-get: installed successfully

Return type:

str

upgrade_all_cli()

Generates the CLI to upgrade all packages.

$ sudo prt-get sysup

Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)

Generates the CLI to upgrade one package.

$ sudo prt-get update dosfstools

Return type:

tuple[str, ...]

remove(package_id)

Remove one package.

$ sudo prt-get remove dosfstools

-- Packages removed
dosfstools

Return type:

str

sync()

Sync the ports tree.

$ sudo ports -u
Updating file list from crux.nu::ports/crux-3.8/xorg/
Updating collection xorg
Finished successfully

Return type:

None