New subcommand `spack config scopes [-hips]` by greenc-FNAL · Pull Request #41455 · spack/spack

greenc-FNAL · 2023-12-06T14:23:27Z

List the scopes available in the current environment in descending priority order.

With -p|--path-scopes, list only writable, file-based scopes (ignoring command_line and _builtin).
With -i|--included, list only included scopes (specified in include.yaml or an environment include: clause).
With -s|--show-paths, annotate scopes with their directory or file (with non-option argument section) locations when appropriate.
Automatically takes account of SPACK_DISABLE_LOCAL_CONFIG=true

Useful for understanding the best scope in which to put a particular specific configuration item, or for debugging "missing" config.

Examples

MacOS:

$ spack arch
darwin-sequoia-m1
$ spack config scopes
command_line user site system defaults defaults:darwin defaults:base _builtin

Linux:

$ spack arch
linux-almalinux9-cascadelake
$ spack config scopes
command_line user site system defaults defaults:linux defaults:base _builtin
$ SPACK_DISABLE_LOCAL_CONFIG=1 spack config scopes
command_line site defaults defaults:linux defaults:base _builtin
$ SPACK_DISABLE_LOCAL_CONFIG=1 spack config --scope=site scopes --path-scopes
site defaults defaults:linux defaults:base
$ SPACK_DISABLE_LOCAL_CONFIG=1 spack config --scope=site scopes --included
defaults:linux defaults:base
$ SPACK_DISABLE_LOCAL_CONFIG=1 spack config --scope=site scopes --included --show-paths
defaults:linux (/home/greenc/work/cet-is/sources/Spack/spack/run/etc/spack/defaults/linux/) defaults:base (/home/greenc/work/cet-is/sources/Spack/spack/run/etc/spack/defaults/base/)
$ SPACK_DISABLE_LOCAL_CONFIG=1 spack config --scope=site scopes modules
command_line site (/home/greenc/work/cet-is/sources/Spack/spack/run/etc/spack/) defaults (/home/greenc/work/cet-is/sources/Spack/spack/run/etc/spack/defaults/modules.yaml) defaults:linux (/home/greenc/work/cetis/sources/Spack/spack/run/etc/spack/defaults/linux/modules.yaml) defaults:base (/home/greenc/work/cet-is/sources/Spack/spack/run/etc/spack/defaults/base/) builtin

greenc-FNAL · 2025-03-24T20:04:31Z

@tldahlgren I have (I believe) brought this PR up to date in the light of #48784. I'd be grateful if you could help me get this merged, please.

Merge from upstream, replacing arch config scopes with spack#48784 and updating `spack config list-scopes` to match spack#41455.

tldahlgren

LGTM. I have a couple of questions. One is about the mutual exclusion of the options. The other is have you confirmed the outputs in the description are up-to-date?

lib/spack/spack/cmd/config.py

lib/spack/spack/test/cmd/config.py

greenc-FNAL · 2025-03-24T21:58:00Z

LGTM. I have a couple of questions. One is about the mutual exclusion of the options. The other is have you confirmed the outputs in the description are up-to-date?

Looking into removing mutual exclusion, and I have updated the description.

lib/spack/spack/cmd/config.py

lib/spack/spack/test/cmd/config.py

greenc-FNAL · 2025-03-26T14:24:32Z

@tldahlgren I think I've addressed your comments, but if you have any tips on how to test either the inclusion/exclusion of platform scopes, or --included, I'd appreciate it.

lib/spack/spack/cmd/config.py

greenc-FNAL · 2025-05-22T13:24:23Z

This will need to be adjusted when platform scopes go away with #50603.

greenc-FNAL · 2025-05-22T13:25:51Z

Also @tldahlgren @tgamblin Any chance this can be in 1.0? I think this would complement #50603 nicely.

Per spack#41455 (comment).

* Improve help text for `spack config scopes` * New option `--show-paths|-s` to show paths where scopes have them * Add shortcut `-i` to `--include` * Add non-option argument to specify section for which to show paths * `--path` -> `--path-scopes` to avoid confusion with `--show-paths`

Fix style

greenc-FNAL · 2025-05-28T19:16:48Z

@tldahlgren pending your re-review, and Gitlab getting around to running the CI pipeline, I think this is ready to go.

greenc-FNAL · 2025-05-28T20:50:30Z

@spackbot run pipeline

