meta_package_manager.managers.gext module

meta_package_manager.managers.gext.DRY_RUN_UPDATES_FOUND = 17

Exit code gext update --dry-run uses to report that updates exist.

A dry run finding nothing exits 0, and finding something raises SystemExit(17) after printing its report, so neither is a failure. Anything else is.

class meta_package_manager.managers.gext.Gext

Bases: PackageManager

Manager of GNOME Shell extensions, from extensions.gnome.org.

Caution

An extension is identified by its UUID (caffeine@patapon.info), which is what the listing reports and what every other operation accepts. The human-readable name printed beside it is decoration and is never a valid argument.

Important

A running GNOME is required, whichever backend is in play. gext talks to GNOME Shell over D-Bus when a session is there and falls back to reading the filesystem otherwise, but even that fallback shells out to gsettings for the enabled-extension list, so a host without GNOME’s schemas fails rather than reporting an empty inventory. mpm leaves the backend choice to gext rather than forcing one, so a desktop session and a plain shell each get the path that works there.

No escalation is ever needed: extensions install under the user’s own data directory.

Initialize cli_errors list.

operation_notes: ClassVar = {'cleanup': 'The tool ships nothing that prunes, so there is no cache to clear.', 'sync': 'The registry is queried per operation, so there is no index to refresh.'}

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 = 'GNOME Shell extensions'

Return package manager’s common name.

Default value is based on class name.

repository_url: str | None = 'https://github.com/essembeh/gnome-extensions-cli'

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.

logo: str | None = 'gnome'

Slug of the brand mark standing for this manager in the documentation.

Names an SVG vendored under docs/assets/managers/, whose provenance and license are recorded in docs/assets/managers/logos.yaml. Inlined at the top of the manager’s page by meta_package_manager._docs; a manager leaving it unset keeps the page’s default package glyph.

Several managers legitimately share one slug, either because they wrap the same upstream (brew and cask) or because the tool has no mark of its own and its ecosystem’s stands in (apt under Debian’s swirl, cargo under Rust’s gear). Documentation-only, like homepage_url: no CLI output reads it.

platforms: frozenset[Platform] | Group | Platform | Iterable[Platform | Group] = frozenset({Platform(id='aix', name='IBM AIX'), 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='cygwin', name='Cygwin'), Platform(id='debian', name='Debian'), Platform(id='dragonfly_bsd', name='DragonFly BSD'), Platform(id='endeavouros', name='EndeavourOS'), Platform(id='exherbo', name='Exherbo Linux'), Platform(id='fedora', name='Fedora'), Platform(id='freebsd', name='FreeBSD'), Platform(id='generic_linux', name='Generic Linux'), Platform(id='gentoo', name='Gentoo Linux'), Platform(id='guix', name='Guix System'), Platform(id='haiku', name='Haiku'), Platform(id='hurd', name='GNU/Hurd'), Platform(id='ibm_powerkvm', name='IBM PowerKVM'), Platform(id='illumos', name='illumos'), 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='midnightbsd', name='MidnightBSD'), Platform(id='netbsd', name='NetBSD'), Platform(id='nixos', name='NixOS'), Platform(id='nobara', name='Nobara'), Platform(id='nutyx', name='NuTyX'), Platform(id='openbsd', name='OpenBSD'), Platform(id='opensuse', name='openSUSE'), Platform(id='openwrt', name='OpenWrt'), Platform(id='oracle', name='Oracle Linux'), Platform(id='os400', name='IBM i'), 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='solaris', name='Solaris'), Platform(id='solus', name='Solus'), Platform(id='sourcemage', name='Source Mage GNU/Linux'), Platform(id='sunos', name='SunOS'), 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.11.0'

The release every format below was captured from.

The parser most likely tolerates the 0.10.x series, whose output is not known to differ, but the floor tracks what was verified rather than what was assumed: the outdated query depends on the dry run’s exit code, which was only observed on this release.

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

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

extra_env: ClassVar = {'NO_COLOR': '1'}

Additional environment variables to add to the current context.

Automatically applied on each meta_package_manager.execution.CLIExecutor.run_cli() calls.

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

Search the version right after the program name.

$ gext --version
gext 0.11.0

property installed: Iterator[Package]

Fetch installed packages.

$ gext list --all
🔵 Dash to Dock (dash-to-dock@micxgx.gmail.com) v92 /user
🔵 Version Free (no-version@example.org)  /user
⚪ Caffeine (caffeine@patapon.info) v58 /user

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

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.

property outdated: Iterator[Package]

Fetch outdated packages.

Important

The dry run exits 17 once it has something to report, so a non-zero exit is the populated answer here and 0 is the empty one. Only a third code means the check itself failed. The entry that failing exit records is discarded, this one being a result rather than an error.

Caution

Only enabled extensions carrying a version are checked, which is gext’s own rule rather than a filter applied here: a disabled extension appears in the inventory above but never in this report.

$ gext update --dry-run
[1] Found extension Caffeine (caffeine@patapon.info) v60 : outdated
[2] Found extension Dash to Dock (dash-to-dock@micxgx.gmail.com) v105 : outdated

📦 Extensions to update:
   caffeine@patapon.info
   dash-to-dock@micxgx.gmail.com

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.

Caution

Search supports neither extended nor exact matching: the registry decides what the query matches, so meta_package_manager.manager.PackageManager.refiltered_search() narrows whatever comes back.

$ gext search caffeine
⚪ [1/6] Caffeine (caffeine@patapon.info)
   link : https://extensions.gnome.org/extension/517/caffeine/
   screenshot : https://extensions.gnome.org/extension-data/screenshots/screenshot_517.png
   creator : eon

Return type:

Iterator[Package]

install(package_id, version=None)

Install one package.

gext picks the release matching the running GNOME Shell on its own, so there is no version to pin.

$ gext install caffeine@patapon.info

Return type:

str

upgrade_all_cli()

Generates the CLI to upgrade all packages.

--yes answers the single confirmation update asks before applying; without it the command blocks on a prompt.

$ gext update --yes

Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)

Generates the CLI to upgrade the package provided as parameter.

Naming an extension restricts the run to it.

$ gext update --yes caffeine@patapon.info

Return type:

tuple[str, ...]

remove(package_id)

Removes a package.

$ gext uninstall caffeine@patapon.info

Return type:

str