Implement the new calcfunction decorator.#2203
Merged
giovannipizzi merged 1 commit intoNov 15, 2018
Merged
Conversation
sphuber
force-pushed
the
fix_2172_implement_calcfunction_decorator
branch
from
b54cd8d to
0b9fb4f
Compare
This `calcfunction` decorator replaces the `make_inline` and `optional_inline` decorators, which are deprecated. The `calcfunction` operates identical to the `workfunction` except the former gets a `CalcFunctionNode` to represent itself in the provenance graph as opposed to the `WorkFunctionNode` of the latter. The behavior of the `optional_inline` decorator is already intrinsically contained within the `calcfunction` and `workfunction` decorators. Since under the hood a `FunctionProcess` will be generated, and each process has an input port `store_provenace` that can be toggled to `False` to prevent the provenance from being stored, each `calcfunction` can be run without storing the provenance by simply passing `store_provenance=False` when calling the function.
sphuber
force-pushed
the
fix_2172_implement_calcfunction_decorator
branch
from
0b9fb4f to
e667ea0
Compare
Member
giovannipizzi
left a comment
giovannipizzi
left a comment
There was a problem hiding this comment.
All very good!
I just think that this is a good moment to add a documentation about store_provenance
Contributor
Author
|
I consciously did not add it yet, because there is still #2180 . Should we discuss this a bit more and finalize a decision? Then I can put in the necessary documentation |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 #2172
This
calcfunctiondecorator replaces themake_inlineandoptional_inlinedecorators, which are deprecated. The
calcfunctionoperates identical to theworkfunctionexcept the former gets aCalcFunctionNodeto represent itselfin the provenance graph as opposed to the
WorkFunctionNodeof the latter.The behavior of the
optional_inlinedecorator is already intrinsicallycontained within the
calcfunctionandworkfunctiondecorators. Since underthe hood a
FunctionProcesswill be generated, and each process has an inputport
store_provenacethat can be toggled toFalseto prevent the provenancefrom being stored, each
calcfunctioncan be run without storing the provenanceby simply passing
store_provenance=Falsewhen calling the function.