spackbot-app · 2025-05-28T20:50:33Z

I'm sorry, gitlab does not have your latest revision yet, I can't run that pipeline for you right now.

One likely possibility is that your PR pipeline has been temporarily deferred, in which case, it is awaiting a develop pipeline, and will be run when that finishes.

Please check the gitlab commit status message to see if more information is available.

Details

pr head: d590a35, gitlab commit parents: ['7bca5ed', '5f0cf46']

tldahlgren

LGTM.

@tldahlgren

* New command list-scopes [--file] [--non-platform] - Add missing `_non_platform_scopes()` - Update shell completion scripts - Scope is "defaults," not, "default." - Reorder tests to look for OS-dependent test hysteresis - Disable output suppression for pipeline failure diagnosis - Remove problematic test criteria - `defaults` apparently not available in test environment * `--file` and `--non-platform` are no longer mutually-exclusive * Add `-f` alias for `--file` option * Remove test dependence on external shell environment * Add tests for platform-specific scopes * Add test for `--file --non-platform` * Update shell completion files * Fix key error in test * Use test platform in tests * Remove faulty list-scopes assertions * New `list-scopes` option `--included` * Update command completion * Remove non-working test code * `list-scopes` -> `scopes` Per spack#41455 (comment). * Remove `--non-platform` in antipication of spack#50603 * file -> path * Rationalize options and add ability to specify sections * Improve help text for `spack config scopes` * New option `--show-paths|-s` to show paths where scopes have the * Add shortcut `-i` to `--include` * Add non-option argument to specify section for which to show paths * `--path` -> `--path-scopes` to avoid confusion with `--show-paths` * Remove unhelpful type hint * Per @tldahlgren review * Improve tests per @tldahlgren suggestions * Attempt to accommodate Windows™ * Non-option argument `<section>` implies `-s|--show-paths`

@tldahlgren

* New command list-scopes [--file] [--non-platform] - Add missing `_non_platform_scopes()` - Update shell completion scripts - Scope is "defaults," not, "default." - Reorder tests to look for OS-dependent test hysteresis - Disable output suppression for pipeline failure diagnosis - Remove problematic test criteria - `defaults` apparently not available in test environment * `--file` and `--non-platform` are no longer mutually-exclusive * Add `-f` alias for `--file` option * Remove test dependence on external shell environment * Add tests for platform-specific scopes * Add test for `--file --non-platform` * Update shell completion files * Fix key error in test * Use test platform in tests * Remove faulty list-scopes assertions * New `list-scopes` option `--included` * Update command completion * Remove non-working test code * `list-scopes` -> `scopes` Per spack#41455 (comment). * Remove `--non-platform` in antipication of spack#50603 * file -> path * Rationalize options and add ability to specify sections * Improve help text for `spack config scopes` * New option `--show-paths|-s` to show paths where scopes have the * Add shortcut `-i` to `--include` * Add non-option argument to specify section for which to show paths * `--path` -> `--path-scopes` to avoid confusion with `--show-paths` * Remove unhelpful type hint * Per @tldahlgren review * Improve tests per @tldahlgren suggestions * Attempt to accommodate Windows™ * Non-option argument `<section>` implies `-s|--show-paths`

spackbot-app bot added commands core PR affects Spack core functionality tests General test capability(ies) shell-support labels Dec 6, 2023

greenc-FNAL changed the title ~~New command list-scopes [--file] [--non-platform]~~ New command list-scopes [--file|--non-platform] Dec 7, 2023

greenc-FNAL force-pushed the feature/config-list-scopes branch from 5b5404c to 579abf3 Compare December 7, 2023 22:37

greenc-FNAL requested review from scheibelp and tldahlgren December 12, 2023 14:26

greenc-FNAL force-pushed the feature/config-list-scopes branch from 8878c18 to 5cadea7 Compare March 26, 2024 20:07

greenc-FNAL force-pushed the feature/config-list-scopes branch from 5cadea7 to aea4597 Compare March 24, 2025 20:00

greenc-FNAL added a commit to FNALssi/spack that referenced this pull request Mar 24, 2025

Bring config list-scopes tests into line with spack#41455

ed4c4da

greenc-FNAL mentioned this pull request Mar 24, 2025

Merge from upstream, replacing arch config scopes with #48784 FNALssi/spack#523

Merged

greenc-FNAL added a commit to FNALssi/spack that referenced this pull request Mar 24, 2025

