Parser.parse_from_node: Validate outputs against process spec
#6159
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
The `parse_from_node` clasmethod is a utility function to call the `parse` method of a `Parser` implementation for a given `CalcJobNode`. It automatically calls `parse` in the correct manner, passing the `retrieved` output node, and wrapping it in a calcfunction to optionally store the provenance. However, since the `calcfunction` by default has a dynamic output namespace and so accepts all outputs, it would not perform the same output validation that the original `CalcJob` would have done since that most likely will have defined specific outputs. Especially given that the `parse_from_node` method would often be used in unit tests to test `Parser` implementations, having the output validation be different would make it possible to mis bugs. For example, if the parser assigns an invalid output node, this would go unnoticed. The `parse_from_node` is updated to patch the output specification of the `calcfunction` with that of the process class that was used to created the `CalcJobNode` which is being passed as an argument. As long as the process can of course be loaded. This ensures that when the `calcfunction` return the outputs returned by `Parser.parse` they are validated against the output specification of the original `CalcJob` class. If it fails, a `ValueError` is raised.
|
@mbercx this would have caught the bug in the |
mbercx
approved these changes
Oct 23, 2023
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.
The
parse_from_nodeclasmethod is a utility function to call theparsemethod of aParserimplementation for a givenCalcJobNode. It automatically callsparsein the correct manner, passing theretrievedoutput node, and wrapping it in a calcfunction to optionally store the provenance.However, since the
calcfunctionby default has a dynamic output namespace and so accepts all outputs, it would not perform the same output validation that the originalCalcJobwould have done since that most likely will have defined specific outputs. Especially given that theparse_from_nodemethod would often be used in unit tests to testParserimplementations, having the output validation be different would make it possible to mis bugs. For example, if the parser assigns an invalid output node, this would go unnoticed.The
parse_from_nodeis updated to patch the output specification of thecalcfunctionwith that of the process class that was used to created theCalcJobNodewhich is being passed as an argument. As long as the process can of course be loaded. This ensures that when thecalcfunctionreturn the outputs returned byParser.parsethey are validated against the output specification of the originalCalcJobclass. If it fails, aValueErroris raised.