A return type of job/iterable of jobs from a Job is interpreted as a replace #833
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.
Summary
When a creating dynamic flow, it is currently the
Job's responsibility to create aFlowand returnResponsewith areplace:This works fine, but we feel that a cleaner way might be if the following worked directly:
i.e. if a
Jobreturns an iterable ofJobobjects (or a singleJobobject), it is interpreted as a replacement, and the actual mechanics of replacement (Response/replace) are handled internally injobflow.This enhancement is related to making
jobflowcloser to a drop-in replacement of a workflow engine (along withparsl,prefectetc) for the quacc platform.This tweak allows this enhancement, while preserving old behavior.
Additional dependencies introduced (if any)
None
TODO (if any)
None
Checklist
Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.
Before a pull request can be merged, the following items must be checked:
The easiest way to handle this is to run the following in the correct sequence on
your local machine. Start with running black on your new code. This will
automatically reformat your code to PEP8 conventions and removes most issues. Then run
pycodestyle, followed by flake8.
Run pydocstyle on your code.
type check your code.
Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply
pip install pre-commitand thenpre-commit installand a check will be runprior to allowing commits.