meta_package_manager.managers.pear module

meta_package_manager.managers.pear.RELEASE_STATES = ('snapshot', 'devel', 'alpha', 'beta', 'stable')

The quality states a PEAR release can carry.

Source: PEAR_Validate::getValidStates() in PEAR/Validate.php, repeated verbatim in PEAR/Common.php and both REST clients.

The listing parsers key on this vocabulary because it is what separates a package row from the table furniture around it: a row ends on one of these lowercase words, while the PACKAGE VERSION STATE header ends on an uppercase one and the (no packages installed) placeholder on a parenthesis.

class meta_package_manager.managers.pear.PEAR

Bases: PackageManager

The PHP Extension and Application Repository.

PEAR ships with PHP itself and installs libraries into the interpreter’s php_dir, against its own registry at pear.php.net.

Important

Whether an install needs root is a property of the PHP install, not of PEAR: a distribution’s php_dir is /usr/share/php and refuses an ordinary user with Cannot install, php_dir for channel “pear.php.net” is not writable by the current user. Escalate the mutating operations with mpm --sudo, or a [mpm.overrides.pear] sudo = true entry. The privilege-free alternative is relocating the PEAR prefix to a directory you own.

Caution

Every network operation costs one REST round-trip per package, and pear.php.net answers slowly: outdated measured 63 seconds warm and 105 seconds cold against a host carrying only six packages, so it approaches mpm’s 120-second read-only cap on an inventory barely larger. Raise mpm --timeout on a host with more. installed is unaffected, reading the local registry with no network at all.

Initialize cli_errors list.

operation_notes: ClassVar = {'installed': 'Each package is reported under its bare name, so the same name on two channels would collapse onto one entry.', 'search': "Search needs one REST call per package against `pear.php.net` and never completes within `mpm`'s read-only timeout."}

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

Return package manager’s common name.

Default value is based on class name.

homepage_url: str | None = 'https://pear.php.net'

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://pear.php.net/manual/en/guide.users.commandline.cli.php'

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/pear/pear-core'

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.

wikipedia_url: str | None = 'https://en.wikipedia.org/wiki/PEAR'

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.

logo: str | None = 'php'

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

privileged_operations: ClassVar[frozenset[str]] = frozenset({'cleanup', 'install', 'remove', 'sync', 'upgrade', 'upgrade_all'})

Operations with at least one command this manager marks privileged.

Keyed by the Operations member name, like operation_notes. An operation belongs here when a method implementing it passes sudo=True to run_cli() or build_cli(), with the method-to-operation map of METHOD_OPERATIONS. Those commands are the only ones the escalation policy (sudo, else default_sudo) wraps in the escalator. A definition derives the set from the operations it marks sudo = true.

prime_sudo() reads it to prompt only for the managers that escalate a command of the current run. With [mpm.overrides.gem] sudo = true, mpm sync asks for no password: the gem sources --update command of sync carries no marker. test_privileged_operations holds the set to the markers in the method bodies.

requirement: str | None = '>=1.10.0'

The series every current distribution ships, and the one upstream still releases from (1.10.18, 2026-01-25).

A conservative floor rather than a feature bisect: every verb driven here is older, the bare upgrade delegation to doUpgradeAll being present already in 1.9.5.

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

pear --version is rejected as Command '--version' is not valid, so the version comes from the version verb instead.

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

$ pear version
PEAR Version: 1.10.16
PHP Version: 8.4.24
Zend Engine Version: 4.4.24
Running on: Linux debian 6.12.94+deb13-arm64 #1 SMP Debian 6.12.94-1 (2026-06-20) aarch64

property installed: Iterator[Package]

Fetch installed packages.

--allchannels is not optional: a bare pear list reports the default channel alone and silently omits everything installed from any other. The listing is a section per channel, and the parser keeps only the rows closing on a release state.

$ pear list --allchannels
INSTALLED PACKAGES, CHANNEL __URI:
==================================
(no packages installed)

INSTALLED PACKAGES, CHANNEL DOC.PHP.NET:
========================================
(no packages installed)

INSTALLED PACKAGES, CHANNEL PEAR.PHP.NET:
=========================================
PACKAGE          VERSION STATE
Archive_Tar      1.5.0   stable
Console_Getopt   1.4.3   stable
PEAR             1.10.16 stable
PEAR_Manpages    1.10.0  stable
Structures_Graph 1.2.0   stable
XML_Util         1.4.5   stable

INSTALLED PACKAGES, CHANNEL PECL.PHP.NET:
=========================================
(no packages installed)

property outdated: Iterator[Package]

Fetch outdated packages.

list-upgrades walks every registered channel on its own, so it takes no --allchannels. Each version column carries its release state in parentheses, which is what tells a package row from the header above it.

$ pear list-upgrades
PEAR.PHP.NET AVAILABLE UPGRADES (STABLE):
=========================================
CHANNEL      PACKAGE     LOCAL            REMOTE           SIZE
pear.php.net Archive_Tar 1.5.0 (stable)   1.6.0 (stable)   22kB
pear.php.net PEAR        1.10.16 (stable) 1.10.18 (stable) 288kB

install(package_id, version=None)

Install one package.

A version is appended to the name with a dash, the Package-1.1 form PEAR’s own install help documents. PEAR package names use underscores, so the dash never collides with one.

$ pear install Text_Password
downloading Text_Password-1.2.1.tgz ...
Starting to download Text_Password-1.2.1.tgz (5,631 bytes)
.....done: 5,631 bytes
install ok: channel://pear.php.net/Text_Password-1.2.1

$ pear install Text_Password-1.2.1
Starting to download Text_Password-1.2.1.tgz (5,631 bytes)
.....done: 5,631 bytes
install ok: channel://pear.php.net/Text_Password-1.2.1

Return type:

str

upgrade_all_cli()

Generates the CLI to upgrade all outdated packages.

upgrade with no package named is the documented spelling: the separate upgrade-all verb still exists but announces itself as deprecated in favour of this one, and both land on the same doUpgradeAll handler.

Caution

PEAR is itself a PEAR package, so an upgrade of everything replaces the tool along with the libraries it manages.

$ pear upgrade

Return type:

tuple[str, ...]

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

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

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 the provided package.

$ pear upgrade Text_Password

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.

remove(package_id)

Remove one package.

$ pear uninstall Text_Password
uninstall ok: channel://pear.php.net/Text_Password-1.2.1

Return type:

str

sync()

Sync package metadata.

Refreshes the definition of every registered channel. A channel whose server answers badly is reported and stepped over, the run still exiting 0.

$ pear update-channels
Updating channel "doc.php.net"
Error: Unable to create XML parser
Invalid channel.xml file
Updating channel "pear.php.net"
Channel "pear.php.net" is up to date
Updating channel "pecl.php.net"
Update of Channel "pecl.php.net" succeeded

Return type:

None

cleanup_cache()

Clear the cached REST responses.

$ pear clear-cache
reading directory /tmp/pear/cache
100 cache entries cleared

Return type:

None