Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1from __future__ import annotations
3from abc import abstractmethod
4from signal import Signals
6from ._resources import AsyncResource
7from ._streams import ByteReceiveStream, ByteSendStream
10class Process(AsyncResource):
11 """An asynchronous version of :class:`subprocess.Popen`."""
13 @abstractmethod
14 async def wait(self) -> int:
15 """
16 Wait until the process exits.
18 :return: the exit code of the process
19 """
21 @abstractmethod
22 def terminate(self) -> None:
23 """
24 Terminates the process, gracefully if possible.
26 On Windows, this calls ``TerminateProcess()``.
27 On POSIX systems, this sends ``SIGTERM`` to the process.
29 .. seealso:: :meth:`subprocess.Popen.terminate`
30 """
32 @abstractmethod
33 def kill(self) -> None:
34 """
35 Kills the process.
37 On Windows, this calls ``TerminateProcess()``.
38 On POSIX systems, this sends ``SIGKILL`` to the process.
40 .. seealso:: :meth:`subprocess.Popen.kill`
41 """
43 @abstractmethod
44 def send_signal(self, signal: Signals) -> None:
45 """
46 Send a signal to the subprocess.
48 .. seealso:: :meth:`subprocess.Popen.send_signal`
50 :param signal: the signal number (e.g. :data:`signal.SIGHUP`)
51 """
53 @property
54 @abstractmethod
55 def pid(self) -> int:
56 """The process ID of the process."""
58 @property
59 @abstractmethod
60 def returncode(self) -> int | None:
61 """
62 The return code of the process. If the process has not yet terminated, this will
63 be ``None``.
64 """
66 @property
67 @abstractmethod
68 def stdin(self) -> ByteSendStream | None:
69 """The stream for the standard input of the process."""
71 @property
72 @abstractmethod
73 def stdout(self) -> ByteReceiveStream | None:
74 """The stream for the standard output of the process."""
76 @property
77 @abstractmethod
78 def stderr(self) -> ByteReceiveStream | None:
79 """The stream for the standard error output of the process."""