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.

Note

GNOME ships an official gnome-extensions tool, which is deliberately not what this wraps. That one installs from a local bundle and never reaches the extension registry, has no search, and offers no upgrade verb at all; its list --updates filters on a boolean carrying no available version, so it could not report an outdated package even in principle. gext reaches the registry, and every operation below rests on that.

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.

Warning

The inventory forces --all. Left off, gext list reports only the enabled extensions, silently omitting every installed-but-disabled one: that is the tool’s own default and it would make the inventory a lie rather than a shorter list.

No sync: the registry is queried per operation and there is no index to refresh. No cleanup: nothing prunes anything.

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

Documentation: gnome-extensions-cli.

Initialize cli_errors list.

name: str = 'GNOME Shell extensions'

Return package manager’s common name.

Default value is based on class name.

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

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

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='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='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='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 dry run’s exit code in particular is load-bearing here and 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 ([email protected]) v92 /user
🔵 Version Free ([email protected])  /user
⚪ Caffeine ([email protected]) v58 /user

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 ([email protected]) v60 : outdated
[2] Found extension Dash to Dock ([email protected]) v105 : outdated

📦 Extensions to update:
   [email protected]
   [email protected]

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.

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

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 genuinely restricts the run to it.

$ gext update --yes [email protected]

Return type:

tuple[str, ...]

remove(package_id)

Removes a package.

$ gext uninstall [email protected]

Return type:

str