meta_package_manager.managers.ips module

class meta_package_manager.managers.ips.IPS

Bases: PackageManager

The Image Packaging System, the native pkg of Solaris and illumos.

The CLI is named pkg, which the FreeBSD PKG manager also claims. The two never coexist, their platforms being disjoint, but the manager ID here is ips so the two stay addressable apart.

Note

Only root may modify the image, so mutating operations escalate through sudo. sync escalates too: refreshing the catalog writes into the image’s own metadata rather than a user cache.

Caution

The inventory is a local read: the catalog is not refreshed, so the listing works offline.

Todo

Implement outdated, on a host whose image has fallen behind its publisher: that is the only state emitting output that names both the installed and the available version, and the one illumos host available reported no packages have newer versions available.

The state cannot be manufactured on a consistent image, so do not spend time trying: installing a superseded build to force one is refused with did not match any allowable packages, the release incorporations constraining an image to one allowable version per package. Inventing a fixture is not an option either, a sample having to parse through this manager’s own parser and having to be real.

Initialize cli_errors list.

operation_notes: ClassVar = {'outdated': 'Awaiting a real sample naming both the installed and the available version, which only a host whose image has fallen behind its publisher emits.'}

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.

name: str = 'Image Packaging System'

Return package manager’s common name.

Default value is based on class name.

documentation_url: str | None = 'https://docs.oracle.com/cd/E88353_01/html/E37839/pkg-1.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/OpenIndiana/pkg5'

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.

wikipedia_url: str | None = 'https://en.wikipedia.org/wiki/Image_Packaging_System'

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.

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

The name the upstream project answers to, which the ips ID does not carry.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({Platform(id='illumos', name='illumos'), Platform(id='solaris', name='Solaris')})

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.

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

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, ...] = ('list', '-H', '--no-refresh', 'package/pkg')

IPS reports no version of its own: pkg --version is answered with pkg: illegal global option -- version and exit 2, while bare pkg version prints the build hash alone (4e1d42c7), which carries no ordering. IPS does package itself as package/pkg on every distribution, so its own inventory row is the version, and --no-refresh keeps the probe from reaching the network.

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

$ pkg list -H --no-refresh package/pkg
package/pkg                                       0.5.11-2025.0.0.5626       i--

property installed: Iterator[Package]

Fetch installed packages.

$ pkg list -H --no-refresh
SUNWcs                                            0.5.11-2026.0.0.23029      i--
SUNWcsd                                           0.5.11-2026.0.0.23029      i--
archiver/gnu-tar                                  1.35-2023.0.0.0            i--
audio/audio-utilities                             0.5.11-2026.0.0.23029      i--
audio/lame                                        3.100-2025.0.0.3           i--

search(query, extended, exact)

Search packages.

-p reports one row per matching package instead of one per matching action, which is what the bare form emits: a package whose summary and description both match is otherwise returned twice.

IPS indexes the summary and description alongside the name, so a query always searches them. That is wider than mpm’s default, and neither capability is declared: mpm refilters the results itself, narrowing the plain case and leaving the extended one alone.

$ pkg search -H -p tar
pkg:/SUNWcs@0.5.11-2026.0.0.23029       openindiana.org
pkg:/archiver/gnu-tar@1.35-2023.0.0.0   openindiana.org
pkg:/archiver/ofarc@1.5.1-2026.0.0.0    openindiana.org
pkg:/developer/quilt@0.69-2026.0.0.2    openindiana.org
pkg:/library/perl-5/archive-tar@3.4-2025.0.0.1  openindiana.org

Return type:

Iterator[Package]

install(package_id, version=None)

Install one package.

--accept accepts the package licenses, which IPS would otherwise stop and prompt for, hanging the subprocess.

$ sudo pkg install --accept archiver/gnu-tar

Return type:

str

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

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.

upgrade_all_cli()

Upgrade all packages.

$ sudo pkg update --accept

Return type:

tuple[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_one_cli(package_id, version=None)

Upgrade one package.

$ sudo pkg update --accept archiver/gnu-tar

Return type:

tuple[str, ...]

remove(package_id)

Remove one package.

$ sudo pkg uninstall archiver/gnu-tar

Return type:

str

sync()

Refresh the publishers’ catalogs.

$ sudo pkg refresh

Return type:

None

cleanup_cache()

Purge the image’s operation history.

IPS caches nothing a user can reclaim: downloaded content lands straight in the image, so purge-history is the only space this manager frees, and mpm cleanup --cache is the category that reaches it.

$ sudo pkg purge-history

Return type:

None