Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix retry() annotations with async sleep= function #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 3 commits into from
Feb 7, 2026
+28 −3
Merged

Fix retry() annotations with async sleep= function #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42e1545
improve annotations
Zac-HD Feb 5, 2026
38190ff
ruff format
Zac-HD Feb 6, 2026
399b08c
fix for py311
Zac-HD Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions releasenotes/notes/fix-async-retry-type-overloads-27f3e0c239ed6b.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
fixes:
- |
The ``@retry`` decorator's type overloads for the ``sleep=`` parameter
(e.g. ``sleep=trio.sleep``) have been improved. Previously, the
async-sleep overload used ``R | Awaitable[R]`` as the return type
bound, which was ambiguous: for ``async def f() -> T``, pyright could
infer ``R = Coroutine[Any, Any, T]`` instead of ``R = T``, producing
false-positive type errors in downstream code.
22 changes: 19 additions & 3 deletions tenacity/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import sys
import threading
import time
import types
import typing as t
import warnings
from abc import ABC, abstractmethod
Expand Down Expand Up @@ -87,8 +88,6 @@
tornado = None

if t.TYPE_CHECKING:
import types

from typing_extensions import Self

from . import asyncio as tasyncio
Expand Down Expand Up @@ -585,6 +584,23 @@ def __repr__(self) -> str:
return f"<{clsname} {id(self)}: attempt #{self.attempt_number}; slept for {slept}; last result: {result}>"


class _AsyncRetryDecorator(t.Protocol):
@t.overload
def __call__(
self, fn: "t.Callable[P, types.CoroutineType[t.Any, t.Any, R]]"
) -> "t.Callable[P, types.CoroutineType[t.Any, t.Any, R]]": ...
@t.overload
def __call__(
self, fn: t.Callable[P, t.Coroutine[t.Any, t.Any, R]]
) -> t.Callable[P, t.Coroutine[t.Any, t.Any, R]]: ...
@t.overload
def __call__(
self, fn: t.Callable[P, t.Awaitable[R]]
) -> t.Callable[P, t.Awaitable[R]]: ...
@t.overload
def __call__(self, fn: t.Callable[P, R]) -> t.Callable[P, t.Awaitable[R]]: ...
Comment on lines +600 to +601

@Zac-HD Zac-HD Feb 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and then this is the "if wasn't a coroutine function or otherwise returning an awaitable, it is now" annotation



@t.overload
def retry(func: WrappedFn) -> WrappedFn: ...

Expand All @@ -606,7 +622,7 @@ def retry(
retry_error_callback: t.Optional[
t.Callable[["RetryCallState"], t.Union[t.Any, t.Awaitable[t.Any]]]
] = ...,
) -> t.Callable[[t.Callable[P, R | t.Awaitable[R]]], t.Callable[P, t.Awaitable[R]]]: ...
) -> _AsyncRetryDecorator: ...


@t.overload
Expand Down