Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 1 | __all__ = 'create_subprocess_exec', 'create_subprocess_shell' |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 2 | |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 3 | import subprocess |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 4 | import warnings |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 5 | |
| 6 | from . import events |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 7 | from . import protocols |
| 8 | from . import streams |
| 9 | from . import tasks |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 10 | from .log import logger |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 11 | |
| 12 | |
| 13 | PIPE = subprocess.PIPE |
| 14 | STDOUT = subprocess.STDOUT |
| 15 | DEVNULL = subprocess.DEVNULL |
| 16 | |
| 17 | |
| 18 | class SubprocessStreamProtocol(streams.FlowControlMixin, |
| 19 | protocols.SubprocessProtocol): |
| 20 | """Like StreamReaderProtocol, but for a subprocess.""" |
| 21 | |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 22 | def __init__(self, limit, loop, *, _asyncio_internal=False): |
| 23 | super().__init__(loop=loop, _asyncio_internal=_asyncio_internal) |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 24 | self._limit = limit |
| 25 | self.stdin = self.stdout = self.stderr = None |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 26 | self._transport = None |
Seth M. Larson | 481cb70 | 2017-03-02 22:21:18 -0600 | [diff] [blame] | 27 | self._process_exited = False |
| 28 | self._pipe_fds = [] |
Andrew Svetlov | 1cc0ee7 | 2019-05-07 16:53:19 -0400 | [diff] [blame] | 29 | self._stdin_closed = self._loop.create_future() |
Andrew Svetlov | 23b4b69 | 2019-05-27 22:56:22 +0300 | [diff] [blame] | 30 | self._stdout_closed = self._loop.create_future() |
| 31 | self._stderr_closed = self._loop.create_future() |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 32 | |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 33 | def __repr__(self): |
| 34 | info = [self.__class__.__name__] |
| 35 | if self.stdin is not None: |
Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 36 | info.append(f'stdin={self.stdin!r}') |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 37 | if self.stdout is not None: |
Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 38 | info.append(f'stdout={self.stdout!r}') |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 39 | if self.stderr is not None: |
Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 40 | info.append(f'stderr={self.stderr!r}') |
| 41 | return '<{}>'.format(' '.join(info)) |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 42 | |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 43 | def connection_made(self, transport): |
| 44 | self._transport = transport |
Victor Stinner | 5ef586f | 2014-11-25 17:20:33 +0100 | [diff] [blame] | 45 | stdout_transport = transport.get_pipe_transport(1) |
| 46 | if stdout_transport is not None: |
Andrew Svetlov | 23b4b69 | 2019-05-27 22:56:22 +0300 | [diff] [blame] | 47 | self.stdout = streams.Stream(mode=streams.StreamMode.READ, |
| 48 | transport=stdout_transport, |
| 49 | protocol=self, |
| 50 | limit=self._limit, |
| 51 | loop=self._loop, |
| 52 | _asyncio_internal=True) |
Victor Stinner | 5ef586f | 2014-11-25 17:20:33 +0100 | [diff] [blame] | 53 | self.stdout.set_transport(stdout_transport) |
Seth M. Larson | 481cb70 | 2017-03-02 22:21:18 -0600 | [diff] [blame] | 54 | self._pipe_fds.append(1) |
Victor Stinner | 5ef586f | 2014-11-25 17:20:33 +0100 | [diff] [blame] | 55 | |
| 56 | stderr_transport = transport.get_pipe_transport(2) |
| 57 | if stderr_transport is not None: |
Andrew Svetlov | 23b4b69 | 2019-05-27 22:56:22 +0300 | [diff] [blame] | 58 | self.stderr = streams.Stream(mode=streams.StreamMode.READ, |
| 59 | transport=stderr_transport, |
| 60 | protocol=self, |
| 61 | limit=self._limit, |
| 62 | loop=self._loop, |
| 63 | _asyncio_internal=True) |
Victor Stinner | 5ef586f | 2014-11-25 17:20:33 +0100 | [diff] [blame] | 64 | self.stderr.set_transport(stderr_transport) |
Seth M. Larson | 481cb70 | 2017-03-02 22:21:18 -0600 | [diff] [blame] | 65 | self._pipe_fds.append(2) |
Victor Stinner | 5ef586f | 2014-11-25 17:20:33 +0100 | [diff] [blame] | 66 | |
| 67 | stdin_transport = transport.get_pipe_transport(0) |
| 68 | if stdin_transport is not None: |
Andrew Svetlov | 23b4b69 | 2019-05-27 22:56:22 +0300 | [diff] [blame] | 69 | self.stdin = streams.Stream(mode=streams.StreamMode.WRITE, |
| 70 | transport=stdin_transport, |
| 71 | protocol=self, |
| 72 | loop=self._loop, |
| 73 | _asyncio_internal=True) |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 74 | |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 75 | def pipe_data_received(self, fd, data): |
| 76 | if fd == 1: |
| 77 | reader = self.stdout |
| 78 | elif fd == 2: |
| 79 | reader = self.stderr |
| 80 | else: |
| 81 | reader = None |
| 82 | if reader is not None: |
| 83 | reader.feed_data(data) |
| 84 | |
| 85 | def pipe_connection_lost(self, fd, exc): |
| 86 | if fd == 0: |
| 87 | pipe = self.stdin |
| 88 | if pipe is not None: |
| 89 | pipe.close() |
| 90 | self.connection_lost(exc) |
Andrew Svetlov | 1cc0ee7 | 2019-05-07 16:53:19 -0400 | [diff] [blame] | 91 | if exc is None: |
| 92 | self._stdin_closed.set_result(None) |
| 93 | else: |
| 94 | self._stdin_closed.set_exception(exc) |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 95 | return |
| 96 | if fd == 1: |
| 97 | reader = self.stdout |
| 98 | elif fd == 2: |
| 99 | reader = self.stderr |
| 100 | else: |
| 101 | reader = None |
Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 102 | if reader is not None: |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 103 | if exc is None: |
| 104 | reader.feed_eof() |
| 105 | else: |
| 106 | reader.set_exception(exc) |
Yury Selivanov | 2f15645 | 2017-03-02 23:25:31 -0500 | [diff] [blame] | 107 | |
Seth M. Larson | 481cb70 | 2017-03-02 22:21:18 -0600 | [diff] [blame] | 108 | if fd in self._pipe_fds: |
| 109 | self._pipe_fds.remove(fd) |
| 110 | self._maybe_close_transport() |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 111 | |
| 112 | def process_exited(self): |
Seth M. Larson | 481cb70 | 2017-03-02 22:21:18 -0600 | [diff] [blame] | 113 | self._process_exited = True |
| 114 | self._maybe_close_transport() |
Yury Selivanov | 2f15645 | 2017-03-02 23:25:31 -0500 | [diff] [blame] | 115 | |
Seth M. Larson | 481cb70 | 2017-03-02 22:21:18 -0600 | [diff] [blame] | 116 | def _maybe_close_transport(self): |
| 117 | if len(self._pipe_fds) == 0 and self._process_exited: |
| 118 | self._transport.close() |
| 119 | self._transport = None |
Victor Stinner | 791009b | 2015-01-15 13:16:02 +0100 | [diff] [blame] | 120 | |
Andrew Svetlov | 1cc0ee7 | 2019-05-07 16:53:19 -0400 | [diff] [blame] | 121 | def _get_close_waiter(self, stream): |
| 122 | if stream is self.stdin: |
| 123 | return self._stdin_closed |
Andrew Svetlov | 23b4b69 | 2019-05-27 22:56:22 +0300 | [diff] [blame] | 124 | elif stream is self.stdout: |
| 125 | return self._stdout_closed |
| 126 | elif stream is self.stderr: |
| 127 | return self._stderr_closed |
Andrew Svetlov | 1cc0ee7 | 2019-05-07 16:53:19 -0400 | [diff] [blame] | 128 | |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 129 | |
| 130 | class Process: |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 131 | def __init__(self, transport, protocol, loop, *, _asyncio_internal=False): |
| 132 | if not _asyncio_internal: |
| 133 | warnings.warn(f"{self.__class__} should be instaniated " |
| 134 | "by asyncio internals only, " |
| 135 | "please avoid its creation from user code", |
| 136 | DeprecationWarning) |
| 137 | |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 138 | self._transport = transport |
| 139 | self._protocol = protocol |
| 140 | self._loop = loop |
| 141 | self.stdin = protocol.stdin |
| 142 | self.stdout = protocol.stdout |
| 143 | self.stderr = protocol.stderr |
| 144 | self.pid = transport.get_pid() |
| 145 | |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 146 | def __repr__(self): |
Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 147 | return f'<{self.__class__.__name__} {self.pid}>' |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 148 | |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 149 | @property |
| 150 | def returncode(self): |
| 151 | return self._transport.get_returncode() |
| 152 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 153 | async def wait(self): |
| 154 | """Wait until the process exit and return the process return code.""" |
| 155 | return await self._transport._wait() |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 156 | |
| 157 | def send_signal(self, signal): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 158 | self._transport.send_signal(signal) |
| 159 | |
| 160 | def terminate(self): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 161 | self._transport.terminate() |
| 162 | |
| 163 | def kill(self): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 164 | self._transport.kill() |
| 165 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 166 | async def _feed_stdin(self, input): |
Victor Stinner | d55b54d | 2014-07-17 13:12:03 +0200 | [diff] [blame] | 167 | debug = self._loop.get_debug() |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 168 | self.stdin.write(input) |
Victor Stinner | d55b54d | 2014-07-17 13:12:03 +0200 | [diff] [blame] | 169 | if debug: |
Yury Selivanov | 6370f34 | 2017-12-10 18:36:12 -0500 | [diff] [blame] | 170 | logger.debug( |
| 171 | '%r communicate: feed stdin (%s bytes)', self, len(input)) |
Victor Stinner | cc996b5 | 2014-07-17 12:25:27 +0200 | [diff] [blame] | 172 | try: |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 173 | await self.stdin.drain() |
Victor Stinner | d55b54d | 2014-07-17 13:12:03 +0200 | [diff] [blame] | 174 | except (BrokenPipeError, ConnectionResetError) as exc: |
| 175 | # communicate() ignores BrokenPipeError and ConnectionResetError |
| 176 | if debug: |
| 177 | logger.debug('%r communicate: stdin got %r', self, exc) |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 178 | |
Victor Stinner | d55b54d | 2014-07-17 13:12:03 +0200 | [diff] [blame] | 179 | if debug: |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 180 | logger.debug('%r communicate: close stdin', self) |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 181 | self.stdin.close() |
| 182 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 183 | async def _noop(self): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 184 | return None |
| 185 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 186 | async def _read_stream(self, fd): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 187 | transport = self._transport.get_pipe_transport(fd) |
| 188 | if fd == 2: |
| 189 | stream = self.stderr |
| 190 | else: |
| 191 | assert fd == 1 |
| 192 | stream = self.stdout |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 193 | if self._loop.get_debug(): |
| 194 | name = 'stdout' if fd == 1 else 'stderr' |
| 195 | logger.debug('%r communicate: read %s', self, name) |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 196 | output = await stream.read() |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 197 | if self._loop.get_debug(): |
| 198 | name = 'stdout' if fd == 1 else 'stderr' |
| 199 | logger.debug('%r communicate: close %s', self, name) |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 200 | transport.close() |
| 201 | return output |
| 202 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 203 | async def communicate(self, input=None): |
Yury Selivanov | 7657f6b | 2016-05-13 15:35:28 -0400 | [diff] [blame] | 204 | if input is not None: |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 205 | stdin = self._feed_stdin(input) |
| 206 | else: |
| 207 | stdin = self._noop() |
| 208 | if self.stdout is not None: |
| 209 | stdout = self._read_stream(1) |
| 210 | else: |
| 211 | stdout = self._noop() |
| 212 | if self.stderr is not None: |
| 213 | stderr = self._read_stream(2) |
| 214 | else: |
| 215 | stderr = self._noop() |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 216 | stdin, stdout, stderr = await tasks.gather(stdin, stdout, stderr, |
| 217 | loop=self._loop) |
| 218 | await self.wait() |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 219 | return (stdout, stderr) |
| 220 | |
| 221 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 222 | async def create_subprocess_shell(cmd, stdin=None, stdout=None, stderr=None, |
| 223 | loop=None, limit=streams._DEFAULT_LIMIT, |
| 224 | **kwds): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 225 | if loop is None: |
| 226 | loop = events.get_event_loop() |
| 227 | protocol_factory = lambda: SubprocessStreamProtocol(limit=limit, |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 228 | loop=loop, |
| 229 | _asyncio_internal=True) |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 230 | transport, protocol = await loop.subprocess_shell( |
| 231 | protocol_factory, |
| 232 | cmd, stdin=stdin, stdout=stdout, |
| 233 | stderr=stderr, **kwds) |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 234 | return Process(transport, protocol, loop, _asyncio_internal=True) |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 235 | |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 236 | |
| 237 | async def create_subprocess_exec(program, *args, stdin=None, stdout=None, |
| 238 | stderr=None, loop=None, |
| 239 | limit=streams._DEFAULT_LIMIT, **kwds): |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 240 | if loop is None: |
| 241 | loop = events.get_event_loop() |
| 242 | protocol_factory = lambda: SubprocessStreamProtocol(limit=limit, |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 243 | loop=loop, |
| 244 | _asyncio_internal=True) |
Andrew Svetlov | 5f841b5 | 2017-12-09 00:23:48 +0200 | [diff] [blame] | 245 | transport, protocol = await loop.subprocess_exec( |
| 246 | protocol_factory, |
| 247 | program, *args, |
| 248 | stdin=stdin, stdout=stdout, |
| 249 | stderr=stderr, **kwds) |
Andrew Svetlov | ad4ed87 | 2019-05-06 22:52:11 -0400 | [diff] [blame] | 250 | return Process(transport, protocol, loop, _asyncio_internal=True) |