VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2025-12-09 05:24:52 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve asyncio.subprocess stubs (#5327)

Browse Source
This commit is contained in:
Jelle Zijlstra
2021-05-02 21:50:29 -07:00
committed by GitHub
parent 1826072dd1
commit 38dfb57adf
3 changed files with 113 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
stdlib/asyncio/base_events.pyi
View File

@@ -315,9 +315,9 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
protocol_factory: _ProtocolFactory,
cmd: Union[bytes, str],
*,
stdin: Any = ...,
stdout: Any = ...,
stderr: Any = ...,
stdin: Union[int, IO[Any], None] = ...,
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
@@ -329,10 +329,16 @@ class BaseEventLoop(AbstractEventLoop, metaclass=ABCMeta):
async def subprocess_exec(
self,
protocol_factory: _ProtocolFactory,
program: Any,
*args: Any,
stdin: Any = ...,
stdout: Any = ...,
stderr: Any = ...,
stdin: Union[int, IO[Any], None] = ...,
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
**kwargs: Any,
) -> _TransProtPair: ...
def add_reader(self, fd: FileDescriptorLike, callback: Callable[..., Any], *args: Any) -> None: ...

25
stdlib/asyncio/events.pyi
View File

@@ -9,6 +9,7 @@ from asyncio.transports import BaseTransport
from asyncio.unix_events import AbstractChildWatcher
from socket import AddressFamily, SocketKind, _Address, _RetAddress, socket
from typing import IO, Any, Awaitable, Callable, Dict, Generator, List, Optional, Sequence, Tuple, TypeVar, Union, overload
from typing_extensions import Literal
if sys.version_info >= (3, 7):
from contextvars import Context
@@ -399,19 +400,31 @@ class AbstractEventLoop(metaclass=ABCMeta):
protocol_factory: _ProtocolFactory,
cmd: Union[bytes, str],
*,
stdin: Any = ...,
stdout: Any = ...,
stderr: Any = ...,
stdin: Union[int, IO[Any], None] = ...,
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
text: Literal[False, None] = ...,
**kwargs: Any,
) -> _TransProtPair: ...
@abstractmethod
async def subprocess_exec(
self,
protocol_factory: _ProtocolFactory,
program: Any,
*args: Any,
stdin: Any = ...,
stdout: Any = ...,
stderr: Any = ...,
stdin: Union[int, IO[Any], None] = ...,
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
**kwargs: Any,
) -> _TransProtPair: ...
@abstractmethod

93
stdlib/asyncio/subprocess.pyi
View File

@@ -1,13 +1,14 @@
import subprocess
import sys
from _typeshed import AnyPath
from asyncio import events, protocols, streams, transports
from typing import IO, Any, Optional, Tuple, Union
from typing import IO, Any, Callable, Optional, Tuple, Union
from typing_extensions import Literal
if sys.version_info >= (3, 8):
from os import PathLike
_ExecArg = Union[str, bytes, PathLike[str], PathLike[bytes]]
_ExecArg = AnyPath
else:
_ExecArg = Union[str, bytes] # Union used instead of AnyStr due to mypy issue #1236
_ExecArg = Union[str, bytes]
PIPE: int
STDOUT: int
@@ -41,12 +42,30 @@ class Process:
if sys.version_info >= (3, 10):
async def create_subprocess_shell(
cmd: Union[str, bytes], # Union used instead of AnyStr due to mypy issue #1236
cmd: Union[str, bytes],
stdin: Union[int, IO[Any], None] = ...,
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
limit: int = ...,
**kwds: Any,
*,
# These parameters are forced to these values by BaseEventLoop.subprocess_shell
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
text: Literal[False, None] = ...,
# These parameters are taken by subprocess.Popen, which this ultimately delegates to
executable: Optional[AnyPath] = ...,
preexec_fn: Optional[Callable[[], Any]] = ...,
close_fds: bool = ...,
cwd: Optional[AnyPath] = ...,
env: Optional[subprocess._ENV] = ...,
startupinfo: Optional[Any] = ...,
creationflags: int = ...,
restore_signals: bool = ...,
start_new_session: bool = ...,
pass_fds: Any = ...,
) -> Process: ...
async def create_subprocess_exec(
program: _ExecArg,
@@ -55,18 +74,53 @@ if sys.version_info >= (3, 10):
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
limit: int = ...,
**kwds: Any,
# These parameters are forced to these values by BaseEventLoop.subprocess_shell
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
# These parameters are taken by subprocess.Popen, which this ultimately delegates to
text: Optional[bool] = ...,
executable: Optional[AnyPath] = ...,
preexec_fn: Optional[Callable[[], Any]] = ...,
close_fds: bool = ...,
cwd: Optional[AnyPath] = ...,
env: Optional[subprocess._ENV] = ...,
startupinfo: Optional[Any] = ...,
creationflags: int = ...,
restore_signals: bool = ...,
start_new_session: bool = ...,
pass_fds: Any = ...,
) -> Process: ...
else:
async def create_subprocess_shell(
cmd: Union[str, bytes], # Union used instead of AnyStr due to mypy issue #1236
cmd: Union[str, bytes],
stdin: Union[int, IO[Any], None] = ...,
stdout: Union[int, IO[Any], None] = ...,
stderr: Union[int, IO[Any], None] = ...,
loop: Optional[events.AbstractEventLoop] = ...,
limit: int = ...,
**kwds: Any,
*,
# These parameters are forced to these values by BaseEventLoop.subprocess_shell
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
text: Literal[False, None] = ...,
# These parameters are taken by subprocess.Popen, which this ultimately delegates to
executable: Optional[AnyPath] = ...,
preexec_fn: Optional[Callable[[], Any]] = ...,
close_fds: bool = ...,
cwd: Optional[AnyPath] = ...,
env: Optional[subprocess._ENV] = ...,
startupinfo: Optional[Any] = ...,
creationflags: int = ...,
restore_signals: bool = ...,
start_new_session: bool = ...,
pass_fds: Any = ...,
) -> Process: ...
async def create_subprocess_exec(
program: _ExecArg,
@@ -76,5 +130,22 @@ else:
stderr: Union[int, IO[Any], None] = ...,
loop: Optional[events.AbstractEventLoop] = ...,
limit: int = ...,
**kwds: Any,
# These parameters are forced to these values by BaseEventLoop.subprocess_shell
universal_newlines: Literal[False] = ...,
shell: Literal[True] = ...,
bufsize: Literal[0] = ...,
encoding: None = ...,
errors: None = ...,
# These parameters are taken by subprocess.Popen, which this ultimately delegates to
text: Optional[bool] = ...,
executable: Optional[AnyPath] = ...,
preexec_fn: Optional[Callable[[], Any]] = ...,
close_fds: bool = ...,
cwd: Optional[AnyPath] = ...,
env: Optional[subprocess._ENV] = ...,
startupinfo: Optional[Any] = ...,
creationflags: int = ...,
restore_signals: bool = ...,
start_new_session: bool = ...,
pass_fds: Any = ...,
) -> Process: ...