Add the concept of a "lazy" PortNamespace
#121
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
sphuber
force-pushed
the
fix_117_lazy_port_namespaces
branch
from
3710be6
to
1a6e8db
Compare
The current design will skip the validation of a `PortNamespace` if it is not required *and* no values are passed for it upon process creation. However, before validation, the inputs are pre-processed. This entails that the input dictionary is mapped onto the input port namespace and any input that is not explicitly specified, but corresponds to a port with a default, has the field populated with said default value. This behavior, however, now makes it impossible to skip the validation of a non-required port namespace by not specifying any inputs, as soon as it contains any port with a default. Even if no inputs are passed, the pre-processing will populate the defaults, which will trigger the validation because the inputs for the namespace are no longer empty. To make it possible to have non-required namespaces, that contain nested ports with default values, optionally validated, we introduce a new port namespace property: `populate_defaults`. If a `PortNamespace` has the `populate_defaults` set to `False` the pre processing will only be triggered if there are explicit inputs defined for it. If this is not the case, the population of defaults is skipped.
sphuber
force-pushed
the
fix_117_lazy_port_namespaces
branch
from
1a6e8db
to
1fb6627
Compare
|
OK @giovannipizzi , the port namespace property has been renamed to |
| :param dynamic: boolean, if True, the namespace will accept values even when no explicit port is defined | ||
| :param populate_defaults: boolean, if False, the pre-processing step does not populate defaults, also not of any | ||
| nested ports, if no value was explicitly specified for this namespace. | ||
| """ |
There was a problem hiding this comment.
I would just add an explicit note: ".. note: if the port is explicitly specified, this parameter is ignored and the defaults are populated"
There was a problem hiding this comment.
that is what it says, but maybe I can reword it, so that it more clear
There was a problem hiding this comment.
I have changed the docstring. I think it should be clear now
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 #117
The current design will skip the validation of a
PortNamespaceif itis not required and no values are passed for it upon process creation.
However, before validation, the inputs are pre-processed. This entails
that the input dictionary is mapped onto the input port namespace and
any input that is not explicitly specified, but corresponds to a port
with a default, has the field populated with said default value.
This behavior, however, now makes it impossible to skip the validation
of a non-required port namespace by not specifying any inputs, as soon
as it contains any port with a default. Even if no inputs are passed,
the pre-processing will populate the defaults, which will trigger the
validation because the inputs for the namespace are no longer empty.
To make it possible to have non-required namespaces, that contain nested
ports with defaul values, optionally validated, we introduce a new port
namespace property: "lazy". If a
PortNamespaceis "lazy" the preprocessing will only be triggered if there are explicit inputs defined
for it. If this is not the case, the population of defaults is skipped.