meta_package_manager.managers.protonplus module

meta_package_manager.managers.protonplus.MARKER = '.protonplus'

The record ProtonPlus writes into the directory of every release it installs.

A JSON object naming the launcher, the runner and the release tag. ProtonPlus builds its own inventory from these files (src/utils/metadata.vala), and defaults a missing field to an empty string.

meta_package_manager.managers.protonplus.GROUP_DIRECTORIES = ('compatibilitytools.d', 'dxvk', 'runners', 'runners/wine', 'runtime/dxvk', 'runtime/vkd3d', 'Runners', 'tools/proton', 'tools/wine')

Where a launcher keeps its runners, relative to the launcher’s own directory.

Mirrors get_group_directory() in src/models/launcher.vala of ProtonPlus 0.6.8: compatibilitytools.d for Steam and Faugus Launcher, runners/wine, runtime/dxvk and runtime/vkd3d for Lutris, tools/proton and tools/wine for Heroic Games Launcher, runners and dxvk for Bottles, and Runners for WineZGUI.

class meta_package_manager.managers.protonplus.ProtonPlus

Bases: PackageManager

ProtonPlus, installing Proton, Wine, DXVK and VKD3D builds into game launchers.

A package is one runner on one launcher, identified as <launcher_id>/<runner_id>: lutris-system/dxvk-doitsujin is DXVK (doitsujin) as the natively installed Lutris sees it. protonplus list names the launchers ProtonPlus detects. ProtonPlus has no catalog command, but protonplus install <launcher_id> <runner_id> answers an unknown runner ID with the list of the ones that launcher accepts.

The inventory reads the .protonplus record ProtonPlus writes into every release it installs, which is also what ProtonPlus builds its own listing from. protonplus list <launcher_id> prints directory names only, with neither runner nor version, and mixes in the launcher’s own directories. The records are looked for in the launcher directories ProtonPlus checks as of 0.6.8, which is an implementation detail rather than a documented contract: a release missing from the inventory after a ProtonPlus upgrade points there first. A runner kept at several releases is listed once, at its newest.

install fetches the newest release into a rolling <runner title> Latest directory, the one release that upgrade moves forward. A release installed at a chosen version from ProtonPlus itself is listed too, but upgrade --all passes it over, and upgrading a runner that holds no rolling release fails with ProtonPlus’s own This compatibility tool is not installed. error: run mpm install on it first. remove deletes every release of the runner on that launcher.

mpm runs the protonplus command. The AppImage build carries a longer file name: link it as protonplus into a directory on PATH.

Initialize cli_errors list.

operation_notes: ClassVar = {'outdated': 'ProtonPlus compares releases only while `update` applies them.', 'search': 'ProtonPlus has no catalog, only an error listing the runner IDs.'}

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

Return package manager’s common name.

Default value is based on class name.

repository_url: str | None = 'https://github.com/Vysp3r/ProtonPlus'

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.

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

The first release writing .protonplus records that name the launcher and the runner, and taking the latest and all arguments of install, uninstall and update.

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

CLI options used to produce the version of the package manager.

The raw output produced by the package manager CLI will be parsed with the version_regexes below to extract the version number.

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

$ protonplus version
ProtonPlus 0.6.8

property installed: Iterator[Package]

Fetch installed packages.

Each release carries its record, like this one ProtonPlus wrote for the rolling DXVK release of Lutris, in ~/.local/share/lutris/runtime/dxvk/DXVK (doitsujin) Latest/.protonplus:

{"runner_endpoint":"https://api.github.com/repos/doitsujin/dxvk/releases","runner_title":"DXVK (doitsujin)","tag":"v3.1.1","provider_id":"dxvk-doitsujin","tool_id":"lutris-system/dxvk/dxvk-doitsujin","launcher_id":"lutris-system","variant_id":"standard","release_id":"381956359"}

A record naming no launcher or no runner is skipped, since no command could address its release.

Todo

Read the inventory from protonplus list and drop the record scan, with GROUP_DIRECTORIES and the launcher directory table, once Vysp3r/ProtonPlus#1313 makes list print the runner ID and tag of each release.

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

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

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.

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

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.

install(package_id, version=None)

Install one package.

latest fetches the newest release into the rolling <runner title> Latest directory. Without it ProtonPlus lists the releases and waits for a number on its standard input, so a pinned version is not supported.

The block below illustrates rather than captures: the package ID splits into two arguments, so the corpus cannot rebuild this command from a stand-in package id.

$ protonplus install lutris-system dxvk-doitsujin latest

Return type:

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.

upgrade_all_cli()

Generate the CLI to upgrade the rolling release of every runner.

$ protonplus update all

Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)

Generate the CLI to upgrade the rolling release of one runner.

The block below illustrates rather than captures: the package ID splits into two arguments, so the corpus cannot rebuild this command from a stand-in package id.

$ protonplus update lutris-system dxvk-doitsujin

Return type:

tuple[str, ...]

remove(package_id)

Remove every release of one runner from its launcher.

The block below illustrates rather than captures: the package ID splits into two arguments, so the corpus cannot rebuild this command from a stand-in package id.

$ protonplus uninstall lutris-system dxvk-doitsujin all

Return type:

str