meta_package_manager.managers.spack module¶
- class meta_package_manager.managers.spack.Spack[source]¶
Bases:
PackageManagerSpack, the package manager built for supercomputers and HPC clusters.
A package is a spec: a package name carrying a version, a compiler, a target architecture and a set of build options, each combination installed into a prefix of its own. mpm keys a package on its id alone, so the spec is reduced to the name every verb accepts back.
Note
Holding several builds of one package at once is Spack’s whole purpose, so the inventory repeats a name as many times as the host has builds of it. That reduction to one entry per id is what makes this a class rather than a bundled definition, the same case
luarocksandvagrantanswer.Reducing on the version alone is a deliberate loss: two builds of the same version differing only in compiler or build options collapse into one entry, which mpm has no way to tell apart and no verb to address separately.
Caution
--no-envis load-bearing, and silently so. Spack scopes every command to the active environment, which the user activates withspack env activateor by exportingSPACK_ENV, and an environment is a project, not the machine. With one active,spack findreports that environment’s contents: a host holding four installed packages reports none at all, an empty answer indistinguishable from an empty machine. Worse, anSPACK_ENVleft pointing at a deleted environment makes the command fail outright with Error: no environment in ….The flag is a global one, placed before the subcommand, which is why it is declared as
pre_argsrather than repeated per operation. Note that-Eis not a portable shorthand for it:spack gcbinds its own-Eto--except-any-environment, so the long form is the only spelling that means the same thing everywhere. The version probe skipspre_argsentirely and so runs bare.haxelibforces--globalandluarocks--no-projectagainst the same hazard.Note
The inventory is a projection rather than the default display.
spack findnormally groups its output under-- darwin-tahoe-m1 / %c=apple-clang@21.0.0banners whose text depends on the host’s architecture and compilers, while--formatprints the requested fields alone.gcloudreaches for the same escape.Note
Every spec Spack’s database holds is reported, which is broader than what Spack built. Packages pulled in as build dependencies appear, matching the
racoreading that an inventory hiding what was installed on the user’s behalf is the wrong answer, and so do externals: the system compiler Spack registers on first use is listed asapple-clang, since Spack tracks it as installed and its own garbage collector removes it. No flag separates them out.Warning
Spack has no
outdatedand no upgrade verb, and neither is faked. Installing a package that is already present adds a second build rather than replacing the first, which is the point of the tool, so wiringupgradetoinstallwould leave the old build in place while reporting success. Reclaiming the superseded build is whatcleanup --orphansdoes.Warning
A read bootstraps the host on first use. Since Spack 1.0 the package recipes live in spack/spack-packages rather than in Spack itself, and upstream states Spack “clones the package repository automatically when you first run”, so an inventory or a search on a fresh install fetches some twenty thousand objects into
~/.spackbefore answering.ollamastarting a daemon from a listing is the same shape, smaller.Documentation: Spack documentation.
Initialize
cli_errorslist.- homepage_url: str | None = 'https://spack.io'¶
Home page of the project, only used in documentation for reference.
- 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='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='macos', name='macOS'), 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='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='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
frozensetofPlatforminstances at instantiation.
- requirement: str | None = '>=1.0.0'¶
The release that moved the package recipes into a repository of their own, giving them a lifecycle Spack can refresh and
spack repo updatesomething to update.
- pre_args: tuple[str, ...] = ('--no-env',)¶
Ignore whichever environment the user has activated, so every operation answers for the machine rather than for a project.
- property installed: Iterator[Package]¶
Fetch installed packages.
$ spack --no-env find --format {name}@{version} [email protected] [email protected] [email protected] [email protected] [email protected]
- search(query, extended, exact)[source]¶
Fetch matching packages.
Spack matches a query as a substring of the package name, and
--search-descriptionwidens that to the recipes’ descriptions, which is the extended search. There is no way to narrow it to an exact name, so mpm filters exact matches itself.$ spack --no-env list --format version_json zlib-ng [ {"name": "zlib-ng", "latest_version": "2.3.3", "versions": ["2.3.3", "2.3.2", "2.2.5", "2.2.4", "2.2.3", "2.2.2", "2.2.1", "2.1.7", "2.1.6", "2.1.5", "2.1.4", "2.0.7", "2.0.0"], "homepage": "https://github.com/zlib-ng/zlib-ng", "file": "https://github.com/spack/spack-packages/blob/develop/repos/spack_repo/builtin/packages/zlib_ng/package.py", "maintainers": ["haampie"], "dependencies": {"build": ["gnuconfig", "cxx", "gmake", "ninja", "c", "cmake"], "link": [], "run": [], "test": []}} ]
- install(package_id, version=None)[source]¶
Install one package.
A version is pinned by appending it to the name after an
@, which is Spack’s own spec syntax rather than a separate argument.$ spack --no-env install [email protected] [ ] 3iyb7mz [email protected] staging (0s) [ ] 3iyb7mz [email protected] edit (0s) [ ] 3iyb7mz [email protected] build (1s) [ ] 3iyb7mz [email protected] install (2s) [+] 3iyb7mz [email protected] /opt/homebrew/Cellar/spack/1.2.2/opt/spack/darwin-m1/zlib-1.3.1-3iyb7mzv7ij3w2o43t4nb2pq25az6pt7 (2s)
- Return type:
- remove(package_id)[source]¶
Remove one package.
--allis load-bearing rather than a convenience. Naming a package that the host holds more than one build of is refused outright, with Error: zlib matches multiple packages, so without the flag a removal fails on exactly the hosts Spack exists to serve.$ spack --no-env uninstall --yes-to-all --all zlib ==> Successfully uninstalled [email protected]+optimize+pic+shared build_system=makefile platform=darwin os=tahoe target=m1/3iyb7mz ==> Successfully uninstalled [email protected]+optimize+pic+shared build_system=makefile platform=darwin os=tahoe target=m1/7ib3y53
- Return type:
- cli_names: tuple[str, ...] = ('spack',)¶
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
pythonorpython3.
By default, this property’s value is derived from the manager’s ID (see the
MetaPackageManager.__init__method above).
- id: str = 'spack'¶
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.
- sync()[source]¶
Sync package metadata.
Pulls the package repository Spack clones on first use, which is where every recipe now lives.
$ spack --no-env repo update ==> builtin: Already up to date.
- Return type:
- 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_orphan()[source]¶
Remove every spec nothing depends on any more.
Reclaims the build dependencies an install pulled in, and the builds a later install superseded. Explicitly installed packages are kept.
$ spack --no-env gc --yes-to-all ==> Successfully uninstalled [email protected]~guile build_system=generic platform=darwin os=tahoe target=m1/x7otsag ==> Successfully uninstalled [email protected] build_system=bundle platform=darwin os=tahoe target=aarch64/ti7wjie ==> Successfully uninstalled [email protected] build_system=generic platform=darwin os=tahoe target=m1/2eppidz
- Return type:
- cleanup_cache()[source]¶
Scrub the build stages, downloads and caches.
Bootstrap software is deliberately left alone:
--bootstrapwould remove the concretizer Spack needs before it can resolve anything, so the next operation would have to fetch it again.$ spack --no-env clean --downloads --misc-cache --python-cache --stage ==> Removing all temporary build stages ==> Removing cached downloads ==> Removing cached information on repositories ==> Removing python cache files
- Return type: