Engine: Remove *args from the Process.submit method
#5753
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
This method erroneously accepted variable arguments, however, they would
simply be passed down the stack to ultimately be ignored in the function
`aiida.engine.utils.instantiate_process`. This silently ignoring of
arguments led to problems with users accidentally forgetting to expand a
dictionary of inputs when calling submit. For example they called:
self.submit(cls, inputs)
inside of a workchain step, instead of:
self.submit(cls, **inputs)
The exception that would be raised is the validation error of the first
required input port that would be parsed:
Error occurred validating port: required value was not provided
Instead, the passing of unsupported argument should be detected way
earlier. This is now the case by removing the variable arguments from
the signature of the `Process.submit` method and all the methods it
calls downstream. This will now cause a `TypeError` to be raised:
submit() takes 2 positional arguments but 3 were given
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 #3609
This method erroneously accepted variable arguments, however, they would simply be passed down the stack to ultimately be ignored in the function
aiida.engine.utils.instantiate_process. This silently ignoring of arguments led to problems with users accidentally forgetting to expand a dictionary of inputs when calling submit. For example they called:inside of a workchain step, instead of:
The exception that would be raised is the validation error of the first required input port that would be parsed:
Instead, the passing of unsupported argument should be detected way earlier. This is now the case by removing the variable arguments from the signature of the
Process.submitmethod and all the methods it calls downstream. This will now cause aTypeErrorto be raised: