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

Jump to bottom

Use more precise return types in asyncio methods #6937

Merged
merged 1 commit into from
Jan 17, 2022
Merged

Use more precise return types in asyncio methods #6937

Show file tree
Hide file tree
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
58 changes: 31 additions & 27 deletions stdlib/asyncio/base_events.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ if sys.version_info >= (3, 7):
from contextvars import Context

_T = TypeVar("_T")
_ProtocolT = TypeVar("_ProtocolT", bound=BaseProtocol)
_Context = dict[str, Any]
_ExceptionHandler = Callable[[AbstractEventLoop, _Context], Any]
_ProtocolFactory = Callable[[], BaseProtocol]
_SSLContext = Union[bool, None, ssl.SSLContext]
_TransProtPair = tuple[BaseTransport, BaseProtocol]

class Server(AbstractServer):
if sys.version_info >= (3, 7):
Expand Down Expand Up @@ -95,7 +95,7 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
@overload
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: str = ...,
port: int = ...,
*,
Expand All @@ -109,11 +109,11 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
ssl_handshake_timeout: float | None = ...,
happy_eyeballs_delay: float | None = ...,
interleave: int | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@overload
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: None = ...,
port: None = ...,
*,
Expand All @@ -127,12 +127,12 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
ssl_handshake_timeout: float | None = ...,
happy_eyeballs_delay: float | None = ...,
interleave: int | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
elif sys.version_info >= (3, 7):
@overload
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: str = ...,
port: int = ...,
*,
Expand All @@ -144,11 +144,11 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
local_addr: tuple[str, int] | None = ...,
server_hostname: str | None = ...,
ssl_handshake_timeout: float | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@overload
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: None = ...,
port: None = ...,
*,
Expand All @@ -160,12 +160,12 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
local_addr: None = ...,
server_hostname: str | None = ...,
ssl_handshake_timeout: float | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
else:
@overload
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: str = ...,
port: int = ...,
*,
Expand All @@ -176,11 +176,11 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
sock: None = ...,
local_addr: tuple[str, int] | None = ...,
server_hostname: str | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@overload
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: None = ...,
port: None = ...,
*,
Expand All @@ -191,7 +191,7 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
sock: socket,
local_addr: None = ...,
server_hostname: str | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
if sys.version_info >= (3, 7):
async def sock_sendfile(
self, sock: socket, file: IO[bytes], offset: int = ..., count: int | None = ..., *, fallback: bool | None = ...
Expand Down Expand Up @@ -232,12 +232,12 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
) -> Server: ...
async def connect_accepted_socket(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
sock: socket,
*,
ssl: _SSLContext = ...,
ssl_handshake_timeout: float | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
async def sendfile(
self, transport: BaseTransport, file: IO[bytes], offset: int = ..., count: int | None = ..., *, fallback: bool = ...
) -> int: ...
Expand Down Expand Up @@ -283,12 +283,12 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
reuse_port: bool | None = ...,
) -> Server: ...
async def connect_accepted_socket(
self, protocol_factory: _ProtocolFactory, sock: socket, *, ssl: _SSLContext = ...
) -> _TransProtPair: ...
self, protocol_factory: Callable[[], _ProtocolT], sock: socket, *, ssl: _SSLContext = ...
) -> tuple[BaseTransport, _ProtocolT]: ...
if sys.version_info >= (3, 11):
async def create_datagram_endpoint(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
local_addr: tuple[str, int] | None = ...,
remote_addr: tuple[str, int] | None = ...,
*,
Expand All @@ -298,11 +298,11 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
reuse_port: bool | None = ...,
allow_broadcast: bool | None = ...,
sock: socket | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
else:
async def create_datagram_endpoint(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
local_addr: tuple[str, int] | None = ...,
remote_addr: tuple[str, int] | None = ...,
*,
Expand All @@ -313,13 +313,17 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
reuse_port: bool | None = ...,
allow_broadcast: bool | None = ...,
sock: socket | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
# Pipes and subprocesses.
async def connect_read_pipe(self, protocol_factory: _ProtocolFactory, pipe: Any) -> _TransProtPair: ...
async def connect_write_pipe(self, protocol_factory: _ProtocolFactory, pipe: Any) -> _TransProtPair: ...
async def connect_read_pipe(
self, protocol_factory: Callable[[], _ProtocolT], pipe: Any
) -> tuple[BaseTransport, _ProtocolT]: ...
async def connect_write_pipe(
self, protocol_factory: Callable[[], _ProtocolT], pipe: Any
) -> tuple[BaseTransport, _ProtocolT]: ...
async def subprocess_shell(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
cmd: bytes | str,
*,
stdin: int | IO[Any] | None = ...,
Expand All @@ -332,10 +336,10 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
errors: None = ...,
text: Literal[False, None] = ...,
**kwargs: Any,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
async def subprocess_exec(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
program: Any,
*args: Any,
stdin: int | IO[Any] | None = ...,
Expand All @@ -347,7 +351,7 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
encoding: None = ...,
errors: None = ...,
**kwargs: Any,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
def add_reader(self, fd: FileDescriptorLike, callback: Callable[..., Any], *args: Any) -> None: ...
def remove_reader(self, fd: FileDescriptorLike) -> None: ...
def add_writer(self, fd: FileDescriptorLike, callback: Callable[..., Any], *args: Any) -> None: ...
Expand Down
54 changes: 29 additions & 25 deletions stdlib/asyncio/events.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ if sys.version_info >= (3, 7):
from contextvars import Context

_T = TypeVar("_T")
_ProtocolT = TypeVar("_ProtocolT", bound=BaseProtocol)
_Context = dict[str, Any]
_ExceptionHandler = Callable[[AbstractEventLoop, _Context], Any]
_ProtocolFactory = Callable[[], BaseProtocol]
_SSLContext = Union[bool, None, ssl.SSLContext]
_TransProtPair = tuple[BaseTransport, BaseProtocol]

class Handle:
_cancelled: bool
Expand Down Expand Up @@ -127,7 +127,7 @@ class AbstractEventLoop(metaclass=ABCMeta):
@abstractmethod
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: str = ...,
port: int = ...,
*,
Expand All @@ -141,12 +141,12 @@ class AbstractEventLoop(metaclass=ABCMeta):
ssl_handshake_timeout: float | None = ...,
happy_eyeballs_delay: float | None = ...,
interleave: int | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@overload
@abstractmethod
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: None = ...,
port: None = ...,
*,
Expand All @@ -160,13 +160,13 @@ class AbstractEventLoop(metaclass=ABCMeta):
ssl_handshake_timeout: float | None = ...,
happy_eyeballs_delay: float | None = ...,
interleave: int | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
elif sys.version_info >= (3, 7):
@overload
@abstractmethod
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: str = ...,
port: int = ...,
*,
Expand All @@ -178,12 +178,12 @@ class AbstractEventLoop(metaclass=ABCMeta):
local_addr: tuple[str, int] | None = ...,
server_hostname: str | None = ...,
ssl_handshake_timeout: float | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@overload
@abstractmethod
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: None = ...,
port: None = ...,
*,
Expand All @@ -195,13 +195,13 @@ class AbstractEventLoop(metaclass=ABCMeta):
local_addr: None = ...,
server_hostname: str | None = ...,
ssl_handshake_timeout: float | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
else:
@overload
@abstractmethod
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: str = ...,
port: int = ...,
*,
Expand All @@ -212,12 +212,12 @@ class AbstractEventLoop(metaclass=ABCMeta):
sock: None = ...,
local_addr: tuple[str, int] | None = ...,
server_hostname: str | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@overload
@abstractmethod
async def create_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
host: None = ...,
port: None = ...,
*,
Expand All @@ -228,7 +228,7 @@ class AbstractEventLoop(metaclass=ABCMeta):
sock: socket,
local_addr: None = ...,
server_hostname: str | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
if sys.version_info >= (3, 7):
@abstractmethod
async def sock_sendfile(
Expand Down Expand Up @@ -272,14 +272,14 @@ class AbstractEventLoop(metaclass=ABCMeta):
) -> Server: ...
async def create_unix_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
path: str | None = ...,
*,
ssl: _SSLContext = ...,
sock: socket | None = ...,
server_hostname: str | None = ...,
ssl_handshake_timeout: float | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
async def create_unix_server(
self,
protocol_factory: _ProtocolFactory,
Expand Down Expand Up @@ -341,13 +341,13 @@ class AbstractEventLoop(metaclass=ABCMeta):
) -> Server: ...
async def create_unix_connection(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
path: str,
*,
ssl: _SSLContext = ...,
sock: socket | None = ...,
server_hostname: str | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
async def create_unix_server(
self,
protocol_factory: _ProtocolFactory,
Expand All @@ -360,7 +360,7 @@ class AbstractEventLoop(metaclass=ABCMeta):
@abstractmethod
async def create_datagram_endpoint(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
local_addr: tuple[str, int] | None = ...,
remote_addr: tuple[str, int] | None = ...,
*,
Expand All @@ -371,16 +371,20 @@ class AbstractEventLoop(metaclass=ABCMeta):
reuse_port: bool | None = ...,
allow_broadcast: bool | None = ...,
sock: socket | None = ...,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
# Pipes and subprocesses.
@abstractmethod
async def connect_read_pipe(self, protocol_factory: _ProtocolFactory, pipe: Any) -> _TransProtPair: ...
async def connect_read_pipe(
self, protocol_factory: Callable[[], _ProtocolT], pipe: Any
) -> tuple[BaseTransport, _ProtocolT]: ...
@abstractmethod
async def connect_write_pipe(self, protocol_factory: _ProtocolFactory, pipe: Any) -> _TransProtPair: ...
async def connect_write_pipe(
self, protocol_factory: Callable[[], _ProtocolT], pipe: Any
) -> tuple[BaseTransport, _ProtocolT]: ...
@abstractmethod
async def subprocess_shell(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
cmd: bytes | str,
*,
stdin: int | IO[Any] | None = ...,
Expand All @@ -393,11 +397,11 @@ class AbstractEventLoop(metaclass=ABCMeta):
errors: None = ...,
text: Literal[False, None] = ...,
**kwargs: Any,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@abstractmethod
async def subprocess_exec(
self,
protocol_factory: _ProtocolFactory,
protocol_factory: Callable[[], _ProtocolT],
program: Any,
*args: Any,
stdin: int | IO[Any] | None = ...,
Expand All @@ -409,7 +413,7 @@ class AbstractEventLoop(metaclass=ABCMeta):
encoding: None = ...,
errors: None = ...,
**kwargs: Any,
) -> _TransProtPair: ...
) -> tuple[BaseTransport, _ProtocolT]: ...
@abstractmethod
def add_reader(self, fd: FileDescriptorLike, callback: Callable[..., Any], *args: Any) -> None: ...
@abstractmethod
Expand Down