Skip to content

Convert AbstractContextManager from a protocol to an ABC #11269

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

Closed
NeilGirdhar wants to merge 1 commit into from
Closed

Convert AbstractContextManager from a protocol to an ABC #11269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions stdlib/contextlib.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ from _typeshed import FileDescriptorOrPath, Unused
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 import IO, Any, Generic, Protocol, TypeVar, overload
from typing_extensions import ParamSpec, Self, TypeAlias

__all__ = [
Expand Down Expand Up @@ -37,16 +37,18 @@ _P = ParamSpec("_P")
_ExitFunc: TypeAlias = Callable[[type[BaseException] | None, BaseException | None, TracebackType | None], bool | None]
_CM_EF = TypeVar("_CM_EF", bound=AbstractContextManager[Any] | _ExitFunc)

@runtime_checkable
class AbstractContextManager(Protocol[_T_co]):
# AbstractContextManager should not be a protocol or else the exit method, which is abstract, cannot be determined by type checkers to
# be implemented. This prevents users from calling super. For details, see this comment:
# https://github.com/microsoft/pyright/issues/6965#issuecomment-1889704569
class AbstractContextManager(Generic[_T_co], metaclass=abc.ABCMeta):
def __enter__(self) -> _T_co: ...
@abstractmethod
def __exit__(
self, __exc_type: type[BaseException] | None, __exc_value: BaseException | None, __traceback: TracebackType | None
) -> bool | None: ...

@runtime_checkable
class AbstractAsyncContextManager(Protocol[_T_co]):
# As with AbstractContextManager, this should not be a protocol.
class AbstractAsyncContextManager(Generic[_T_co], metaclass=abc.ABCMeta):
async def __aenter__(self) -> _T_co: ...
@abstractmethod
async def __aexit__(
Expand Down