meta_package_manager.managers.prt_get module

class meta_package_manager.managers.prt_get.PrtGet

Bases: PackageManager

The ports front-end of CRUX.

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.

Initialize cli_errors list.

operation_notes: ClassVar = {'orphans': 'The `listorphans` command lists ports nothing depends on, which on a stock install includes the base system, so mapping it would remove the machine.'}

Per-operation hints rendered in the Notes column of the manager page’s Operations table.

Keyed by the Operations member name, each value is a single short sentence explaining why the manager lacks the operation, or what makes its implementation partial: the pointer a reader needs to judge whether the gap is one they could help close. Each sentence starts with a capital and closes with a period, and starts on a word rather than a code span, so the cell reads standalone beside its row. A blank cell stays silent: a manager documenting nothing documents no gap.

The full rationale never lives here: it belongs in a comment beside the implementing method (or beside this declaration, for an operation with no method to hang it on), so the sentence on the page stays a hint and the code keeps the story. The class docstring follows the same split: it keeps only what a user needs to run the tool day to day, never how mpm wraps it.

Validated by test_operation_notes, which also checks every key matches a real operation: a key outside the enum’s vocabulary would never reach a page.

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/doc/prt-get%20-%20User%20Manual.html'

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.

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

privileged_operations: ClassVar[frozenset[str]] = frozenset({'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 = '>=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, jw@tks6.net

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

documentation_url: str | None = None

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.

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

repository_url: str | None = None

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.

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.

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