Add exit choices for the DFK context manager #3468
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
Most important is a ``wait`` exit mode which will make the context manager wait for tasks to complete at exit, unless an exception is raised. This addresses a common usability problem where users forget to wait for their tasks and are then confused by their workflow exiting immediately, but does not defer exceptions - this block-on-exception behaviour was the main usability problem when attempting this before in PR #610.
|
@WardLT you might be interested in this - I think the same choices could be applied to the ParslPoolExecutor when used as a context manager. |
khk-globus
approved these changes
Jun 6, 2024
Comment on lines
+223
to
+235
| if mode == "cleanup": | ||
| logger.info("Calling cleanup for DFK") | ||
| self.cleanup() | ||
| elif mode == "skip": | ||
| logger.info("Skipping all cleanup handling") | ||
| elif mode == "wait": | ||
| if exc_type is None: | ||
| logger.info("Waiting for all tasks to complete") | ||
| self.wait_for_current_tasks() | ||
| self.cleanup() | ||
| else: | ||
| logger.info("There was an exception - cleaning up without waiting for task completion") | ||
| self.cleanup() |
There was a problem hiding this comment.
If cleanup is the default in almost all cases, could make the code follow "moral" suit. Consider:
# with typeguard, is this, in fact, necessary?
if mode not in ("cleanup", "wait", "skip"):
raise InternalConsistencyError(f"Exit case for {mode} should be unreachable, validated by typeguard on Config()")
if mode == "skip":
logger.info("Skipping all cleanup handling")
return
if mode == "wait":
if exc_type is None:
logger.info("Waiting ...")
self.wait_for_current_tasks()
else:
logger.info("was an exc ...")
logger.info("Calling cleanup for DFK")
self.cleanup()There was a problem hiding this comment.
could do - I think it comes down to seeing this case statement as choosing three distinct behaviours vs a "normal flow" that gets ornamented by different things on the way. I've ended up with more of a preference for being explicit about all three flows as explicit separate options, but I think it would be fine either way.
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.
Most important is a
waitexit mode which will make the context manager wait for tasks to complete at exit, unless an exception is raised. This addresses a common usability problem where users forget to wait for their tasks and are then confused by their workflow exiting immediately, but does not defer exceptions - this block-on-exception behaviour was the main usability problem when attempting this before in PR #610.Changed Behaviour
The default mode should preserve existing behaviour - so none.
Type of change