BaseRestartWorkChain: add method to enable/disable process handlers
#3786
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
|
Thanks, @sphuber, I will test it in lsmo-epfl/aiida-raspa#56 and will let you know. |
The `process_handler` decorator is updated with a new keyword argument `enabled` which is by default `True`. By setting it to `False` the process handler is disabled and will always be skipped during the `inspect_process` outline step. This default can be overridden on a per instance basis through a new input called `handler_overrides`. The base spec of `BaseRestartWorkChain` defines this new base input called `handler_overrides` which takes a mapping of process handler names to a boolean. For `True` the process handler is enabled and for `False` it is disabled, where disabled means that during the `inspect_process` call it is not called but skipped. The validator on the port ensures that the keys correspond to actual instance methods of the work chain that are decorated with `process_handler`. The value specified in `handler_overrides`, as the name suggests, override the default value specified in the decorator.
sphuber
force-pushed
the
fix_3773_base_restart_enable_disable
branch
from
e8c5b9f to
2789ea9
Compare
yakutovicha
reviewed
Feb 29, 2020
There was a problem hiding this comment.
Thanks a lot, @sphuber. I tested the updated functionality of the base restart work chain on aiida-raspa work chains and everything seems to work without a problem. In particular, I tested disabling/enabling handlers that are enabled/disabled by default and get_process_handlers() function (see my note below).
This was referenced Mar 31, 2020
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 #3773
The
process_handlerdecorator is updated with a new keyword argumentenabledwhich is by defaultTrue. By setting it toFalsetheprocess handler is disabled and will always be skipped during the
inspect_processoutline step. This default can be overridden on a perinstance basis through a new input called
handler_overrides.The base spec of
BaseRestartWorkChaindefines this new base inputcalled
handler_overrideswhich takes a mapping of process handlernames to a boolean. For
Truethe process handler is enabled and forFalseit is disabled, where disabled means that during theinspect_processcall it is not called but skipped. The validator onthe port ensures that the keys correspond to actual instance methods of
the work chain that are decorated with
process_handler. The valuespecified in
handler_overrides, as the name suggests, override thedefault value specified in the decorator.