Skip to content

Refactor async_context_manager type annotations using ParamSpec #828

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

Open
junyilou wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Refactor async_context_manager type annotations using ParamSpec #828

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
14 changes: 8 additions & 6 deletions asyncssh/misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
from types import TracebackType
from typing import Any, AsyncContextManager, Awaitable, Callable, Dict
from typing import Generator, Generic, IO, Iterator, List, Literal, Mapping
from typing import Sequence, Optional, Protocol, Tuple, Type, TypeVar, Union
from typing import cast, overload
from typing import Sequence, Optional, ParamSpec, Protocol, Tuple, Type
from typing import TypeVar, Union, cast, overload

from .constants import DEFAULT_LANG
from .constants import DISC_COMPRESSION_ERROR, DISC_CONNECTION_LOST
Expand Down Expand Up @@ -473,10 +473,11 @@ async def __aexit__(self, exc_type: Optional[Type[BaseException]],
return exit_result


_ACMCoro = Callable[..., Awaitable[_ACM]]
_ACMWrapperFunc = Callable[..., _ACMWrapper[_ACM]]
_ACMParam = ParamSpec("_ACMParam")

def async_context_manager(coro: _ACMCoro[_ACM]) -> _ACMWrapperFunc[_ACM]:
def async_context_manager(
coro: Callable[_ACMParam, Awaitable[_ACM]]
) -> Callable[_ACMParam, _ACMWrapper[_ACM]]:
"""Decorator for functions returning asynchronous context managers

This decorator can be used on functions which return objects
Expand All @@ -490,7 +491,8 @@ def async_context_manager(coro: _ACMCoro[_ACM]) -> _ACMWrapperFunc[_ACM]:
"""

@functools.wraps(coro)
def context_wrapper(*args, **kwargs) -> _ACMWrapper[_ACM]:
def context_wrapper(*args: _ACMParam.args,
**kwargs: _ACMParam.kwargs) -> _ACMWrapper[_ACM]:
"""Return an async context manager wrapper for this coroutine"""

return _ACMWrapper(coro(*args, **kwargs))
Expand Down