Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update fs mode to use --key-path CLI switch / key_path API argument #670

Merged
merged 9 commits into from
Dec 10, 2024
Merged

Update fs mode to use --key-path CLI switch / key_path API argument #670

merged 9 commits into from
Dec 10, 2024

Conversation

maddenp-noaa
Copy link
Collaborator

@maddenp-noaa maddenp-noaa commented Dec 9, 2024 •
edited
Loading

Synopsis

Fixes #668.

  • In fs mode/actions, replace position key-path arguments on CLI with an explicit --key-path argument, consistent with other modes.
  • Updated typing to accept YAML immutable types -- bool, float, int, str -- as key-path values, to support a wider variety of user configs.
  • Updated docs to exercise --key-path CLI argument.
  • Updated fs notebook to exercise key_path API argument.

Type

  • Code maintenance (refactoring, etc. without behavior change)
  • Documentation

Impact

  • This is a breaking change (changes existing functionality)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.

@maddenp-noaa maddenp-noaa self-assigned this Dec 9, 2024
maddenp-noaa
maddenp-noaa commented Dec 9, 2024
View reviewed changes
docs/sections/user_guide/cli/drivers/cdeps/run-help.out Show resolved Hide resolved
docs/sections/user_guide/cli/tools/fs/copy-exec-no-target-dir-err.cmd Show resolved Hide resolved
src/uwtools/cli.py Show resolved Hide resolved
src/uwtools/config/support.py Show resolved Hide resolved
src/uwtools/config/tools.py Show resolved Hide resolved
src/uwtools/fs.py Show resolved Hide resolved
src/uwtools/tests/config/test_tools.py Show resolved Hide resolved
@maddenp-noaa maddenp-noaa marked this pull request as ready for review December 9, 2024 22:15
christinaholtNOAA
christinaholtNOAA approved these changes Dec 9, 2024
View reviewed changes
Copy link
Collaborator

@christinaholtNOAA christinaholtNOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

notebooks/fs.ipynb Show resolved Hide resolved
@maddenp-noaa maddenp-noaa merged commit a95fa0b into ufs-community:main Dec 10, 2024
2 checks passed
@maddenp-noaa maddenp-noaa deleted the gh-668-fs-mode-key-path branch December 10, 2024 01:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaholtNOAA christinaholtNOAA christinaholtNOAA approved these changes

@Byrnetp Byrnetp Awaiting requested review from Byrnetp Byrnetp is a code owner

@NaureenBharwaniNOAA NaureenBharwaniNOAA Awaiting requested review from NaureenBharwaniNOAA NaureenBharwaniNOAA is a code owner

@elcarpenterNOAA elcarpenterNOAA Awaiting requested review from elcarpenterNOAA elcarpenterNOAA is a code owner

Assignees

@maddenp-noaa maddenp-noaa

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

In fs mode, replace KEY positional arguments with --key-path
2 participants
@maddenp-noaa @christinaholtNOAA