Fix inverted notify/notify_all in BQueue.Interrupt - #177
Open
winklemad wants to merge 1 commit into
Open
Conversation
BQueue.Interrupt(notifyAll) called notify() when notifyAll was True and notify_all() when it was False — the opposite of the parameter's meaning. As a result, Interrupt(notifyAll=True) woke only a single blocked Get() waiter instead of all of them. Swap the two branches so the parameter behaves as documented.
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
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.
Problem
BQueue.Interrupt(notifyAll)calls the wrongConditionmethod for each branch:The two branches are swapped relative to the parameter's meaning:
notifyAll=Truewakes only a single blockedGet()waiter, while the defaultnotifyAll=Falsewakes all of them. So a caller that relies onInterrupt(notifyAll=True)to release every consumer blocked inGet()only releases one; the rest keep waiting until their timeout (or forever, if called withtimeout=None).The current in-tree caller (
core/channel.pyClose()) uses the default and has a single consumer thread, so it happens to work — but the method's contract is still inverted.Reproduce
Fix
Swap the two branches so
notifyAll=Truecallsnotify_all()andnotifyAll=Falsecallsnotify(). After the fix the snippet prints[0, 1], and the single-consumerInterrupt()path used bychannel.pyis unchanged.