[Core] Fix bug when emiting event in EventManager #425
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
cas--
reviewed
May 25, 2023
| for session_id, interest in self.factory.interested_events.items(): | ||
| # The interested_events dict can change while iterating, | ||
| # therefore we need to iterate over a copy | ||
| for session_id, interest in self.factory.interested_events.copy().items(): |
There was a problem hiding this comment.
I feel the comment is redundant since the commit message explains the reasoning
There was a problem hiding this comment.
Well, the commit message is to explain why the change is needed. The comment is to ensure nobody removes the copy part later on because "It doesn't seem necessary".
There was a problem hiding this comment.
That's a reasonable point, okay let's remove original redundant comment and make the new comment a short one-liner:
- # Find sessions interested in this event
for session_id, interest in self.factory.interested_events.items():
- # The interested_events dict can change while iterating,
- # therefore we need to iterate over a copy
+ # Use copy of `interested_events` since it can mutate while iterating.There was a problem hiding this comment.
Should I commit and rebase?
In some cases, when emiting events with EventManager.emit_event(), the underlying dictionary of interested sessions can change during iteration, causing: RuntimeError: dictionary changed size during iteration Fix by iterating over a copy of the dictionary. Closes: https://dev.deluge-torrent.org/ticket/3351
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.
In some cases, when emiting events with EventManager.emit_event(), the underlying dictionary of interested sessions can change during iteration, causing: RuntimeError: dictionary changed size during iteration
Fix by iterating over a copy of the dictionary.
Closes: https://dev.deluge-torrent.org/ticket/3351