Add --show-schema support to drivers #588
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maddenp-noaa
commented
Aug 22, 2024
maddenp-noaa
requested review from
NaureenBharwaniNOAA and
christinaholtNOAA
as code owners
maddenp-noaa
requested review from
elcarpenterNOAA,
fgabelmannjr and
WeirAE
as code owners
NaureenBharwaniNOAA
approved these changes
Aug 23, 2024
christinaholtNOAA
approved these changes
Aug 23, 2024
I hadn't even thought of that use case -- great insight! Our prototype YAML files show some of the config options, but the schema tells much more of the story. We've discussed the tradeoff between strict/complete schemas for e.g. namelist content and more permissive ones, and I think this use case lends even more weight to the script/complete argument, in that a schema with more information is a better guide to figuring out what one's options are. |
Byrnetp
added a commit
that referenced
this pull request
Sep 3, 2024
* update_values() -> update_from() (#578) * DRY out Driver._validate() (#579) * Move execute() to its own API namespace, disambiguate (#580) * Config classes to API (#582) * Simplify unknown-extension error message (#584) * UW-657 fs makedirs (#572) * Docstring cleanup (#585) * GH 586 bad stdin_ok prompt (#587) * Fix issue with creating a metatask dep. (#589) The rocoto schema is set up to allow metataskdep entries in the YAML, but the logic was not included in the tool to handle them. This addition fixes that. * Add --show-schema support to drivers (#588) * add file system notebook, unit tests, binder links * Add missing newlines * Add a table of contents * Makefile and .gitignore changes from review * Apply suggestions from code review Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com> * Apply review suggestions to all sections of the notebook * Specific rmtree() targeting and output cell test update * Apply suggestions from code review Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com> --------- Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com> Co-authored-by: Christina Holt <56881914+christinaholtNOAA@users.noreply.github.com>
Byrnetp
added a commit
that referenced
this pull request
Oct 17, 2024
* update_values() -> update_from() (#578) * DRY out Driver._validate() (#579) * Move execute() to its own API namespace, disambiguate (#580) * Config classes to API (#582) * Simplify unknown-extension error message (#584) * UW-657 fs makedirs (#572) * Docstring cleanup (#585) * GH 586 bad stdin_ok prompt (#587) * Fix issue with creating a metatask dep. (#589) The rocoto schema is set up to allow metataskdep entries in the YAML, but the logic was not included in the tool to handle them. This addition fixes that. * Add --show-schema support to drivers (#588) * Config notebook p2 and example notebook removal * removing merge diff text * pin python version for RtD * improvements from code review * add config.compare() format mismatch example * Remove typo Co-authored-by: Emily Carpenter <137525341+elcarpenterNOAA@users.noreply.github.com> --------- Co-authored-by: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com> Co-authored-by: Christina Holt <56881914+christinaholtNOAA@users.noreply.github.com> Co-authored-by: Emily Carpenter <137525341+elcarpenterNOAA@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Synopsis
Add
--show-schemaflag to UW drivers to dump tostdouta dereferenced form of a built-in driver's built-in schema. Here, "dereferenced" means that$refreferences pointing tourn:uwtools:*URIs have been replaced by the schema content they refer to, so that the schema shown is standalone and complete.Don't Panic: Several small, repeated changes to code and docs constitute the bulk of the PR.
Type
Impact
Checklist