WorkChains: Raise if predicate if_/while_ does not return boolean
#5924
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
Before the conditionals created by the `if_` and `while_` constructs would enter their body as long as the predicate returned anything that was truthy. This could lead to unexpected behavior. For example, if a user tried to abort a workchain from the predicate of a while-loop by returning an `ExitCode` instance, the while stepper would accept the exit code as truthy and continue the loop. To prevent this, the conditionals will now raise a `TypeError` whenever the value returned by the predicate is not a boolean. Since this logic was added in `plumpy==0.21.4` the dependency requirement is updated.
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.
Fixes #5477
Before the conditionals created by the
if_andwhile_constructs would enter their body as long as the predicate returned anything that was truthy. This could lead to unexpected behavior. For example, if a user tried to abort a workchain from the predicate of a while-loop by returning anExitCodeinstance, the while stepper would accept the exit code as truthy and continue the loop.To prevent this, the conditionals will now raise a
TypeErrorwhenever the value returned by the predicate is not a boolean. Since this logic was added inplumpy==0.21.4the dependency requirement is updated.