Change future checks from .cancelled() to .done() before setting future results.#55
Merged
markedwards merged 3 commits intoNov 28, 2025
Conversation
markedwards
approved these changes
Nov 28, 2025
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.
Fix: Use
.done()instead of.cancelled()to prevent InvalidStateErrorProblem
The code was checking
if not ql.future.cancelled()before setting results or exceptions on futures. However, a future can be in a "done" state for multiple reasons:see: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.done
If a future already has a result or exception set (but is not cancelled), the
cancelled()check would pass, and attempting to callset_result()orset_exception()on an already-done future would raiseInvalidStateError.Solution
Changed all checks from
cancelled()todone()in three locations:dispatch_queue_batch()- when setting results/exceptions from batch loadfailed_dispatch()- when setting exceptions after batch failureprime()- when priming the cache with valuesThe
done()check is more comprehensive as it catches all completion states, preventingInvalidStateErrorin all scenarios.Testing
All existing tests pass, and new tests verify that:
InvalidStateErrorexceptions are raised