Await returned awaitables from async retry lifecycle callbacks - #728
Open
harbinresearcher wants to merge 1 commit into
Open
harbinresearcher wants to merge 1 commit into
harbinresearcher wants to merge 1 commit into
Conversation
This branch has not been deployed
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
AsyncRetryingacceptsbefore,after, andbefore_sleepcallbacks returningAwaitable[None] | None. A regular function returning a coroutine, Task, or Future satisfies this contract, but_utils.wrap_to_async_funconly decides whether to await from the callable's declaration. Its synchronous wrapper returns the awaitable as a value without waiting for it.Consequently, an operation can run before its
beforecallback finishes, or the next attempt can start beforeafter/before_sleepfinishes. Exceptions from a callback's Future can also be ignored.A local reproducer using a regular
beforefunction returningasyncio.create_task(...)records['operation']whenAsyncRetryingreturns. Only after explicitly draining the task does it record['operation', 'before'].Change
Resolve the actual result of only the three lifecycle callbacks in
AsyncRetrying._add_action_func. Call each callback once, await its result if it is awaitable, and leave ordinary synchronous results unchanged. Callback attributes and copying retain their existing behavior.The shared utility and other internal actions are intentionally unchanged. Successful operation results can themselves be awaitables used as data; they must not be awaited a second time. The regression coverage checks that a pending Future returned by an async operation remains the identical, still-pending object.
This does not change callable detection, sleeping, retry policies, or statistics, and does not depend on #657.
Verification
On Python 3.12.14 / Windows:
git diff --checkpassed.OpenAI Codex assisted with investigation, implementation, tests, and independent review. Review found and rejected an initial overly broad shared-utility change that would await an operation result twice; the submitted change is callback-scoped and includes a regression for that behavior. All verification above was run locally.