Skip to content
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

Fix the signatures of @(async)contextmanager #12087

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Fix the signatures of @(async)contextmanager #12087

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8d59204
Use overloads to deprecate the less specific signature, less accurate…
Sachaa-Thanasius Jun 2, 2024
37638ab
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 2, 2024
d68ad23
Add asynccontextmanager too, why not. It has the same issue.
Sachaa-Thanasius Jun 2, 2024
6a357cf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 2, 2024
91ff757
Merge branch 'main' into contexmanager/deprecate-iterator-signature
Sachaa-Thanasius Jun 3, 2024
35f10aa
Update phrasing of `@deprecated` messages based on feedback.
Sachaa-Thanasius Jun 3, 2024
5045680
Merge branch 'main' into contexmanager/deprecate-iterator-signature
Sachaa-Thanasius Aug 2, 2024
da47550
Merge branch 'main' into contexmanager/deprecate-iterator-signature
Sachaa-Thanasius Aug 8, 2024
fba4b4f
Merge branch 'main' into contexmanager/deprecate-iterator-signature
Sachaa-Thanasius Sep 2, 2024
840b918
Merge branch 'main' into contexmanager/deprecate-iterator-signature
srittau Oct 21, 2024
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
14 changes: 13 additions & 1 deletion stdlib/contextlib.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ from abc import abstractmethod
from collections.abc import AsyncGenerator, AsyncIterator, Awaitable, Callable, Generator, Iterator
from types import TracebackType
from typing import IO, Any, Generic, Protocol, TypeVar, overload, runtime_checkable
from typing_extensions import ParamSpec, Self, TypeAlias
from typing_extensions import ParamSpec, Self, TypeAlias, deprecated

__all__ = [
"contextmanager",
Expand Down Expand Up @@ -75,6 +75,12 @@ class _GeneratorContextManager(AbstractContextManager[_T_co, bool | None], Conte
self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
) -> bool | None: ...

@overload
def contextmanager(func: Callable[_P, Generator[_T_co]]) -> Callable[_P, _GeneratorContextManager[_T_co]]: ...
Copy link

Choose a reason for hiding this comment

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

Perhaps the type here should be Generator[_T_co, None, object] instead? contextmanager does not actually care what the return type of the generator is. E.g. this:

@contextmanager
def f():
    yield
    return 1

is fine (though pointless).

@overload
@deprecated(
"Annotating the return type as `-> Iterator[Foo]` with `@contextmanager` is deprecated. Use `-> Generator[Foo]` instead."
)
def contextmanager(func: Callable[_P, Iterator[_T_co]]) -> Callable[_P, _GeneratorContextManager[_T_co]]: ...

if sys.version_info >= (3, 10):
Expand Down Expand Up @@ -107,6 +113,12 @@ else:
self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
) -> bool | None: ...

@overload
def asynccontextmanager(func: Callable[_P, AsyncGenerator[_T_co]]) -> Callable[_P, _AsyncGeneratorContextManager[_T_co]]: ...
@overload
@deprecated(
"Annotating the return type as `-> AsyncIterator[Foo]` with `@contextmanager` is deprecated. Use `-> AsyncGenerator[Foo]` instead."
)
def asynccontextmanager(func: Callable[_P, AsyncIterator[_T_co]]) -> Callable[_P, _AsyncGeneratorContextManager[_T_co]]: ...

class _SupportsClose(Protocol):
Expand Down
Loading