Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1 | # subprocess - Subprocesses with accessible I/O streams |
| 2 | # |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 3 | # For more information about this module, see PEP 324. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 4 | # |
Peter Astrand | 3a708df | 2005-09-23 17:37:29 +0000 | [diff] [blame] | 5 | # Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se> |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 6 | # |
Peter Astrand | 69bf13f | 2005-02-14 08:56:32 +0000 | [diff] [blame] | 7 | # Licensed to PSF under a Contributor Agreement. |
Peter Astrand | 3a708df | 2005-09-23 17:37:29 +0000 | [diff] [blame] | 8 | # See http://www.python.org/2.4/license for licensing details. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 9 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 10 | r"""Subprocesses with accessible I/O streams |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 11 | |
Fredrik Lundh | 15aaacc | 2004-10-17 14:47:05 +0000 | [diff] [blame] | 12 | This module allows you to spawn processes, connect to their |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 13 | input/output/error pipes, and obtain their return codes. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 14 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 15 | For a complete description of this module see the Python documentation. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 16 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 17 | Main API |
| 18 | ======== |
| 19 | run(...): Runs a command, waits for it to complete, then returns a |
| 20 | CompletedProcess instance. |
| 21 | Popen(...): A class for flexibly executing a command in a new process |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 22 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 23 | Constants |
| 24 | --------- |
| 25 | DEVNULL: Special value that indicates that os.devnull should be used |
| 26 | PIPE: Special value that indicates a pipe should be created |
| 27 | STDOUT: Special value that indicates that stderr should go to stdout |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 28 | |
| 29 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 30 | Older API |
| 31 | ========= |
| 32 | call(...): Runs a command, waits for it to complete, then returns |
| 33 | the return code. |
| 34 | check_call(...): Same as call() but raises CalledProcessError() |
| 35 | if return code is not 0 |
| 36 | check_output(...): Same as check_call() but returns the contents of |
| 37 | stdout instead of a return code |
| 38 | getoutput(...): Runs a command in the shell, waits for it to complete, |
| 39 | then returns the output |
| 40 | getstatusoutput(...): Runs a command in the shell, waits for it to complete, |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 41 | then returns a (exitcode, output) tuple |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 42 | """ |
| 43 | |
| 44 | import sys |
Gregory P. Smith | cb6fdf2 | 2015-04-07 16:11:33 -0700 | [diff] [blame] | 45 | _mswindows = (sys.platform == "win32") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 46 | |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 47 | import io |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 48 | import os |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 49 | import time |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 50 | import signal |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 51 | import builtins |
Gregory P. Smith | d23047b | 2010-12-04 09:10:44 +0000 | [diff] [blame] | 52 | import warnings |
Ross Lagerwall | 4f61b02 | 2011-04-05 15:34:00 +0200 | [diff] [blame] | 53 | import errno |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 54 | from time import monotonic as _time |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 55 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 56 | # Exception classes used by this module. |
Gregory P. Smith | 54d412e | 2011-03-14 14:08:43 -0400 | [diff] [blame] | 57 | class SubprocessError(Exception): pass |
| 58 | |
| 59 | |
| 60 | class CalledProcessError(SubprocessError): |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 61 | """Raised when run() is called with check=True and the process |
| 62 | returns a non-zero exit status. |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | d6da760 | 2016-06-03 06:14:06 +0000 | [diff] [blame] | 63 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 64 | Attributes: |
| 65 | cmd, returncode, stdout, stderr, output |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 66 | """ |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 67 | def __init__(self, returncode, cmd, output=None, stderr=None): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 68 | self.returncode = returncode |
| 69 | self.cmd = cmd |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 70 | self.output = output |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 71 | self.stderr = stderr |
| 72 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 73 | def __str__(self): |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | d6da760 | 2016-06-03 06:14:06 +0000 | [diff] [blame] | 74 | if self.returncode and self.returncode < 0: |
| 75 | try: |
| 76 | return "Command '%s' died with %r." % ( |
| 77 | self.cmd, signal.Signals(-self.returncode)) |
| 78 | except ValueError: |
| 79 | return "Command '%s' died with unknown signal %d." % ( |
| 80 | self.cmd, -self.returncode) |
| 81 | else: |
| 82 | return "Command '%s' returned non-zero exit status %d." % ( |
| 83 | self.cmd, self.returncode) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 84 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 85 | @property |
| 86 | def stdout(self): |
| 87 | """Alias for output attribute, to match stderr""" |
| 88 | return self.output |
| 89 | |
| 90 | @stdout.setter |
| 91 | def stdout(self, value): |
| 92 | # There's no obvious reason to set this, but allow it anyway so |
| 93 | # .stdout is a transparent alias for .output |
| 94 | self.output = value |
| 95 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 96 | |
Gregory P. Smith | 54d412e | 2011-03-14 14:08:43 -0400 | [diff] [blame] | 97 | class TimeoutExpired(SubprocessError): |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 98 | """This exception is raised when the timeout expires while waiting for a |
| 99 | child process. |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 100 | |
| 101 | Attributes: |
| 102 | cmd, output, stdout, stderr, timeout |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 103 | """ |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 104 | def __init__(self, cmd, timeout, output=None, stderr=None): |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 105 | self.cmd = cmd |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 106 | self.timeout = timeout |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 107 | self.output = output |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 108 | self.stderr = stderr |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 109 | |
| 110 | def __str__(self): |
| 111 | return ("Command '%s' timed out after %s seconds" % |
| 112 | (self.cmd, self.timeout)) |
| 113 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 114 | @property |
| 115 | def stdout(self): |
| 116 | return self.output |
| 117 | |
| 118 | @stdout.setter |
| 119 | def stdout(self, value): |
| 120 | # There's no obvious reason to set this, but allow it anyway so |
| 121 | # .stdout is a transparent alias for .output |
| 122 | self.output = value |
| 123 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 124 | |
Gregory P. Smith | cb6fdf2 | 2015-04-07 16:11:33 -0700 | [diff] [blame] | 125 | if _mswindows: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 126 | import threading |
| 127 | import msvcrt |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 128 | import _winapi |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 129 | class STARTUPINFO: |
Subhendu Ghosh | ae160bb | 2017-02-25 20:29:05 +0530 | [diff] [blame] | 130 | def __init__(self, *, dwFlags=0, hStdInput=None, hStdOutput=None, |
| 131 | hStdError=None, wShowWindow=0): |
| 132 | self.dwFlags = dwFlags |
| 133 | self.hStdInput = hStdInput |
| 134 | self.hStdOutput = hStdOutput |
| 135 | self.hStdError = hStdError |
| 136 | self.wShowWindow = wShowWindow |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 137 | else: |
Gregory P. Smith | 59fd1bf | 2011-05-28 09:32:39 -0700 | [diff] [blame] | 138 | import _posixsubprocess |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 139 | import select |
| 140 | import selectors |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 141 | import threading |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 142 | |
Amaury Forgeot d'Arc | ace3102 | 2009-07-09 22:44:11 +0000 | [diff] [blame] | 143 | # When select or poll has indicated that the file is writable, |
| 144 | # we can write up to _PIPE_BUF bytes without risk of blocking. |
| 145 | # POSIX defines PIPE_BUF as >= 512. |
| 146 | _PIPE_BUF = getattr(select, 'PIPE_BUF', 512) |
| 147 | |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 148 | # poll/select have the advantage of not requiring any extra file |
| 149 | # descriptor, contrarily to epoll/kqueue (also, they require a single |
| 150 | # syscall). |
| 151 | if hasattr(selectors, 'PollSelector'): |
| 152 | _PopenSelector = selectors.PollSelector |
| 153 | else: |
| 154 | _PopenSelector = selectors.SelectSelector |
| 155 | |
Amaury Forgeot d'Arc | ace3102 | 2009-07-09 22:44:11 +0000 | [diff] [blame] | 156 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 157 | __all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput", |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 158 | "getoutput", "check_output", "run", "CalledProcessError", "DEVNULL", |
| 159 | "SubprocessError", "TimeoutExpired", "CompletedProcess"] |
Gregory P. Smith | ace5586 | 2015-04-07 15:57:54 -0700 | [diff] [blame] | 160 | # NOTE: We intentionally exclude list2cmdline as it is |
| 161 | # considered an internal implementation detail. issue10838. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 162 | |
Gregory P. Smith | cb6fdf2 | 2015-04-07 16:11:33 -0700 | [diff] [blame] | 163 | if _mswindows: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 164 | from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP, |
| 165 | STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, |
| 166 | STD_ERROR_HANDLE, SW_HIDE, |
| 167 | STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW) |
Brian Curtin | 5d9deaa | 2011-04-29 16:24:07 -0500 | [diff] [blame] | 168 | |
Brian Curtin | 08fd8d9 | 2011-04-29 16:11:30 -0500 | [diff] [blame] | 169 | __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP", |
Brian Curtin | 8b8e7f4 | 2011-04-29 15:48:13 -0500 | [diff] [blame] | 170 | "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE", |
| 171 | "STD_ERROR_HANDLE", "SW_HIDE", |
Martin Panter | 528619b | 2016-04-16 23:42:37 +0000 | [diff] [blame] | 172 | "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW", |
| 173 | "STARTUPINFO"]) |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 174 | |
| 175 | class Handle(int): |
| 176 | closed = False |
| 177 | |
| 178 | def Close(self, CloseHandle=_winapi.CloseHandle): |
| 179 | if not self.closed: |
| 180 | self.closed = True |
| 181 | CloseHandle(self) |
| 182 | |
| 183 | def Detach(self): |
| 184 | if not self.closed: |
| 185 | self.closed = True |
| 186 | return int(self) |
| 187 | raise ValueError("already closed") |
| 188 | |
| 189 | def __repr__(self): |
Serhiy Storchaka | 465e60e | 2014-07-25 23:36:00 +0300 | [diff] [blame] | 190 | return "%s(%d)" % (self.__class__.__name__, int(self)) |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 191 | |
| 192 | __del__ = Close |
| 193 | __str__ = __repr__ |
| 194 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 195 | |
Charles-François Natali | 134a8ba | 2011-08-18 18:49:39 +0200 | [diff] [blame] | 196 | # This lists holds Popen instances for which the underlying process had not |
| 197 | # exited at the time its __del__ method got called: those processes are wait()ed |
| 198 | # for synchronously from _cleanup() when a new Popen object is created, to avoid |
| 199 | # zombie processes. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 200 | _active = [] |
| 201 | |
| 202 | def _cleanup(): |
| 203 | for inst in _active[:]: |
Georg Brandl | 6aa2d1f | 2008-08-12 08:35:52 +0000 | [diff] [blame] | 204 | res = inst._internal_poll(_deadstate=sys.maxsize) |
Charles-François Natali | 134a8ba | 2011-08-18 18:49:39 +0200 | [diff] [blame] | 205 | if res is not None: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 206 | try: |
| 207 | _active.remove(inst) |
| 208 | except ValueError: |
| 209 | # This can happen if two threads create a new Popen instance. |
| 210 | # It's harmless that it was already removed, so ignore. |
| 211 | pass |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 212 | |
| 213 | PIPE = -1 |
| 214 | STDOUT = -2 |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 215 | DEVNULL = -3 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 216 | |
| 217 | |
Antoine Pitrou | ebdcd85 | 2012-05-18 18:33:07 +0200 | [diff] [blame] | 218 | # XXX This function is only used by multiprocessing and the test suite, |
| 219 | # but it's here so that it can be imported when Python is compiled without |
| 220 | # threads. |
| 221 | |
Victor Stinner | 9def284 | 2016-01-18 12:15:08 +0100 | [diff] [blame] | 222 | def _optim_args_from_interpreter_flags(): |
| 223 | """Return a list of command-line arguments reproducing the current |
| 224 | optimization settings in sys.flags.""" |
| 225 | args = [] |
| 226 | value = sys.flags.optimize |
| 227 | if value > 0: |
| 228 | args.append('-' + 'O' * value) |
| 229 | return args |
| 230 | |
| 231 | |
Antoine Pitrou | ebdcd85 | 2012-05-18 18:33:07 +0200 | [diff] [blame] | 232 | def _args_from_interpreter_flags(): |
| 233 | """Return a list of command-line arguments reproducing the current |
| 234 | settings in sys.flags and sys.warnoptions.""" |
| 235 | flag_opt_map = { |
| 236 | 'debug': 'd', |
| 237 | # 'inspect': 'i', |
| 238 | # 'interactive': 'i', |
Antoine Pitrou | ebdcd85 | 2012-05-18 18:33:07 +0200 | [diff] [blame] | 239 | 'dont_write_bytecode': 'B', |
| 240 | 'no_user_site': 's', |
| 241 | 'no_site': 'S', |
| 242 | 'ignore_environment': 'E', |
| 243 | 'verbose': 'v', |
| 244 | 'bytes_warning': 'b', |
| 245 | 'quiet': 'q', |
Victor Stinner | 9def284 | 2016-01-18 12:15:08 +0100 | [diff] [blame] | 246 | # -O is handled in _optim_args_from_interpreter_flags() |
Antoine Pitrou | ebdcd85 | 2012-05-18 18:33:07 +0200 | [diff] [blame] | 247 | } |
Victor Stinner | 9def284 | 2016-01-18 12:15:08 +0100 | [diff] [blame] | 248 | args = _optim_args_from_interpreter_flags() |
Antoine Pitrou | ebdcd85 | 2012-05-18 18:33:07 +0200 | [diff] [blame] | 249 | for flag, opt in flag_opt_map.items(): |
| 250 | v = getattr(sys.flags, flag) |
| 251 | if v > 0: |
| 252 | args.append('-' + opt * v) |
| 253 | for opt in sys.warnoptions: |
| 254 | args.append('-W' + opt) |
| 255 | return args |
| 256 | |
| 257 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 258 | def call(*popenargs, timeout=None, **kwargs): |
| 259 | """Run command with arguments. Wait for command to complete or |
| 260 | timeout, then return the returncode attribute. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 261 | |
| 262 | The arguments are the same as for the Popen constructor. Example: |
| 263 | |
| 264 | retcode = call(["ls", "-l"]) |
| 265 | """ |
Victor Stinner | c15c88c | 2011-09-01 23:45:04 +0200 | [diff] [blame] | 266 | with Popen(*popenargs, **kwargs) as p: |
| 267 | try: |
| 268 | return p.wait(timeout=timeout) |
| 269 | except: |
| 270 | p.kill() |
| 271 | p.wait() |
| 272 | raise |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 273 | |
| 274 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 275 | def check_call(*popenargs, **kwargs): |
| 276 | """Run command with arguments. Wait for command to complete. If |
| 277 | the exit code was zero then return, otherwise raise |
| 278 | CalledProcessError. The CalledProcessError object will have the |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 279 | return code in the returncode attribute. |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 280 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 281 | The arguments are the same as for the call function. Example: |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 282 | |
| 283 | check_call(["ls", "-l"]) |
| 284 | """ |
| 285 | retcode = call(*popenargs, **kwargs) |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 286 | if retcode: |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 287 | cmd = kwargs.get("args") |
| 288 | if cmd is None: |
| 289 | cmd = popenargs[0] |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 290 | raise CalledProcessError(retcode, cmd) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 291 | return 0 |
| 292 | |
| 293 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 294 | def check_output(*popenargs, timeout=None, **kwargs): |
Gregory P. Smith | 91110f5 | 2013-03-19 23:25:16 -0700 | [diff] [blame] | 295 | r"""Run command with arguments and return its output. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 296 | |
| 297 | If the exit code was non-zero it raises a CalledProcessError. The |
| 298 | CalledProcessError object will have the return code in the returncode |
| 299 | attribute and output in the output attribute. |
| 300 | |
| 301 | The arguments are the same as for the Popen constructor. Example: |
| 302 | |
| 303 | >>> check_output(["ls", "-l", "/dev/null"]) |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 304 | b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n' |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 305 | |
| 306 | The stdout argument is not allowed as it is used internally. |
Georg Brandl | 127d470 | 2009-12-28 08:10:38 +0000 | [diff] [blame] | 307 | To capture standard error in the result, use stderr=STDOUT. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 308 | |
| 309 | >>> check_output(["/bin/sh", "-c", |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 310 | ... "ls -l non_existent_file ; exit 0"], |
Georg Brandl | 127d470 | 2009-12-28 08:10:38 +0000 | [diff] [blame] | 311 | ... stderr=STDOUT) |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 312 | b'ls: non_existent_file: No such file or directory\n' |
Gregory P. Smith | 91110f5 | 2013-03-19 23:25:16 -0700 | [diff] [blame] | 313 | |
Serhiy Storchaka | fcd9f22 | 2013-04-22 20:20:54 +0300 | [diff] [blame] | 314 | There is an additional optional argument, "input", allowing you to |
| 315 | pass a string to the subprocess's stdin. If you use this argument |
| 316 | you may not also use the Popen constructor's "stdin" argument, as |
| 317 | it too will be used internally. Example: |
| 318 | |
| 319 | >>> check_output(["sed", "-e", "s/foo/bar/"], |
| 320 | ... input=b"when in the course of fooman events\n") |
| 321 | b'when in the course of barman events\n' |
| 322 | |
Andrew Kuchling | 4f7b0c3 | 2014-04-14 15:08:18 -0400 | [diff] [blame] | 323 | If universal_newlines=True is passed, the "input" argument must be a |
| 324 | string and the return value will be a string rather than bytes. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 325 | """ |
| 326 | if 'stdout' in kwargs: |
| 327 | raise ValueError('stdout argument not allowed, it will be overridden.') |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 328 | |
| 329 | if 'input' in kwargs and kwargs['input'] is None: |
| 330 | # Explicitly passing input=None was previously equivalent to passing an |
| 331 | # empty string. That is maintained here for backwards compatibility. |
| 332 | kwargs['input'] = '' if kwargs.get('universal_newlines', False) else b'' |
| 333 | |
| 334 | return run(*popenargs, stdout=PIPE, timeout=timeout, check=True, |
| 335 | **kwargs).stdout |
| 336 | |
| 337 | |
| 338 | class CompletedProcess(object): |
| 339 | """A process that has finished running. |
| 340 | |
| 341 | This is returned by run(). |
| 342 | |
| 343 | Attributes: |
| 344 | args: The list or str args passed to run(). |
| 345 | returncode: The exit code of the process, negative for signals. |
| 346 | stdout: The standard output (None if not captured). |
| 347 | stderr: The standard error (None if not captured). |
| 348 | """ |
| 349 | def __init__(self, args, returncode, stdout=None, stderr=None): |
| 350 | self.args = args |
| 351 | self.returncode = returncode |
| 352 | self.stdout = stdout |
| 353 | self.stderr = stderr |
| 354 | |
| 355 | def __repr__(self): |
| 356 | args = ['args={!r}'.format(self.args), |
| 357 | 'returncode={!r}'.format(self.returncode)] |
| 358 | if self.stdout is not None: |
| 359 | args.append('stdout={!r}'.format(self.stdout)) |
| 360 | if self.stderr is not None: |
| 361 | args.append('stderr={!r}'.format(self.stderr)) |
| 362 | return "{}({})".format(type(self).__name__, ', '.join(args)) |
| 363 | |
| 364 | def check_returncode(self): |
| 365 | """Raise CalledProcessError if the exit code is non-zero.""" |
| 366 | if self.returncode: |
| 367 | raise CalledProcessError(self.returncode, self.args, self.stdout, |
| 368 | self.stderr) |
| 369 | |
| 370 | |
| 371 | def run(*popenargs, input=None, timeout=None, check=False, **kwargs): |
| 372 | """Run command with arguments and return a CompletedProcess instance. |
| 373 | |
| 374 | The returned instance will have attributes args, returncode, stdout and |
| 375 | stderr. By default, stdout and stderr are not captured, and those attributes |
| 376 | will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them. |
| 377 | |
| 378 | If check is True and the exit code was non-zero, it raises a |
| 379 | CalledProcessError. The CalledProcessError object will have the return code |
| 380 | in the returncode attribute, and output & stderr attributes if those streams |
| 381 | were captured. |
| 382 | |
| 383 | If timeout is given, and the process takes too long, a TimeoutExpired |
| 384 | exception will be raised. |
| 385 | |
| 386 | There is an optional argument "input", allowing you to |
| 387 | pass a string to the subprocess's stdin. If you use this argument |
| 388 | you may not also use the Popen constructor's "stdin" argument, as |
| 389 | it will be used internally. |
| 390 | |
| 391 | The other arguments are the same as for the Popen constructor. |
| 392 | |
| 393 | If universal_newlines=True is passed, the "input" argument must be a |
| 394 | string and stdout/stderr in the returned object will be strings rather than |
| 395 | bytes. |
| 396 | """ |
| 397 | if input is not None: |
Serhiy Storchaka | fcd9f22 | 2013-04-22 20:20:54 +0300 | [diff] [blame] | 398 | if 'stdin' in kwargs: |
| 399 | raise ValueError('stdin and input arguments may not both be used.') |
Serhiy Storchaka | fcd9f22 | 2013-04-22 20:20:54 +0300 | [diff] [blame] | 400 | kwargs['stdin'] = PIPE |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 401 | |
| 402 | with Popen(*popenargs, **kwargs) as process: |
Victor Stinner | c15c88c | 2011-09-01 23:45:04 +0200 | [diff] [blame] | 403 | try: |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 404 | stdout, stderr = process.communicate(input, timeout=timeout) |
Victor Stinner | c15c88c | 2011-09-01 23:45:04 +0200 | [diff] [blame] | 405 | except TimeoutExpired: |
| 406 | process.kill() |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 407 | stdout, stderr = process.communicate() |
| 408 | raise TimeoutExpired(process.args, timeout, output=stdout, |
| 409 | stderr=stderr) |
Victor Stinner | c15c88c | 2011-09-01 23:45:04 +0200 | [diff] [blame] | 410 | except: |
| 411 | process.kill() |
| 412 | process.wait() |
| 413 | raise |
| 414 | retcode = process.poll() |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 415 | if check and retcode: |
| 416 | raise CalledProcessError(retcode, process.args, |
| 417 | output=stdout, stderr=stderr) |
| 418 | return CompletedProcess(process.args, retcode, stdout, stderr) |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 419 | |
| 420 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 421 | def list2cmdline(seq): |
| 422 | """ |
| 423 | Translate a sequence of arguments into a command line |
| 424 | string, using the same rules as the MS C runtime: |
| 425 | |
| 426 | 1) Arguments are delimited by white space, which is either a |
| 427 | space or a tab. |
| 428 | |
| 429 | 2) A string surrounded by double quotation marks is |
| 430 | interpreted as a single argument, regardless of white space |
Jean-Paul Calderone | 1ddd407 | 2010-06-18 20:03:54 +0000 | [diff] [blame] | 431 | contained within. A quoted string can be embedded in an |
| 432 | argument. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 433 | |
| 434 | 3) A double quotation mark preceded by a backslash is |
| 435 | interpreted as a literal double quotation mark. |
| 436 | |
| 437 | 4) Backslashes are interpreted literally, unless they |
| 438 | immediately precede a double quotation mark. |
| 439 | |
| 440 | 5) If backslashes immediately precede a double quotation mark, |
| 441 | every pair of backslashes is interpreted as a literal |
| 442 | backslash. If the number of backslashes is odd, the last |
| 443 | backslash escapes the next double quotation mark as |
| 444 | described in rule 3. |
| 445 | """ |
| 446 | |
| 447 | # See |
Eric Smith | 3c573af | 2009-11-09 15:23:15 +0000 | [diff] [blame] | 448 | # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx |
| 449 | # or search http://msdn.microsoft.com for |
| 450 | # "Parsing C++ Command-Line Arguments" |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 451 | result = [] |
| 452 | needquote = False |
| 453 | for arg in seq: |
| 454 | bs_buf = [] |
| 455 | |
| 456 | # Add a space to separate this argument from the others |
| 457 | if result: |
| 458 | result.append(' ') |
| 459 | |
Jean-Paul Calderone | 1ddd407 | 2010-06-18 20:03:54 +0000 | [diff] [blame] | 460 | needquote = (" " in arg) or ("\t" in arg) or not arg |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 461 | if needquote: |
| 462 | result.append('"') |
| 463 | |
| 464 | for c in arg: |
| 465 | if c == '\\': |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 466 | # Don't know if we need to double yet. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 467 | bs_buf.append(c) |
| 468 | elif c == '"': |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 469 | # Double backslashes. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 470 | result.append('\\' * len(bs_buf)*2) |
| 471 | bs_buf = [] |
| 472 | result.append('\\"') |
| 473 | else: |
| 474 | # Normal char |
| 475 | if bs_buf: |
| 476 | result.extend(bs_buf) |
| 477 | bs_buf = [] |
| 478 | result.append(c) |
| 479 | |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 480 | # Add remaining backslashes, if any. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 481 | if bs_buf: |
| 482 | result.extend(bs_buf) |
| 483 | |
| 484 | if needquote: |
Peter Astrand | 7e78ade | 2005-03-03 21:10:23 +0000 | [diff] [blame] | 485 | result.extend(bs_buf) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 486 | result.append('"') |
| 487 | |
| 488 | return ''.join(result) |
| 489 | |
| 490 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 491 | # Various tools for executing commands and looking at their output and status. |
| 492 | # |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 493 | |
| 494 | def getstatusoutput(cmd): |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 495 | """Return (exitcode, output) of executing cmd in a shell. |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 496 | |
Tim Golden | 6079814 | 2013-11-05 12:57:25 +0000 | [diff] [blame] | 497 | Execute the string 'cmd' in a shell with 'check_output' and |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 498 | return a 2-tuple (status, output). The locale encoding is used |
| 499 | to decode the output and process newlines. |
Tim Golden | 6079814 | 2013-11-05 12:57:25 +0000 | [diff] [blame] | 500 | |
| 501 | A trailing newline is stripped from the output. |
| 502 | The exit status for the command can be interpreted |
| 503 | according to the rules for the function 'wait'. Example: |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 504 | |
| 505 | >>> import subprocess |
| 506 | >>> subprocess.getstatusoutput('ls /bin/ls') |
| 507 | (0, '/bin/ls') |
| 508 | >>> subprocess.getstatusoutput('cat /bin/junk') |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 509 | (1, 'cat: /bin/junk: No such file or directory') |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 510 | >>> subprocess.getstatusoutput('/bin/junk') |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 511 | (127, 'sh: /bin/junk: not found') |
| 512 | >>> subprocess.getstatusoutput('/bin/kill $$') |
| 513 | (-15, '') |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 514 | """ |
Tim Golden | e004175 | 2013-11-03 12:53:17 +0000 | [diff] [blame] | 515 | try: |
| 516 | data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT) |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 517 | exitcode = 0 |
Tim Golden | e004175 | 2013-11-03 12:53:17 +0000 | [diff] [blame] | 518 | except CalledProcessError as ex: |
| 519 | data = ex.output |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 520 | exitcode = ex.returncode |
Tim Golden | e004175 | 2013-11-03 12:53:17 +0000 | [diff] [blame] | 521 | if data[-1:] == '\n': |
| 522 | data = data[:-1] |
Gregory P. Smith | 2eb0cb4 | 2017-09-07 16:11:02 -0700 | [diff] [blame] | 523 | return exitcode, data |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 524 | |
| 525 | def getoutput(cmd): |
| 526 | """Return output (stdout or stderr) of executing cmd in a shell. |
| 527 | |
| 528 | Like getstatusoutput(), except the exit status is ignored and the return |
| 529 | value is a string containing the command's output. Example: |
| 530 | |
| 531 | >>> import subprocess |
| 532 | >>> subprocess.getoutput('ls /bin/ls') |
| 533 | '/bin/ls' |
| 534 | """ |
| 535 | return getstatusoutput(cmd)[1] |
| 536 | |
| 537 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 538 | _PLATFORM_DEFAULT_CLOSE_FDS = object() |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 539 | |
| 540 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 541 | class Popen(object): |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 542 | """ Execute a child program in a new process. |
Serhiy Storchaka | 72e7761 | 2014-02-10 19:20:22 +0200 | [diff] [blame] | 543 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 544 | For a complete description of the arguments see the Python documentation. |
| 545 | |
| 546 | Arguments: |
| 547 | args: A string, or a sequence of program arguments. |
| 548 | |
| 549 | bufsize: supplied as the buffering argument to the open() function when |
| 550 | creating the stdin/stdout/stderr pipe file objects |
| 551 | |
| 552 | executable: A replacement program to execute. |
| 553 | |
| 554 | stdin, stdout and stderr: These specify the executed programs' standard |
| 555 | input, standard output and standard error file handles, respectively. |
| 556 | |
| 557 | preexec_fn: (POSIX only) An object to be called in the child process |
| 558 | just before the child is executed. |
| 559 | |
| 560 | close_fds: Controls closing or inheriting of file descriptors. |
| 561 | |
| 562 | shell: If true, the command will be executed through the shell. |
| 563 | |
| 564 | cwd: Sets the current directory before the child is executed. |
| 565 | |
| 566 | env: Defines the environment variables for the new process. |
| 567 | |
| 568 | universal_newlines: If true, use universal line endings for file |
| 569 | objects stdin, stdout and stderr. |
| 570 | |
| 571 | startupinfo and creationflags (Windows only) |
| 572 | |
| 573 | restore_signals (POSIX only) |
| 574 | |
| 575 | start_new_session (POSIX only) |
| 576 | |
| 577 | pass_fds (POSIX only) |
| 578 | |
Martin Panter | 3dca624 | 2016-10-25 23:41:42 +0000 | [diff] [blame] | 579 | encoding and errors: Text mode encoding and error handling to use for |
| 580 | file objects stdin, stdout and stderr. |
| 581 | |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 582 | Attributes: |
| 583 | stdin, stdout, stderr, pid, returncode |
| 584 | """ |
Serhiy Storchaka | 72e7761 | 2014-02-10 19:20:22 +0200 | [diff] [blame] | 585 | _child_created = False # Set here since __del__ checks it |
| 586 | |
Gregory P. Smith | a1ed539 | 2013-03-23 11:44:25 -0700 | [diff] [blame] | 587 | def __init__(self, args, bufsize=-1, executable=None, |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 588 | stdin=None, stdout=None, stderr=None, |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 589 | preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS, |
| 590 | shell=False, cwd=None, env=None, universal_newlines=False, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 591 | startupinfo=None, creationflags=0, |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 592 | restore_signals=True, start_new_session=False, |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 593 | pass_fds=(), *, encoding=None, errors=None): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 594 | """Create new Popen instance.""" |
| 595 | _cleanup() |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 596 | # Held while anything is calling waitpid before returncode has been |
| 597 | # updated to prevent clobbering returncode if wait() or poll() are |
| 598 | # called from multiple threads at once. After acquiring the lock, |
| 599 | # code must re-check self.returncode to see if another thread just |
| 600 | # finished a waitpid() call. |
| 601 | self._waitpid_lock = threading.Lock() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 602 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 603 | self._input = None |
| 604 | self._communication_started = False |
Guido van Rossum | 46a05a7 | 2007-06-07 21:56:45 +0000 | [diff] [blame] | 605 | if bufsize is None: |
Gregory P. Smith | a1ed539 | 2013-03-23 11:44:25 -0700 | [diff] [blame] | 606 | bufsize = -1 # Restore default |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 607 | if not isinstance(bufsize, int): |
Peter Astrand | 738131d | 2004-11-30 21:04:45 +0000 | [diff] [blame] | 608 | raise TypeError("bufsize must be an integer") |
| 609 | |
Gregory P. Smith | cb6fdf2 | 2015-04-07 16:11:33 -0700 | [diff] [blame] | 610 | if _mswindows: |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 611 | if preexec_fn is not None: |
| 612 | raise ValueError("preexec_fn is not supported on Windows " |
| 613 | "platforms") |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 614 | any_stdio_set = (stdin is not None or stdout is not None or |
| 615 | stderr is not None) |
| 616 | if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS: |
| 617 | if any_stdio_set: |
| 618 | close_fds = False |
| 619 | else: |
| 620 | close_fds = True |
| 621 | elif close_fds and any_stdio_set: |
| 622 | raise ValueError( |
| 623 | "close_fds is not supported on Windows platforms" |
| 624 | " if you redirect stdin/stdout/stderr") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 625 | else: |
| 626 | # POSIX |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 627 | if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS: |
| 628 | close_fds = True |
| 629 | if pass_fds and not close_fds: |
| 630 | warnings.warn("pass_fds overriding close_fds.", RuntimeWarning) |
| 631 | close_fds = True |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 632 | if startupinfo is not None: |
| 633 | raise ValueError("startupinfo is only supported on Windows " |
| 634 | "platforms") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 635 | if creationflags != 0: |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 636 | raise ValueError("creationflags is only supported on Windows " |
| 637 | "platforms") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 638 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 639 | self.args = args |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 640 | self.stdin = None |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 641 | self.stdout = None |
| 642 | self.stderr = None |
| 643 | self.pid = None |
| 644 | self.returncode = None |
| 645 | self.universal_newlines = universal_newlines |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 646 | self.encoding = encoding |
| 647 | self.errors = errors |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 648 | |
| 649 | # Input and output objects. The general principle is like |
| 650 | # this: |
| 651 | # |
| 652 | # Parent Child |
| 653 | # ------ ----- |
| 654 | # p2cwrite ---stdin---> p2cread |
| 655 | # c2pread <--stdout--- c2pwrite |
| 656 | # errread <--stderr--- errwrite |
| 657 | # |
| 658 | # On POSIX, the child objects are file descriptors. On |
| 659 | # Windows, these are Windows file handles. The parent objects |
| 660 | # are file descriptors on both platforms. The parent objects |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 661 | # are -1 when not using PIPEs. The child objects are -1 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 662 | # when not redirecting. |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 663 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 664 | (p2cread, p2cwrite, |
| 665 | c2pread, c2pwrite, |
| 666 | errread, errwrite) = self._get_handles(stdin, stdout, stderr) |
| 667 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 668 | # We wrap OS handles *before* launching the child, otherwise a |
| 669 | # quickly terminating child could make our fds unwrappable |
| 670 | # (see #8458). |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 671 | |
Gregory P. Smith | cb6fdf2 | 2015-04-07 16:11:33 -0700 | [diff] [blame] | 672 | if _mswindows: |
Florent Xicluna | 3b8bfef | 2010-03-14 12:31:06 +0000 | [diff] [blame] | 673 | if p2cwrite != -1: |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 674 | p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0) |
Florent Xicluna | 3b8bfef | 2010-03-14 12:31:06 +0000 | [diff] [blame] | 675 | if c2pread != -1: |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 676 | c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0) |
Florent Xicluna | 3b8bfef | 2010-03-14 12:31:06 +0000 | [diff] [blame] | 677 | if errread != -1: |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 678 | errread = msvcrt.open_osfhandle(errread.Detach(), 0) |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 679 | |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 680 | text_mode = encoding or errors or universal_newlines |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 681 | |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 682 | self._closed_child_pipe_fds = False |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 683 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 684 | try: |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 685 | if p2cwrite != -1: |
| 686 | self.stdin = io.open(p2cwrite, 'wb', bufsize) |
| 687 | if text_mode: |
| 688 | self.stdin = io.TextIOWrapper(self.stdin, write_through=True, |
| 689 | line_buffering=(bufsize == 1), |
| 690 | encoding=encoding, errors=errors) |
| 691 | if c2pread != -1: |
| 692 | self.stdout = io.open(c2pread, 'rb', bufsize) |
| 693 | if text_mode: |
| 694 | self.stdout = io.TextIOWrapper(self.stdout, |
| 695 | encoding=encoding, errors=errors) |
| 696 | if errread != -1: |
| 697 | self.stderr = io.open(errread, 'rb', bufsize) |
| 698 | if text_mode: |
| 699 | self.stderr = io.TextIOWrapper(self.stderr, |
| 700 | encoding=encoding, errors=errors) |
| 701 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 702 | self._execute_child(args, executable, preexec_fn, close_fds, |
Andrew Svetlov | 592df20 | 2012-08-15 17:36:15 +0300 | [diff] [blame] | 703 | pass_fds, cwd, env, |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 704 | startupinfo, creationflags, shell, |
| 705 | p2cread, p2cwrite, |
| 706 | c2pread, c2pwrite, |
| 707 | errread, errwrite, |
| 708 | restore_signals, start_new_session) |
| 709 | except: |
Gregory P. Smith | 3d8e776 | 2012-11-10 22:32:22 -0800 | [diff] [blame] | 710 | # Cleanup if the child failed starting. |
| 711 | for f in filter(None, (self.stdin, self.stdout, self.stderr)): |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 712 | try: |
| 713 | f.close() |
Andrew Svetlov | 3438fa4 | 2012-12-17 23:35:18 +0200 | [diff] [blame] | 714 | except OSError: |
Gregory P. Smith | 3d8e776 | 2012-11-10 22:32:22 -0800 | [diff] [blame] | 715 | pass # Ignore EBADF or other errors. |
| 716 | |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 717 | if not self._closed_child_pipe_fds: |
| 718 | to_close = [] |
| 719 | if stdin == PIPE: |
| 720 | to_close.append(p2cread) |
| 721 | if stdout == PIPE: |
| 722 | to_close.append(c2pwrite) |
| 723 | if stderr == PIPE: |
| 724 | to_close.append(errwrite) |
| 725 | if hasattr(self, '_devnull'): |
| 726 | to_close.append(self._devnull) |
| 727 | for fd in to_close: |
| 728 | try: |
Segev Finer | 4d38517 | 2017-08-18 16:18:13 +0300 | [diff] [blame] | 729 | if _mswindows and isinstance(fd, Handle): |
| 730 | fd.Close() |
| 731 | else: |
| 732 | os.close(fd) |
Gregory P. Smith | 22ba31a | 2013-06-15 18:14:56 -0700 | [diff] [blame] | 733 | except OSError: |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 734 | pass |
Gregory P. Smith | 3d8e776 | 2012-11-10 22:32:22 -0800 | [diff] [blame] | 735 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 736 | raise |
| 737 | |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 738 | def _translate_newlines(self, data, encoding, errors): |
| 739 | data = data.decode(encoding, errors) |
Andrew Svetlov | 8286071 | 2012-08-19 22:13:41 +0300 | [diff] [blame] | 740 | return data.replace("\r\n", "\n").replace("\r", "\n") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 741 | |
Brian Curtin | 79cdb66 | 2010-12-03 02:46:02 +0000 | [diff] [blame] | 742 | def __enter__(self): |
| 743 | return self |
| 744 | |
| 745 | def __exit__(self, type, value, traceback): |
| 746 | if self.stdout: |
| 747 | self.stdout.close() |
| 748 | if self.stderr: |
| 749 | self.stderr.close() |
Serhiy Storchaka | ab900c2 | 2015-02-28 12:43:08 +0200 | [diff] [blame] | 750 | try: # Flushing a BufferedWriter may raise an error |
| 751 | if self.stdin: |
| 752 | self.stdin.close() |
| 753 | finally: |
| 754 | # Wait for the process to terminate, to avoid zombies. |
| 755 | self.wait() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 756 | |
Victor Stinner | 9505b03 | 2017-01-06 10:44:44 +0100 | [diff] [blame] | 757 | def __del__(self, _maxsize=sys.maxsize, _warn=warnings.warn): |
Serhiy Storchaka | 72e7761 | 2014-02-10 19:20:22 +0200 | [diff] [blame] | 758 | if not self._child_created: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 759 | # We didn't get to successfully create a child process. |
| 760 | return |
Victor Stinner | 5a48e21 | 2016-05-20 12:11:15 +0200 | [diff] [blame] | 761 | if self.returncode is None: |
Victor Stinner | c206f1e | 2016-06-14 16:42:59 +0200 | [diff] [blame] | 762 | # Not reading subprocess exit status creates a zombi process which |
| 763 | # is only destroyed at the parent python process exit |
Victor Stinner | 9505b03 | 2017-01-06 10:44:44 +0100 | [diff] [blame] | 764 | _warn("subprocess %s is still running" % self.pid, |
| 765 | ResourceWarning, source=self) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 766 | # In case the child hasn't been waited on, check if it's done. |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 767 | self._internal_poll(_deadstate=_maxsize) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 768 | if self.returncode is None and _active is not None: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 769 | # Child is still running, keep us alive until we can wait on it. |
| 770 | _active.append(self) |
| 771 | |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 772 | def _get_devnull(self): |
| 773 | if not hasattr(self, '_devnull'): |
| 774 | self._devnull = os.open(os.devnull, os.O_RDWR) |
| 775 | return self._devnull |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 776 | |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 777 | def _stdin_write(self, input): |
| 778 | if input: |
| 779 | try: |
| 780 | self.stdin.write(input) |
| 781 | except BrokenPipeError: |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | 1ef8c7e | 2016-06-04 00:22:17 +0000 | [diff] [blame] | 782 | pass # communicate() must ignore broken pipe errors. |
Victor Stinner | d52aa31 | 2017-06-08 17:30:39 +0200 | [diff] [blame] | 783 | except OSError as exc: |
| 784 | if exc.errno == errno.EINVAL: |
| 785 | # bpo-19612, bpo-30418: On Windows, stdin.write() fails |
| 786 | # with EINVAL if the child process exited or if the child |
| 787 | # process is still running but closed the pipe. |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 788 | pass |
| 789 | else: |
| 790 | raise |
Victor Stinner | d52aa31 | 2017-06-08 17:30:39 +0200 | [diff] [blame] | 791 | |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | 1ef8c7e | 2016-06-04 00:22:17 +0000 | [diff] [blame] | 792 | try: |
| 793 | self.stdin.close() |
| 794 | except BrokenPipeError: |
| 795 | pass # communicate() must ignore broken pipe errors. |
Victor Stinner | d52aa31 | 2017-06-08 17:30:39 +0200 | [diff] [blame] | 796 | except OSError as exc: |
| 797 | if exc.errno == errno.EINVAL: |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | 1ef8c7e | 2016-06-04 00:22:17 +0000 | [diff] [blame] | 798 | pass |
| 799 | else: |
| 800 | raise |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 801 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 802 | def communicate(self, input=None, timeout=None): |
Joel Schaerer | 88031a9 | 2017-09-13 21:11:20 +0200 | [diff] [blame] | 803 | """Interact with process: Send data to stdin and close it. |
| 804 | Read data from stdout and stderr, until end-of-file is |
| 805 | reached. Wait for process to terminate. |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 806 | |
Andrew Kuchling | 4f7b0c3 | 2014-04-14 15:08:18 -0400 | [diff] [blame] | 807 | The optional "input" argument should be data to be sent to the |
| 808 | child process (if self.universal_newlines is True, this should |
| 809 | be a string; if it is False, "input" should be bytes), or |
| 810 | None, if no data should be sent to the child. |
| 811 | |
| 812 | communicate() returns a tuple (stdout, stderr). These will be |
| 813 | bytes or, if self.universal_newlines was True, a string. |
| 814 | """ |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 815 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 816 | if self._communication_started and input: |
| 817 | raise ValueError("Cannot send input after starting communication") |
| 818 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 819 | # Optimization: If we are not worried about timeouts, we haven't |
| 820 | # started communicating, and we have one or zero pipes, using select() |
| 821 | # or threads is unnecessary. |
Victor Stinner | 7a8d081 | 2011-04-05 13:13:08 +0200 | [diff] [blame] | 822 | if (timeout is None and not self._communication_started and |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 823 | [self.stdin, self.stdout, self.stderr].count(None) >= 2): |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 824 | stdout = None |
| 825 | stderr = None |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 826 | if self.stdin: |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 827 | self._stdin_write(input) |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 828 | elif self.stdout: |
Charles-François Natali | 6e6c59b | 2015-02-07 13:27:50 +0000 | [diff] [blame] | 829 | stdout = self.stdout.read() |
Georg Brandl | f08a9dd | 2008-06-10 16:57:31 +0000 | [diff] [blame] | 830 | self.stdout.close() |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 831 | elif self.stderr: |
Charles-François Natali | 6e6c59b | 2015-02-07 13:27:50 +0000 | [diff] [blame] | 832 | stderr = self.stderr.read() |
Georg Brandl | f08a9dd | 2008-06-10 16:57:31 +0000 | [diff] [blame] | 833 | self.stderr.close() |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 834 | self.wait() |
Victor Stinner | 7a8d081 | 2011-04-05 13:13:08 +0200 | [diff] [blame] | 835 | else: |
| 836 | if timeout is not None: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame] | 837 | endtime = _time() + timeout |
Victor Stinner | 7a8d081 | 2011-04-05 13:13:08 +0200 | [diff] [blame] | 838 | else: |
| 839 | endtime = None |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 840 | |
Victor Stinner | 7a8d081 | 2011-04-05 13:13:08 +0200 | [diff] [blame] | 841 | try: |
| 842 | stdout, stderr = self._communicate(input, endtime, timeout) |
| 843 | finally: |
| 844 | self._communication_started = True |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 845 | |
Victor Stinner | 7a8d081 | 2011-04-05 13:13:08 +0200 | [diff] [blame] | 846 | sts = self.wait(timeout=self._remaining_time(endtime)) |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 847 | |
| 848 | return (stdout, stderr) |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 849 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 850 | |
Georg Brandl | 6aa2d1f | 2008-08-12 08:35:52 +0000 | [diff] [blame] | 851 | def poll(self): |
Martin Panter | 4afdca0 | 2016-10-25 22:20:48 +0000 | [diff] [blame] | 852 | """Check if child process has terminated. Set and return returncode |
| 853 | attribute.""" |
Georg Brandl | 6aa2d1f | 2008-08-12 08:35:52 +0000 | [diff] [blame] | 854 | return self._internal_poll() |
| 855 | |
| 856 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 857 | def _remaining_time(self, endtime): |
| 858 | """Convenience for _communicate when computing timeouts.""" |
| 859 | if endtime is None: |
| 860 | return None |
| 861 | else: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame] | 862 | return endtime - _time() |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 863 | |
| 864 | |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 865 | def _check_timeout(self, endtime, orig_timeout): |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 866 | """Convenience for checking if a timeout has expired.""" |
| 867 | if endtime is None: |
| 868 | return |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame] | 869 | if _time() > endtime: |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 870 | raise TimeoutExpired(self.args, orig_timeout) |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 871 | |
| 872 | |
Gregory P. Smith | cb6fdf2 | 2015-04-07 16:11:33 -0700 | [diff] [blame] | 873 | if _mswindows: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 874 | # |
| 875 | # Windows methods |
| 876 | # |
| 877 | def _get_handles(self, stdin, stdout, stderr): |
Alexandre Vassalotti | 711ed4a | 2009-07-17 10:42:05 +0000 | [diff] [blame] | 878 | """Construct and return tuple with IO objects: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 879 | p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite |
| 880 | """ |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 881 | if stdin is None and stdout is None and stderr is None: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 882 | return (-1, -1, -1, -1, -1, -1) |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 883 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 884 | p2cread, p2cwrite = -1, -1 |
| 885 | c2pread, c2pwrite = -1, -1 |
| 886 | errread, errwrite = -1, -1 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 887 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 888 | if stdin is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 889 | p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 890 | if p2cread is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 891 | p2cread, _ = _winapi.CreatePipe(None, 0) |
| 892 | p2cread = Handle(p2cread) |
| 893 | _winapi.CloseHandle(_) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 894 | elif stdin == PIPE: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 895 | p2cread, p2cwrite = _winapi.CreatePipe(None, 0) |
| 896 | p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite) |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 897 | elif stdin == DEVNULL: |
| 898 | p2cread = msvcrt.get_osfhandle(self._get_devnull()) |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 899 | elif isinstance(stdin, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 900 | p2cread = msvcrt.get_osfhandle(stdin) |
| 901 | else: |
| 902 | # Assuming file-like object |
| 903 | p2cread = msvcrt.get_osfhandle(stdin.fileno()) |
| 904 | p2cread = self._make_inheritable(p2cread) |
| 905 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 906 | if stdout is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 907 | c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 908 | if c2pwrite is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 909 | _, c2pwrite = _winapi.CreatePipe(None, 0) |
| 910 | c2pwrite = Handle(c2pwrite) |
| 911 | _winapi.CloseHandle(_) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 912 | elif stdout == PIPE: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 913 | c2pread, c2pwrite = _winapi.CreatePipe(None, 0) |
| 914 | c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite) |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 915 | elif stdout == DEVNULL: |
| 916 | c2pwrite = msvcrt.get_osfhandle(self._get_devnull()) |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 917 | elif isinstance(stdout, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 918 | c2pwrite = msvcrt.get_osfhandle(stdout) |
| 919 | else: |
| 920 | # Assuming file-like object |
| 921 | c2pwrite = msvcrt.get_osfhandle(stdout.fileno()) |
| 922 | c2pwrite = self._make_inheritable(c2pwrite) |
| 923 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 924 | if stderr is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 925 | errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 926 | if errwrite is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 927 | _, errwrite = _winapi.CreatePipe(None, 0) |
| 928 | errwrite = Handle(errwrite) |
| 929 | _winapi.CloseHandle(_) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 930 | elif stderr == PIPE: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 931 | errread, errwrite = _winapi.CreatePipe(None, 0) |
| 932 | errread, errwrite = Handle(errread), Handle(errwrite) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 933 | elif stderr == STDOUT: |
| 934 | errwrite = c2pwrite |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 935 | elif stderr == DEVNULL: |
| 936 | errwrite = msvcrt.get_osfhandle(self._get_devnull()) |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 937 | elif isinstance(stderr, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 938 | errwrite = msvcrt.get_osfhandle(stderr) |
| 939 | else: |
| 940 | # Assuming file-like object |
| 941 | errwrite = msvcrt.get_osfhandle(stderr.fileno()) |
| 942 | errwrite = self._make_inheritable(errwrite) |
| 943 | |
| 944 | return (p2cread, p2cwrite, |
| 945 | c2pread, c2pwrite, |
| 946 | errread, errwrite) |
| 947 | |
| 948 | |
| 949 | def _make_inheritable(self, handle): |
| 950 | """Return a duplicate of handle, which is inheritable""" |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 951 | h = _winapi.DuplicateHandle( |
| 952 | _winapi.GetCurrentProcess(), handle, |
| 953 | _winapi.GetCurrentProcess(), 0, 1, |
| 954 | _winapi.DUPLICATE_SAME_ACCESS) |
| 955 | return Handle(h) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 956 | |
| 957 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 958 | def _execute_child(self, args, executable, preexec_fn, close_fds, |
Andrew Svetlov | 592df20 | 2012-08-15 17:36:15 +0300 | [diff] [blame] | 959 | pass_fds, cwd, env, |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 960 | startupinfo, creationflags, shell, |
| 961 | p2cread, p2cwrite, |
| 962 | c2pread, c2pwrite, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 963 | errread, errwrite, |
| 964 | unused_restore_signals, unused_start_new_session): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 965 | """Execute program (MS Windows version)""" |
| 966 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 967 | assert not pass_fds, "pass_fds not supported on Windows." |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 968 | |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 969 | if not isinstance(args, str): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 970 | args = list2cmdline(args) |
| 971 | |
Peter Astrand | c1d6536 | 2004-11-07 14:30:34 +0000 | [diff] [blame] | 972 | # Process startup details |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 973 | if startupinfo is None: |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 974 | startupinfo = STARTUPINFO() |
Victor Stinner | b369358 | 2010-05-21 20:13:12 +0000 | [diff] [blame] | 975 | if -1 not in (p2cread, c2pwrite, errwrite): |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 976 | startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES |
Peter Astrand | c1d6536 | 2004-11-07 14:30:34 +0000 | [diff] [blame] | 977 | startupinfo.hStdInput = p2cread |
| 978 | startupinfo.hStdOutput = c2pwrite |
| 979 | startupinfo.hStdError = errwrite |
| 980 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 981 | if shell: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 982 | startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW |
| 983 | startupinfo.wShowWindow = _winapi.SW_HIDE |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 984 | comspec = os.environ.get("COMSPEC", "cmd.exe") |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 985 | args = '{} /c "{}"'.format (comspec, args) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 986 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 987 | # Start the process |
| 988 | try: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 989 | hp, ht, pid, tid = _winapi.CreateProcess(executable, args, |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 990 | # no special security |
| 991 | None, None, |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 992 | int(not close_fds), |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 993 | creationflags, |
| 994 | env, |
Benjamin Peterson | cb90f26 | 2017-03-02 00:03:41 -0800 | [diff] [blame] | 995 | os.fspath(cwd) if cwd is not None else None, |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 996 | startupinfo) |
Tim Golden | ad537f2 | 2010-08-08 11:18:16 +0000 | [diff] [blame] | 997 | finally: |
| 998 | # Child is launched. Close the parent's copy of those pipe |
| 999 | # handles that only the child should have open. You need |
| 1000 | # to make sure that no handles to the write end of the |
| 1001 | # output pipe are maintained in this process or else the |
| 1002 | # pipe will not close when the child process exits and the |
| 1003 | # ReadFile will hang. |
| 1004 | if p2cread != -1: |
| 1005 | p2cread.Close() |
| 1006 | if c2pwrite != -1: |
| 1007 | c2pwrite.Close() |
| 1008 | if errwrite != -1: |
| 1009 | errwrite.Close() |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 1010 | if hasattr(self, '_devnull'): |
| 1011 | os.close(self._devnull) |
Segev Finer | 4d38517 | 2017-08-18 16:18:13 +0300 | [diff] [blame] | 1012 | # Prevent a double close of these handles/fds from __init__ |
| 1013 | # on error. |
| 1014 | self._closed_child_pipe_fds = True |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1015 | |
| 1016 | # Retain the process handle, but close the thread handle |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1017 | self._child_created = True |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1018 | self._handle = Handle(hp) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1019 | self.pid = pid |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1020 | _winapi.CloseHandle(ht) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1021 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1022 | def _internal_poll(self, _deadstate=None, |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1023 | _WaitForSingleObject=_winapi.WaitForSingleObject, |
| 1024 | _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0, |
| 1025 | _GetExitCodeProcess=_winapi.GetExitCodeProcess): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1026 | """Check if child process has terminated. Returns returncode |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1027 | attribute. |
| 1028 | |
| 1029 | This method is called by __del__, so it can only refer to objects |
| 1030 | in its local scope. |
| 1031 | |
| 1032 | """ |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1033 | if self.returncode is None: |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1034 | if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0: |
| 1035 | self.returncode = _GetExitCodeProcess(self._handle) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1036 | return self.returncode |
| 1037 | |
| 1038 | |
Gregory P. Smith | 82604e0 | 2016-11-20 16:31:07 -0800 | [diff] [blame] | 1039 | def wait(self, timeout=None): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1040 | """Wait for child process to terminate. Returns returncode |
| 1041 | attribute.""" |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1042 | if timeout is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1043 | timeout_millis = _winapi.INFINITE |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1044 | else: |
Reid Kleckner | 91156ff | 2011-03-21 10:06:10 -0700 | [diff] [blame] | 1045 | timeout_millis = int(timeout * 1000) |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1046 | if self.returncode is None: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1047 | result = _winapi.WaitForSingleObject(self._handle, |
| 1048 | timeout_millis) |
| 1049 | if result == _winapi.WAIT_TIMEOUT: |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 1050 | raise TimeoutExpired(self.args, timeout) |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1051 | self.returncode = _winapi.GetExitCodeProcess(self._handle) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1052 | return self.returncode |
| 1053 | |
| 1054 | |
| 1055 | def _readerthread(self, fh, buffer): |
| 1056 | buffer.append(fh.read()) |
Victor Stinner | 667d4b5 | 2010-12-25 22:40:32 +0000 | [diff] [blame] | 1057 | fh.close() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1058 | |
| 1059 | |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 1060 | def _communicate(self, input, endtime, orig_timeout): |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1061 | # Start reader threads feeding into a list hanging off of this |
| 1062 | # object, unless they've already been started. |
| 1063 | if self.stdout and not hasattr(self, "_stdout_buff"): |
| 1064 | self._stdout_buff = [] |
| 1065 | self.stdout_thread = \ |
| 1066 | threading.Thread(target=self._readerthread, |
| 1067 | args=(self.stdout, self._stdout_buff)) |
| 1068 | self.stdout_thread.daemon = True |
| 1069 | self.stdout_thread.start() |
| 1070 | if self.stderr and not hasattr(self, "_stderr_buff"): |
| 1071 | self._stderr_buff = [] |
| 1072 | self.stderr_thread = \ |
| 1073 | threading.Thread(target=self._readerthread, |
| 1074 | args=(self.stderr, self._stderr_buff)) |
| 1075 | self.stderr_thread.daemon = True |
| 1076 | self.stderr_thread.start() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1077 | |
| 1078 | if self.stdin: |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 1079 | self._stdin_write(input) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1080 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1081 | # Wait for the reader threads, or time out. If we time out, the |
| 1082 | # threads remain reading and the fds left open in case the user |
| 1083 | # calls communicate again. |
| 1084 | if self.stdout is not None: |
| 1085 | self.stdout_thread.join(self._remaining_time(endtime)) |
Andrew Svetlov | 377a152 | 2012-08-19 20:49:39 +0300 | [diff] [blame] | 1086 | if self.stdout_thread.is_alive(): |
Reid Kleckner | 9a67e6c | 2011-03-20 08:28:07 -0700 | [diff] [blame] | 1087 | raise TimeoutExpired(self.args, orig_timeout) |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1088 | if self.stderr is not None: |
| 1089 | self.stderr_thread.join(self._remaining_time(endtime)) |
Andrew Svetlov | 377a152 | 2012-08-19 20:49:39 +0300 | [diff] [blame] | 1090 | if self.stderr_thread.is_alive(): |
Reid Kleckner | 9a67e6c | 2011-03-20 08:28:07 -0700 | [diff] [blame] | 1091 | raise TimeoutExpired(self.args, orig_timeout) |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1092 | |
| 1093 | # Collect the output from and close both pipes, now that we know |
| 1094 | # both have been read successfully. |
| 1095 | stdout = None |
| 1096 | stderr = None |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1097 | if self.stdout: |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1098 | stdout = self._stdout_buff |
| 1099 | self.stdout.close() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1100 | if self.stderr: |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1101 | stderr = self._stderr_buff |
| 1102 | self.stderr.close() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1103 | |
| 1104 | # All data exchanged. Translate lists into strings. |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1105 | if stdout is not None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1106 | stdout = stdout[0] |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1107 | if stderr is not None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1108 | stderr = stderr[0] |
| 1109 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1110 | return (stdout, stderr) |
| 1111 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1112 | def send_signal(self, sig): |
Gregory P. Smith | a0c9caa | 2015-11-15 18:19:10 -0800 | [diff] [blame] | 1113 | """Send a signal to the process.""" |
| 1114 | # Don't signal a process that we know has already died. |
| 1115 | if self.returncode is not None: |
| 1116 | return |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1117 | if sig == signal.SIGTERM: |
| 1118 | self.terminate() |
Brian Curtin | eb24d74 | 2010-04-12 17:16:38 +0000 | [diff] [blame] | 1119 | elif sig == signal.CTRL_C_EVENT: |
| 1120 | os.kill(self.pid, signal.CTRL_C_EVENT) |
| 1121 | elif sig == signal.CTRL_BREAK_EVENT: |
| 1122 | os.kill(self.pid, signal.CTRL_BREAK_EVENT) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1123 | else: |
Brian Curtin | 1965136 | 2010-09-07 13:24:38 +0000 | [diff] [blame] | 1124 | raise ValueError("Unsupported signal: {}".format(sig)) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1125 | |
| 1126 | def terminate(self): |
Gregory P. Smith | a0c9caa | 2015-11-15 18:19:10 -0800 | [diff] [blame] | 1127 | """Terminates the process.""" |
| 1128 | # Don't terminate a process that we know has already died. |
| 1129 | if self.returncode is not None: |
| 1130 | return |
Antoine Pitrou | 1f9a835 | 2012-03-11 19:29:12 +0100 | [diff] [blame] | 1131 | try: |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1132 | _winapi.TerminateProcess(self._handle, 1) |
Antoine Pitrou | b69ef16 | 2012-03-11 19:33:29 +0100 | [diff] [blame] | 1133 | except PermissionError: |
Antoine Pitrou | 1f9a835 | 2012-03-11 19:29:12 +0100 | [diff] [blame] | 1134 | # ERROR_ACCESS_DENIED (winerror 5) is received when the |
| 1135 | # process already died. |
Antoine Pitrou | 23bba4c | 2012-04-18 20:51:15 +0200 | [diff] [blame] | 1136 | rc = _winapi.GetExitCodeProcess(self._handle) |
| 1137 | if rc == _winapi.STILL_ACTIVE: |
Antoine Pitrou | 1f9a835 | 2012-03-11 19:29:12 +0100 | [diff] [blame] | 1138 | raise |
| 1139 | self.returncode = rc |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1140 | |
| 1141 | kill = terminate |
| 1142 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1143 | else: |
| 1144 | # |
| 1145 | # POSIX methods |
| 1146 | # |
| 1147 | def _get_handles(self, stdin, stdout, stderr): |
Alexandre Vassalotti | 711ed4a | 2009-07-17 10:42:05 +0000 | [diff] [blame] | 1148 | """Construct and return tuple with IO objects: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1149 | p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite |
| 1150 | """ |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1151 | p2cread, p2cwrite = -1, -1 |
| 1152 | c2pread, c2pwrite = -1, -1 |
| 1153 | errread, errwrite = -1, -1 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1154 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1155 | if stdin is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1156 | pass |
| 1157 | elif stdin == PIPE: |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1158 | p2cread, p2cwrite = os.pipe() |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 1159 | elif stdin == DEVNULL: |
| 1160 | p2cread = self._get_devnull() |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1161 | elif isinstance(stdin, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1162 | p2cread = stdin |
| 1163 | else: |
| 1164 | # Assuming file-like object |
| 1165 | p2cread = stdin.fileno() |
| 1166 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1167 | if stdout is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1168 | pass |
| 1169 | elif stdout == PIPE: |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1170 | c2pread, c2pwrite = os.pipe() |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 1171 | elif stdout == DEVNULL: |
| 1172 | c2pwrite = self._get_devnull() |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1173 | elif isinstance(stdout, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1174 | c2pwrite = stdout |
| 1175 | else: |
| 1176 | # Assuming file-like object |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 1177 | c2pwrite = stdout.fileno() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1178 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1179 | if stderr is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1180 | pass |
| 1181 | elif stderr == PIPE: |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1182 | errread, errwrite = os.pipe() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1183 | elif stderr == STDOUT: |
Martin Panter | c763589 | 2016-05-13 01:54:44 +0000 | [diff] [blame] | 1184 | if c2pwrite != -1: |
| 1185 | errwrite = c2pwrite |
| 1186 | else: # child's stdout is not set, use parent's stdout |
| 1187 | errwrite = sys.__stdout__.fileno() |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 1188 | elif stderr == DEVNULL: |
| 1189 | errwrite = self._get_devnull() |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1190 | elif isinstance(stderr, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1191 | errwrite = stderr |
| 1192 | else: |
| 1193 | # Assuming file-like object |
| 1194 | errwrite = stderr.fileno() |
| 1195 | |
| 1196 | return (p2cread, p2cwrite, |
| 1197 | c2pread, c2pwrite, |
| 1198 | errread, errwrite) |
| 1199 | |
| 1200 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1201 | def _execute_child(self, args, executable, preexec_fn, close_fds, |
Andrew Svetlov | 592df20 | 2012-08-15 17:36:15 +0300 | [diff] [blame] | 1202 | pass_fds, cwd, env, |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1203 | startupinfo, creationflags, shell, |
| 1204 | p2cread, p2cwrite, |
| 1205 | c2pread, c2pwrite, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1206 | errread, errwrite, |
| 1207 | restore_signals, start_new_session): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1208 | """Execute program (POSIX version)""" |
| 1209 | |
Victor Stinner | 7b3b20a | 2011-03-03 12:54:05 +0000 | [diff] [blame] | 1210 | if isinstance(args, (str, bytes)): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1211 | args = [args] |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 1212 | else: |
| 1213 | args = list(args) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1214 | |
| 1215 | if shell: |
Xavier de Gaye | b35fc62 | 2016-12-13 16:32:21 +0100 | [diff] [blame] | 1216 | # On Android the default shell is at '/system/bin/sh'. |
| 1217 | unix_shell = ('/system/bin/sh' if |
| 1218 | hasattr(sys, 'getandroidapilevel') else '/bin/sh') |
| 1219 | args = [unix_shell, "-c"] + args |
Stefan Krah | 9542cc6 | 2010-07-19 14:20:53 +0000 | [diff] [blame] | 1220 | if executable: |
| 1221 | args[0] = executable |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1222 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1223 | if executable is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1224 | executable = args[0] |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1225 | orig_executable = executable |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1226 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1227 | # For transferring possible exec failure from child to parent. |
| 1228 | # Data format: "exception name:hex errno:description" |
| 1229 | # Pickle is not used; it is complex and involves memory allocation. |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 1230 | errpipe_read, errpipe_write = os.pipe() |
Gregory P. Smith | 53dd816 | 2013-12-01 16:03:24 -0800 | [diff] [blame] | 1231 | # errpipe_write must not be in the standard io 0, 1, or 2 fd range. |
| 1232 | low_fds_to_close = [] |
| 1233 | while errpipe_write < 3: |
| 1234 | low_fds_to_close.append(errpipe_write) |
| 1235 | errpipe_write = os.dup(errpipe_write) |
| 1236 | for low_fd in low_fds_to_close: |
| 1237 | os.close(low_fd) |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 1238 | try: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1239 | try: |
Gregory P. Smith | 59fd1bf | 2011-05-28 09:32:39 -0700 | [diff] [blame] | 1240 | # We must avoid complex work that could involve |
| 1241 | # malloc or free in the child process to avoid |
| 1242 | # potential deadlocks, thus we do all this here. |
| 1243 | # and pass it to fork_exec() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1244 | |
Victor Stinner | 372b838 | 2011-06-21 17:24:21 +0200 | [diff] [blame] | 1245 | if env is not None: |
Serhiy Storchaka | d174d24 | 2017-06-23 19:39:27 +0300 | [diff] [blame] | 1246 | env_list = [] |
| 1247 | for k, v in env.items(): |
| 1248 | k = os.fsencode(k) |
| 1249 | if b'=' in k: |
| 1250 | raise ValueError("illegal environment variable name") |
| 1251 | env_list.append(k + b'=' + os.fsencode(v)) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1252 | else: |
Gregory P. Smith | 59fd1bf | 2011-05-28 09:32:39 -0700 | [diff] [blame] | 1253 | env_list = None # Use execv instead of execve. |
| 1254 | executable = os.fsencode(executable) |
| 1255 | if os.path.dirname(executable): |
| 1256 | executable_list = (executable,) |
| 1257 | else: |
| 1258 | # This matches the behavior of os._execvpe(). |
| 1259 | executable_list = tuple( |
| 1260 | os.path.join(os.fsencode(dir), executable) |
| 1261 | for dir in os.get_exec_path(env)) |
Gregory P. Smith | 361e30c | 2013-12-01 00:12:24 -0800 | [diff] [blame] | 1262 | fds_to_keep = set(pass_fds) |
Gregory P. Smith | 59fd1bf | 2011-05-28 09:32:39 -0700 | [diff] [blame] | 1263 | fds_to_keep.add(errpipe_write) |
| 1264 | self.pid = _posixsubprocess.fork_exec( |
| 1265 | args, executable_list, |
Serhiy Storchaka | 66bffd1 | 2017-04-19 21:12:46 +0300 | [diff] [blame] | 1266 | close_fds, tuple(sorted(map(int, fds_to_keep))), |
| 1267 | cwd, env_list, |
Gregory P. Smith | 59fd1bf | 2011-05-28 09:32:39 -0700 | [diff] [blame] | 1268 | p2cread, p2cwrite, c2pread, c2pwrite, |
| 1269 | errread, errwrite, |
| 1270 | errpipe_read, errpipe_write, |
| 1271 | restore_signals, start_new_session, preexec_fn) |
Charles-François Natali | 558639f | 2011-08-18 19:11:29 +0200 | [diff] [blame] | 1272 | self._child_created = True |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1273 | finally: |
| 1274 | # be sure the FD is closed no matter what |
| 1275 | os.close(errpipe_write) |
| 1276 | |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 1277 | # self._devnull is not always defined. |
| 1278 | devnull_fd = getattr(self, '_devnull', None) |
| 1279 | if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd: |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1280 | os.close(p2cread) |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 1281 | if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd: |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1282 | os.close(c2pwrite) |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 1283 | if errwrite != -1 and errread != -1 and errwrite != devnull_fd: |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1284 | os.close(errwrite) |
Gregory P. Smith | b5461b9 | 2013-06-15 18:04:26 -0700 | [diff] [blame] | 1285 | if devnull_fd is not None: |
| 1286 | os.close(devnull_fd) |
| 1287 | # Prevent a double close of these fds from __init__ on error. |
| 1288 | self._closed_child_pipe_fds = True |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1289 | |
| 1290 | # Wait for exec to fail or succeed; possibly raising an |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1291 | # exception (limited in size) |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1292 | errpipe_data = bytearray() |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1293 | while True: |
Charles-François Natali | 6e6c59b | 2015-02-07 13:27:50 +0000 | [diff] [blame] | 1294 | part = os.read(errpipe_read, 50000) |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1295 | errpipe_data += part |
| 1296 | if not part or len(errpipe_data) > 50000: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1297 | break |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1298 | finally: |
| 1299 | # be sure the FD is closed no matter what |
| 1300 | os.close(errpipe_read) |
| 1301 | |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1302 | if errpipe_data: |
Gregory P. Smith | e85db2b | 2010-12-14 14:38:00 +0000 | [diff] [blame] | 1303 | try: |
Victor Stinner | a58e2c5 | 2016-05-20 12:08:12 +0200 | [diff] [blame] | 1304 | pid, sts = os.waitpid(self.pid, 0) |
| 1305 | if pid == self.pid: |
| 1306 | self._handle_exitstatus(sts) |
| 1307 | else: |
| 1308 | self.returncode = sys.maxsize |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 1309 | except ChildProcessError: |
| 1310 | pass |
Victor Stinner | a58e2c5 | 2016-05-20 12:08:12 +0200 | [diff] [blame] | 1311 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1312 | try: |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1313 | exception_name, hex_errno, err_msg = ( |
| 1314 | errpipe_data.split(b':', 2)) |
Ammar Askar | 3fc499b | 2017-09-06 02:41:30 -0400 | [diff] [blame] | 1315 | # The encoding here should match the encoding |
| 1316 | # written in by the subprocess implementations |
| 1317 | # like _posixsubprocess |
| 1318 | err_msg = err_msg.decode() |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1319 | except ValueError: |
Gregory P. Smith | 8d07c26 | 2012-11-10 23:53:47 -0800 | [diff] [blame] | 1320 | exception_name = b'SubprocessError' |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1321 | hex_errno = b'0' |
Ammar Askar | 3fc499b | 2017-09-06 02:41:30 -0400 | [diff] [blame] | 1322 | err_msg = 'Bad exception data from child: {!r}'.format( |
| 1323 | bytes(errpipe_data)) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1324 | child_exception_type = getattr( |
| 1325 | builtins, exception_name.decode('ascii'), |
Gregory P. Smith | 8d07c26 | 2012-11-10 23:53:47 -0800 | [diff] [blame] | 1326 | SubprocessError) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1327 | if issubclass(child_exception_type, OSError) and hex_errno: |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1328 | errno_num = int(hex_errno, 16) |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1329 | child_exec_never_called = (err_msg == "noexec") |
| 1330 | if child_exec_never_called: |
| 1331 | err_msg = "" |
Gregory P. Smith | 8621bb5 | 2017-08-24 14:58:25 -0700 | [diff] [blame] | 1332 | # The error must be from chdir(cwd). |
| 1333 | err_filename = cwd |
| 1334 | else: |
| 1335 | err_filename = orig_executable |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1336 | if errno_num != 0: |
| 1337 | err_msg = os.strerror(errno_num) |
| 1338 | if errno_num == errno.ENOENT: |
Gregory P. Smith | 8621bb5 | 2017-08-24 14:58:25 -0700 | [diff] [blame] | 1339 | err_msg += ': ' + repr(err_filename) |
| 1340 | raise child_exception_type(errno_num, err_msg, err_filename) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1341 | raise child_exception_type(err_msg) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1342 | |
| 1343 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1344 | def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED, |
| 1345 | _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED, |
Gregory P. Smith | 50e16e3 | 2017-01-22 17:28:38 -0800 | [diff] [blame] | 1346 | _WEXITSTATUS=os.WEXITSTATUS, _WIFSTOPPED=os.WIFSTOPPED, |
| 1347 | _WSTOPSIG=os.WSTOPSIG): |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1348 | """All callers to this function MUST hold self._waitpid_lock.""" |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1349 | # This method is called (indirectly) by __del__, so it cannot |
Serhiy Storchaka | 72e7761 | 2014-02-10 19:20:22 +0200 | [diff] [blame] | 1350 | # refer to anything outside of its local scope. |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1351 | if _WIFSIGNALED(sts): |
| 1352 | self.returncode = -_WTERMSIG(sts) |
| 1353 | elif _WIFEXITED(sts): |
| 1354 | self.returncode = _WEXITSTATUS(sts) |
Gregory P. Smith | 50e16e3 | 2017-01-22 17:28:38 -0800 | [diff] [blame] | 1355 | elif _WIFSTOPPED(sts): |
| 1356 | self.returncode = -_WSTOPSIG(sts) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1357 | else: |
| 1358 | # Should never happen |
Gregory P. Smith | 8d07c26 | 2012-11-10 23:53:47 -0800 | [diff] [blame] | 1359 | raise SubprocessError("Unknown child exit status!") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1360 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1361 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1362 | def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid, |
Andrew Svetlov | 1d960fe | 2012-12-24 20:08:53 +0200 | [diff] [blame] | 1363 | _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1364 | """Check if child process has terminated. Returns returncode |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1365 | attribute. |
| 1366 | |
| 1367 | This method is called by __del__, so it cannot reference anything |
| 1368 | outside of the local scope (nor can any methods it calls). |
| 1369 | |
| 1370 | """ |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1371 | if self.returncode is None: |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1372 | if not self._waitpid_lock.acquire(False): |
| 1373 | # Something else is busy calling waitpid. Don't allow two |
| 1374 | # at once. We know nothing yet. |
| 1375 | return None |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1376 | try: |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1377 | if self.returncode is not None: |
| 1378 | return self.returncode # Another thread waited. |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1379 | pid, sts = _waitpid(self.pid, _WNOHANG) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1380 | if pid == self.pid: |
| 1381 | self._handle_exitstatus(sts) |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 1382 | except OSError as e: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1383 | if _deadstate is not None: |
| 1384 | self.returncode = _deadstate |
Andrew Svetlov | 08bab07 | 2012-12-24 20:06:35 +0200 | [diff] [blame] | 1385 | elif e.errno == _ECHILD: |
Gregory P. Smith | 3905171 | 2012-09-29 11:40:38 -0700 | [diff] [blame] | 1386 | # This happens if SIGCLD is set to be ignored or |
| 1387 | # waiting for child processes has otherwise been |
| 1388 | # disabled for our process. This child is dead, we |
| 1389 | # can't get the status. |
| 1390 | # http://bugs.python.org/issue15756 |
| 1391 | self.returncode = 0 |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1392 | finally: |
| 1393 | self._waitpid_lock.release() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1394 | return self.returncode |
| 1395 | |
| 1396 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1397 | def _try_wait(self, wait_flags): |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1398 | """All callers to this function MUST hold self._waitpid_lock.""" |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1399 | try: |
Charles-François Natali | 6e6c59b | 2015-02-07 13:27:50 +0000 | [diff] [blame] | 1400 | (pid, sts) = os.waitpid(self.pid, wait_flags) |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 1401 | except ChildProcessError: |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1402 | # This happens if SIGCLD is set to be ignored or waiting |
| 1403 | # for child processes has otherwise been disabled for our |
| 1404 | # process. This child is dead, we can't get the status. |
| 1405 | pid = self.pid |
| 1406 | sts = 0 |
| 1407 | return (pid, sts) |
| 1408 | |
| 1409 | |
Gregory P. Smith | 82604e0 | 2016-11-20 16:31:07 -0800 | [diff] [blame] | 1410 | def wait(self, timeout=None): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1411 | """Wait for child process to terminate. Returns returncode |
| 1412 | attribute.""" |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1413 | if self.returncode is not None: |
| 1414 | return self.returncode |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 1415 | |
Gregory P. Smith | 82604e0 | 2016-11-20 16:31:07 -0800 | [diff] [blame] | 1416 | if timeout is not None: |
| 1417 | endtime = _time() + timeout |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1418 | # Enter a busy loop if we have a timeout. This busy loop was |
| 1419 | # cribbed from Lib/threading.py in Thread.wait() at r71065. |
| 1420 | delay = 0.0005 # 500 us -> initial delay of 1 ms |
| 1421 | while True: |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1422 | if self._waitpid_lock.acquire(False): |
| 1423 | try: |
| 1424 | if self.returncode is not None: |
| 1425 | break # Another thread waited. |
| 1426 | (pid, sts) = self._try_wait(os.WNOHANG) |
| 1427 | assert pid == self.pid or pid == 0 |
| 1428 | if pid == self.pid: |
| 1429 | self._handle_exitstatus(sts) |
| 1430 | break |
| 1431 | finally: |
| 1432 | self._waitpid_lock.release() |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1433 | remaining = self._remaining_time(endtime) |
| 1434 | if remaining <= 0: |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 1435 | raise TimeoutExpired(self.args, timeout) |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1436 | delay = min(delay * 2, remaining, .05) |
| 1437 | time.sleep(delay) |
Gregory P. Smith | f328d79 | 2012-11-10 21:06:18 -0800 | [diff] [blame] | 1438 | else: |
| 1439 | while self.returncode is None: |
Gregory P. Smith | d65ba51 | 2014-04-23 00:27:17 -0700 | [diff] [blame] | 1440 | with self._waitpid_lock: |
| 1441 | if self.returncode is not None: |
| 1442 | break # Another thread waited. |
| 1443 | (pid, sts) = self._try_wait(0) |
| 1444 | # Check the pid and loop as waitpid has been known to |
| 1445 | # return 0 even without WNOHANG in odd situations. |
| 1446 | # http://bugs.python.org/issue14396. |
| 1447 | if pid == self.pid: |
| 1448 | self._handle_exitstatus(sts) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1449 | return self.returncode |
| 1450 | |
| 1451 | |
Reid Kleckner | 2b228f0 | 2011-03-16 16:57:54 -0400 | [diff] [blame] | 1452 | def _communicate(self, input, endtime, orig_timeout): |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1453 | if self.stdin and not self._communication_started: |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1454 | # Flush stdio buffer. This might block, if the user has |
| 1455 | # been writing to .stdin in an uncontrolled fashion. |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | 1ef8c7e | 2016-06-04 00:22:17 +0000 | [diff] [blame] | 1456 | try: |
| 1457 | self.stdin.flush() |
| 1458 | except BrokenPipeError: |
| 1459 | pass # communicate() must ignore BrokenPipeError. |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1460 | if not input: |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | 1ef8c7e | 2016-06-04 00:22:17 +0000 | [diff] [blame] | 1461 | try: |
| 1462 | self.stdin.close() |
| 1463 | except BrokenPipeError: |
| 1464 | pass # communicate() must ignore BrokenPipeError. |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1465 | |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 1466 | stdout = None |
| 1467 | stderr = None |
| 1468 | |
| 1469 | # Only create this mapping if we haven't already. |
| 1470 | if not self._communication_started: |
| 1471 | self._fileobj2output = {} |
| 1472 | if self.stdout: |
| 1473 | self._fileobj2output[self.stdout] = [] |
| 1474 | if self.stderr: |
| 1475 | self._fileobj2output[self.stderr] = [] |
| 1476 | |
| 1477 | if self.stdout: |
| 1478 | stdout = self._fileobj2output[self.stdout] |
| 1479 | if self.stderr: |
| 1480 | stderr = self._fileobj2output[self.stderr] |
| 1481 | |
| 1482 | self._save_input(input) |
| 1483 | |
Gregory P. Smith | 5ca129b | 2013-12-07 19:14:59 -0800 | [diff] [blame] | 1484 | if self._input: |
| 1485 | input_view = memoryview(self._input) |
| 1486 | |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 1487 | with _PopenSelector() as selector: |
| 1488 | if self.stdin and input: |
| 1489 | selector.register(self.stdin, selectors.EVENT_WRITE) |
| 1490 | if self.stdout: |
| 1491 | selector.register(self.stdout, selectors.EVENT_READ) |
| 1492 | if self.stderr: |
| 1493 | selector.register(self.stderr, selectors.EVENT_READ) |
| 1494 | |
| 1495 | while selector.get_map(): |
| 1496 | timeout = self._remaining_time(endtime) |
| 1497 | if timeout is not None and timeout < 0: |
| 1498 | raise TimeoutExpired(self.args, orig_timeout) |
| 1499 | |
| 1500 | ready = selector.select(timeout) |
| 1501 | self._check_timeout(endtime, orig_timeout) |
| 1502 | |
| 1503 | # XXX Rewrite these to use non-blocking I/O on the file |
| 1504 | # objects; they are no longer using C stdio! |
| 1505 | |
| 1506 | for key, events in ready: |
| 1507 | if key.fileobj is self.stdin: |
Gregory P. Smith | 5ca129b | 2013-12-07 19:14:59 -0800 | [diff] [blame] | 1508 | chunk = input_view[self._input_offset : |
| 1509 | self._input_offset + _PIPE_BUF] |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 1510 | try: |
| 1511 | self._input_offset += os.write(key.fd, chunk) |
Victor Stinner | a5e881d | 2015-01-14 17:07:59 +0100 | [diff] [blame] | 1512 | except BrokenPipeError: |
| 1513 | selector.unregister(key.fileobj) |
| 1514 | key.fileobj.close() |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 1515 | else: |
| 1516 | if self._input_offset >= len(self._input): |
| 1517 | selector.unregister(key.fileobj) |
| 1518 | key.fileobj.close() |
| 1519 | elif key.fileobj in (self.stdout, self.stderr): |
Gregory P. Smith | 7b83b18 | 2013-12-08 10:58:28 -0800 | [diff] [blame] | 1520 | data = os.read(key.fd, 32768) |
Charles-François Natali | 3a4586a | 2013-11-08 19:56:59 +0100 | [diff] [blame] | 1521 | if not data: |
| 1522 | selector.unregister(key.fileobj) |
| 1523 | key.fileobj.close() |
| 1524 | self._fileobj2output[key.fileobj].append(data) |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 1525 | |
| 1526 | self.wait(timeout=self._remaining_time(endtime)) |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1527 | |
| 1528 | # All data exchanged. Translate lists into strings. |
| 1529 | if stdout is not None: |
| 1530 | stdout = b''.join(stdout) |
| 1531 | if stderr is not None: |
| 1532 | stderr = b''.join(stderr) |
| 1533 | |
| 1534 | # Translate newlines, if requested. |
| 1535 | # This also turns bytes into strings. |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 1536 | if self.encoding or self.errors or self.universal_newlines: |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1537 | if stdout is not None: |
| 1538 | stdout = self._translate_newlines(stdout, |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 1539 | self.stdout.encoding, |
| 1540 | self.stdout.errors) |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1541 | if stderr is not None: |
| 1542 | stderr = self._translate_newlines(stderr, |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 1543 | self.stderr.encoding, |
| 1544 | self.stderr.errors) |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1545 | |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1546 | return (stdout, stderr) |
| 1547 | |
| 1548 | |
Andrew Svetlov | aa0dbdc | 2012-08-14 18:40:21 +0300 | [diff] [blame] | 1549 | def _save_input(self, input): |
| 1550 | # This method is called from the _communicate_with_*() methods |
| 1551 | # so that if we time out while communicating, we can continue |
| 1552 | # sending input if we retry. |
| 1553 | if self.stdin and self._input is None: |
| 1554 | self._input_offset = 0 |
| 1555 | self._input = input |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 1556 | if input is not None and ( |
| 1557 | self.encoding or self.errors or self.universal_newlines): |
| 1558 | self._input = self._input.encode(self.stdin.encoding, |
| 1559 | self.stdin.errors) |
Andrew Svetlov | aa0dbdc | 2012-08-14 18:40:21 +0300 | [diff] [blame] | 1560 | |
| 1561 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1562 | def send_signal(self, sig): |
Gregory P. Smith | a0c9caa | 2015-11-15 18:19:10 -0800 | [diff] [blame] | 1563 | """Send a signal to the process.""" |
| 1564 | # Skip signalling a process that we know has already died. |
| 1565 | if self.returncode is None: |
| 1566 | os.kill(self.pid, sig) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1567 | |
| 1568 | def terminate(self): |
| 1569 | """Terminate the process with SIGTERM |
| 1570 | """ |
| 1571 | self.send_signal(signal.SIGTERM) |
| 1572 | |
| 1573 | def kill(self): |
| 1574 | """Kill the process with SIGKILL |
| 1575 | """ |
| 1576 | self.send_signal(signal.SIGKILL) |