blob: 4b011e4ce5579402121405b1a2084e619f6ceb35 [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001# subprocess - Subprocesses with accessible I/O streams
2#
Tim Peterse718f612004-10-12 21:51:32 +00003# For more information about this module, see PEP 324.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00004#
Peter Astrand3a708df2005-09-23 17:37:29 +00005# Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00006#
Peter Astrand69bf13f2005-02-14 08:56:32 +00007# Licensed to PSF under a Contributor Agreement.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00008
Martin Panter4afdca02016-10-25 22:20:48 +00009r"""Subprocesses with accessible I/O streams
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000010
Fredrik Lundh15aaacc2004-10-17 14:47:05 +000011This module allows you to spawn processes, connect to their
Martin Panter4afdca02016-10-25 22:20:48 +000012input/output/error pipes, and obtain their return codes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000013
Martin Panter4afdca02016-10-25 22:20:48 +000014For a complete description of this module see the Python documentation.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000015
Martin Panter4afdca02016-10-25 22:20:48 +000016Main API
17========
18run(...): Runs a command, waits for it to complete, then returns a
19 CompletedProcess instance.
20Popen(...): A class for flexibly executing a command in a new process
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000021
Martin Panter4afdca02016-10-25 22:20:48 +000022Constants
23---------
24DEVNULL: Special value that indicates that os.devnull should be used
25PIPE: Special value that indicates a pipe should be created
26STDOUT: Special value that indicates that stderr should go to stdout
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000027
28
Martin Panter4afdca02016-10-25 22:20:48 +000029Older API
30=========
31call(...): Runs a command, waits for it to complete, then returns
32 the return code.
33check_call(...): Same as call() but raises CalledProcessError()
34 if return code is not 0
35check_output(...): Same as check_call() but returns the contents of
36 stdout instead of a return code
37getoutput(...): Runs a command in the shell, waits for it to complete,
38 then returns the output
39getstatusoutput(...): Runs a command in the shell, waits for it to complete,
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -070040 then returns a (exitcode, output) tuple
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000041"""
42
Zachary Ware880d42a2018-09-10 16:16:08 -070043import builtins
44import errno
Guido van Rossumfa0054a2007-05-24 04:05:35 +000045import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000046import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -040047import time
Christian Heimesa342c012008-04-20 21:01:16 +000048import signal
Zachary Ware880d42a2018-09-10 16:16:08 -070049import sys
50import threading
Gregory P. Smithd23047b2010-12-04 09:10:44 +000051import warnings
Giampaolo Rodolabafa8482019-01-29 22:14:24 +010052import contextlib
Victor Stinnerae586492014-09-02 23:18:25 +020053from time import monotonic as _time
Guido van Rossum48b069a2020-04-07 09:50:06 -070054import types
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000055
Patrick McLean2b2ead72019-09-12 10:15:44 -070056try:
Ruben Vorderman23c0fb82020-10-20 01:30:02 +020057 import fcntl
58except ImportError:
59 fcntl = None
60
Zachary Ware880d42a2018-09-10 16:16:08 -070061
62__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
63 "getoutput", "check_output", "run", "CalledProcessError", "DEVNULL",
64 "SubprocessError", "TimeoutExpired", "CompletedProcess"]
65 # NOTE: We intentionally exclude list2cmdline as it is
66 # considered an internal implementation detail. issue10838.
67
68try:
69 import msvcrt
70 import _winapi
71 _mswindows = True
72except ModuleNotFoundError:
73 _mswindows = False
74 import _posixsubprocess
75 import select
76 import selectors
77else:
78 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
79 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
80 STD_ERROR_HANDLE, SW_HIDE,
81 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW,
82 ABOVE_NORMAL_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS,
83 HIGH_PRIORITY_CLASS, IDLE_PRIORITY_CLASS,
84 NORMAL_PRIORITY_CLASS, REALTIME_PRIORITY_CLASS,
85 CREATE_NO_WINDOW, DETACHED_PROCESS,
86 CREATE_DEFAULT_ERROR_MODE, CREATE_BREAKAWAY_FROM_JOB)
87
88 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
89 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
90 "STD_ERROR_HANDLE", "SW_HIDE",
91 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW",
92 "STARTUPINFO",
93 "ABOVE_NORMAL_PRIORITY_CLASS", "BELOW_NORMAL_PRIORITY_CLASS",
94 "HIGH_PRIORITY_CLASS", "IDLE_PRIORITY_CLASS",
95 "NORMAL_PRIORITY_CLASS", "REALTIME_PRIORITY_CLASS",
96 "CREATE_NO_WINDOW", "DETACHED_PROCESS",
97 "CREATE_DEFAULT_ERROR_MODE", "CREATE_BREAKAWAY_FROM_JOB"])
98
99
Peter Astrand454f7672005-01-01 09:36:35 +0000100# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400101class SubprocessError(Exception): pass
102
103
104class CalledProcessError(SubprocessError):
Martin Panter4afdca02016-10-25 22:20:48 +0000105 """Raised when run() is called with check=True and the process
106 returns a non-zero exit status.
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)d6da7602016-06-03 06:14:06 +0000107
Martin Panter4afdca02016-10-25 22:20:48 +0000108 Attributes:
109 cmd, returncode, stdout, stderr, output
Georg Brandlf9734072008-12-07 15:30:06 +0000110 """
Gregory P. Smith6e730002015-04-14 16:14:25 -0700111 def __init__(self, returncode, cmd, output=None, stderr=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000112 self.returncode = returncode
113 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000114 self.output = output
Gregory P. Smith6e730002015-04-14 16:14:25 -0700115 self.stderr = stderr
116
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000117 def __str__(self):
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)d6da7602016-06-03 06:14:06 +0000118 if self.returncode and self.returncode < 0:
119 try:
120 return "Command '%s' died with %r." % (
121 self.cmd, signal.Signals(-self.returncode))
122 except ValueError:
123 return "Command '%s' died with unknown signal %d." % (
124 self.cmd, -self.returncode)
125 else:
126 return "Command '%s' returned non-zero exit status %d." % (
127 self.cmd, self.returncode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000128
Gregory P. Smith6e730002015-04-14 16:14:25 -0700129 @property
130 def stdout(self):
131 """Alias for output attribute, to match stderr"""
132 return self.output
133
134 @stdout.setter
135 def stdout(self, value):
136 # There's no obvious reason to set this, but allow it anyway so
137 # .stdout is a transparent alias for .output
138 self.output = value
139
Peter Astrand454f7672005-01-01 09:36:35 +0000140
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400141class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400142 """This exception is raised when the timeout expires while waiting for a
143 child process.
Martin Panter4afdca02016-10-25 22:20:48 +0000144
145 Attributes:
146 cmd, output, stdout, stderr, timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400147 """
Gregory P. Smith6e730002015-04-14 16:14:25 -0700148 def __init__(self, cmd, timeout, output=None, stderr=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400149 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400150 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400151 self.output = output
Gregory P. Smith6e730002015-04-14 16:14:25 -0700152 self.stderr = stderr
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400153
154 def __str__(self):
155 return ("Command '%s' timed out after %s seconds" %
156 (self.cmd, self.timeout))
157
Gregory P. Smith6e730002015-04-14 16:14:25 -0700158 @property
159 def stdout(self):
160 return self.output
161
162 @stdout.setter
163 def stdout(self, value):
164 # There's no obvious reason to set this, but allow it anyway so
165 # .stdout is a transparent alias for .output
166 self.output = value
167
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400168
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700169if _mswindows:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000170 class STARTUPINFO:
Subhendu Ghoshae160bb2017-02-25 20:29:05 +0530171 def __init__(self, *, dwFlags=0, hStdInput=None, hStdOutput=None,
Segev Finerb2a60832017-12-18 11:28:19 +0200172 hStdError=None, wShowWindow=0, lpAttributeList=None):
Subhendu Ghoshae160bb2017-02-25 20:29:05 +0530173 self.dwFlags = dwFlags
174 self.hStdInput = hStdInput
175 self.hStdOutput = hStdOutput
176 self.hStdError = hStdError
177 self.wShowWindow = wShowWindow
Segev Finerb2a60832017-12-18 11:28:19 +0200178 self.lpAttributeList = lpAttributeList or {"handle_list": []}
Victor Stinner483422f2018-07-05 22:54:17 +0200179
180 def copy(self):
181 attr_list = self.lpAttributeList.copy()
182 if 'handle_list' in attr_list:
183 attr_list['handle_list'] = list(attr_list['handle_list'])
184
185 return STARTUPINFO(dwFlags=self.dwFlags,
186 hStdInput=self.hStdInput,
187 hStdOutput=self.hStdOutput,
188 hStdError=self.hStdError,
189 wShowWindow=self.wShowWindow,
190 lpAttributeList=attr_list)
191
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200192
193 class Handle(int):
194 closed = False
195
196 def Close(self, CloseHandle=_winapi.CloseHandle):
197 if not self.closed:
198 self.closed = True
199 CloseHandle(self)
200
201 def Detach(self):
202 if not self.closed:
203 self.closed = True
204 return int(self)
205 raise ValueError("already closed")
206
207 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300208 return "%s(%d)" % (self.__class__.__name__, int(self))
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200209
210 __del__ = Close
Zachary Ware880d42a2018-09-10 16:16:08 -0700211else:
212 # When select or poll has indicated that the file is writable,
213 # we can write up to _PIPE_BUF bytes without risk of blocking.
214 # POSIX defines PIPE_BUF as >= 512.
215 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
216
217 # poll/select have the advantage of not requiring any extra file
218 # descriptor, contrarily to epoll/kqueue (also, they require a single
219 # syscall).
220 if hasattr(selectors, 'PollSelector'):
221 _PopenSelector = selectors.PollSelector
222 else:
223 _PopenSelector = selectors.SelectSelector
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200224
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225
Ruslan Kuprieiev042821a2019-06-28 19:12:16 +0300226if _mswindows:
227 # On Windows we just need to close `Popen._handle` when we no longer need
228 # it, so that the kernel can free it. `Popen._handle` gets closed
229 # implicitly when the `Popen` instance is finalized (see `Handle.__del__`,
230 # which is calling `CloseHandle` as requested in [1]), so there is nothing
231 # for `_cleanup` to do.
232 #
233 # [1] https://docs.microsoft.com/en-us/windows/desktop/ProcThread/
234 # creating-processes
235 _active = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000236
Ruslan Kuprieiev042821a2019-06-28 19:12:16 +0300237 def _cleanup():
238 pass
239else:
240 # This lists holds Popen instances for which the underlying process had not
241 # exited at the time its __del__ method got called: those processes are
242 # wait()ed for synchronously from _cleanup() when a new Popen object is
243 # created, to avoid zombie processes.
244 _active = []
245
246 def _cleanup():
247 if _active is None:
248 return
249 for inst in _active[:]:
250 res = inst._internal_poll(_deadstate=sys.maxsize)
251 if res is not None:
252 try:
253 _active.remove(inst)
254 except ValueError:
255 # This can happen if two threads create a new Popen instance.
256 # It's harmless that it was already removed, so ignore.
257 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000258
259PIPE = -1
260STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200261DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000262
263
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200264# XXX This function is only used by multiprocessing and the test suite,
265# but it's here so that it can be imported when Python is compiled without
266# threads.
267
Victor Stinner9def2842016-01-18 12:15:08 +0100268def _optim_args_from_interpreter_flags():
269 """Return a list of command-line arguments reproducing the current
270 optimization settings in sys.flags."""
271 args = []
272 value = sys.flags.optimize
273 if value > 0:
274 args.append('-' + 'O' * value)
275 return args
276
277
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200278def _args_from_interpreter_flags():
279 """Return a list of command-line arguments reproducing the current
Victor Stinner747f48e2017-12-12 22:59:48 +0100280 settings in sys.flags, sys.warnoptions and sys._xoptions."""
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200281 flag_opt_map = {
282 'debug': 'd',
283 # 'inspect': 'i',
284 # 'interactive': 'i',
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200285 'dont_write_bytecode': 'B',
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200286 'no_site': 'S',
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200287 'verbose': 'v',
288 'bytes_warning': 'b',
289 'quiet': 'q',
Victor Stinner9def2842016-01-18 12:15:08 +0100290 # -O is handled in _optim_args_from_interpreter_flags()
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200291 }
Victor Stinner9def2842016-01-18 12:15:08 +0100292 args = _optim_args_from_interpreter_flags()
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200293 for flag, opt in flag_opt_map.items():
294 v = getattr(sys.flags, flag)
295 if v > 0:
296 args.append('-' + opt * v)
Victor Stinnerf39b6742017-11-20 15:24:56 -0800297
Victor Stinner9de36322018-11-23 17:54:20 +0100298 if sys.flags.isolated:
299 args.append('-I')
300 else:
301 if sys.flags.ignore_environment:
302 args.append('-E')
303 if sys.flags.no_user_site:
304 args.append('-s')
305
Victor Stinnerf39b6742017-11-20 15:24:56 -0800306 # -W options
Victor Stinner747f48e2017-12-12 22:59:48 +0100307 warnopts = sys.warnoptions[:]
308 bytes_warning = sys.flags.bytes_warning
309 xoptions = getattr(sys, '_xoptions', {})
310 dev_mode = ('dev' in xoptions)
311
312 if bytes_warning > 1:
313 warnopts.remove("error::BytesWarning")
314 elif bytes_warning:
315 warnopts.remove("default::BytesWarning")
316 if dev_mode:
317 warnopts.remove('default')
318 for opt in warnopts:
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200319 args.append('-W' + opt)
Victor Stinnerf39b6742017-11-20 15:24:56 -0800320
321 # -X options
Victor Stinner747f48e2017-12-12 22:59:48 +0100322 if dev_mode:
Victor Stinnerf39b6742017-11-20 15:24:56 -0800323 args.extend(('-X', 'dev'))
324 for opt in ('faulthandler', 'tracemalloc', 'importtime',
Pablo Galindo1ed83ad2020-06-11 17:30:46 +0100325 'showrefcount', 'utf8'):
Victor Stinnerf39b6742017-11-20 15:24:56 -0800326 if opt in xoptions:
327 value = xoptions[opt]
328 if value is True:
329 arg = opt
330 else:
331 arg = '%s=%s' % (opt, value)
332 args.extend(('-X', arg))
333
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200334 return args
335
336
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400337def call(*popenargs, timeout=None, **kwargs):
338 """Run command with arguments. Wait for command to complete or
339 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000340
341 The arguments are the same as for the Popen constructor. Example:
342
343 retcode = call(["ls", "-l"])
344 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200345 with Popen(*popenargs, **kwargs) as p:
346 try:
347 return p.wait(timeout=timeout)
Gregory P. Smithf4d644f2018-01-29 21:27:39 -0800348 except: # Including KeyboardInterrupt, wait handled that.
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200349 p.kill()
Gregory P. Smithf4d644f2018-01-29 21:27:39 -0800350 # We don't call p.wait() again as p.__exit__ does that for us.
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200351 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000352
353
Peter Astrand454f7672005-01-01 09:36:35 +0000354def check_call(*popenargs, **kwargs):
355 """Run command with arguments. Wait for command to complete. If
356 the exit code was zero then return, otherwise raise
357 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000358 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000359
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400360 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000361
362 check_call(["ls", "-l"])
363 """
364 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000365 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000366 cmd = kwargs.get("args")
367 if cmd is None:
368 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000369 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000370 return 0
371
372
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400373def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700374 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000375
376 If the exit code was non-zero it raises a CalledProcessError. The
377 CalledProcessError object will have the return code in the returncode
378 attribute and output in the output attribute.
379
380 The arguments are the same as for the Popen constructor. Example:
381
382 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000383 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000384
385 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000386 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000387
388 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000389 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000390 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000391 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700392
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300393 There is an additional optional argument, "input", allowing you to
394 pass a string to the subprocess's stdin. If you use this argument
395 you may not also use the Popen constructor's "stdin" argument, as
396 it too will be used internally. Example:
397
398 >>> check_output(["sed", "-e", "s/foo/bar/"],
399 ... input=b"when in the course of fooman events\n")
400 b'when in the course of barman events\n'
401
andyclegg7fed7bd2017-10-23 03:01:19 +0100402 By default, all communication is in bytes, and therefore any "input"
Matthias182e1d12019-09-10 15:51:09 +0200403 should be bytes, and the return value will be bytes. If in text mode,
andyclegg7fed7bd2017-10-23 03:01:19 +0100404 any "input" should be a string, and the return value will be a string
405 decoded according to locale encoding, or by "encoding" if set. Text mode
406 is triggered by setting any of text, encoding, errors or universal_newlines.
Georg Brandlf9734072008-12-07 15:30:06 +0000407 """
408 if 'stdout' in kwargs:
409 raise ValueError('stdout argument not allowed, it will be overridden.')
Gregory P. Smith6e730002015-04-14 16:14:25 -0700410
411 if 'input' in kwargs and kwargs['input'] is None:
412 # Explicitly passing input=None was previously equivalent to passing an
413 # empty string. That is maintained here for backwards compatibility.
Gregory P. Smith64abf372020-12-24 20:57:21 -0800414 if kwargs.get('universal_newlines') or kwargs.get('text'):
415 empty = ''
416 else:
417 empty = b''
418 kwargs['input'] = empty
Gregory P. Smith6e730002015-04-14 16:14:25 -0700419
420 return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
421 **kwargs).stdout
422
423
424class CompletedProcess(object):
425 """A process that has finished running.
426
427 This is returned by run().
428
429 Attributes:
430 args: The list or str args passed to run().
431 returncode: The exit code of the process, negative for signals.
432 stdout: The standard output (None if not captured).
433 stderr: The standard error (None if not captured).
434 """
435 def __init__(self, args, returncode, stdout=None, stderr=None):
436 self.args = args
437 self.returncode = returncode
438 self.stdout = stdout
439 self.stderr = stderr
440
441 def __repr__(self):
442 args = ['args={!r}'.format(self.args),
443 'returncode={!r}'.format(self.returncode)]
444 if self.stdout is not None:
445 args.append('stdout={!r}'.format(self.stdout))
446 if self.stderr is not None:
447 args.append('stderr={!r}'.format(self.stderr))
448 return "{}({})".format(type(self).__name__, ', '.join(args))
449
Guido van Rossum48b069a2020-04-07 09:50:06 -0700450 __class_getitem__ = classmethod(types.GenericAlias)
Batuhan Taşkaya4dc5a9d2019-12-30 19:02:04 +0300451
452
Gregory P. Smith6e730002015-04-14 16:14:25 -0700453 def check_returncode(self):
454 """Raise CalledProcessError if the exit code is non-zero."""
455 if self.returncode:
456 raise CalledProcessError(self.returncode, self.args, self.stdout,
457 self.stderr)
458
459
Bo Baylesce0f33d2018-01-30 00:40:39 -0600460def run(*popenargs,
461 input=None, capture_output=False, timeout=None, check=False, **kwargs):
Gregory P. Smith6e730002015-04-14 16:14:25 -0700462 """Run command with arguments and return a CompletedProcess instance.
463
464 The returned instance will have attributes args, returncode, stdout and
465 stderr. By default, stdout and stderr are not captured, and those attributes
466 will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.
467
468 If check is True and the exit code was non-zero, it raises a
469 CalledProcessError. The CalledProcessError object will have the return code
470 in the returncode attribute, and output & stderr attributes if those streams
471 were captured.
472
473 If timeout is given, and the process takes too long, a TimeoutExpired
474 exception will be raised.
475
476 There is an optional argument "input", allowing you to
andyclegg7fed7bd2017-10-23 03:01:19 +0100477 pass bytes or a string to the subprocess's stdin. If you use this argument
Gregory P. Smith6e730002015-04-14 16:14:25 -0700478 you may not also use the Popen constructor's "stdin" argument, as
479 it will be used internally.
480
andyclegg7fed7bd2017-10-23 03:01:19 +0100481 By default, all communication is in bytes, and therefore any "input" should
482 be bytes, and the stdout and stderr will be bytes. If in text mode, any
483 "input" should be a string, and stdout and stderr will be strings decoded
484 according to locale encoding, or by "encoding" if set. Text mode is
485 triggered by setting any of text, encoding, errors or universal_newlines.
Gregory P. Smith6e730002015-04-14 16:14:25 -0700486
andyclegg7fed7bd2017-10-23 03:01:19 +0100487 The other arguments are the same as for the Popen constructor.
Gregory P. Smith6e730002015-04-14 16:14:25 -0700488 """
489 if input is not None:
Rémi Lapeyre8cc605a2019-06-08 16:56:24 +0200490 if kwargs.get('stdin') is not None:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300491 raise ValueError('stdin and input arguments may not both be used.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300492 kwargs['stdin'] = PIPE
Gregory P. Smith6e730002015-04-14 16:14:25 -0700493
Bo Baylesce0f33d2018-01-30 00:40:39 -0600494 if capture_output:
Rémi Lapeyre8cc605a2019-06-08 16:56:24 +0200495 if kwargs.get('stdout') is not None or kwargs.get('stderr') is not None:
Bo Baylesce0f33d2018-01-30 00:40:39 -0600496 raise ValueError('stdout and stderr arguments may not be used '
497 'with capture_output.')
498 kwargs['stdout'] = PIPE
499 kwargs['stderr'] = PIPE
500
Gregory P. Smith6e730002015-04-14 16:14:25 -0700501 with Popen(*popenargs, **kwargs) as process:
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200502 try:
Gregory P. Smith6e730002015-04-14 16:14:25 -0700503 stdout, stderr = process.communicate(input, timeout=timeout)
Gregory P. Smith580d2782019-09-11 04:23:05 -0500504 except TimeoutExpired as exc:
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200505 process.kill()
Gregory P. Smith580d2782019-09-11 04:23:05 -0500506 if _mswindows:
507 # Windows accumulates the output in a single blocking
508 # read() call run on child threads, with the timeout
509 # being done in a join() on those threads. communicate()
510 # _after_ kill() is required to collect that and add it
511 # to the exception.
512 exc.stdout, exc.stderr = process.communicate()
513 else:
514 # POSIX _communicate already populated the output so
515 # far into the TimeoutExpired exception.
516 process.wait()
517 raise
Gregory P. Smithf4d644f2018-01-29 21:27:39 -0800518 except: # Including KeyboardInterrupt, communicate handled that.
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200519 process.kill()
Gregory P. Smithf4d644f2018-01-29 21:27:39 -0800520 # We don't call process.wait() as .__exit__ does that for us.
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200521 raise
522 retcode = process.poll()
Gregory P. Smith6e730002015-04-14 16:14:25 -0700523 if check and retcode:
524 raise CalledProcessError(retcode, process.args,
525 output=stdout, stderr=stderr)
526 return CompletedProcess(process.args, retcode, stdout, stderr)
Peter Astrand454f7672005-01-01 09:36:35 +0000527
528
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000529def list2cmdline(seq):
530 """
531 Translate a sequence of arguments into a command line
532 string, using the same rules as the MS C runtime:
533
534 1) Arguments are delimited by white space, which is either a
535 space or a tab.
536
537 2) A string surrounded by double quotation marks is
538 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000539 contained within. A quoted string can be embedded in an
540 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000541
542 3) A double quotation mark preceded by a backslash is
543 interpreted as a literal double quotation mark.
544
545 4) Backslashes are interpreted literally, unless they
546 immediately precede a double quotation mark.
547
548 5) If backslashes immediately precede a double quotation mark,
549 every pair of backslashes is interpreted as a literal
550 backslash. If the number of backslashes is odd, the last
551 backslash escapes the next double quotation mark as
552 described in rule 3.
553 """
554
555 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000556 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
557 # or search http://msdn.microsoft.com for
558 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000559 result = []
560 needquote = False
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +0300561 for arg in map(os.fsdecode, seq):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000562 bs_buf = []
563
564 # Add a space to separate this argument from the others
565 if result:
566 result.append(' ')
567
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000568 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000569 if needquote:
570 result.append('"')
571
572 for c in arg:
573 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000574 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000575 bs_buf.append(c)
576 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000577 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000578 result.append('\\' * len(bs_buf)*2)
579 bs_buf = []
580 result.append('\\"')
581 else:
582 # Normal char
583 if bs_buf:
584 result.extend(bs_buf)
585 bs_buf = []
586 result.append(c)
587
Christian Heimesfdab48e2008-01-20 09:06:41 +0000588 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000589 if bs_buf:
590 result.extend(bs_buf)
591
592 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000593 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000594 result.append('"')
595
596 return ''.join(result)
597
598
Brett Cannona23810f2008-05-26 19:04:21 +0000599# Various tools for executing commands and looking at their output and status.
600#
Brett Cannona23810f2008-05-26 19:04:21 +0000601
602def getstatusoutput(cmd):
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -0700603 """Return (exitcode, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000604
Tim Golden60798142013-11-05 12:57:25 +0000605 Execute the string 'cmd' in a shell with 'check_output' and
Steve Dower050acae2016-09-06 20:16:17 -0700606 return a 2-tuple (status, output). The locale encoding is used
607 to decode the output and process newlines.
Tim Golden60798142013-11-05 12:57:25 +0000608
609 A trailing newline is stripped from the output.
610 The exit status for the command can be interpreted
611 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000612
613 >>> import subprocess
614 >>> subprocess.getstatusoutput('ls /bin/ls')
615 (0, '/bin/ls')
616 >>> subprocess.getstatusoutput('cat /bin/junk')
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -0700617 (1, 'cat: /bin/junk: No such file or directory')
Brett Cannona23810f2008-05-26 19:04:21 +0000618 >>> subprocess.getstatusoutput('/bin/junk')
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -0700619 (127, 'sh: /bin/junk: not found')
620 >>> subprocess.getstatusoutput('/bin/kill $$')
621 (-15, '')
Brett Cannona23810f2008-05-26 19:04:21 +0000622 """
Tim Goldene0041752013-11-03 12:53:17 +0000623 try:
andyclegg7fed7bd2017-10-23 03:01:19 +0100624 data = check_output(cmd, shell=True, text=True, stderr=STDOUT)
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -0700625 exitcode = 0
Tim Goldene0041752013-11-03 12:53:17 +0000626 except CalledProcessError as ex:
627 data = ex.output
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -0700628 exitcode = ex.returncode
Tim Goldene0041752013-11-03 12:53:17 +0000629 if data[-1:] == '\n':
630 data = data[:-1]
Gregory P. Smith2eb0cb42017-09-07 16:11:02 -0700631 return exitcode, data
Brett Cannona23810f2008-05-26 19:04:21 +0000632
633def getoutput(cmd):
634 """Return output (stdout or stderr) of executing cmd in a shell.
635
636 Like getstatusoutput(), except the exit status is ignored and the return
637 value is a string containing the command's output. Example:
638
639 >>> import subprocess
640 >>> subprocess.getoutput('ls /bin/ls')
641 '/bin/ls'
642 """
643 return getstatusoutput(cmd)[1]
644
645
Victor Stinner9daecf32019-01-16 00:02:35 +0100646def _use_posix_spawn():
Gregory P. Smith81d04bc2019-01-26 15:19:11 -0800647 """Check if posix_spawn() can be used for subprocess.
Victor Stinner9daecf32019-01-16 00:02:35 +0100648
Gregory P. Smith81d04bc2019-01-26 15:19:11 -0800649 subprocess requires a posix_spawn() implementation that properly reports
650 errors to the parent process, & sets errno on the following failures:
Victor Stinner9daecf32019-01-16 00:02:35 +0100651
Gregory P. Smith81d04bc2019-01-26 15:19:11 -0800652 * Process attribute actions failed.
653 * File actions failed.
654 * exec() failed.
Victor Stinner9daecf32019-01-16 00:02:35 +0100655
Gregory P. Smith81d04bc2019-01-26 15:19:11 -0800656 Prefer an implementation which can use vfork() in some cases for best
657 performance.
Victor Stinner9daecf32019-01-16 00:02:35 +0100658 """
659 if _mswindows or not hasattr(os, 'posix_spawn'):
660 # os.posix_spawn() is not available
661 return False
662
663 if sys.platform == 'darwin':
664 # posix_spawn() is a syscall on macOS and properly reports errors
665 return True
666
667 # Check libc name and runtime libc version
668 try:
669 ver = os.confstr('CS_GNU_LIBC_VERSION')
670 # parse 'glibc 2.28' as ('glibc', (2, 28))
671 parts = ver.split(maxsplit=1)
672 if len(parts) != 2:
673 # reject unknown format
674 raise ValueError
675 libc = parts[0]
676 version = tuple(map(int, parts[1].split('.')))
677
678 if sys.platform == 'linux' and libc == 'glibc' and version >= (2, 24):
679 # glibc 2.24 has a new Linux posix_spawn implementation using vfork
680 # which properly reports errors to the parent process.
681 return True
Gregory P. Smith81d04bc2019-01-26 15:19:11 -0800682 # Note: Don't use the implementation in earlier glibc because it doesn't
Victor Stinner9daecf32019-01-16 00:02:35 +0100683 # use vfork (even if glibc 2.26 added a pipe to properly report errors
684 # to the parent process).
685 except (AttributeError, ValueError, OSError):
686 # os.confstr() or CS_GNU_LIBC_VERSION value not available
687 pass
688
Gregory P. Smith81d04bc2019-01-26 15:19:11 -0800689 # By default, assume that posix_spawn() does not properly report errors.
Victor Stinner9daecf32019-01-16 00:02:35 +0100690 return False
691
692
693_USE_POSIX_SPAWN = _use_posix_spawn()
694
695
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000696class Popen(object):
Martin Panter4afdca02016-10-25 22:20:48 +0000697 """ Execute a child program in a new process.
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200698
Martin Panter4afdca02016-10-25 22:20:48 +0000699 For a complete description of the arguments see the Python documentation.
700
701 Arguments:
702 args: A string, or a sequence of program arguments.
703
704 bufsize: supplied as the buffering argument to the open() function when
705 creating the stdin/stdout/stderr pipe file objects
706
707 executable: A replacement program to execute.
708
709 stdin, stdout and stderr: These specify the executed programs' standard
710 input, standard output and standard error file handles, respectively.
711
712 preexec_fn: (POSIX only) An object to be called in the child process
713 just before the child is executed.
714
715 close_fds: Controls closing or inheriting of file descriptors.
716
717 shell: If true, the command will be executed through the shell.
718
719 cwd: Sets the current directory before the child is executed.
720
721 env: Defines the environment variables for the new process.
722
andyclegg7fed7bd2017-10-23 03:01:19 +0100723 text: If true, decode stdin, stdout and stderr using the given encoding
724 (if set) or the system default otherwise.
725
726 universal_newlines: Alias of text, provided for backwards compatibility.
Martin Panter4afdca02016-10-25 22:20:48 +0000727
728 startupinfo and creationflags (Windows only)
729
730 restore_signals (POSIX only)
731
732 start_new_session (POSIX only)
733
Patrick McLean2b2ead72019-09-12 10:15:44 -0700734 group (POSIX only)
735
736 extra_groups (POSIX only)
737
738 user (POSIX only)
739
Gregory P. Smithf3751ef2019-10-12 13:24:56 -0700740 umask (POSIX only)
741
Martin Panter4afdca02016-10-25 22:20:48 +0000742 pass_fds (POSIX only)
743
Martin Panter3dca6242016-10-25 23:41:42 +0000744 encoding and errors: Text mode encoding and error handling to use for
745 file objects stdin, stdout and stderr.
746
Martin Panter4afdca02016-10-25 22:20:48 +0000747 Attributes:
748 stdin, stdout, stderr, pid, returncode
749 """
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200750 _child_created = False # Set here since __del__ checks it
751
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700752 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 stdin=None, stdout=None, stderr=None,
Segev Finerb2a60832017-12-18 11:28:19 +0200754 preexec_fn=None, close_fds=True,
andyclegg7fed7bd2017-10-23 03:01:19 +0100755 shell=False, cwd=None, env=None, universal_newlines=None,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000756 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000757 restore_signals=True, start_new_session=False,
Patrick McLean2b2ead72019-09-12 10:15:44 -0700758 pass_fds=(), *, user=None, group=None, extra_groups=None,
Ruben Vorderman23c0fb82020-10-20 01:30:02 +0200759 encoding=None, errors=None, text=None, umask=-1, pipesize=-1):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000760 """Create new Popen instance."""
761 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700762 # Held while anything is calling waitpid before returncode has been
763 # updated to prevent clobbering returncode if wait() or poll() are
764 # called from multiple threads at once. After acquiring the lock,
765 # code must re-check self.returncode to see if another thread just
766 # finished a waitpid() call.
767 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000768
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400769 self._input = None
770 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000771 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700772 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000773 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000774 raise TypeError("bufsize must be an integer")
775
Ruben Vorderman23c0fb82020-10-20 01:30:02 +0200776 if pipesize is None:
777 pipesize = -1 # Restore default
778 if not isinstance(pipesize, int):
779 raise TypeError("pipesize must be an integer")
780
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700781 if _mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000782 if preexec_fn is not None:
783 raise ValueError("preexec_fn is not supported on Windows "
784 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000785 else:
786 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000787 if pass_fds and not close_fds:
788 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
789 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000790 if startupinfo is not None:
791 raise ValueError("startupinfo is only supported on Windows "
792 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000793 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000794 raise ValueError("creationflags is only supported on Windows "
795 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000796
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400797 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000798 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000799 self.stdout = None
800 self.stderr = None
801 self.pid = None
802 self.returncode = None
Steve Dower050acae2016-09-06 20:16:17 -0700803 self.encoding = encoding
804 self.errors = errors
Ruben Vorderman23c0fb82020-10-20 01:30:02 +0200805 self.pipesize = pipesize
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000806
andyclegg7fed7bd2017-10-23 03:01:19 +0100807 # Validate the combinations of text and universal_newlines
808 if (text is not None and universal_newlines is not None
809 and bool(universal_newlines) != bool(text)):
810 raise SubprocessError('Cannot disambiguate when both text '
811 'and universal_newlines are supplied but '
812 'different. Pass one or the other.')
813
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000814 # Input and output objects. The general principle is like
815 # this:
816 #
817 # Parent Child
818 # ------ -----
819 # p2cwrite ---stdin---> p2cread
820 # c2pread <--stdout--- c2pwrite
821 # errread <--stderr--- errwrite
822 #
823 # On POSIX, the child objects are file descriptors. On
824 # Windows, these are Windows file handles. The parent objects
825 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000826 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000827 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000828
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000829 (p2cread, p2cwrite,
830 c2pread, c2pwrite,
831 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
832
Antoine Pitrouc9982322011-01-04 19:07:07 +0000833 # We wrap OS handles *before* launching the child, otherwise a
834 # quickly terminating child could make our fds unwrappable
835 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000836
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700837 if _mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000838 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000839 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000840 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000841 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000842 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000843 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000844
andyclegg7fed7bd2017-10-23 03:01:19 +0100845 self.text_mode = encoding or errors or text or universal_newlines
Tim Peterse718f612004-10-12 21:51:32 +0000846
Gregory P. Smithf4d644f2018-01-29 21:27:39 -0800847 # How long to resume waiting on a child after the first ^C.
848 # There is no right value for this. The purpose is to be polite
849 # yet remain good for interactive users trying to exit a tool.
850 self._sigint_wait_secs = 0.25 # 1/xkcd221.getRandomNumber()
851
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700852 self._closed_child_pipe_fds = False
Steve Dower050acae2016-09-06 20:16:17 -0700853
Alexey Izbysheva2670562018-10-20 03:22:31 +0300854 if self.text_mode:
855 if bufsize == 1:
856 line_buffering = True
857 # Use the default buffer size for the underlying binary streams
858 # since they don't support line buffering.
859 bufsize = -1
860 else:
861 line_buffering = False
862
Patrick McLean2b2ead72019-09-12 10:15:44 -0700863 gid = None
864 if group is not None:
865 if not hasattr(os, 'setregid'):
866 raise ValueError("The 'group' parameter is not supported on the "
867 "current platform")
868
869 elif isinstance(group, str):
Victor Stinnerd72e8d42021-03-23 17:42:51 +0100870 try:
871 import grp
872 except ImportError:
Patrick McLean2b2ead72019-09-12 10:15:44 -0700873 raise ValueError("The group parameter cannot be a string "
874 "on systems without the grp module")
875
876 gid = grp.getgrnam(group).gr_gid
877 elif isinstance(group, int):
878 gid = group
879 else:
880 raise TypeError("Group must be a string or an integer, not {}"
881 .format(type(group)))
882
883 if gid < 0:
884 raise ValueError(f"Group ID cannot be negative, got {gid}")
885
886 gids = None
887 if extra_groups is not None:
888 if not hasattr(os, 'setgroups'):
889 raise ValueError("The 'extra_groups' parameter is not "
890 "supported on the current platform")
891
892 elif isinstance(extra_groups, str):
893 raise ValueError("Groups must be a list, not a string")
894
895 gids = []
896 for extra_group in extra_groups:
897 if isinstance(extra_group, str):
Victor Stinnerd72e8d42021-03-23 17:42:51 +0100898 try:
899 import grp
900 except ImportError:
Patrick McLean2b2ead72019-09-12 10:15:44 -0700901 raise ValueError("Items in extra_groups cannot be "
902 "strings on systems without the "
903 "grp module")
904
905 gids.append(grp.getgrnam(extra_group).gr_gid)
906 elif isinstance(extra_group, int):
907 gids.append(extra_group)
908 else:
909 raise TypeError("Items in extra_groups must be a string "
910 "or integer, not {}"
911 .format(type(extra_group)))
912
913 # make sure that the gids are all positive here so we can do less
914 # checking in the C code
915 for gid_check in gids:
916 if gid_check < 0:
917 raise ValueError(f"Group ID cannot be negative, got {gid_check}")
918
919 uid = None
920 if user is not None:
921 if not hasattr(os, 'setreuid'):
922 raise ValueError("The 'user' parameter is not supported on "
923 "the current platform")
924
925 elif isinstance(user, str):
Victor Stinnerd72e8d42021-03-23 17:42:51 +0100926 try:
927 import pwd
928 except ImportError:
Patrick McLean2b2ead72019-09-12 10:15:44 -0700929 raise ValueError("The user parameter cannot be a string "
930 "on systems without the pwd module")
Patrick McLean2b2ead72019-09-12 10:15:44 -0700931 uid = pwd.getpwnam(user).pw_uid
932 elif isinstance(user, int):
933 uid = user
934 else:
935 raise TypeError("User must be a string or an integer")
936
937 if uid < 0:
938 raise ValueError(f"User ID cannot be negative, got {uid}")
939
Antoine Pitrouc9982322011-01-04 19:07:07 +0000940 try:
Steve Dower050acae2016-09-06 20:16:17 -0700941 if p2cwrite != -1:
942 self.stdin = io.open(p2cwrite, 'wb', bufsize)
andyclegg7fed7bd2017-10-23 03:01:19 +0100943 if self.text_mode:
Steve Dower050acae2016-09-06 20:16:17 -0700944 self.stdin = io.TextIOWrapper(self.stdin, write_through=True,
Alexey Izbysheva2670562018-10-20 03:22:31 +0300945 line_buffering=line_buffering,
Steve Dower050acae2016-09-06 20:16:17 -0700946 encoding=encoding, errors=errors)
947 if c2pread != -1:
948 self.stdout = io.open(c2pread, 'rb', bufsize)
andyclegg7fed7bd2017-10-23 03:01:19 +0100949 if self.text_mode:
Steve Dower050acae2016-09-06 20:16:17 -0700950 self.stdout = io.TextIOWrapper(self.stdout,
951 encoding=encoding, errors=errors)
952 if errread != -1:
953 self.stderr = io.open(errread, 'rb', bufsize)
andyclegg7fed7bd2017-10-23 03:01:19 +0100954 if self.text_mode:
Steve Dower050acae2016-09-06 20:16:17 -0700955 self.stderr = io.TextIOWrapper(self.stderr,
956 encoding=encoding, errors=errors)
957
Antoine Pitrouc9982322011-01-04 19:07:07 +0000958 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300959 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000960 startupinfo, creationflags, shell,
961 p2cread, p2cwrite,
962 c2pread, c2pwrite,
963 errread, errwrite,
Patrick McLean2b2ead72019-09-12 10:15:44 -0700964 restore_signals,
Gregory P. Smithf3751ef2019-10-12 13:24:56 -0700965 gid, gids, uid, umask,
Patrick McLean2b2ead72019-09-12 10:15:44 -0700966 start_new_session)
Antoine Pitrouc9982322011-01-04 19:07:07 +0000967 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800968 # Cleanup if the child failed starting.
969 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000970 try:
971 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200972 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800973 pass # Ignore EBADF or other errors.
974
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700975 if not self._closed_child_pipe_fds:
976 to_close = []
977 if stdin == PIPE:
978 to_close.append(p2cread)
979 if stdout == PIPE:
980 to_close.append(c2pwrite)
981 if stderr == PIPE:
982 to_close.append(errwrite)
983 if hasattr(self, '_devnull'):
984 to_close.append(self._devnull)
985 for fd in to_close:
986 try:
Segev Finer4d385172017-08-18 16:18:13 +0300987 if _mswindows and isinstance(fd, Handle):
988 fd.Close()
989 else:
990 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700991 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700992 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800993
Antoine Pitrouc9982322011-01-04 19:07:07 +0000994 raise
995
Andrey Doroschenko645005e2019-11-17 17:08:31 +0300996 def __repr__(self):
997 obj_repr = (
998 f"<{self.__class__.__name__}: "
999 f"returncode: {self.returncode} args: {list(self.args)!r}>"
1000 )
1001 if len(obj_repr) > 80:
1002 obj_repr = obj_repr[:76] + "...>"
1003 return obj_repr
1004
Guido van Rossum48b069a2020-04-07 09:50:06 -07001005 __class_getitem__ = classmethod(types.GenericAlias)
Batuhan Taşkaya4dc5a9d2019-12-30 19:02:04 +03001006
andyclegg7fed7bd2017-10-23 03:01:19 +01001007 @property
1008 def universal_newlines(self):
1009 # universal_newlines as retained as an alias of text_mode for API
luzpaza5293b42017-11-05 07:37:50 -06001010 # compatibility. bpo-31756
andyclegg7fed7bd2017-10-23 03:01:19 +01001011 return self.text_mode
1012
1013 @universal_newlines.setter
1014 def universal_newlines(self, universal_newlines):
1015 self.text_mode = bool(universal_newlines)
1016
Steve Dower050acae2016-09-06 20:16:17 -07001017 def _translate_newlines(self, data, encoding, errors):
1018 data = data.decode(encoding, errors)
Andrew Svetlov82860712012-08-19 22:13:41 +03001019 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001020
Brian Curtin79cdb662010-12-03 02:46:02 +00001021 def __enter__(self):
1022 return self
1023
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001024 def __exit__(self, exc_type, value, traceback):
Brian Curtin79cdb662010-12-03 02:46:02 +00001025 if self.stdout:
1026 self.stdout.close()
1027 if self.stderr:
1028 self.stderr.close()
Serhiy Storchakaab900c22015-02-28 12:43:08 +02001029 try: # Flushing a BufferedWriter may raise an error
1030 if self.stdin:
1031 self.stdin.close()
1032 finally:
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001033 if exc_type == KeyboardInterrupt:
1034 # https://bugs.python.org/issue25942
1035 # In the case of a KeyboardInterrupt we assume the SIGINT
1036 # was also already sent to our child processes. We can't
1037 # block indefinitely as that is not user friendly.
1038 # If we have not already waited a brief amount of time in
1039 # an interrupted .wait() or .communicate() call, do so here
1040 # for consistency.
1041 if self._sigint_wait_secs > 0:
1042 try:
1043 self._wait(timeout=self._sigint_wait_secs)
1044 except TimeoutExpired:
1045 pass
1046 self._sigint_wait_secs = 0 # Note that this has been done.
1047 return # resume the KeyboardInterrupt
1048
Serhiy Storchakaab900c22015-02-28 12:43:08 +02001049 # Wait for the process to terminate, to avoid zombies.
1050 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001051
Victor Stinner9505b032017-01-06 10:44:44 +01001052 def __del__(self, _maxsize=sys.maxsize, _warn=warnings.warn):
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001053 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001054 # We didn't get to successfully create a child process.
1055 return
Victor Stinner5a48e212016-05-20 12:11:15 +02001056 if self.returncode is None:
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001057 # Not reading subprocess exit status creates a zombie process which
Victor Stinnerc206f1e2016-06-14 16:42:59 +02001058 # is only destroyed at the parent python process exit
Victor Stinner9505b032017-01-06 10:44:44 +01001059 _warn("subprocess %s is still running" % self.pid,
1060 ResourceWarning, source=self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001061 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +00001062 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001063 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001064 # Child is still running, keep us alive until we can wait on it.
1065 _active.append(self)
1066
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001067 def _get_devnull(self):
1068 if not hasattr(self, '_devnull'):
1069 self._devnull = os.open(os.devnull, os.O_RDWR)
1070 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001071
Victor Stinnera5e881d2015-01-14 17:07:59 +01001072 def _stdin_write(self, input):
1073 if input:
1074 try:
1075 self.stdin.write(input)
1076 except BrokenPipeError:
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)1ef8c7e2016-06-04 00:22:17 +00001077 pass # communicate() must ignore broken pipe errors.
Victor Stinnerd52aa312017-06-08 17:30:39 +02001078 except OSError as exc:
1079 if exc.errno == errno.EINVAL:
1080 # bpo-19612, bpo-30418: On Windows, stdin.write() fails
1081 # with EINVAL if the child process exited or if the child
1082 # process is still running but closed the pipe.
Victor Stinnera5e881d2015-01-14 17:07:59 +01001083 pass
1084 else:
1085 raise
Victor Stinnerd52aa312017-06-08 17:30:39 +02001086
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)1ef8c7e2016-06-04 00:22:17 +00001087 try:
1088 self.stdin.close()
1089 except BrokenPipeError:
1090 pass # communicate() must ignore broken pipe errors.
Victor Stinnerd52aa312017-06-08 17:30:39 +02001091 except OSError as exc:
1092 if exc.errno == errno.EINVAL:
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)1ef8c7e2016-06-04 00:22:17 +00001093 pass
1094 else:
1095 raise
Victor Stinnera5e881d2015-01-14 17:07:59 +01001096
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001097 def communicate(self, input=None, timeout=None):
Joel Schaerer88031a92017-09-13 21:11:20 +02001098 """Interact with process: Send data to stdin and close it.
1099 Read data from stdout and stderr, until end-of-file is
1100 reached. Wait for process to terminate.
Tim Peterseba28be2005-03-28 01:08:02 +00001101
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001102 The optional "input" argument should be data to be sent to the
andyclegg7fed7bd2017-10-23 03:01:19 +01001103 child process, or None, if no data should be sent to the child.
1104 communicate() returns a tuple (stdout, stderr).
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001105
andyclegg7fed7bd2017-10-23 03:01:19 +01001106 By default, all communication is in bytes, and therefore any
1107 "input" should be bytes, and the (stdout, stderr) will be bytes.
1108 If in text mode (indicated by self.text_mode), any "input" should
1109 be a string, and (stdout, stderr) will be strings decoded
1110 according to locale encoding, or by "encoding" if set. Text mode
1111 is triggered by setting any of text, encoding, errors or
1112 universal_newlines.
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001113 """
Peter Astrand23109f02005-03-03 20:28:59 +00001114
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001115 if self._communication_started and input:
1116 raise ValueError("Cannot send input after starting communication")
1117
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001118 # Optimization: If we are not worried about timeouts, we haven't
1119 # started communicating, and we have one or zero pipes, using select()
1120 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +02001121 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001122 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +00001123 stdout = None
1124 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +00001125 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001126 self._stdin_write(input)
Peter Astrand23109f02005-03-03 20:28:59 +00001127 elif self.stdout:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001128 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +00001129 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +00001130 elif self.stderr:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001131 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +00001132 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +00001133 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +02001134 else:
1135 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001136 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +02001137 else:
1138 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +00001139
Victor Stinner7a8d0812011-04-05 13:13:08 +02001140 try:
1141 stdout, stderr = self._communicate(input, endtime, timeout)
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001142 except KeyboardInterrupt:
1143 # https://bugs.python.org/issue25942
1144 # See the detailed comment in .wait().
1145 if timeout is not None:
1146 sigint_timeout = min(self._sigint_wait_secs,
1147 self._remaining_time(endtime))
1148 else:
1149 sigint_timeout = self._sigint_wait_secs
1150 self._sigint_wait_secs = 0 # nothing else should wait.
1151 try:
1152 self._wait(timeout=sigint_timeout)
1153 except TimeoutExpired:
1154 pass
1155 raise # resume the KeyboardInterrupt
1156
Victor Stinner7a8d0812011-04-05 13:13:08 +02001157 finally:
1158 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001159
Victor Stinner7a8d0812011-04-05 13:13:08 +02001160 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001161
1162 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +00001163
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001164
Georg Brandl6aa2d1f2008-08-12 08:35:52 +00001165 def poll(self):
Martin Panter4afdca02016-10-25 22:20:48 +00001166 """Check if child process has terminated. Set and return returncode
1167 attribute."""
Georg Brandl6aa2d1f2008-08-12 08:35:52 +00001168 return self._internal_poll()
1169
1170
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001171 def _remaining_time(self, endtime):
1172 """Convenience for _communicate when computing timeouts."""
1173 if endtime is None:
1174 return None
1175 else:
Victor Stinner949d8c92012-05-30 13:30:32 +02001176 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001177
1178
Gregory P. Smith580d2782019-09-11 04:23:05 -05001179 def _check_timeout(self, endtime, orig_timeout, stdout_seq, stderr_seq,
1180 skip_check_and_raise=False):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001181 """Convenience for checking if a timeout has expired."""
1182 if endtime is None:
1183 return
Gregory P. Smith580d2782019-09-11 04:23:05 -05001184 if skip_check_and_raise or _time() > endtime:
1185 raise TimeoutExpired(
1186 self.args, orig_timeout,
1187 output=b''.join(stdout_seq) if stdout_seq else None,
1188 stderr=b''.join(stderr_seq) if stderr_seq else None)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001189
1190
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001191 def wait(self, timeout=None):
1192 """Wait for child process to terminate; returns self.returncode."""
1193 if timeout is not None:
1194 endtime = _time() + timeout
1195 try:
1196 return self._wait(timeout=timeout)
1197 except KeyboardInterrupt:
1198 # https://bugs.python.org/issue25942
1199 # The first keyboard interrupt waits briefly for the child to
1200 # exit under the common assumption that it also received the ^C
1201 # generated SIGINT and will exit rapidly.
1202 if timeout is not None:
1203 sigint_timeout = min(self._sigint_wait_secs,
1204 self._remaining_time(endtime))
1205 else:
1206 sigint_timeout = self._sigint_wait_secs
1207 self._sigint_wait_secs = 0 # nothing else should wait.
1208 try:
1209 self._wait(timeout=sigint_timeout)
1210 except TimeoutExpired:
1211 pass
1212 raise # resume the KeyboardInterrupt
1213
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001214 def _close_pipe_fds(self,
1215 p2cread, p2cwrite,
1216 c2pread, c2pwrite,
1217 errread, errwrite):
1218 # self._devnull is not always defined.
1219 devnull_fd = getattr(self, '_devnull', None)
1220
Giampaolo Rodolabafa8482019-01-29 22:14:24 +01001221 with contextlib.ExitStack() as stack:
1222 if _mswindows:
1223 if p2cread != -1:
1224 stack.callback(p2cread.Close)
1225 if c2pwrite != -1:
1226 stack.callback(c2pwrite.Close)
1227 if errwrite != -1:
1228 stack.callback(errwrite.Close)
1229 else:
1230 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
1231 stack.callback(os.close, p2cread)
1232 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
1233 stack.callback(os.close, c2pwrite)
1234 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
1235 stack.callback(os.close, errwrite)
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001236
Giampaolo Rodolabafa8482019-01-29 22:14:24 +01001237 if devnull_fd is not None:
1238 stack.callback(os.close, devnull_fd)
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001239
1240 # Prevent a double close of these handles/fds from __init__ on error.
1241 self._closed_child_pipe_fds = True
1242
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -07001243 if _mswindows:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244 #
1245 # Windows methods
1246 #
1247 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001248 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001249 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1250 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001251 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001252 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +00001253
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001254 p2cread, p2cwrite = -1, -1
1255 c2pread, c2pwrite = -1, -1
1256 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001257
Peter Astrandd38ddf42005-02-10 08:32:50 +00001258 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001259 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001260 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001261 p2cread, _ = _winapi.CreatePipe(None, 0)
1262 p2cread = Handle(p2cread)
1263 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001264 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001265 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1266 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001267 elif stdin == DEVNULL:
1268 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001269 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001270 p2cread = msvcrt.get_osfhandle(stdin)
1271 else:
1272 # Assuming file-like object
1273 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1274 p2cread = self._make_inheritable(p2cread)
1275
Peter Astrandd38ddf42005-02-10 08:32:50 +00001276 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001277 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001278 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001279 _, c2pwrite = _winapi.CreatePipe(None, 0)
1280 c2pwrite = Handle(c2pwrite)
1281 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001282 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001283 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1284 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001285 elif stdout == DEVNULL:
1286 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001287 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001288 c2pwrite = msvcrt.get_osfhandle(stdout)
1289 else:
1290 # Assuming file-like object
1291 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1292 c2pwrite = self._make_inheritable(c2pwrite)
1293
Peter Astrandd38ddf42005-02-10 08:32:50 +00001294 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001295 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001296 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001297 _, errwrite = _winapi.CreatePipe(None, 0)
1298 errwrite = Handle(errwrite)
1299 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001300 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001301 errread, errwrite = _winapi.CreatePipe(None, 0)
1302 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303 elif stderr == STDOUT:
1304 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001305 elif stderr == DEVNULL:
1306 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001307 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001308 errwrite = msvcrt.get_osfhandle(stderr)
1309 else:
1310 # Assuming file-like object
1311 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1312 errwrite = self._make_inheritable(errwrite)
1313
1314 return (p2cread, p2cwrite,
1315 c2pread, c2pwrite,
1316 errread, errwrite)
1317
1318
1319 def _make_inheritable(self, handle):
1320 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001321 h = _winapi.DuplicateHandle(
1322 _winapi.GetCurrentProcess(), handle,
1323 _winapi.GetCurrentProcess(), 0, 1,
1324 _winapi.DUPLICATE_SAME_ACCESS)
1325 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001326
1327
Segev Finerb2a60832017-12-18 11:28:19 +02001328 def _filter_handle_list(self, handle_list):
1329 """Filter out console handles that can't be used
1330 in lpAttributeList["handle_list"] and make sure the list
1331 isn't empty. This also removes duplicate handles."""
1332 # An handle with it's lowest two bits set might be a special console
1333 # handle that if passed in lpAttributeList["handle_list"], will
1334 # cause it to fail.
1335 return list({handle for handle in handle_list
1336 if handle & 0x3 != 0x3
1337 or _winapi.GetFileType(handle) !=
1338 _winapi.FILE_TYPE_CHAR})
1339
1340
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001341 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001342 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343 startupinfo, creationflags, shell,
1344 p2cread, p2cwrite,
1345 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001346 errread, errwrite,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001347 unused_restore_signals,
1348 unused_gid, unused_gids, unused_uid,
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07001349 unused_umask,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001350 unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001351 """Execute program (MS Windows version)"""
1352
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001353 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001354
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +03001355 if isinstance(args, str):
1356 pass
1357 elif isinstance(args, bytes):
1358 if shell:
1359 raise TypeError('bytes args is not allowed on Windows')
1360 args = list2cmdline([args])
1361 elif isinstance(args, os.PathLike):
1362 if shell:
1363 raise TypeError('path-like args is not allowed when '
1364 'shell is true')
1365 args = list2cmdline([args])
1366 else:
Serhiy Storchakabe50a7b2018-02-28 01:03:46 +02001367 args = list2cmdline(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001368
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +03001369 if executable is not None:
1370 executable = os.fsdecode(executable)
1371
Peter Astrandc1d65362004-11-07 14:30:34 +00001372 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001373 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001374 startupinfo = STARTUPINFO()
Victor Stinner483422f2018-07-05 22:54:17 +02001375 else:
1376 # bpo-34044: Copy STARTUPINFO since it is modified above,
1377 # so the caller can reuse it multiple times.
1378 startupinfo = startupinfo.copy()
Segev Finerb2a60832017-12-18 11:28:19 +02001379
1380 use_std_handles = -1 not in (p2cread, c2pwrite, errwrite)
1381 if use_std_handles:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001382 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001383 startupinfo.hStdInput = p2cread
1384 startupinfo.hStdOutput = c2pwrite
1385 startupinfo.hStdError = errwrite
1386
Segev Finerb2a60832017-12-18 11:28:19 +02001387 attribute_list = startupinfo.lpAttributeList
1388 have_handle_list = bool(attribute_list and
1389 "handle_list" in attribute_list and
1390 attribute_list["handle_list"])
1391
1392 # If we were given an handle_list or need to create one
1393 if have_handle_list or (use_std_handles and close_fds):
1394 if attribute_list is None:
1395 attribute_list = startupinfo.lpAttributeList = {}
1396 handle_list = attribute_list["handle_list"] = \
1397 list(attribute_list.get("handle_list", []))
1398
1399 if use_std_handles:
1400 handle_list += [int(p2cread), int(c2pwrite), int(errwrite)]
1401
1402 handle_list[:] = self._filter_handle_list(handle_list)
1403
1404 if handle_list:
1405 if not close_fds:
1406 warnings.warn("startupinfo.lpAttributeList['handle_list'] "
1407 "overriding close_fds", RuntimeWarning)
1408
1409 # When using the handle_list we always request to inherit
1410 # handles but the only handles that will be inherited are
1411 # the ones in the handle_list
1412 close_fds = False
1413
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001414 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001415 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1416 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001417 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001418 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001419
Steve Dower60419a72019-06-24 08:42:54 -07001420 if cwd is not None:
1421 cwd = os.fsdecode(cwd)
1422
1423 sys.audit("subprocess.Popen", executable, args, cwd, env)
1424
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001425 # Start the process
1426 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001427 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001428 # no special security
1429 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001430 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001431 creationflags,
1432 env,
Steve Dower60419a72019-06-24 08:42:54 -07001433 cwd,
Tim Peterse8374a52004-10-13 03:15:00 +00001434 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001435 finally:
1436 # Child is launched. Close the parent's copy of those pipe
1437 # handles that only the child should have open. You need
1438 # to make sure that no handles to the write end of the
1439 # output pipe are maintained in this process or else the
1440 # pipe will not close when the child process exits and the
1441 # ReadFile will hang.
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001442 self._close_pipe_fds(p2cread, p2cwrite,
1443 c2pread, c2pwrite,
1444 errread, errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001445
1446 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001447 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001448 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001449 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001450 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001451
Brett Cannon84df1e62010-05-14 00:33:40 +00001452 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001453 _WaitForSingleObject=_winapi.WaitForSingleObject,
1454 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1455 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001456 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001457 attribute.
1458
1459 This method is called by __del__, so it can only refer to objects
1460 in its local scope.
1461
1462 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001463 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001464 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1465 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001466 return self.returncode
1467
1468
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001469 def _wait(self, timeout):
1470 """Internal implementation of wait() on Windows."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001471 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001472 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001473 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001474 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001475 if self.returncode is None:
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001476 # API note: Returns immediately if timeout_millis == 0.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001477 result = _winapi.WaitForSingleObject(self._handle,
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001478 timeout_millis)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001479 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001480 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001481 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001482 return self.returncode
1483
1484
1485 def _readerthread(self, fh, buffer):
1486 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001487 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001488
1489
Reid Kleckner2b228f02011-03-16 16:57:54 -04001490 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001491 # Start reader threads feeding into a list hanging off of this
1492 # object, unless they've already been started.
1493 if self.stdout and not hasattr(self, "_stdout_buff"):
1494 self._stdout_buff = []
1495 self.stdout_thread = \
1496 threading.Thread(target=self._readerthread,
1497 args=(self.stdout, self._stdout_buff))
1498 self.stdout_thread.daemon = True
1499 self.stdout_thread.start()
1500 if self.stderr and not hasattr(self, "_stderr_buff"):
1501 self._stderr_buff = []
1502 self.stderr_thread = \
1503 threading.Thread(target=self._readerthread,
1504 args=(self.stderr, self._stderr_buff))
1505 self.stderr_thread.daemon = True
1506 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001507
1508 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001509 self._stdin_write(input)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001510
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001511 # Wait for the reader threads, or time out. If we time out, the
1512 # threads remain reading and the fds left open in case the user
1513 # calls communicate again.
1514 if self.stdout is not None:
1515 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001516 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001517 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001518 if self.stderr is not None:
1519 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001520 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001521 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001522
1523 # Collect the output from and close both pipes, now that we know
1524 # both have been read successfully.
1525 stdout = None
1526 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001527 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001528 stdout = self._stdout_buff
1529 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001530 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001531 stderr = self._stderr_buff
1532 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001533
1534 # All data exchanged. Translate lists into strings.
Chris Griffithb4fc44b2021-03-11 13:43:29 -06001535 stdout = stdout[0] if stdout else None
1536 stderr = stderr[0] if stderr else None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001537
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001538 return (stdout, stderr)
1539
Christian Heimesa342c012008-04-20 21:01:16 +00001540 def send_signal(self, sig):
Gregory P. Smitha0c9caa2015-11-15 18:19:10 -08001541 """Send a signal to the process."""
1542 # Don't signal a process that we know has already died.
1543 if self.returncode is not None:
1544 return
Christian Heimesa342c012008-04-20 21:01:16 +00001545 if sig == signal.SIGTERM:
1546 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001547 elif sig == signal.CTRL_C_EVENT:
1548 os.kill(self.pid, signal.CTRL_C_EVENT)
1549 elif sig == signal.CTRL_BREAK_EVENT:
1550 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001551 else:
Brian Curtin19651362010-09-07 13:24:38 +00001552 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001553
1554 def terminate(self):
Gregory P. Smitha0c9caa2015-11-15 18:19:10 -08001555 """Terminates the process."""
1556 # Don't terminate a process that we know has already died.
1557 if self.returncode is not None:
1558 return
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001559 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001560 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001561 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001562 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1563 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001564 rc = _winapi.GetExitCodeProcess(self._handle)
1565 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001566 raise
1567 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001568
1569 kill = terminate
1570
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001571 else:
1572 #
1573 # POSIX methods
1574 #
1575 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001576 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001577 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1578 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001579 p2cread, p2cwrite = -1, -1
1580 c2pread, c2pwrite = -1, -1
1581 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001582
Peter Astrandd38ddf42005-02-10 08:32:50 +00001583 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001584 pass
1585 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001586 p2cread, p2cwrite = os.pipe()
Ruben Vorderman23c0fb82020-10-20 01:30:02 +02001587 if self.pipesize > 0 and hasattr(fcntl, "F_SETPIPE_SZ"):
1588 fcntl.fcntl(p2cwrite, fcntl.F_SETPIPE_SZ, self.pipesize)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001589 elif stdin == DEVNULL:
1590 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001591 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001592 p2cread = stdin
1593 else:
1594 # Assuming file-like object
1595 p2cread = stdin.fileno()
1596
Peter Astrandd38ddf42005-02-10 08:32:50 +00001597 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001598 pass
1599 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001600 c2pread, c2pwrite = os.pipe()
Ruben Vorderman23c0fb82020-10-20 01:30:02 +02001601 if self.pipesize > 0 and hasattr(fcntl, "F_SETPIPE_SZ"):
1602 fcntl.fcntl(c2pwrite, fcntl.F_SETPIPE_SZ, self.pipesize)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001603 elif stdout == DEVNULL:
1604 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001605 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001606 c2pwrite = stdout
1607 else:
1608 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001609 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001610
Peter Astrandd38ddf42005-02-10 08:32:50 +00001611 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001612 pass
1613 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001614 errread, errwrite = os.pipe()
Ruben Vorderman23c0fb82020-10-20 01:30:02 +02001615 if self.pipesize > 0 and hasattr(fcntl, "F_SETPIPE_SZ"):
1616 fcntl.fcntl(errwrite, fcntl.F_SETPIPE_SZ, self.pipesize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001617 elif stderr == STDOUT:
Martin Panterc7635892016-05-13 01:54:44 +00001618 if c2pwrite != -1:
1619 errwrite = c2pwrite
1620 else: # child's stdout is not set, use parent's stdout
1621 errwrite = sys.__stdout__.fileno()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001622 elif stderr == DEVNULL:
1623 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001624 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001625 errwrite = stderr
1626 else:
1627 # Assuming file-like object
1628 errwrite = stderr.fileno()
1629
1630 return (p2cread, p2cwrite,
1631 c2pread, c2pwrite,
1632 errread, errwrite)
1633
1634
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001635 def _posix_spawn(self, args, executable, env, restore_signals,
1636 p2cread, p2cwrite,
1637 c2pread, c2pwrite,
1638 errread, errwrite):
Victor Stinner8c349562019-01-16 23:38:06 +01001639 """Execute program using os.posix_spawn()."""
Victor Stinner9daecf32019-01-16 00:02:35 +01001640 if env is None:
1641 env = os.environ
1642
1643 kwargs = {}
1644 if restore_signals:
1645 # See _Py_RestoreSignals() in Python/pylifecycle.c
1646 sigset = []
1647 for signame in ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ'):
1648 signum = getattr(signal, signame, None)
1649 if signum is not None:
1650 sigset.append(signum)
1651 kwargs['setsigdef'] = sigset
1652
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001653 file_actions = []
1654 for fd in (p2cwrite, c2pread, errread):
1655 if fd != -1:
1656 file_actions.append((os.POSIX_SPAWN_CLOSE, fd))
1657 for fd, fd2 in (
1658 (p2cread, 0),
1659 (c2pwrite, 1),
1660 (errwrite, 2),
1661 ):
1662 if fd != -1:
1663 file_actions.append((os.POSIX_SPAWN_DUP2, fd, fd2))
1664 if file_actions:
1665 kwargs['file_actions'] = file_actions
1666
Victor Stinner8c349562019-01-16 23:38:06 +01001667 self.pid = os.posix_spawn(executable, args, env, **kwargs)
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001668 self._child_created = True
1669
1670 self._close_pipe_fds(p2cread, p2cwrite,
1671 c2pread, c2pwrite,
1672 errread, errwrite)
Victor Stinner9daecf32019-01-16 00:02:35 +01001673
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001674 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001675 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001676 startupinfo, creationflags, shell,
1677 p2cread, p2cwrite,
1678 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001679 errread, errwrite,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001680 restore_signals,
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07001681 gid, gids, uid, umask,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001682 start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001683 """Execute program (POSIX version)"""
1684
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001685 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001686 args = [args]
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +03001687 elif isinstance(args, os.PathLike):
1688 if shell:
1689 raise TypeError('path-like args is not allowed when '
1690 'shell is true')
1691 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001692 else:
Serhiy Storchakabe50a7b2018-02-28 01:03:46 +02001693 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001694
1695 if shell:
Xavier de Gayeb35fc622016-12-13 16:32:21 +01001696 # On Android the default shell is at '/system/bin/sh'.
1697 unix_shell = ('/system/bin/sh' if
1698 hasattr(sys, 'getandroidapilevel') else '/bin/sh')
1699 args = [unix_shell, "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001700 if executable:
1701 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001702
Peter Astrandd38ddf42005-02-10 08:32:50 +00001703 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001704 executable = args[0]
Victor Stinner9daecf32019-01-16 00:02:35 +01001705
Steve Dower60419a72019-06-24 08:42:54 -07001706 sys.audit("subprocess.Popen", executable, args, cwd, env)
1707
Victor Stinner9daecf32019-01-16 00:02:35 +01001708 if (_USE_POSIX_SPAWN
Victor Stinner8c349562019-01-16 23:38:06 +01001709 and os.path.dirname(executable)
Victor Stinner9daecf32019-01-16 00:02:35 +01001710 and preexec_fn is None
1711 and not close_fds
1712 and not pass_fds
1713 and cwd is None
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001714 and (p2cread == -1 or p2cread > 2)
1715 and (c2pwrite == -1 or c2pwrite > 2)
1716 and (errwrite == -1 or errwrite > 2)
Victor Stinnerfaca8552019-09-25 15:52:49 +02001717 and not start_new_session
1718 and gid is None
1719 and gids is None
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07001720 and uid is None
1721 and umask < 0):
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001722 self._posix_spawn(args, executable, env, restore_signals,
1723 p2cread, p2cwrite,
1724 c2pread, c2pwrite,
1725 errread, errwrite)
Victor Stinner9daecf32019-01-16 00:02:35 +01001726 return
1727
Gregory P. Smith5591b022012-10-10 03:34:47 -07001728 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001729
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001730 # For transferring possible exec failure from child to parent.
1731 # Data format: "exception name:hex errno:description"
1732 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001733 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001734 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1735 low_fds_to_close = []
1736 while errpipe_write < 3:
1737 low_fds_to_close.append(errpipe_write)
1738 errpipe_write = os.dup(errpipe_write)
1739 for low_fd in low_fds_to_close:
1740 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001741 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001743 # We must avoid complex work that could involve
1744 # malloc or free in the child process to avoid
1745 # potential deadlocks, thus we do all this here.
1746 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001747
Victor Stinner372b8382011-06-21 17:24:21 +02001748 if env is not None:
Serhiy Storchakad174d242017-06-23 19:39:27 +03001749 env_list = []
1750 for k, v in env.items():
1751 k = os.fsencode(k)
1752 if b'=' in k:
1753 raise ValueError("illegal environment variable name")
1754 env_list.append(k + b'=' + os.fsencode(v))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001755 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001756 env_list = None # Use execv instead of execve.
1757 executable = os.fsencode(executable)
1758 if os.path.dirname(executable):
1759 executable_list = (executable,)
1760 else:
1761 # This matches the behavior of os._execvpe().
1762 executable_list = tuple(
1763 os.path.join(os.fsencode(dir), executable)
1764 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001765 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001766 fds_to_keep.add(errpipe_write)
1767 self.pid = _posixsubprocess.fork_exec(
1768 args, executable_list,
Serhiy Storchaka66bffd12017-04-19 21:12:46 +03001769 close_fds, tuple(sorted(map(int, fds_to_keep))),
1770 cwd, env_list,
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001771 p2cread, p2cwrite, c2pread, c2pwrite,
1772 errread, errwrite,
1773 errpipe_read, errpipe_write,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001774 restore_signals, start_new_session,
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07001775 gid, gids, uid, umask,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001776 preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001777 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001778 finally:
1779 # be sure the FD is closed no matter what
1780 os.close(errpipe_write)
1781
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001782 self._close_pipe_fds(p2cread, p2cwrite,
1783 c2pread, c2pwrite,
1784 errread, errwrite)
Facundo Batista10706e22009-06-19 20:34:30 +00001785
1786 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001787 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001788 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001789 while True:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001790 part = os.read(errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001791 errpipe_data += part
1792 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001793 break
Facundo Batista10706e22009-06-19 20:34:30 +00001794 finally:
1795 # be sure the FD is closed no matter what
1796 os.close(errpipe_read)
1797
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001798 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001799 try:
Victor Stinnera58e2c52016-05-20 12:08:12 +02001800 pid, sts = os.waitpid(self.pid, 0)
1801 if pid == self.pid:
1802 self._handle_exitstatus(sts)
1803 else:
1804 self.returncode = sys.maxsize
Victor Stinnera5e881d2015-01-14 17:07:59 +01001805 except ChildProcessError:
1806 pass
Victor Stinnera58e2c52016-05-20 12:08:12 +02001807
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001808 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001809 exception_name, hex_errno, err_msg = (
1810 errpipe_data.split(b':', 2))
Ammar Askar3fc499b2017-09-06 02:41:30 -04001811 # The encoding here should match the encoding
1812 # written in by the subprocess implementations
1813 # like _posixsubprocess
1814 err_msg = err_msg.decode()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001815 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001816 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001817 hex_errno = b'0'
Ammar Askar3fc499b2017-09-06 02:41:30 -04001818 err_msg = 'Bad exception data from child: {!r}'.format(
1819 bytes(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001820 child_exception_type = getattr(
1821 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001822 SubprocessError)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001823 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001824 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001825 child_exec_never_called = (err_msg == "noexec")
1826 if child_exec_never_called:
1827 err_msg = ""
Gregory P. Smith8621bb52017-08-24 14:58:25 -07001828 # The error must be from chdir(cwd).
1829 err_filename = cwd
1830 else:
1831 err_filename = orig_executable
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001832 if errno_num != 0:
1833 err_msg = os.strerror(errno_num)
Gregory P. Smith8621bb52017-08-24 14:58:25 -07001834 raise child_exception_type(errno_num, err_msg, err_filename)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001835 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001836
1837
Victor Stinner65a796e2020-04-01 18:49:29 +02001838 def _handle_exitstatus(self, sts,
1839 waitstatus_to_exitcode=os.waitstatus_to_exitcode,
1840 _WIFSTOPPED=os.WIFSTOPPED,
1841 _WSTOPSIG=os.WSTOPSIG):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001842 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001843 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001844 # refer to anything outside of its local scope.
Victor Stinner65a796e2020-04-01 18:49:29 +02001845 if _WIFSTOPPED(sts):
Gregory P. Smith50e16e32017-01-22 17:28:38 -08001846 self.returncode = -_WSTOPSIG(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001847 else:
Victor Stinner65a796e2020-04-01 18:49:29 +02001848 self.returncode = waitstatus_to_exitcode(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001849
Brett Cannon84df1e62010-05-14 00:33:40 +00001850 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001851 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001852 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001853 attribute.
1854
1855 This method is called by __del__, so it cannot reference anything
1856 outside of the local scope (nor can any methods it calls).
1857
1858 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001859 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001860 if not self._waitpid_lock.acquire(False):
1861 # Something else is busy calling waitpid. Don't allow two
1862 # at once. We know nothing yet.
1863 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001864 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001865 if self.returncode is not None:
1866 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001867 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001868 if pid == self.pid:
1869 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001870 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001871 if _deadstate is not None:
1872 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001873 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001874 # This happens if SIGCLD is set to be ignored or
1875 # waiting for child processes has otherwise been
1876 # disabled for our process. This child is dead, we
1877 # can't get the status.
1878 # http://bugs.python.org/issue15756
1879 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001880 finally:
1881 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001882 return self.returncode
1883
1884
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001885 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001886 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001887 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001888 (pid, sts) = os.waitpid(self.pid, wait_flags)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001889 except ChildProcessError:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001890 # This happens if SIGCLD is set to be ignored or waiting
1891 # for child processes has otherwise been disabled for our
1892 # process. This child is dead, we can't get the status.
1893 pid = self.pid
1894 sts = 0
1895 return (pid, sts)
1896
1897
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08001898 def _wait(self, timeout):
1899 """Internal implementation of wait() on POSIX."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001900 if self.returncode is not None:
1901 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001902
Gregory P. Smith82604e02016-11-20 16:31:07 -08001903 if timeout is not None:
1904 endtime = _time() + timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001905 # Enter a busy loop if we have a timeout. This busy loop was
1906 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1907 delay = 0.0005 # 500 us -> initial delay of 1 ms
1908 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001909 if self._waitpid_lock.acquire(False):
1910 try:
1911 if self.returncode is not None:
1912 break # Another thread waited.
1913 (pid, sts) = self._try_wait(os.WNOHANG)
1914 assert pid == self.pid or pid == 0
1915 if pid == self.pid:
1916 self._handle_exitstatus(sts)
1917 break
1918 finally:
1919 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001920 remaining = self._remaining_time(endtime)
1921 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001922 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001923 delay = min(delay * 2, remaining, .05)
1924 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001925 else:
1926 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001927 with self._waitpid_lock:
1928 if self.returncode is not None:
1929 break # Another thread waited.
1930 (pid, sts) = self._try_wait(0)
1931 # Check the pid and loop as waitpid has been known to
1932 # return 0 even without WNOHANG in odd situations.
1933 # http://bugs.python.org/issue14396.
1934 if pid == self.pid:
1935 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001936 return self.returncode
1937
1938
Reid Kleckner2b228f02011-03-16 16:57:54 -04001939 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001940 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001941 # Flush stdio buffer. This might block, if the user has
1942 # been writing to .stdin in an uncontrolled fashion.
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)1ef8c7e2016-06-04 00:22:17 +00001943 try:
1944 self.stdin.flush()
1945 except BrokenPipeError:
1946 pass # communicate() must ignore BrokenPipeError.
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001947 if not input:
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)1ef8c7e2016-06-04 00:22:17 +00001948 try:
1949 self.stdin.close()
1950 except BrokenPipeError:
1951 pass # communicate() must ignore BrokenPipeError.
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001952
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001953 stdout = None
1954 stderr = None
1955
1956 # Only create this mapping if we haven't already.
1957 if not self._communication_started:
1958 self._fileobj2output = {}
1959 if self.stdout:
1960 self._fileobj2output[self.stdout] = []
1961 if self.stderr:
1962 self._fileobj2output[self.stderr] = []
1963
1964 if self.stdout:
1965 stdout = self._fileobj2output[self.stdout]
1966 if self.stderr:
1967 stderr = self._fileobj2output[self.stderr]
1968
1969 self._save_input(input)
1970
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001971 if self._input:
1972 input_view = memoryview(self._input)
1973
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001974 with _PopenSelector() as selector:
1975 if self.stdin and input:
1976 selector.register(self.stdin, selectors.EVENT_WRITE)
Alex Rebertd3ae95e2020-01-22 18:28:31 -05001977 if self.stdout and not self.stdout.closed:
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001978 selector.register(self.stdout, selectors.EVENT_READ)
Alex Rebertd3ae95e2020-01-22 18:28:31 -05001979 if self.stderr and not self.stderr.closed:
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001980 selector.register(self.stderr, selectors.EVENT_READ)
1981
1982 while selector.get_map():
1983 timeout = self._remaining_time(endtime)
1984 if timeout is not None and timeout < 0:
Gregory P. Smith580d2782019-09-11 04:23:05 -05001985 self._check_timeout(endtime, orig_timeout,
1986 stdout, stderr,
1987 skip_check_and_raise=True)
1988 raise RuntimeError( # Impossible :)
1989 '_check_timeout(..., skip_check_and_raise=True) '
1990 'failed to raise TimeoutExpired.')
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001991
1992 ready = selector.select(timeout)
Gregory P. Smith580d2782019-09-11 04:23:05 -05001993 self._check_timeout(endtime, orig_timeout, stdout, stderr)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001994
1995 # XXX Rewrite these to use non-blocking I/O on the file
1996 # objects; they are no longer using C stdio!
1997
1998 for key, events in ready:
1999 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08002000 chunk = input_view[self._input_offset :
2001 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01002002 try:
2003 self._input_offset += os.write(key.fd, chunk)
Victor Stinnera5e881d2015-01-14 17:07:59 +01002004 except BrokenPipeError:
2005 selector.unregister(key.fileobj)
2006 key.fileobj.close()
Charles-François Natali3a4586a2013-11-08 19:56:59 +01002007 else:
2008 if self._input_offset >= len(self._input):
2009 selector.unregister(key.fileobj)
2010 key.fileobj.close()
2011 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08002012 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01002013 if not data:
2014 selector.unregister(key.fileobj)
2015 key.fileobj.close()
2016 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04002017
2018 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00002019
2020 # All data exchanged. Translate lists into strings.
2021 if stdout is not None:
2022 stdout = b''.join(stdout)
2023 if stderr is not None:
2024 stderr = b''.join(stderr)
2025
2026 # Translate newlines, if requested.
2027 # This also turns bytes into strings.
andyclegg7fed7bd2017-10-23 03:01:19 +01002028 if self.text_mode:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00002029 if stdout is not None:
2030 stdout = self._translate_newlines(stdout,
Steve Dower050acae2016-09-06 20:16:17 -07002031 self.stdout.encoding,
2032 self.stdout.errors)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00002033 if stderr is not None:
2034 stderr = self._translate_newlines(stderr,
Steve Dower050acae2016-09-06 20:16:17 -07002035 self.stderr.encoding,
2036 self.stderr.errors)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00002037
Gregory P. Smithd06fa472009-07-04 02:46:54 +00002038 return (stdout, stderr)
2039
2040
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03002041 def _save_input(self, input):
2042 # This method is called from the _communicate_with_*() methods
2043 # so that if we time out while communicating, we can continue
2044 # sending input if we retry.
2045 if self.stdin and self._input is None:
2046 self._input_offset = 0
2047 self._input = input
andyclegg7fed7bd2017-10-23 03:01:19 +01002048 if input is not None and self.text_mode:
Steve Dower050acae2016-09-06 20:16:17 -07002049 self._input = self._input.encode(self.stdin.encoding,
2050 self.stdin.errors)
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03002051
2052
Christian Heimesa342c012008-04-20 21:01:16 +00002053 def send_signal(self, sig):
Gregory P. Smitha0c9caa2015-11-15 18:19:10 -08002054 """Send a signal to the process."""
Victor Stinnere85a3052020-01-15 17:38:55 +01002055 # bpo-38630: Polling reduces the risk of sending a signal to the
2056 # wrong process if the process completed, the Popen.returncode
2057 # attribute is still None, and the pid has been reassigned
2058 # (recycled) to a new different process. This race condition can
2059 # happens in two cases.
2060 #
2061 # Case 1. Thread A calls Popen.poll(), thread B calls
2062 # Popen.send_signal(). In thread A, waitpid() succeed and returns
2063 # the exit status. Thread B calls kill() because poll() in thread A
2064 # did not set returncode yet. Calling poll() in thread B prevents
2065 # the race condition thanks to Popen._waitpid_lock.
2066 #
2067 # Case 2. waitpid(pid, 0) has been called directly, without
2068 # using Popen methods: returncode is still None is this case.
2069 # Calling Popen.poll() will set returncode to a default value,
2070 # since waitpid() fails with ProcessLookupError.
2071 self.poll()
2072 if self.returncode is not None:
2073 # Skip signalling a process that we know has already died.
2074 return
2075
2076 # The race condition can still happen if the race condition
2077 # described above happens between the returncode test
2078 # and the kill() call.
Filipe Laíns01a202a2020-11-21 09:22:08 +00002079 try:
2080 os.kill(self.pid, sig)
2081 except ProcessLookupError:
2082 # Supress the race condition error; bpo-40550.
2083 pass
Christian Heimesa342c012008-04-20 21:01:16 +00002084
2085 def terminate(self):
2086 """Terminate the process with SIGTERM
2087 """
2088 self.send_signal(signal.SIGTERM)
2089
2090 def kill(self):
2091 """Kill the process with SIGKILL
2092 """
2093 self.send_signal(signal.SIGKILL)