meta_package_manager.managers.flatpak module¶

class meta_package_manager.managers.flatpak.Flatpak[source]¶

Bases: PackageManager

Flatpak manages sandboxed desktop applications pulled from remotes like Flathub.

mpm covers applications only: every listing passes --app, so runtimes and SDKs stay out of scope. Listings are requested with --columns=name,application,version --ostree-verbose and parsed as tab-separated rows.

Note

All operations target the system-wide scope except cleanup which only repairs the user installation. Per-scope targeting (system vs user) is tracked in #1725.

Note

Escalation is polkit’s job, so no operation is marked sudo: flatpak hands system-scope mutations to its privileged system helper over D-Bus, which authorizes them through polkit (Flathub documents plain flatpak install). Under a strict polkit policy, unattended mutations need a rule permitting them without interactive authentication.

Caution

outdated reads each pending update’s latest version from remote-ls --updates, then runs one flatpak info per package to recover its installed version: a follow-up CLI call for every outdated app.

Note

A --brewfile dump emits the bare flatpak "id" form, mpm capturing no origin remote per app. See Snapshot and export, section “Flatpak remote”.

Initialize cli_errors list.

homepage_url: str | None = 'https://flatpak.org'¶

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

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.

brewfile_entry_type: ClassVar[str | None] = 'flatpak'¶

Mapped to Homebrew Bundle’s flatpak extension.

Its with: ["remote"] keyword goes unused, installed() capturing no origin remote to fill it with. See Snapshot and export, section “Flatpak remote”.

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 = '>=1.2.0'¶

Version requirement specifier.

Supports a comma-separated range of constraints (e.g. ">=1.20.0,<2.0.0"). A bare version string like "1.20.0" is treated as >=1.20.0.

Parsed by meta_package_manager.version.VersionRange.

Defaults to None, which deactivates version check entirely.

version_regexes: tuple[str, ...] = ('Flatpak\\s+(?P<version>\\S+)',)¶
$ flatpak --version
Flatpak 1.4.2
property installed: Iterator[Package]¶

Fetch installed packages.

$ flatpak list --app --columns=name,application,version         > --ostree-verbose
Peek    com.uploadedlobster.peek        1.3.1
Fragments       de.haeckerfelix.Fragments       1.4
GNOME MPV       io.github.GnomeMpv      0.16
Syncthing GTK   me.kozec.syncthingtk    v0.9.4.3
Builder org.flatpak.Builder
property outdated: Iterator[Package]¶

Fetch outdated packages.

$ flatpak remote-ls --app --updates --columns=name,application,version             --ostree-verbose
GNOME Dictionary        org.gnome.Dictionary    3.26.0
Files   org.gnome.Nautilus      42.2
release_date(package_id)[source]¶

Publication timestamp of the latest build of an app, read off its remote.

The date is the ostree commit timestamp of the newest commit on the app’s branch, reported by flatpak remote-info and rendered in UTC with a literal +0000 offset whatever the host locale. The remote’s build service stamps it at publication (Flathub’s buildbot for the flathub remote), so the app’s author cannot backdate it, which is what makes it a sound cooldown clock. On a third-party remote the publisher stamps it instead: the probe is then only as trustworthy as the remote itself, exactly like the packages it serves.

The probe resolves the remote to interrogate from the installed app’s origin, and falls back to trying every configured remote for an app not installed yet (an install gated before its first installation). On a host with several remotes, that fallback logs one error per remote not serving the app.

$ flatpak remote-info --ostree-verbose flathub org.gnome.Dictionary

GNOME Dictionary - Check word definitions and spellings

        ID: org.gnome.Dictionary
       Ref: app/org.gnome.Dictionary/x86_64/stable
      Arch: x86_64
    Branch: stable
Collection: org.flathub.Stable
  Download: 1.3 MB
 Installed: 5.3 MB
   Runtime: org.gnome.Platform/x86_64/3.38
       Sdk: org.gnome.Sdk/x86_64/3.38
    Commit: 5697aaea8f6a55b02c34e77504cbe4e419257b482ec7cba434255f5bd6f4
   Subject: Export org.gnome.Dictionary
      Date: 2020-12-08 12:00:26 +0000
Return type:

datetime | None

search(query, extended, exact)[source]¶

Fetch matching packages.

Caution

Search does not support extended or exact matching. So we return the best subset of results and let meta_package_manager.manager.PackageManager.refiltered_search() refine them.

$ flatpak search gitg --ostree-verbose
gitg    GUI for git        org.gnome.gitg  3.32.1  stable  flathub
Return type:

Iterator[Package]

install(package_id, version=None)[source]¶

Install one package.

$ flatpak install --noninteractive org.gnome.Dictionary
Return type:

str

upgrade_all_cli()[source]¶

Generates the CLI to upgrade all outdated packages.

$ flatpak update --noninteractive
Return type:

tuple[str, ...]

upgrade_one_cli(package_id, version=None)[source]¶

Generates the CLI to upgrade the provided package.

$ flatpak update --noninteractive org.gnome.Dictionary
Return type:

tuple[str, ...]

remove(package_id)[source]¶

Remove one package.

$ flatpak uninstall --noninteractive org.gnome.Dictionary
Return type:

str

cleanup_orphan()[source]¶

Uninstall runtimes and extensions no longer used by any installed app.

$ flatpak uninstall --unused --noninteractive
Return type:

None

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

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 = 'flatpak'¶

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.

name: str = 'Flatpak'¶

Return package manager’s common name.

Default value is based on class name.

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.

cleanup_repair()[source]¶

Verify and repair the per-user installation.

See the flatpak repair reference.

$ flatpak repair --user
Return type:

None

doctor_cli()[source]¶

Generates the CLI running the native self-diagnosis.

The read-only twin of cleanup_repair(): --dry-run reports what a repair of the per-user installation would fix without touching it.

$ flatpak repair --user --dry-run
Return type:

tuple[str, ...]