Skip to content

refine asyncio call_exception_handler context type #6981

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
wants to merge 14 commits into from
Closed

refine asyncio call_exception_handler context type #6981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
73cb1fa
refine asyncio call_exception_handler context type
graingert Jan 20, 2022
3ea5c10
Merge branch 'master' into refine-exception-handler-context-type
JelleZijlstra Feb 12, 2022
07a8708
Update stdlib/asyncio/base_events.pyi
JelleZijlstra Feb 12, 2022
ef514d6
Update stdlib/asyncio/base_events.pyi
JelleZijlstra Feb 12, 2022
63636ec
Update stdlib/asyncio/events.pyi
JelleZijlstra Feb 12, 2022
c9ecc07
Update stdlib/asyncio/events.pyi
JelleZijlstra Feb 12, 2022
923cc2f
Update stdlib/asyncio/events.pyi
JelleZijlstra Feb 12, 2022
eba70da
Update stdlib/asyncio/base_events.pyi
JelleZijlstra Feb 12, 2022
6d0b0fd
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 12, 2022
9be3e73
Update stdlib/asyncio/events.pyi
JelleZijlstra Feb 12, 2022
e7daeb7
Merge branch 'master' into refine-exception-handler-context-type
AlexWaygood Mar 20, 2022
8385b71
Merge branch 'master' into refine-exception-handler-context-type
AlexWaygood Apr 18, 2022
5fe10e9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 18, 2022
f17ee70
Fix bad merge
AlexWaygood Apr 18, 2022
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
19 changes: 16 additions & 3 deletions stdlib/asyncio/base_events.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ from asyncio.futures import Future
from asyncio.protocols import BaseProtocol
from asyncio.tasks import Task
from asyncio.transports import BaseTransport, ReadTransport, SubprocessTransport, WriteTransport
from collections.abc import Awaitable, Callable, Coroutine, Generator, Iterable, Sequence
from collections.abc import AsyncGenerator, Awaitable, Callable, Coroutine, Generator, Iterable, Sequence
from socket import AddressFamily, SocketKind, _Address, _RetAddress, socket
from typing import IO, Any, TypeVar, overload
from typing_extensions import Literal, TypeAlias
from typing_extensions import Literal, TypeAlias, TypedDict

if sys.version_info >= (3, 7):
from contextvars import Context
Expand All @@ -23,7 +23,20 @@ else:

_T = TypeVar("_T")
_ProtocolT = TypeVar("_ProtocolT", bound=BaseProtocol)
_Context: TypeAlias = dict[str, Any]

class _BaseContext(TypedDict):
message: str
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this really required? At least default_exception_handler() uses .get() to access it:

https://github.com/python/cpython/blob/0a222db2bca63070f429c0e613707da1bdfaf0e0/Lib/asyncio/base_events.py#L1719


class _Context(_BaseContext, total=False):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Looking forward to PEP 655.

default_exception_handler() also adds a handle_trackback field to the context:

https://github.com/python/cpython/blob/0a222db2bca63070f429c0e613707da1bdfaf0e0/Lib/asyncio/base_events.py#L1732-L1733

Copy link
Collaborator

Choose a reason for hiding this comment

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

And Handle._run() adds source_traceback under some conditions:

https://github.com/python/cpython/blob/0a222db2bca63070f429c0e613707da1bdfaf0e0/Lib/asyncio/events.py#L92-L93

exception: BaseException
future: Future[Any]
task: Task[Any]
handle: Handle
protocol: BaseProtocol
transport: BaseTransport
socket: socket
asyncgen: AsyncGenerator[Any, Any]

_ExceptionHandler: TypeAlias = Callable[[AbstractEventLoop, _Context], Any]
_ProtocolFactory: TypeAlias = Callable[[], BaseProtocol]
_SSLContext: TypeAlias = bool | None | ssl.SSLContext
Expand Down
3 changes: 1 addition & 2 deletions stdlib/asyncio/events.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ from socket import AddressFamily, SocketKind, _Address, _RetAddress, socket
from typing import IO, Any, TypeVar, overload
from typing_extensions import Literal, TypeAlias

from .base_events import Server
from .base_events import Server, _Context
from .futures import Future
from .protocols import BaseProtocol
from .tasks import Task
Expand Down Expand Up @@ -76,7 +76,6 @@ else:

_T = TypeVar("_T")
_ProtocolT = TypeVar("_ProtocolT", bound=BaseProtocol)
_Context: TypeAlias = dict[str, Any]
_ExceptionHandler: TypeAlias = Callable[[AbstractEventLoop, _Context], Any]
_ProtocolFactory: TypeAlias = Callable[[], BaseProtocol]
_SSLContext: TypeAlias = bool | None | ssl.SSLContext
Expand Down