meta_package_manager.managers.ips module

class meta_package_manager.managers.ips.IPS[source]

Bases: PackageManager

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

Documentation: pkg(1) man page.

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

installed passes --no-refresh to keep the inventory a local read. Left off, pkg list contacts every configured publisher first, which turns a listing into a network round-trip and fails outright when the host is offline.

Todo

outdated is not implemented. The operation needs a sample naming both the installed and the available version, and the only illumos host available reported no packages have newer versions available.

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

Capture it on a host whose image has fallen behind its publisher, which is the only state that emits the output.

Initialize cli_errors list.

name: str = 'Image Packaging System'

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://github.com/OpenIndiana/pkg5'

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

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.

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)[source]

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:/[email protected]       openindiana.org
pkg:/archiver/[email protected]   openindiana.org
pkg:/archiver/[email protected]    openindiana.org
pkg:/developer/[email protected]    openindiana.org
pkg:/library/perl-5/[email protected]  openindiana.org
Return type:

Iterator[Package]

install(package_id, version=None)[source]

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

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()[source]

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)[source]

Upgrade one package.

$ sudo pkg update --accept archiver/gnu-tar
Return type:

tuple[str, ...]

remove(package_id)[source]

Remove one package.

$ sudo pkg uninstall archiver/gnu-tar
Return type:

str

sync()[source]

Refresh the publishers’ catalogs.

$ sudo pkg refresh
Return type:

None

cleanup()[source]

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.

$ sudo pkg purge-history
Return type:

None