Merge from upstream as at 2025-04-23

0326f53

Merge from upstream, replacing arch config scopes with spack#48784 and updating `spack config list-scopes` to match spack#41455.

tldahlgren reviewed Mar 24, 2025

View reviewed changes

lib/spack/spack/cmd/config.py Outdated Show resolved Hide resolved

tldahlgren self-assigned this Mar 24, 2025

tldahlgren changed the title ~~New command list-scopes [--file|--non-platform]~~ New subcommand list-scopes [--file|--non-platform] Mar 24, 2025

tldahlgren reviewed Mar 24, 2025

View reviewed changes

lib/spack/spack/test/cmd/config.py Outdated Show resolved Hide resolved

tldahlgren requested changes Mar 24, 2025

View reviewed changes

lib/spack/spack/cmd/config.py Outdated Show resolved Hide resolved

tldahlgren reviewed Mar 24, 2025

View reviewed changes

lib/spack/spack/test/cmd/config.py Outdated Show resolved Hide resolved

lib/spack/spack/test/cmd/config.py Outdated Show resolved Hide resolved

greenc-FNAL force-pushed the feature/config-list-scopes branch from ec20835 to 2fbcb66 Compare March 26, 2025 14:22

greenc-FNAL force-pushed the feature/config-list-scopes branch from 2fbcb66 to 2195805 Compare March 26, 2025 14:48

greenc-FNAL force-pushed the feature/config-list-scopes branch 2 times, most recently from 56af9d9 to 2a1bfda Compare May 21, 2025 20:22

tldahlgren reviewed May 21, 2025

View reviewed changes

lib/spack/spack/cmd/config.py Outdated Show resolved Hide resolved

greenc-FNAL added a commit to greenc-FNAL/spack that referenced this pull request May 22, 2025

list-scopes -> scopes

ad2218f

Per spack#41455 (comment).

greenc-FNAL added 15 commits May 28, 2025 08:59

Add test for --file --non-platform

3754f62

Update shell completion files

ef1a3b1

Fix key error in test

0afc636

Use test platform in tests

177b5dd

Remove faulty list-scopes assertions

7203f04

New list-scopes option --included

be0e503

Update command completion

6f19859

Remove non-working test code

ab40d71

list-scopes -> scopes

99a24b7

Per spack#41455 (comment).

Remove --non-platform in antipication of spack#50603

304dec6

file -> path

712cc25

Remove unhelpful type hint

d01fede

Per @tldahlgren review

e6bf68a

Fix style

Improve tests per @tldahlgren suggestions

51d744a

greenc-FNAL force-pushed the feature/config-list-scopes branch from 5f0cf46 to 51d744a Compare May 28, 2025 15:43

Attempt to accommodate Windows™

8237da1

greenc-FNAL force-pushed the feature/config-list-scopes branch from 740b1ed to 8237da1 Compare May 28, 2025 16:46

Non-option argument <section> implies -s|--show-paths

d590a35

greenc-FNAL requested a review from tldahlgren May 28, 2025 19:15

greenc-FNAL added the pipelines:urgent Skip "deferred pipelines" check. Only use if rebasing on a tested develop commit is unfeasible label May 28, 2025

tldahlgren approved these changes May 28, 2025

View reviewed changes

tldahlgren changed the title ~~New subcommand spack config scopes [--included][--path-scopes][--show-paths]~~ New subcommand spack config scopes [-hips] May 28, 2025

tldahlgren merged commit 2c567ed into spack:develop May 28, 2025
36 checks passed

greenc-FNAL mentioned this pull request Jun 2, 2025

Back-port platform scope removal and spack config scopes from upstream develop FNALssi/spack#554

Merged

Conversation

greenc-FNAL commented Dec 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examples

Uh oh!

greenc-FNAL commented Mar 24, 2025

Uh oh!

tldahlgren left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

greenc-FNAL commented Mar 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greenc-FNAL commented Mar 26, 2025

Uh oh!

Uh oh!

greenc-FNAL commented May 22, 2025

Uh oh!

greenc-FNAL commented May 22, 2025

Uh oh!

greenc-FNAL commented May 28, 2025

Uh oh!

greenc-FNAL commented May 28, 2025

Uh oh!

spackbot-app bot commented May 28, 2025

Uh oh!

tldahlgren left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

greenc-FNAL commented Dec 6, 2023 •

edited

Loading