meta_package_manager.managers.pixi module

class meta_package_manager.managers.pixi.Pixi

Bases: PackageManager

pixi installs conda packages, either into a project workspace or machine-wide as global tools.

mpm is system-scoped, so this wrapper drives the pixi global scope alone and never touches a pixi.toml workspace. Global tools resolve from conda channels, conda-forge by default, and land in their own prefix under $PIXI_HOME.

Important

pixi isolates each global tool in its own environment, and mpm keys packages on the environment name, not on the conda package names inside it. The environment is the unit every mutating pixi global verb addresses: uninstall deletes one whole environment and update refreshes one whole environment, neither taking a package name. pixi global install <pkg> names the environment after the package, so for everything mpm installs the two are the same string and every operation round-trips.

Todo

Declare a logo once Simple Icons ships the pixi mark requested in simple-icons/simple-icons#13796, a request already cleared of trademark concerns (labelled permission not needed`). Their``pixiv` mark is an unrelated brand, not a stand-in.

Initialize cli_errors list.

operation_notes: ClassVar = {'installed': 'An environment is reported as the single package it is named after, with no version once its contents diverge; its extra packages are invisible to `mpm`.', 'outdated': 'Nothing reports upgradable packages without performing the upgrade ([prefix-dev/pixi#6279](https://github.com/prefix-dev/pixi/issues/6279), closed pointing at a workspace-scoped dry run); `upgrade --all` maps to the native `pixi global update`.', 'remove': 'Removing a package deletes its whole environment, taking any extra packages installed beside it.', 'search': 'The `--json` mode cannot be capped and queries every known conda subdir, so a search would stall on it.', 'sync': 'The `pixi global sync` command reconciles the manifest by installing and removing, so it mutates rather than refreshes.'}

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

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://pixi.sh'

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.

documentation_url: str | None = 'https://pixi.prefix.dev/latest/global_tools/introduction/'

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/prefix-dev/pixi'

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.

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

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='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='macos', name='macOS'), 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='windows', name='Windows'), 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.

requirement: str | None = '>=0.65.0'

0.65.0 is where pixi global list gained the --json flag this wrapper reads (prefix-dev/pixi#5530), and it is the binding floor. Every other operation is far older: install dates to 0.0.4, list to 0.3.0, and uninstall / update to the 0.33.0 rewrite that rebuilt pixi global around its manifest. That same rewrite is why nothing below 0.33.0 would work anyway: pixi global remove meant uninstall back then, and now means removing one dependency from an environment.

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

Both are global options, accepted ahead of any subcommand.

pixi colorizes its listings semantically and draws progress bars while solving. Each turns itself off when the matching stream is not a terminal, but mpm asks explicitly rather than relying on redirection. The version probe runs with auto_pre_args=False and so stays a bare pixi --version.

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

$ pixi --version
pixi 0.78.0

property installed: Iterator[Package]

Fetch installed packages.

The document is an array of environments, each carrying the explicit specs it was created from. Transitive dependencies are not listed, which is what makes this an inventory of tools rather than of everything on disk. Each environment yields exactly one package, keyed on the environment name, and its version is read from the dependency of the same name. A version is null for a package the manifest declares but that is not installed in the prefix, and the optional platform key is omitted unless the environment pins one.

The block below is a capture from pixi 0.78.0. Its ripgrep entry is the one pixi’s own pixi global list reference output documents.

$ pixi --color=never --no-progress global list --json
[
  {
    "name": "ripgrep",
    "dependencies": [
      {
        "name": "ripgrep",
        "version": "14.1.0"
      }
    ],
    "exposed": [
      {
        "exposed_name": "rg",
        "executable": "rg"
      }
    ]
  }
]

install(package_id, version=None)

Install one package.

The positional argument is a conda MatchSpec, so a version is pinned by appending ==<version> to the name rather than through a flag.

$ pixi --color=never --no-progress global install hyperfine

$ pixi --color=never --no-progress global install hyperfine==1.20.0

Return type:

str

upgrade_all_cli()

Generates the CLI to upgrade all packages.

Bare pixi global update updates every environment: there is no --all flag. It also prunes stale environments on the way through.

$ pixi --color=never --no-progress global update

Return type:

tuple[str, ...]

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

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

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

Generates the CLI to upgrade one package.

pixi global update takes environment names and accepts no version at all, so a pinned upgrade is not expressible: mpm warns and upgrades to whatever the channels resolve to.

Routing a pinned upgrade through pixi global install <pkg>==<version> instead was tried and rejected. That verb takes a package spec rather than an environment name, and creates the environment when it is missing, so pinning a package that lives inside a differently-named environment forks a second environment holding a second copy and reports success, leaving the original untouched.

$ pixi --color=never --no-progress global update hyperfine

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.

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.

remove(package_id)

Remove one package.

pixi global uninstall removes a whole environment, deleting its prefix outright, which is the counterpart of the pixi global install that created it and matches the unit installed() reports. An environment carrying co-installed extras loses those too.

The sibling pixi global remove is deliberately not used: it drops one dependency from an environment and leaves the environment behind, which would strand an entry mpm still reports as installed.

$ pixi --color=never --no-progress global uninstall hyperfine

Return type:

str

cleanup_cache()

Clear pixi’s download caches.

--yes is required: with no cache-type flag, pixi clean cache asks for confirmation on <stdin> and would otherwise block forever under mpm.

$ pixi --color=never --no-progress clean cache --yes

Return type:

None