mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-07 04:34:28 +08:00
dccc29bc2f
* Add `None` to type union for `subprocess.Popen.communicate` stub's `input` parameter. * subprocess.communicate `input` annotated as `Optional[AnyStr]` for both 2.7 and 3.x; `timeout` as `Optional[float]`.
250 lines
9.3 KiB
Python
250 lines
9.3 KiB
Python
# Stubs for subprocess
|
|
|
|
# Based on http://docs.python.org/3.5/library/subprocess.html
|
|
import sys
|
|
from typing import Sequence, Any, AnyStr, Mapping, Callable, Tuple, IO, Optional, Union, List, Type
|
|
from types import TracebackType
|
|
|
|
|
|
if sys.version_info >= (3, 5):
|
|
class CompletedProcess:
|
|
args = ... # type: Union[List, str]
|
|
returncode = ... # type: int
|
|
stdout = ... # type: Union[str, bytes]
|
|
stderr = ... # type: Union[str, bytes]
|
|
def __init__(self, args: Union[List, str],
|
|
returncode: int,
|
|
stdout: Union[str, bytes],
|
|
stderr: Union[str, bytes]) -> None: ...
|
|
def check_returncode(self) -> None: ...
|
|
|
|
# Nearly same args as Popen.__init__ except for timeout, input, and check
|
|
def run(args: Union[str, Sequence[str]],
|
|
timeout: float = ...,
|
|
input: Union[str, bytes] = ...,
|
|
check: bool = ...,
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stdout: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...) -> CompletedProcess: ...
|
|
|
|
# Same args as Popen.__init__
|
|
if sys.version_info >= (3, 3):
|
|
# 3.3 added timeout
|
|
def call(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stdout: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...,
|
|
timeout: float = ...) -> int: ...
|
|
else:
|
|
def call(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stdout: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...) -> int: ...
|
|
|
|
# Same args as Popen.__init__
|
|
if sys.version_info >= (3, 3):
|
|
# 3.3 added timeout
|
|
def check_call(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stdout: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...,
|
|
timeout: float = ...) -> int: ...
|
|
else:
|
|
def check_call(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stdout: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...) -> int: ...
|
|
|
|
if sys.version_info >= (3, 4):
|
|
# 3.4 added input
|
|
def check_output(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...,
|
|
timeout: float = ...,
|
|
input: Union[str, bytes] = ...) -> Any: ...
|
|
elif sys.version_info >= (3, 3):
|
|
# 3.3 added timeout
|
|
def check_output(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...,
|
|
timeout: float = ...) -> Any: ...
|
|
else:
|
|
# Same args as Popen.__init__, except for stdout
|
|
def check_output(args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: str = ...,
|
|
stdin: Any = ...,
|
|
stderr: Any = ...,
|
|
preexec_fn: Callable[[], Any] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: str = ...,
|
|
env: Mapping[str, str] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Any = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...) -> Any: ...
|
|
|
|
|
|
# TODO types
|
|
PIPE = ... # type: Any
|
|
STDOUT = ... # type: Any
|
|
if sys.version_info >= (3, 3):
|
|
DEVNULL = ... # type: Any
|
|
class SubprocessError(Exception): ...
|
|
class TimeoutExpired(SubprocessError): ...
|
|
|
|
|
|
class CalledProcessError(Exception):
|
|
returncode = 0
|
|
cmd = ... # type: str
|
|
output = b'' # May be None
|
|
|
|
if sys.version_info >= (3, 5):
|
|
stdout = b''
|
|
stderr = b''
|
|
|
|
def __init__(self, returncode: int, cmd: str, output: Optional[str] = ...,
|
|
stderr: Optional[str] = ...) -> None: ...
|
|
|
|
class Popen:
|
|
stdin = ... # type: IO[Any]
|
|
stdout = ... # type: IO[Any]
|
|
stderr = ... # type: IO[Any]
|
|
pid = 0
|
|
returncode = 0
|
|
|
|
def __init__(self,
|
|
args: Union[str, Sequence[str]],
|
|
bufsize: int = ...,
|
|
executable: Optional[str] = ...,
|
|
stdin: Optional[Any] = ...,
|
|
stdout: Optional[Any] = ...,
|
|
stderr: Optional[Any] = ...,
|
|
preexec_fn: Optional[Callable[[], Any]] = ...,
|
|
close_fds: bool = ...,
|
|
shell: bool = ...,
|
|
cwd: Optional[str] = ...,
|
|
env: Optional[Mapping[str, str]] = ...,
|
|
universal_newlines: bool = ...,
|
|
startupinfo: Optional[Any] = ...,
|
|
creationflags: int = ...,
|
|
restore_signals: bool = ...,
|
|
start_new_session: bool = ...,
|
|
pass_fds: Any = ...) -> None: ...
|
|
|
|
def poll(self) -> int: ...
|
|
if sys.version_info >= (3, 3):
|
|
# 3.3 added timeout
|
|
def wait(self, timeout: Optional[float] = ...) -> int: ...
|
|
else:
|
|
def wait(self) ->int: ...
|
|
# Return str/bytes
|
|
if sys.version_info >= (3, 3):
|
|
def communicate(self, input: Optional[AnyStr] = ..., timeout: Optional[float] = ...) -> Tuple[Any, Any]: ...
|
|
else:
|
|
def communicate(self, input: Optional[AnyStr] = ...) -> Tuple[Any, Any]: ...
|
|
def send_signal(self, signal: int) -> None: ...
|
|
def terminate(self) -> None: ...
|
|
def kill(self) -> None: ...
|
|
def __enter__(self) -> 'Popen': ...
|
|
def __exit__(self, type: Optional[Type[BaseException]], value: Optional[BaseException], traceback: Optional[TracebackType]) -> bool: ...
|
|
|
|
def getstatusoutput(cmd: str) -> Tuple[int, str]: ...
|
|
def getoutput(cmd: str) -> str: ...
|
|
|
|
# Windows-only: STARTUPINFO etc.
|