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.

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

Move execute() to its own API namespace, disambiguate #580

Merged
merged 6 commits into from
Aug 19, 2024

Conversation

maddenp-noaa
Copy link
Contributor

Synopsis

  1. Move execute(), graph(), and tasks() from uwtools.api.driver to a new uwtools.api.execute, to correspond better to the CLI mode name, making it easier for users to find the API docs.
  2. Rename execute() in uwtools.utils.processing to shellcmd() to help disambiguate the term "execute".

This modifies the API and so is a breaking change.

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.

Copy link
Contributor

@elcarpenterNOAA elcarpenterNOAA left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Contributor

@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.

I'm so sorry....

If you hate it, leave it. This one is internal like we've already discussed, so not as big a deal.

src/uwtools/drivers/driver.py Outdated Show resolved Hide resolved
Copy link
Contributor

@WeirAE WeirAE left a comment

Choose a reason for hiding this comment

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

A necessary step!

@maddenp-noaa maddenp-noaa merged commit edc3b83 into ufs-community:main Aug 19, 2024
2 checks passed
@maddenp-noaa maddenp-noaa deleted the move-execute branch August 19, 2024 14:22
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 <[email protected]>

* 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 <[email protected]>

---------

Co-authored-by: Paul Madden <[email protected]>
Co-authored-by: Christina Holt <[email protected]>
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 <[email protected]>

---------

Co-authored-by: Paul Madden <[email protected]>
Co-authored-by: Christina Holt <[email protected]>
Co-authored-by: Emily Carpenter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants