Update sender type in ConfigManagingActor #1010
Merged
Conversation
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
github-actions
bot
added
part:tests
The ConfigManagingActor now sends a collections.abc.Mapping type as the output sender type to indicate to the user that the broadcasted configuration is intended to be read-only. This change leverages type checkers (e.g., mypy, etc.) to help ensure that users do not attempt to modify the dictionary contents. Note that this change won't prevent users from modifying the contents at runtime, but it will help prevent accidental modifications. Signed-off-by: Daniel Zullo <[email protected]>
daniel-zullo-frequenz
force-pushed
the
feature/update-config-manager-sender-type
branch
from
c461248 to
fee07e3
Compare
llucax
approved these changes
Jul 23, 2024
llucax
added
the
scope:breaking-change
daniel-zullo-frequenz
deleted the
feature/update-config-manager-sender-type
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The ConfigManagingActor now sends a
collections.abc.Mappingtype as the output sender type to indicate to the user that the broadcasted configuration is intended to be read-only. This change leverages type checkers (e.g., mypy, etc.) to help ensure that users do not attempt to modify the dictionary contents.Note that this change won't prevent users from modifying the contents at runtime, but it will help prevent accidental modifications.