Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 1 | import collections |
| 2 | import subprocess |
Victor Stinner | 978a9af | 2015-01-29 17:50:58 +0100 | [diff] [blame] | 3 | import warnings |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 4 | |
Yury Selivanov | 2a8911c | 2015-08-04 15:56:33 -0400 | [diff] [blame] | 5 | from . import compat |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 6 | from . import futures |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 7 | from . import protocols |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 8 | from . import transports |
Victor Stinner | f951d28 | 2014-06-29 00:46:45 +0200 | [diff] [blame] | 9 | from .coroutines import coroutine |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 10 | from .log import logger |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 11 | |
| 12 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 13 | class BaseSubprocessTransport(transports.SubprocessTransport): |
| 14 | |
| 15 | def __init__(self, loop, protocol, args, shell, |
| 16 | stdin, stdout, stderr, bufsize, |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 17 | waiter=None, extra=None, **kwargs): |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 18 | super().__init__(extra) |
Victor Stinner | 978a9af | 2015-01-29 17:50:58 +0100 | [diff] [blame] | 19 | self._closed = False |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 20 | self._protocol = protocol |
| 21 | self._loop = loop |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 22 | self._proc = None |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 23 | self._pid = None |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 24 | self._returncode = None |
| 25 | self._exit_waiters = [] |
| 26 | self._pending_calls = collections.deque() |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 27 | self._pipes = {} |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 28 | self._finished = False |
| 29 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 30 | if stdin == subprocess.PIPE: |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 31 | self._pipes[0] = None |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 32 | if stdout == subprocess.PIPE: |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 33 | self._pipes[1] = None |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 34 | if stderr == subprocess.PIPE: |
Victor Stinner | 915bcb0 | 2014-02-01 22:49:59 +0100 | [diff] [blame] | 35 | self._pipes[2] = None |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 36 | |
| 37 | # Create the child process: set the _proc attribute |
Victor Stinner | 6fb1e74 | 2015-07-31 17:49:43 +0200 | [diff] [blame] | 38 | try: |
| 39 | self._start(args=args, shell=shell, stdin=stdin, stdout=stdout, |
| 40 | stderr=stderr, bufsize=bufsize, **kwargs) |
| 41 | except: |
| 42 | self.close() |
| 43 | raise |
| 44 | |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 45 | self._pid = self._proc.pid |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 46 | self._extra['subprocess'] = self._proc |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 47 | |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 48 | if self._loop.get_debug(): |
| 49 | if isinstance(args, (bytes, str)): |
| 50 | program = args |
| 51 | else: |
| 52 | program = args[0] |
| 53 | logger.debug('process %r created: pid %s', |
| 54 | program, self._pid) |
| 55 | |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 56 | self._loop.create_task(self._connect_pipes(waiter)) |
| 57 | |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 58 | def __repr__(self): |
Victor Stinner | 978a9af | 2015-01-29 17:50:58 +0100 | [diff] [blame] | 59 | info = [self.__class__.__name__] |
| 60 | if self._closed: |
| 61 | info.append('closed') |
Victor Stinner | 7a82afe | 2015-03-10 16:32:29 +0100 | [diff] [blame] | 62 | if self._pid is not None: |
| 63 | info.append('pid=%s' % self._pid) |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 64 | if self._returncode is not None: |
| 65 | info.append('returncode=%s' % self._returncode) |
Victor Stinner | 7a82afe | 2015-03-10 16:32:29 +0100 | [diff] [blame] | 66 | elif self._pid is not None: |
Victor Stinner | 4e82fb9 | 2015-02-17 22:50:33 +0100 | [diff] [blame] | 67 | info.append('running') |
Victor Stinner | 7a82afe | 2015-03-10 16:32:29 +0100 | [diff] [blame] | 68 | else: |
| 69 | info.append('not started') |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 70 | |
| 71 | stdin = self._pipes.get(0) |
| 72 | if stdin is not None: |
| 73 | info.append('stdin=%s' % stdin.pipe) |
| 74 | |
| 75 | stdout = self._pipes.get(1) |
| 76 | stderr = self._pipes.get(2) |
| 77 | if stdout is not None and stderr is stdout: |
| 78 | info.append('stdout=stderr=%s' % stdout.pipe) |
| 79 | else: |
| 80 | if stdout is not None: |
| 81 | info.append('stdout=%s' % stdout.pipe) |
| 82 | if stderr is not None: |
| 83 | info.append('stderr=%s' % stderr.pipe) |
| 84 | |
| 85 | return '<%s>' % ' '.join(info) |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 86 | |
| 87 | def _start(self, args, shell, stdin, stdout, stderr, bufsize, **kwargs): |
| 88 | raise NotImplementedError |
| 89 | |
Yury Selivanov | 5bb1afb | 2015-11-16 12:43:21 -0500 | [diff] [blame] | 90 | def is_closing(self): |
| 91 | return self._closed |
| 92 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 93 | def close(self): |
Victor Stinner | f2e43cb | 2015-01-30 01:20:44 +0100 | [diff] [blame] | 94 | if self._closed: |
| 95 | return |
Victor Stinner | 978a9af | 2015-01-29 17:50:58 +0100 | [diff] [blame] | 96 | self._closed = True |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 97 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 98 | for proto in self._pipes.values(): |
Victor Stinner | 29ad011 | 2015-01-15 00:04:21 +0100 | [diff] [blame] | 99 | if proto is None: |
| 100 | continue |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 101 | proto.pipe.close() |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 102 | |
Victor Stinner | 8e36812 | 2015-02-10 14:49:32 +0100 | [diff] [blame] | 103 | if (self._proc is not None |
| 104 | # the child process finished? |
| 105 | and self._returncode is None |
| 106 | # the child process finished but the transport was not notified yet? |
| 107 | and self._proc.poll() is None |
| 108 | ): |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 109 | if self._loop.get_debug(): |
| 110 | logger.warning('Close running child process: kill %r', self) |
| 111 | |
| 112 | try: |
| 113 | self._proc.kill() |
| 114 | except ProcessLookupError: |
| 115 | pass |
| 116 | |
Victor Stinner | f2e43cb | 2015-01-30 01:20:44 +0100 | [diff] [blame] | 117 | # Don't clear the _proc reference yet: _post_init() may still run |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 118 | |
Victor Stinner | 978a9af | 2015-01-29 17:50:58 +0100 | [diff] [blame] | 119 | # On Python 3.3 and older, objects with a destructor part of a reference |
| 120 | # cycle are never destroyed. It's not more the case on Python 3.4 thanks |
| 121 | # to the PEP 442. |
Yury Selivanov | 2a8911c | 2015-08-04 15:56:33 -0400 | [diff] [blame] | 122 | if compat.PY34: |
Victor Stinner | 978a9af | 2015-01-29 17:50:58 +0100 | [diff] [blame] | 123 | def __del__(self): |
| 124 | if not self._closed: |
| 125 | warnings.warn("unclosed transport %r" % self, ResourceWarning) |
| 126 | self.close() |
| 127 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 128 | def get_pid(self): |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 129 | return self._pid |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 130 | |
| 131 | def get_returncode(self): |
| 132 | return self._returncode |
| 133 | |
| 134 | def get_pipe_transport(self, fd): |
| 135 | if fd in self._pipes: |
| 136 | return self._pipes[fd].pipe |
| 137 | else: |
| 138 | return None |
| 139 | |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 140 | def _check_proc(self): |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 141 | if self._proc is None: |
| 142 | raise ProcessLookupError() |
| 143 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 144 | def send_signal(self, signal): |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 145 | self._check_proc() |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 146 | self._proc.send_signal(signal) |
| 147 | |
| 148 | def terminate(self): |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 149 | self._check_proc() |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 150 | self._proc.terminate() |
| 151 | |
| 152 | def kill(self): |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 153 | self._check_proc() |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 154 | self._proc.kill() |
| 155 | |
Victor Stinner | f951d28 | 2014-06-29 00:46:45 +0200 | [diff] [blame] | 156 | @coroutine |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 157 | def _connect_pipes(self, waiter): |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 158 | try: |
| 159 | proc = self._proc |
| 160 | loop = self._loop |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 161 | |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 162 | if proc.stdin is not None: |
| 163 | _, pipe = yield from loop.connect_write_pipe( |
| 164 | lambda: WriteSubprocessPipeProto(self, 0), |
| 165 | proc.stdin) |
| 166 | self._pipes[0] = pipe |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 167 | |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 168 | if proc.stdout is not None: |
| 169 | _, pipe = yield from loop.connect_read_pipe( |
| 170 | lambda: ReadSubprocessPipeProto(self, 1), |
| 171 | proc.stdout) |
| 172 | self._pipes[1] = pipe |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 173 | |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 174 | if proc.stderr is not None: |
| 175 | _, pipe = yield from loop.connect_read_pipe( |
| 176 | lambda: ReadSubprocessPipeProto(self, 2), |
| 177 | proc.stderr) |
| 178 | self._pipes[2] = pipe |
Victor Stinner | aaabc4f | 2014-01-29 14:22:56 -0800 | [diff] [blame] | 179 | |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 180 | assert self._pending_calls is not None |
Victor Stinner | aaabc4f | 2014-01-29 14:22:56 -0800 | [diff] [blame] | 181 | |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 182 | loop.call_soon(self._protocol.connection_made, self) |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 183 | for callback, data in self._pending_calls: |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 184 | loop.call_soon(callback, *data) |
Victor Stinner | f651a60 | 2015-01-14 02:10:33 +0100 | [diff] [blame] | 185 | self._pending_calls = None |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 186 | except Exception as exc: |
| 187 | if waiter is not None and not waiter.cancelled(): |
| 188 | waiter.set_exception(exc) |
| 189 | else: |
| 190 | if waiter is not None and not waiter.cancelled(): |
| 191 | waiter.set_result(None) |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 192 | |
| 193 | def _call(self, cb, *data): |
| 194 | if self._pending_calls is not None: |
| 195 | self._pending_calls.append((cb, data)) |
| 196 | else: |
| 197 | self._loop.call_soon(cb, *data) |
| 198 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 199 | def _pipe_connection_lost(self, fd, exc): |
| 200 | self._call(self._protocol.pipe_connection_lost, fd, exc) |
| 201 | self._try_finish() |
| 202 | |
| 203 | def _pipe_data_received(self, fd, data): |
| 204 | self._call(self._protocol.pipe_data_received, fd, data) |
| 205 | |
| 206 | def _process_exited(self, returncode): |
| 207 | assert returncode is not None, returncode |
| 208 | assert self._returncode is None, self._returncode |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 209 | if self._loop.get_debug(): |
| 210 | logger.info('%r exited with return code %r', |
| 211 | self, returncode) |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 212 | self._returncode = returncode |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 213 | self._call(self._protocol.process_exited) |
| 214 | self._try_finish() |
| 215 | |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 216 | # wake up futures waiting for wait() |
| 217 | for waiter in self._exit_waiters: |
| 218 | if not waiter.cancelled(): |
| 219 | waiter.set_result(returncode) |
| 220 | self._exit_waiters = None |
| 221 | |
Victor Stinner | d6dc7bd | 2015-03-18 11:37:42 +0100 | [diff] [blame] | 222 | @coroutine |
Victor Stinner | 1241ecc | 2015-01-30 00:16:14 +0100 | [diff] [blame] | 223 | def _wait(self): |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 224 | """Wait until the process exit and return the process return code. |
| 225 | |
| 226 | This method is a coroutine.""" |
| 227 | if self._returncode is not None: |
| 228 | return self._returncode |
| 229 | |
Yury Selivanov | 7661db6 | 2016-05-16 15:38:39 -0400 | [diff] [blame] | 230 | waiter = self._loop.create_future() |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 231 | self._exit_waiters.append(waiter) |
| 232 | return (yield from waiter) |
| 233 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 234 | def _try_finish(self): |
| 235 | assert not self._finished |
| 236 | if self._returncode is None: |
| 237 | return |
| 238 | if all(p is not None and p.disconnected |
| 239 | for p in self._pipes.values()): |
| 240 | self._finished = True |
Victor Stinner | 1b9763d | 2014-12-18 23:47:27 +0100 | [diff] [blame] | 241 | self._call(self._call_connection_lost, None) |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 242 | |
| 243 | def _call_connection_lost(self, exc): |
| 244 | try: |
| 245 | self._protocol.connection_lost(exc) |
| 246 | finally: |
Victor Stinner | 47cd10d | 2015-01-30 00:05:19 +0100 | [diff] [blame] | 247 | self._loop = None |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 248 | self._proc = None |
| 249 | self._protocol = None |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 250 | |
| 251 | |
| 252 | class WriteSubprocessPipeProto(protocols.BaseProtocol): |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 253 | |
| 254 | def __init__(self, proc, fd): |
| 255 | self.proc = proc |
| 256 | self.fd = fd |
Victor Stinner | aaabc4f | 2014-01-29 14:22:56 -0800 | [diff] [blame] | 257 | self.pipe = None |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 258 | self.disconnected = False |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 259 | |
| 260 | def connection_made(self, transport): |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 261 | self.pipe = transport |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 262 | |
Victor Stinner | acdb782 | 2014-07-14 18:33:40 +0200 | [diff] [blame] | 263 | def __repr__(self): |
| 264 | return ('<%s fd=%s pipe=%r>' |
| 265 | % (self.__class__.__name__, self.fd, self.pipe)) |
| 266 | |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 267 | def connection_lost(self, exc): |
| 268 | self.disconnected = True |
| 269 | self.proc._pipe_connection_lost(self.fd, exc) |
Victor Stinner | 587feb1 | 2015-01-09 21:34:27 +0100 | [diff] [blame] | 270 | self.proc = None |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 271 | |
Guido van Rossum | 1e9a446 | 2014-01-29 14:28:15 -0800 | [diff] [blame] | 272 | def pause_writing(self): |
| 273 | self.proc._protocol.pause_writing() |
| 274 | |
| 275 | def resume_writing(self): |
| 276 | self.proc._protocol.resume_writing() |
Guido van Rossum | 0016e1d | 2013-10-30 14:56:49 -0700 | [diff] [blame] | 277 | |
| 278 | |
| 279 | class ReadSubprocessPipeProto(WriteSubprocessPipeProto, |
| 280 | protocols.Protocol): |
| 281 | |
| 282 | def data_received(self, data): |
| 283 | self.proc._pipe_data_received(self.fd, data) |