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

Return assets from driver invocation #685

Merged
merged 3 commits into from
Jan 16, 2025

Conversation

maddenp-noaa
Copy link
Collaborator

Synopsis

Currently, uwtools.api.execute.execute() returns a bool meant to indicate whether the task ran to completion. Instead, return the iotaa Assets that are yielded by the task, which allows a caller to extract references (via iotaa.refs()) to the assets the task made ready. For example, execute()ing a namelist driver task would now return a reference to the on-disk namelist file, which the caller could use for whatever purpose. See the updated unit tests for an example.

Type

  • Documentation
  • Enhancement (adds new functionality)

Impact

  • This is a breaking change (changes existing functionality) but it's unlikely any user would notice

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 merged commit ab7c70a into ufs-community:main Jan 16, 2025
2 checks passed
@maddenp-noaa maddenp-noaa deleted the useful-execute-retval branch January 16, 2025 17:43
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.

2 participants