BaseRestartWorkChain: allow to override priority in handler_overrides
#5546
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
|
Still want to add docs to this as the |
|
@sphuber Thanks a lot. Happy to add docs. Where should it go? |
espenfl
previously approved these changes
May 30, 2022
| instance method of the `process_class` that has been decorated with the `process_handler` decorator. The values | ||
| should be boolean. | ||
| The ``handler_overrides`` should be a dictionary where keys are strings that are the name of a process handler, i.e. | ||
| an instance method of the `process_class` that has been decorated with the `process_handler` decorator. The values |
There was a problem hiding this comment.
Should process_handler still be in single quotes?
There was a problem hiding this comment.
No, missed that one. Fixed now.
…des` The `handler_overrides` could so far be used to override the `enabled` keyword of the corresponding handler. This would allow to disable or enable a handler on a per process instance basis. A user may want to do the same for the `priority`. To make this possible the type of the `handler_overrides` is changed where the values should now be dictionaries where the keys `enabled` and `priority` are supported. These can be used to override the original values declared in the source code of the work chain. To provide backwards-compatibility, the old syntax is still supported and automatically converted, with a deprecation warning being displayed.
sphuber
force-pushed
the
feature/5545/handler-overrides-priority
branch
from
0f686e2 to
8df037a
Compare
|
Thanks for the review @espenfl . I actually noticed there was a subtle bug that wasn't being tested for. The initial implementation would actually affect the handlers for multiple executions and not just the single instance. This is now fixed and explicitly tested. I have also added the docs. |
espenfl
approved these changes
May 30, 2022
2 tasks
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 #5545
The
handler_overridescould so far be used to override theenabledkeyword of the corresponding handler. This would allow to disable or
enable a handler on a per process instance basis.
A user may want to do the same for the
priority. To make this possiblethe type of the
handler_overridesis changed where the values shouldnow be dictionaries where the keys
enabledandpriorityaresupported. These can be used to override the original values declared
in the source code of the work chain.
To provide backwards-compatibility, the old syntax is still supported
and automatically converted, with a deprecation warning being displayed.