blob: b853f4d59323e042bfe428f4cfe4a67d2086a04b [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.
Peter Astrand3a708df2005-09-23 17:37:29 +00008# See http://www.python.org/2.4/license for licensing details.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009
Raymond Hettinger837dd932004-10-17 16:36:53 +000010r"""subprocess - Subprocesses with accessible I/O streams
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000011
Fredrik Lundh15aaacc2004-10-17 14:47:05 +000012This module allows you to spawn processes, connect to their
13input/output/error pipes, and obtain their return codes. This module
Benjamin Peterson5eea8a72014-03-12 21:41:35 -050014intends to replace several older modules and functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000015
16os.system
17os.spawn*
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000018
19Information about how the subprocess module can be used to replace these
20modules and functions can be found below.
21
22
23
24Using the subprocess module
25===========================
26This module defines one class called Popen:
27
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070028class Popen(args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000029 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000030 preexec_fn=None, close_fds=True, shell=False,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000031 cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000032 startupinfo=None, creationflags=0,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000033 restore_signals=True, start_new_session=False, pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000034
35
36Arguments are:
37
38args should be a string, or a sequence of program arguments. The
39program to execute is normally the first item in the args sequence or
40string, but can be explicitly set by using the executable argument.
41
Gregory P. Smithf5604852010-12-13 06:45:02 +000042On POSIX, with shell=False (default): In this case, the Popen class
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000043uses os.execvp() to execute the child program. args should normally
44be a sequence. A string will be treated as a sequence with the string
45as the only item (the program to execute).
46
Gregory P. Smithf5604852010-12-13 06:45:02 +000047On POSIX, with shell=True: If args is a string, it specifies the
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000048command string to execute through the shell. If args is a sequence,
49the first item specifies the command string, and any additional items
50will be treated as additional shell arguments.
51
52On Windows: the Popen class uses CreateProcess() to execute the child
53program, which operates on strings. If args is a sequence, it will be
54converted to a string using the list2cmdline method. Please note that
55not all MS Windows applications interpret the command line the same
56way: The list2cmdline is designed for applications using the same
57rules as the MS C runtime.
58
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070059bufsize will be supplied as the corresponding argument to the io.open()
60function when creating the stdin/stdout/stderr pipe file objects:
610 means unbuffered (read & write are one system call and can return short),
621 means line buffered, any other positive value means use a buffer of
63approximately that size. A negative bufsize, the default, means the system
64default of io.DEFAULT_BUFFER_SIZE will be used.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000065
66stdin, stdout and stderr specify the executed programs' standard
67input, standard output and standard error file handles, respectively.
68Valid values are PIPE, an existing file descriptor (a positive
69integer), an existing file object, and None. PIPE indicates that a
70new pipe to the child should be created. With None, no redirection
71will occur; the child's file handles will be inherited from the
72parent. Additionally, stderr can be STDOUT, which indicates that the
73stderr data from the applications should be captured into the same
74file handle as for stdout.
75
Gregory P. Smithf5604852010-12-13 06:45:02 +000076On POSIX, if preexec_fn is set to a callable object, this object will be
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000077called in the child process just before the child is executed. The use
78of preexec_fn is not thread safe, using it in the presence of threads
79could lead to a deadlock in the child process before the new executable
80is executed.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000081
82If close_fds is true, all file descriptors except 0, 1 and 2 will be
Gregory P. Smithf5604852010-12-13 06:45:02 +000083closed before the child process is executed. The default for close_fds
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000084varies by platform: Always true on POSIX. True when stdin/stdout/stderr
85are None on Windows, false otherwise.
86
87pass_fds is an optional sequence of file descriptors to keep open between the
88parent and child. Providing any pass_fds implicitly sets close_fds to true.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000089
90if shell is true, the specified command will be executed through the
91shell.
92
93If cwd is not None, the current directory will be changed to cwd
94before the child is executed.
95
Gregory P. Smithf5604852010-12-13 06:45:02 +000096On POSIX, if restore_signals is True all signals that Python sets to
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000097SIG_IGN are restored to SIG_DFL in the child process before the exec.
98Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. This
99parameter does nothing on Windows.
100
Gregory P. Smithf5604852010-12-13 06:45:02 +0000101On POSIX, if start_new_session is True, the setsid() system call will be made
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000102in the child process prior to executing the command.
103
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000104If env is not None, it defines the environment variables for the new
105process.
106
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400107If universal_newlines is False, the file objects stdin, stdout and stderr
Ronald Oussoren385521c2013-07-07 09:26:45 +0200108are opened as binary files, and no line ending conversion is done.
109
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400110If universal_newlines is True, the file objects stdout and stderr are
111opened as a text file, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000112the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000113'\r\n', the Windows convention. All of these external representations
Gregory P. Smith1f8a40b2013-03-20 18:32:03 -0700114are seen as '\n' by the Python program. Also, the newlines attribute
115of the file objects stdout, stdin and stderr are not updated by the
116communicate() method.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000117
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400118In either case, the process being communicated with should start up
119expecting to receive bytes on its standard input and decode them with
120the same encoding they are sent in.
121
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000122The startupinfo and creationflags, if given, will be passed to the
123underlying CreateProcess() function. They can specify things such as
124appearance of the main window and priority for the new process.
125(Windows only)
126
127
Georg Brandlf9734072008-12-07 15:30:06 +0000128This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000129
Peter Astrand5f5e1412004-12-05 20:15:36 +0000130call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131 Run command with arguments. Wait for command to complete, then
132 return the returncode attribute.
133
134 The arguments are the same as for the Popen constructor. Example:
135
Florent Xicluna4886d242010-03-08 13:27:26 +0000136 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000137
Peter Astrand454f7672005-01-01 09:36:35 +0000138check_call(*popenargs, **kwargs):
139 Run command with arguments. Wait for command to complete. If the
140 exit code was zero then return, otherwise raise
141 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000142 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000143
144 The arguments are the same as for the Popen constructor. Example:
145
Florent Xicluna4886d242010-03-08 13:27:26 +0000146 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000147 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000148
Brett Cannona23810f2008-05-26 19:04:21 +0000149getstatusoutput(cmd):
150 Return (status, output) of executing cmd in a shell.
151
Tim Golden60798142013-11-05 12:57:25 +0000152 Execute the string 'cmd' in a shell with 'check_output' and
153 return a 2-tuple (status, output). Universal newlines mode is used,
154 meaning that the result with be decoded to a string.
155
156 A trailing newline is stripped from the output.
157 The exit status for the command can be interpreted
158 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000159
Brett Cannona23810f2008-05-26 19:04:21 +0000160 >>> subprocess.getstatusoutput('ls /bin/ls')
161 (0, '/bin/ls')
162 >>> subprocess.getstatusoutput('cat /bin/junk')
163 (256, 'cat: /bin/junk: No such file or directory')
164 >>> subprocess.getstatusoutput('/bin/junk')
165 (256, 'sh: /bin/junk: not found')
166
167getoutput(cmd):
168 Return output (stdout or stderr) of executing cmd in a shell.
169
170 Like getstatusoutput(), except the exit status is ignored and the return
171 value is a string containing the command's output. Example:
172
Brett Cannona23810f2008-05-26 19:04:21 +0000173 >>> subprocess.getoutput('ls /bin/ls')
174 '/bin/ls'
175
Georg Brandlf9734072008-12-07 15:30:06 +0000176check_output(*popenargs, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700177 Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Georg Brandl2708f3a2009-12-20 14:38:23 +0000179 If the exit code was non-zero it raises a CalledProcessError. The
180 CalledProcessError object will have the return code in the returncode
181 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000182
Georg Brandl2708f3a2009-12-20 14:38:23 +0000183 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000184
Georg Brandl2708f3a2009-12-20 14:38:23 +0000185 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000186
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300187 There is an additional optional argument, "input", allowing you to
188 pass a string to the subprocess's stdin. If you use this argument
189 you may not also use the Popen constructor's "stdin" argument.
Brett Cannona23810f2008-05-26 19:04:21 +0000190
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400191 If universal_newlines is set to True, the "input" argument must
192 be a string rather than bytes, and the return value will be a string.
193
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000194Exceptions
195----------
196Exceptions raised in the child process, before the new program has
197started to execute, will be re-raised in the parent. Additionally,
198the exception object will have one extra attribute called
199'child_traceback', which is a string containing traceback information
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300200from the child's point of view.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000201
202The most common exception raised is OSError. This occurs, for
203example, when trying to execute a non-existent file. Applications
204should prepare for OSErrors.
205
206A ValueError will be raised if Popen is called with invalid arguments.
207
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400208Exceptions defined within this module inherit from SubprocessError.
209check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400210called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400211be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000212
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000213
214Security
215--------
216Unlike some other popen functions, this implementation will never call
217/bin/sh implicitly. This means that all characters, including shell
218metacharacters, can safely be passed to child processes.
219
220
221Popen objects
222=============
223Instances of the Popen class have the following methods:
224
225poll()
226 Check if child process has terminated. Returns returncode
227 attribute.
228
229wait()
230 Wait for child process to terminate. Returns returncode attribute.
231
232communicate(input=None)
233 Interact with process: Send data to stdin. Read data from stdout
234 and stderr, until end-of-file is reached. Wait for process to
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400235 terminate. The optional input argument should be data to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000236 sent to the child process, or None, if no data should be sent to
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400237 the child. If the Popen instance was constructed with universal_newlines
238 set to True, the input argument should be a string and will be encoded
239 using the preferred system encoding (see locale.getpreferredencoding);
240 if universal_newlines is False, the input argument should be a
241 byte string.
Tim Peterse718f612004-10-12 21:51:32 +0000242
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000243 communicate() returns a tuple (stdout, stderr).
244
245 Note: The data read is buffered in memory, so do not use this
246 method if the data size is large or unlimited.
247
248The following attributes are also available:
249
250stdin
251 If the stdin argument is PIPE, this attribute is a file object
252 that provides input to the child process. Otherwise, it is None.
253
254stdout
255 If the stdout argument is PIPE, this attribute is a file object
256 that provides output from the child process. Otherwise, it is
257 None.
258
259stderr
260 If the stderr argument is PIPE, this attribute is file object that
261 provides error output from the child process. Otherwise, it is
262 None.
263
264pid
265 The process ID of the child process.
266
267returncode
268 The child return code. A None value indicates that the process
269 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000270 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000271
272
273Replacing older functions with the subprocess module
274====================================================
275In this section, "a ==> b" means that b can be used as a replacement
276for a.
277
278Note: All functions in this section fail (more or less) silently if
279the executed program cannot be found; this module raises an OSError
280exception.
281
282In the following examples, we assume that the subprocess module is
283imported with "from subprocess import *".
284
285
286Replacing /bin/sh shell backquote
287---------------------------------
288output=`mycmd myarg`
289==>
290output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
291
292
293Replacing shell pipe line
294-------------------------
295output=`dmesg | grep hda`
296==>
297p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000298p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000299output = p2.communicate()[0]
300
301
302Replacing os.system()
303---------------------
304sts = os.system("mycmd" + " myarg")
305==>
306p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000307pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000308
309Note:
310
311* Calling the program through the shell is usually not required.
312
313* It's easier to look at the returncode attribute than the
314 exitstatus.
315
316A more real-world example would look like this:
317
318try:
319 retcode = call("mycmd" + " myarg", shell=True)
320 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000321 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000322 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000323 print("Child returned", retcode, file=sys.stderr)
324except OSError as e:
325 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000326
327
328Replacing os.spawn*
329-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000330P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000331
332pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
333==>
334pid = Popen(["/bin/mycmd", "myarg"]).pid
335
336
337P_WAIT example:
338
339retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
340==>
341retcode = call(["/bin/mycmd", "myarg"])
342
343
Tim Peterse718f612004-10-12 21:51:32 +0000344Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000345
346os.spawnvp(os.P_NOWAIT, path, args)
347==>
348Popen([path] + args[1:])
349
350
Tim Peterse718f612004-10-12 21:51:32 +0000351Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000352
353os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
354==>
355Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000356"""
357
358import sys
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700359_mswindows = (sys.platform == "win32")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000360
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000361import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000362import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400363import time
Christian Heimesa342c012008-04-20 21:01:16 +0000364import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000365import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000366import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200367import errno
Victor Stinnerae586492014-09-02 23:18:25 +0200368from time import monotonic as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000369
Peter Astrand454f7672005-01-01 09:36:35 +0000370# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400371class SubprocessError(Exception): pass
372
373
374class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000375 """This exception is raised when a process run by check_call() or
376 check_output() returns a non-zero exit status.
377 The exit status will be stored in the returncode attribute;
378 check_output() will also store the output in the output attribute.
379 """
Gregory P. Smith6e730002015-04-14 16:14:25 -0700380 def __init__(self, returncode, cmd, output=None, stderr=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000381 self.returncode = returncode
382 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000383 self.output = output
Gregory P. Smith6e730002015-04-14 16:14:25 -0700384 self.stderr = stderr
385
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000386 def __str__(self):
387 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
388
Gregory P. Smith6e730002015-04-14 16:14:25 -0700389 @property
390 def stdout(self):
391 """Alias for output attribute, to match stderr"""
392 return self.output
393
394 @stdout.setter
395 def stdout(self, value):
396 # There's no obvious reason to set this, but allow it anyway so
397 # .stdout is a transparent alias for .output
398 self.output = value
399
Peter Astrand454f7672005-01-01 09:36:35 +0000400
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400401class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400402 """This exception is raised when the timeout expires while waiting for a
403 child process.
404 """
Gregory P. Smith6e730002015-04-14 16:14:25 -0700405 def __init__(self, cmd, timeout, output=None, stderr=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400406 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400407 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400408 self.output = output
Gregory P. Smith6e730002015-04-14 16:14:25 -0700409 self.stderr = stderr
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400410
411 def __str__(self):
412 return ("Command '%s' timed out after %s seconds" %
413 (self.cmd, self.timeout))
414
Gregory P. Smith6e730002015-04-14 16:14:25 -0700415 @property
416 def stdout(self):
417 return self.output
418
419 @stdout.setter
420 def stdout(self, value):
421 # There's no obvious reason to set this, but allow it anyway so
422 # .stdout is a transparent alias for .output
423 self.output = value
424
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400425
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700426if _mswindows:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000427 import threading
428 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200429 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000430 class STARTUPINFO:
431 dwFlags = 0
432 hStdInput = None
433 hStdOutput = None
434 hStdError = None
435 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000436else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700437 import _posixsubprocess
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100438 import select
439 import selectors
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700440 try:
441 import threading
442 except ImportError:
443 import dummy_threading as threading
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000444
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000445 # When select or poll has indicated that the file is writable,
446 # we can write up to _PIPE_BUF bytes without risk of blocking.
447 # POSIX defines PIPE_BUF as >= 512.
448 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
449
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100450 # poll/select have the advantage of not requiring any extra file
451 # descriptor, contrarily to epoll/kqueue (also, they require a single
452 # syscall).
453 if hasattr(selectors, 'PollSelector'):
454 _PopenSelector = selectors.PollSelector
455 else:
456 _PopenSelector = selectors.SelectSelector
457
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000458
Brett Cannona23810f2008-05-26 19:04:21 +0000459__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Gregory P. Smith6e730002015-04-14 16:14:25 -0700460 "getoutput", "check_output", "run", "CalledProcessError", "DEVNULL",
461 "SubprocessError", "TimeoutExpired", "CompletedProcess"]
Gregory P. Smithace55862015-04-07 15:57:54 -0700462 # NOTE: We intentionally exclude list2cmdline as it is
463 # considered an internal implementation detail. issue10838.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000464
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700465if _mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200466 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
467 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
468 STD_ERROR_HANDLE, SW_HIDE,
469 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500470
Brian Curtin08fd8d92011-04-29 16:11:30 -0500471 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500472 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
473 "STD_ERROR_HANDLE", "SW_HIDE",
Martin Panter528619b2016-04-16 23:42:37 +0000474 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW",
475 "STARTUPINFO"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200476
477 class Handle(int):
478 closed = False
479
480 def Close(self, CloseHandle=_winapi.CloseHandle):
481 if not self.closed:
482 self.closed = True
483 CloseHandle(self)
484
485 def Detach(self):
486 if not self.closed:
487 self.closed = True
488 return int(self)
489 raise ValueError("already closed")
490
491 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300492 return "%s(%d)" % (self.__class__.__name__, int(self))
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200493
494 __del__ = Close
495 __str__ = __repr__
496
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000497
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200498# This lists holds Popen instances for which the underlying process had not
499# exited at the time its __del__ method got called: those processes are wait()ed
500# for synchronously from _cleanup() when a new Popen object is created, to avoid
501# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000502_active = []
503
504def _cleanup():
505 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000506 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200507 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000508 try:
509 _active.remove(inst)
510 except ValueError:
511 # This can happen if two threads create a new Popen instance.
512 # It's harmless that it was already removed, so ignore.
513 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000514
515PIPE = -1
516STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200517DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000518
519
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200520# XXX This function is only used by multiprocessing and the test suite,
521# but it's here so that it can be imported when Python is compiled without
522# threads.
523
Victor Stinner9def2842016-01-18 12:15:08 +0100524def _optim_args_from_interpreter_flags():
525 """Return a list of command-line arguments reproducing the current
526 optimization settings in sys.flags."""
527 args = []
528 value = sys.flags.optimize
529 if value > 0:
530 args.append('-' + 'O' * value)
531 return args
532
533
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200534def _args_from_interpreter_flags():
535 """Return a list of command-line arguments reproducing the current
536 settings in sys.flags and sys.warnoptions."""
537 flag_opt_map = {
538 'debug': 'd',
539 # 'inspect': 'i',
540 # 'interactive': 'i',
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200541 'dont_write_bytecode': 'B',
542 'no_user_site': 's',
543 'no_site': 'S',
544 'ignore_environment': 'E',
545 'verbose': 'v',
546 'bytes_warning': 'b',
547 'quiet': 'q',
Victor Stinner9def2842016-01-18 12:15:08 +0100548 # -O is handled in _optim_args_from_interpreter_flags()
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200549 }
Victor Stinner9def2842016-01-18 12:15:08 +0100550 args = _optim_args_from_interpreter_flags()
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200551 for flag, opt in flag_opt_map.items():
552 v = getattr(sys.flags, flag)
553 if v > 0:
554 args.append('-' + opt * v)
555 for opt in sys.warnoptions:
556 args.append('-W' + opt)
557 return args
558
559
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400560def call(*popenargs, timeout=None, **kwargs):
561 """Run command with arguments. Wait for command to complete or
562 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000563
564 The arguments are the same as for the Popen constructor. Example:
565
566 retcode = call(["ls", "-l"])
567 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200568 with Popen(*popenargs, **kwargs) as p:
569 try:
570 return p.wait(timeout=timeout)
571 except:
572 p.kill()
573 p.wait()
574 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000575
576
Peter Astrand454f7672005-01-01 09:36:35 +0000577def check_call(*popenargs, **kwargs):
578 """Run command with arguments. Wait for command to complete. If
579 the exit code was zero then return, otherwise raise
580 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000581 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000582
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400583 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000584
585 check_call(["ls", "-l"])
586 """
587 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000588 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000589 cmd = kwargs.get("args")
590 if cmd is None:
591 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000592 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000593 return 0
594
595
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400596def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700597 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000598
599 If the exit code was non-zero it raises a CalledProcessError. The
600 CalledProcessError object will have the return code in the returncode
601 attribute and output in the output attribute.
602
603 The arguments are the same as for the Popen constructor. Example:
604
605 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000606 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000607
608 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000609 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000610
611 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000612 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000613 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000614 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700615
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300616 There is an additional optional argument, "input", allowing you to
617 pass a string to the subprocess's stdin. If you use this argument
618 you may not also use the Popen constructor's "stdin" argument, as
619 it too will be used internally. Example:
620
621 >>> check_output(["sed", "-e", "s/foo/bar/"],
622 ... input=b"when in the course of fooman events\n")
623 b'when in the course of barman events\n'
624
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400625 If universal_newlines=True is passed, the "input" argument must be a
626 string and the return value will be a string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000627 """
628 if 'stdout' in kwargs:
629 raise ValueError('stdout argument not allowed, it will be overridden.')
Gregory P. Smith6e730002015-04-14 16:14:25 -0700630
631 if 'input' in kwargs and kwargs['input'] is None:
632 # Explicitly passing input=None was previously equivalent to passing an
633 # empty string. That is maintained here for backwards compatibility.
634 kwargs['input'] = '' if kwargs.get('universal_newlines', False) else b''
635
636 return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
637 **kwargs).stdout
638
639
640class CompletedProcess(object):
641 """A process that has finished running.
642
643 This is returned by run().
644
645 Attributes:
646 args: The list or str args passed to run().
647 returncode: The exit code of the process, negative for signals.
648 stdout: The standard output (None if not captured).
649 stderr: The standard error (None if not captured).
650 """
651 def __init__(self, args, returncode, stdout=None, stderr=None):
652 self.args = args
653 self.returncode = returncode
654 self.stdout = stdout
655 self.stderr = stderr
656
657 def __repr__(self):
658 args = ['args={!r}'.format(self.args),
659 'returncode={!r}'.format(self.returncode)]
660 if self.stdout is not None:
661 args.append('stdout={!r}'.format(self.stdout))
662 if self.stderr is not None:
663 args.append('stderr={!r}'.format(self.stderr))
664 return "{}({})".format(type(self).__name__, ', '.join(args))
665
666 def check_returncode(self):
667 """Raise CalledProcessError if the exit code is non-zero."""
668 if self.returncode:
669 raise CalledProcessError(self.returncode, self.args, self.stdout,
670 self.stderr)
671
672
673def run(*popenargs, input=None, timeout=None, check=False, **kwargs):
674 """Run command with arguments and return a CompletedProcess instance.
675
676 The returned instance will have attributes args, returncode, stdout and
677 stderr. By default, stdout and stderr are not captured, and those attributes
678 will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.
679
680 If check is True and the exit code was non-zero, it raises a
681 CalledProcessError. The CalledProcessError object will have the return code
682 in the returncode attribute, and output & stderr attributes if those streams
683 were captured.
684
685 If timeout is given, and the process takes too long, a TimeoutExpired
686 exception will be raised.
687
688 There is an optional argument "input", allowing you to
689 pass a string to the subprocess's stdin. If you use this argument
690 you may not also use the Popen constructor's "stdin" argument, as
691 it will be used internally.
692
693 The other arguments are the same as for the Popen constructor.
694
695 If universal_newlines=True is passed, the "input" argument must be a
696 string and stdout/stderr in the returned object will be strings rather than
697 bytes.
698 """
699 if input is not None:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300700 if 'stdin' in kwargs:
701 raise ValueError('stdin and input arguments may not both be used.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300702 kwargs['stdin'] = PIPE
Gregory P. Smith6e730002015-04-14 16:14:25 -0700703
704 with Popen(*popenargs, **kwargs) as process:
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200705 try:
Gregory P. Smith6e730002015-04-14 16:14:25 -0700706 stdout, stderr = process.communicate(input, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200707 except TimeoutExpired:
708 process.kill()
Gregory P. Smith6e730002015-04-14 16:14:25 -0700709 stdout, stderr = process.communicate()
710 raise TimeoutExpired(process.args, timeout, output=stdout,
711 stderr=stderr)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200712 except:
713 process.kill()
714 process.wait()
715 raise
716 retcode = process.poll()
Gregory P. Smith6e730002015-04-14 16:14:25 -0700717 if check and retcode:
718 raise CalledProcessError(retcode, process.args,
719 output=stdout, stderr=stderr)
720 return CompletedProcess(process.args, retcode, stdout, stderr)
Peter Astrand454f7672005-01-01 09:36:35 +0000721
722
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000723def list2cmdline(seq):
724 """
725 Translate a sequence of arguments into a command line
726 string, using the same rules as the MS C runtime:
727
728 1) Arguments are delimited by white space, which is either a
729 space or a tab.
730
731 2) A string surrounded by double quotation marks is
732 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000733 contained within. A quoted string can be embedded in an
734 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000735
736 3) A double quotation mark preceded by a backslash is
737 interpreted as a literal double quotation mark.
738
739 4) Backslashes are interpreted literally, unless they
740 immediately precede a double quotation mark.
741
742 5) If backslashes immediately precede a double quotation mark,
743 every pair of backslashes is interpreted as a literal
744 backslash. If the number of backslashes is odd, the last
745 backslash escapes the next double quotation mark as
746 described in rule 3.
747 """
748
749 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000750 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
751 # or search http://msdn.microsoft.com for
752 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 result = []
754 needquote = False
755 for arg in seq:
756 bs_buf = []
757
758 # Add a space to separate this argument from the others
759 if result:
760 result.append(' ')
761
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000762 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000763 if needquote:
764 result.append('"')
765
766 for c in arg:
767 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000768 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000769 bs_buf.append(c)
770 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000771 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000772 result.append('\\' * len(bs_buf)*2)
773 bs_buf = []
774 result.append('\\"')
775 else:
776 # Normal char
777 if bs_buf:
778 result.extend(bs_buf)
779 bs_buf = []
780 result.append(c)
781
Christian Heimesfdab48e2008-01-20 09:06:41 +0000782 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000783 if bs_buf:
784 result.extend(bs_buf)
785
786 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000787 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000788 result.append('"')
789
790 return ''.join(result)
791
792
Brett Cannona23810f2008-05-26 19:04:21 +0000793# Various tools for executing commands and looking at their output and status.
794#
Brett Cannona23810f2008-05-26 19:04:21 +0000795
796def getstatusoutput(cmd):
Tim Golden60798142013-11-05 12:57:25 +0000797 """ Return (status, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000798
Tim Golden60798142013-11-05 12:57:25 +0000799 Execute the string 'cmd' in a shell with 'check_output' and
800 return a 2-tuple (status, output). Universal newlines mode is used,
801 meaning that the result with be decoded to a string.
802
803 A trailing newline is stripped from the output.
804 The exit status for the command can be interpreted
805 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000806
807 >>> import subprocess
808 >>> subprocess.getstatusoutput('ls /bin/ls')
809 (0, '/bin/ls')
810 >>> subprocess.getstatusoutput('cat /bin/junk')
811 (256, 'cat: /bin/junk: No such file or directory')
812 >>> subprocess.getstatusoutput('/bin/junk')
813 (256, 'sh: /bin/junk: not found')
814 """
Tim Goldene0041752013-11-03 12:53:17 +0000815 try:
816 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
817 status = 0
818 except CalledProcessError as ex:
819 data = ex.output
820 status = ex.returncode
821 if data[-1:] == '\n':
822 data = data[:-1]
823 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000824
825def getoutput(cmd):
826 """Return output (stdout or stderr) of executing cmd in a shell.
827
828 Like getstatusoutput(), except the exit status is ignored and the return
829 value is a string containing the command's output. Example:
830
831 >>> import subprocess
832 >>> subprocess.getoutput('ls /bin/ls')
833 '/bin/ls'
834 """
835 return getstatusoutput(cmd)[1]
836
837
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000838_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000839
840
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000841class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200842
843 _child_created = False # Set here since __del__ checks it
844
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700845 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000846 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000847 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
848 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000849 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000850 restore_signals=True, start_new_session=False,
851 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000852 """Create new Popen instance."""
853 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700854 # Held while anything is calling waitpid before returncode has been
855 # updated to prevent clobbering returncode if wait() or poll() are
856 # called from multiple threads at once. After acquiring the lock,
857 # code must re-check self.returncode to see if another thread just
858 # finished a waitpid() call.
859 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000860
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400861 self._input = None
862 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000863 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700864 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000865 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000866 raise TypeError("bufsize must be an integer")
867
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700868 if _mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000869 if preexec_fn is not None:
870 raise ValueError("preexec_fn is not supported on Windows "
871 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000872 any_stdio_set = (stdin is not None or stdout is not None or
873 stderr is not None)
874 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
875 if any_stdio_set:
876 close_fds = False
877 else:
878 close_fds = True
879 elif close_fds and any_stdio_set:
880 raise ValueError(
881 "close_fds is not supported on Windows platforms"
882 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000883 else:
884 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000885 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
886 close_fds = True
887 if pass_fds and not close_fds:
888 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
889 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000890 if startupinfo is not None:
891 raise ValueError("startupinfo is only supported on Windows "
892 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000893 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000894 raise ValueError("creationflags is only supported on Windows "
895 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000896
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400897 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000898 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000899 self.stdout = None
900 self.stderr = None
901 self.pid = None
902 self.returncode = None
903 self.universal_newlines = universal_newlines
904
905 # Input and output objects. The general principle is like
906 # this:
907 #
908 # Parent Child
909 # ------ -----
910 # p2cwrite ---stdin---> p2cread
911 # c2pread <--stdout--- c2pwrite
912 # errread <--stderr--- errwrite
913 #
914 # On POSIX, the child objects are file descriptors. On
915 # Windows, these are Windows file handles. The parent objects
916 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000917 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000918 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000919
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000920 (p2cread, p2cwrite,
921 c2pread, c2pwrite,
922 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
923
Antoine Pitrouc9982322011-01-04 19:07:07 +0000924 # We wrap OS handles *before* launching the child, otherwise a
925 # quickly terminating child could make our fds unwrappable
926 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000927
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700928 if _mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000929 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000930 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000931 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000932 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000933 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000934 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000935
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000936 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000937 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300938 if universal_newlines:
Antoine Pitrouafe8d062014-09-21 21:10:56 +0200939 self.stdin = io.TextIOWrapper(self.stdin, write_through=True,
940 line_buffering=(bufsize == 1))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000941 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000942 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000943 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000944 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000945 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000946 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000947 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000948 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000949
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700950 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000951 try:
952 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300953 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000954 startupinfo, creationflags, shell,
955 p2cread, p2cwrite,
956 c2pread, c2pwrite,
957 errread, errwrite,
958 restore_signals, start_new_session)
959 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800960 # Cleanup if the child failed starting.
961 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000962 try:
963 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200964 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800965 pass # Ignore EBADF or other errors.
966
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700967 if not self._closed_child_pipe_fds:
968 to_close = []
969 if stdin == PIPE:
970 to_close.append(p2cread)
971 if stdout == PIPE:
972 to_close.append(c2pwrite)
973 if stderr == PIPE:
974 to_close.append(errwrite)
975 if hasattr(self, '_devnull'):
976 to_close.append(self._devnull)
977 for fd in to_close:
978 try:
979 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700980 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700981 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800982
Antoine Pitrouc9982322011-01-04 19:07:07 +0000983 raise
984
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000985
Guido van Rossum98297ee2007-11-06 21:34:58 +0000986 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300987 data = data.decode(encoding)
988 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000989
Brian Curtin79cdb662010-12-03 02:46:02 +0000990 def __enter__(self):
991 return self
992
993 def __exit__(self, type, value, traceback):
994 if self.stdout:
995 self.stdout.close()
996 if self.stderr:
997 self.stderr.close()
Serhiy Storchakaab900c22015-02-28 12:43:08 +0200998 try: # Flushing a BufferedWriter may raise an error
999 if self.stdin:
1000 self.stdin.close()
1001 finally:
1002 # Wait for the process to terminate, to avoid zombies.
1003 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001004
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001005 def __del__(self, _maxsize=sys.maxsize):
1006 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001007 # We didn't get to successfully create a child process.
1008 return
Victor Stinner5a48e212016-05-20 12:11:15 +02001009 if self.returncode is None:
1010 warnings.warn("running subprocess %r" % self, ResourceWarning,
1011 source=self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001012 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +00001013 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001014 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001015 # Child is still running, keep us alive until we can wait on it.
1016 _active.append(self)
1017
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001018 def _get_devnull(self):
1019 if not hasattr(self, '_devnull'):
1020 self._devnull = os.open(os.devnull, os.O_RDWR)
1021 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001022
Victor Stinnera5e881d2015-01-14 17:07:59 +01001023 def _stdin_write(self, input):
1024 if input:
1025 try:
1026 self.stdin.write(input)
1027 except BrokenPipeError:
1028 # communicate() must ignore broken pipe error
1029 pass
1030 except OSError as e:
1031 if e.errno == errno.EINVAL and self.poll() is not None:
1032 # Issue #19612: On Windows, stdin.write() fails with EINVAL
1033 # if the process already exited before the write
1034 pass
1035 else:
1036 raise
1037 self.stdin.close()
1038
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001039 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +00001040 """Interact with process: Send data to stdin. Read data from
1041 stdout and stderr, until end-of-file is reached. Wait for
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001042 process to terminate.
Tim Peterseba28be2005-03-28 01:08:02 +00001043
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001044 The optional "input" argument should be data to be sent to the
1045 child process (if self.universal_newlines is True, this should
1046 be a string; if it is False, "input" should be bytes), or
1047 None, if no data should be sent to the child.
1048
1049 communicate() returns a tuple (stdout, stderr). These will be
1050 bytes or, if self.universal_newlines was True, a string.
1051 """
Peter Astrand23109f02005-03-03 20:28:59 +00001052
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001053 if self._communication_started and input:
1054 raise ValueError("Cannot send input after starting communication")
1055
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001056 # Optimization: If we are not worried about timeouts, we haven't
1057 # started communicating, and we have one or zero pipes, using select()
1058 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +02001059 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001060 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +00001061 stdout = None
1062 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +00001063 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001064 self._stdin_write(input)
Peter Astrand23109f02005-03-03 20:28:59 +00001065 elif self.stdout:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001066 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +00001067 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +00001068 elif self.stderr:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001069 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +00001070 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +00001071 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +02001072 else:
1073 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001074 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +02001075 else:
1076 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +00001077
Victor Stinner7a8d0812011-04-05 13:13:08 +02001078 try:
1079 stdout, stderr = self._communicate(input, endtime, timeout)
1080 finally:
1081 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001082
Victor Stinner7a8d0812011-04-05 13:13:08 +02001083 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001084
1085 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +00001086
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001087
Georg Brandl6aa2d1f2008-08-12 08:35:52 +00001088 def poll(self):
1089 return self._internal_poll()
1090
1091
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001092 def _remaining_time(self, endtime):
1093 """Convenience for _communicate when computing timeouts."""
1094 if endtime is None:
1095 return None
1096 else:
Victor Stinner949d8c92012-05-30 13:30:32 +02001097 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001098
1099
Reid Kleckner2b228f02011-03-16 16:57:54 -04001100 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001101 """Convenience for checking if a timeout has expired."""
1102 if endtime is None:
1103 return
Victor Stinner949d8c92012-05-30 13:30:32 +02001104 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001105 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001106
1107
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -07001108 if _mswindows:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109 #
1110 # Windows methods
1111 #
1112 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001113 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1115 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001116 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001117 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +00001118
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001119 p2cread, p2cwrite = -1, -1
1120 c2pread, c2pwrite = -1, -1
1121 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001122
Peter Astrandd38ddf42005-02-10 08:32:50 +00001123 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001124 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001125 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001126 p2cread, _ = _winapi.CreatePipe(None, 0)
1127 p2cread = Handle(p2cread)
1128 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001129 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001130 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1131 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001132 elif stdin == DEVNULL:
1133 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001134 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001135 p2cread = msvcrt.get_osfhandle(stdin)
1136 else:
1137 # Assuming file-like object
1138 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1139 p2cread = self._make_inheritable(p2cread)
1140
Peter Astrandd38ddf42005-02-10 08:32:50 +00001141 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001142 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001143 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001144 _, c2pwrite = _winapi.CreatePipe(None, 0)
1145 c2pwrite = Handle(c2pwrite)
1146 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001147 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001148 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1149 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001150 elif stdout == DEVNULL:
1151 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001152 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001153 c2pwrite = msvcrt.get_osfhandle(stdout)
1154 else:
1155 # Assuming file-like object
1156 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1157 c2pwrite = self._make_inheritable(c2pwrite)
1158
Peter Astrandd38ddf42005-02-10 08:32:50 +00001159 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001160 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001161 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001162 _, errwrite = _winapi.CreatePipe(None, 0)
1163 errwrite = Handle(errwrite)
1164 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001165 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001166 errread, errwrite = _winapi.CreatePipe(None, 0)
1167 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001168 elif stderr == STDOUT:
1169 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001170 elif stderr == DEVNULL:
1171 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001172 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001173 errwrite = msvcrt.get_osfhandle(stderr)
1174 else:
1175 # Assuming file-like object
1176 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1177 errwrite = self._make_inheritable(errwrite)
1178
1179 return (p2cread, p2cwrite,
1180 c2pread, c2pwrite,
1181 errread, errwrite)
1182
1183
1184 def _make_inheritable(self, handle):
1185 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001186 h = _winapi.DuplicateHandle(
1187 _winapi.GetCurrentProcess(), handle,
1188 _winapi.GetCurrentProcess(), 0, 1,
1189 _winapi.DUPLICATE_SAME_ACCESS)
1190 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001191
1192
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001193 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001194 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001195 startupinfo, creationflags, shell,
1196 p2cread, p2cwrite,
1197 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001198 errread, errwrite,
1199 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001200 """Execute program (MS Windows version)"""
1201
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001202 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001203
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001204 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001205 args = list2cmdline(args)
1206
Peter Astrandc1d65362004-11-07 14:30:34 +00001207 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001208 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001209 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001210 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001211 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001212 startupinfo.hStdInput = p2cread
1213 startupinfo.hStdOutput = c2pwrite
1214 startupinfo.hStdError = errwrite
1215
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001216 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001217 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1218 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001219 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001220 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001221
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001222 # Start the process
1223 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001224 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001225 # no special security
1226 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001227 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001228 creationflags,
1229 env,
1230 cwd,
1231 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001232 finally:
1233 # Child is launched. Close the parent's copy of those pipe
1234 # handles that only the child should have open. You need
1235 # to make sure that no handles to the write end of the
1236 # output pipe are maintained in this process or else the
1237 # pipe will not close when the child process exits and the
1238 # ReadFile will hang.
1239 if p2cread != -1:
1240 p2cread.Close()
1241 if c2pwrite != -1:
1242 c2pwrite.Close()
1243 if errwrite != -1:
1244 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001245 if hasattr(self, '_devnull'):
1246 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001247
1248 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001249 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001250 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001252 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001253
Brett Cannon84df1e62010-05-14 00:33:40 +00001254 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001255 _WaitForSingleObject=_winapi.WaitForSingleObject,
1256 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1257 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001258 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001259 attribute.
1260
1261 This method is called by __del__, so it can only refer to objects
1262 in its local scope.
1263
1264 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001265 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001266 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1267 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001268 return self.returncode
1269
1270
Reid Kleckner2b228f02011-03-16 16:57:54 -04001271 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001272 """Wait for child process to terminate. Returns returncode
1273 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001274 if endtime is not None:
1275 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001276 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001277 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001278 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001279 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001280 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001281 result = _winapi.WaitForSingleObject(self._handle,
1282 timeout_millis)
1283 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001284 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001285 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001286 return self.returncode
1287
1288
1289 def _readerthread(self, fh, buffer):
1290 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001291 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001292
1293
Reid Kleckner2b228f02011-03-16 16:57:54 -04001294 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001295 # Start reader threads feeding into a list hanging off of this
1296 # object, unless they've already been started.
1297 if self.stdout and not hasattr(self, "_stdout_buff"):
1298 self._stdout_buff = []
1299 self.stdout_thread = \
1300 threading.Thread(target=self._readerthread,
1301 args=(self.stdout, self._stdout_buff))
1302 self.stdout_thread.daemon = True
1303 self.stdout_thread.start()
1304 if self.stderr and not hasattr(self, "_stderr_buff"):
1305 self._stderr_buff = []
1306 self.stderr_thread = \
1307 threading.Thread(target=self._readerthread,
1308 args=(self.stderr, self._stderr_buff))
1309 self.stderr_thread.daemon = True
1310 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001311
1312 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001313 self._stdin_write(input)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001314
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001315 # Wait for the reader threads, or time out. If we time out, the
1316 # threads remain reading and the fds left open in case the user
1317 # calls communicate again.
1318 if self.stdout is not None:
1319 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001320 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001321 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001322 if self.stderr is not None:
1323 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001324 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001325 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001326
1327 # Collect the output from and close both pipes, now that we know
1328 # both have been read successfully.
1329 stdout = None
1330 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001332 stdout = self._stdout_buff
1333 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001334 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001335 stderr = self._stderr_buff
1336 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001337
1338 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001339 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001340 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001341 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001342 stderr = stderr[0]
1343
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344 return (stdout, stderr)
1345
Christian Heimesa342c012008-04-20 21:01:16 +00001346 def send_signal(self, sig):
Gregory P. Smitha0c9caa2015-11-15 18:19:10 -08001347 """Send a signal to the process."""
1348 # Don't signal a process that we know has already died.
1349 if self.returncode is not None:
1350 return
Christian Heimesa342c012008-04-20 21:01:16 +00001351 if sig == signal.SIGTERM:
1352 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001353 elif sig == signal.CTRL_C_EVENT:
1354 os.kill(self.pid, signal.CTRL_C_EVENT)
1355 elif sig == signal.CTRL_BREAK_EVENT:
1356 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001357 else:
Brian Curtin19651362010-09-07 13:24:38 +00001358 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001359
1360 def terminate(self):
Gregory P. Smitha0c9caa2015-11-15 18:19:10 -08001361 """Terminates the process."""
1362 # Don't terminate a process that we know has already died.
1363 if self.returncode is not None:
1364 return
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001365 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001366 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001367 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001368 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1369 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001370 rc = _winapi.GetExitCodeProcess(self._handle)
1371 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001372 raise
1373 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001374
1375 kill = terminate
1376
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001377 else:
1378 #
1379 # POSIX methods
1380 #
1381 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001382 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001383 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1384 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001385 p2cread, p2cwrite = -1, -1
1386 c2pread, c2pwrite = -1, -1
1387 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001388
Peter Astrandd38ddf42005-02-10 08:32:50 +00001389 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001390 pass
1391 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001392 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001393 elif stdin == DEVNULL:
1394 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001395 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001396 p2cread = stdin
1397 else:
1398 # Assuming file-like object
1399 p2cread = stdin.fileno()
1400
Peter Astrandd38ddf42005-02-10 08:32:50 +00001401 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001402 pass
1403 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001404 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001405 elif stdout == DEVNULL:
1406 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001407 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001408 c2pwrite = stdout
1409 else:
1410 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001411 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001412
Peter Astrandd38ddf42005-02-10 08:32:50 +00001413 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001414 pass
1415 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001416 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001417 elif stderr == STDOUT:
Martin Panterc7635892016-05-13 01:54:44 +00001418 if c2pwrite != -1:
1419 errwrite = c2pwrite
1420 else: # child's stdout is not set, use parent's stdout
1421 errwrite = sys.__stdout__.fileno()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001422 elif stderr == DEVNULL:
1423 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001424 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001425 errwrite = stderr
1426 else:
1427 # Assuming file-like object
1428 errwrite = stderr.fileno()
1429
1430 return (p2cread, p2cwrite,
1431 c2pread, c2pwrite,
1432 errread, errwrite)
1433
1434
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001435 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001436 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001437 startupinfo, creationflags, shell,
1438 p2cread, p2cwrite,
1439 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001440 errread, errwrite,
1441 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001442 """Execute program (POSIX version)"""
1443
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001444 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001445 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001446 else:
1447 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001448
1449 if shell:
1450 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001451 if executable:
1452 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001453
Peter Astrandd38ddf42005-02-10 08:32:50 +00001454 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001455 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001456 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001458 # For transferring possible exec failure from child to parent.
1459 # Data format: "exception name:hex errno:description"
1460 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001461 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001462 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1463 low_fds_to_close = []
1464 while errpipe_write < 3:
1465 low_fds_to_close.append(errpipe_write)
1466 errpipe_write = os.dup(errpipe_write)
1467 for low_fd in low_fds_to_close:
1468 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001469 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001470 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001471 # We must avoid complex work that could involve
1472 # malloc or free in the child process to avoid
1473 # potential deadlocks, thus we do all this here.
1474 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001475
Victor Stinner372b8382011-06-21 17:24:21 +02001476 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001477 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1478 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001479 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001480 env_list = None # Use execv instead of execve.
1481 executable = os.fsencode(executable)
1482 if os.path.dirname(executable):
1483 executable_list = (executable,)
1484 else:
1485 # This matches the behavior of os._execvpe().
1486 executable_list = tuple(
1487 os.path.join(os.fsencode(dir), executable)
1488 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001489 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001490 fds_to_keep.add(errpipe_write)
1491 self.pid = _posixsubprocess.fork_exec(
1492 args, executable_list,
1493 close_fds, sorted(fds_to_keep), cwd, env_list,
1494 p2cread, p2cwrite, c2pread, c2pwrite,
1495 errread, errwrite,
1496 errpipe_read, errpipe_write,
1497 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001498 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001499 finally:
1500 # be sure the FD is closed no matter what
1501 os.close(errpipe_write)
1502
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001503 # self._devnull is not always defined.
1504 devnull_fd = getattr(self, '_devnull', None)
1505 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001506 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001507 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001508 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001509 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001510 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001511 if devnull_fd is not None:
1512 os.close(devnull_fd)
1513 # Prevent a double close of these fds from __init__ on error.
1514 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001515
1516 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001517 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001518 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001519 while True:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001520 part = os.read(errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001521 errpipe_data += part
1522 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001523 break
Facundo Batista10706e22009-06-19 20:34:30 +00001524 finally:
1525 # be sure the FD is closed no matter what
1526 os.close(errpipe_read)
1527
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001528 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001529 try:
Victor Stinnera58e2c52016-05-20 12:08:12 +02001530 pid, sts = os.waitpid(self.pid, 0)
1531 if pid == self.pid:
1532 self._handle_exitstatus(sts)
1533 else:
1534 self.returncode = sys.maxsize
Victor Stinnera5e881d2015-01-14 17:07:59 +01001535 except ChildProcessError:
1536 pass
Victor Stinnera58e2c52016-05-20 12:08:12 +02001537
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001538 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001539 exception_name, hex_errno, err_msg = (
1540 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001541 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001542 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001543 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001544 err_msg = (b'Bad exception data from child: ' +
1545 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001546 child_exception_type = getattr(
1547 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001548 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001549 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001550 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001551 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001552 child_exec_never_called = (err_msg == "noexec")
1553 if child_exec_never_called:
1554 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001555 if errno_num != 0:
1556 err_msg = os.strerror(errno_num)
1557 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001558 if child_exec_never_called:
1559 # The error must be from chdir(cwd).
1560 err_msg += ': ' + repr(cwd)
1561 else:
1562 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001563 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001564 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001565
1566
Brett Cannon84df1e62010-05-14 00:33:40 +00001567 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1568 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1569 _WEXITSTATUS=os.WEXITSTATUS):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001570 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001571 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001572 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001573 if _WIFSIGNALED(sts):
1574 self.returncode = -_WTERMSIG(sts)
1575 elif _WIFEXITED(sts):
1576 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001577 else:
1578 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001579 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001580
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001581
Brett Cannon84df1e62010-05-14 00:33:40 +00001582 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001583 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001584 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001585 attribute.
1586
1587 This method is called by __del__, so it cannot reference anything
1588 outside of the local scope (nor can any methods it calls).
1589
1590 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001591 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001592 if not self._waitpid_lock.acquire(False):
1593 # Something else is busy calling waitpid. Don't allow two
1594 # at once. We know nothing yet.
1595 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001596 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001597 if self.returncode is not None:
1598 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001599 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001600 if pid == self.pid:
1601 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001602 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001603 if _deadstate is not None:
1604 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001605 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001606 # This happens if SIGCLD is set to be ignored or
1607 # waiting for child processes has otherwise been
1608 # disabled for our process. This child is dead, we
1609 # can't get the status.
1610 # http://bugs.python.org/issue15756
1611 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001612 finally:
1613 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001614 return self.returncode
1615
1616
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001617 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001618 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001619 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001620 (pid, sts) = os.waitpid(self.pid, wait_flags)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001621 except ChildProcessError:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001622 # This happens if SIGCLD is set to be ignored or waiting
1623 # for child processes has otherwise been disabled for our
1624 # process. This child is dead, we can't get the status.
1625 pid = self.pid
1626 sts = 0
1627 return (pid, sts)
1628
1629
1630 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001631 """Wait for child process to terminate. Returns returncode
1632 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001633 if self.returncode is not None:
1634 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001635
1636 # endtime is preferred to timeout. timeout is only used for
1637 # printing.
1638 if endtime is not None or timeout is not None:
1639 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001640 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001641 elif timeout is None:
1642 timeout = self._remaining_time(endtime)
1643
1644 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001645 # Enter a busy loop if we have a timeout. This busy loop was
1646 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1647 delay = 0.0005 # 500 us -> initial delay of 1 ms
1648 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001649 if self._waitpid_lock.acquire(False):
1650 try:
1651 if self.returncode is not None:
1652 break # Another thread waited.
1653 (pid, sts) = self._try_wait(os.WNOHANG)
1654 assert pid == self.pid or pid == 0
1655 if pid == self.pid:
1656 self._handle_exitstatus(sts)
1657 break
1658 finally:
1659 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001660 remaining = self._remaining_time(endtime)
1661 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001662 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001663 delay = min(delay * 2, remaining, .05)
1664 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001665 else:
1666 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001667 with self._waitpid_lock:
1668 if self.returncode is not None:
1669 break # Another thread waited.
1670 (pid, sts) = self._try_wait(0)
1671 # Check the pid and loop as waitpid has been known to
1672 # return 0 even without WNOHANG in odd situations.
1673 # http://bugs.python.org/issue14396.
1674 if pid == self.pid:
1675 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001676 return self.returncode
1677
1678
Reid Kleckner2b228f02011-03-16 16:57:54 -04001679 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001680 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001681 # Flush stdio buffer. This might block, if the user has
1682 # been writing to .stdin in an uncontrolled fashion.
1683 self.stdin.flush()
1684 if not input:
1685 self.stdin.close()
1686
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001687 stdout = None
1688 stderr = None
1689
1690 # Only create this mapping if we haven't already.
1691 if not self._communication_started:
1692 self._fileobj2output = {}
1693 if self.stdout:
1694 self._fileobj2output[self.stdout] = []
1695 if self.stderr:
1696 self._fileobj2output[self.stderr] = []
1697
1698 if self.stdout:
1699 stdout = self._fileobj2output[self.stdout]
1700 if self.stderr:
1701 stderr = self._fileobj2output[self.stderr]
1702
1703 self._save_input(input)
1704
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001705 if self._input:
1706 input_view = memoryview(self._input)
1707
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001708 with _PopenSelector() as selector:
1709 if self.stdin and input:
1710 selector.register(self.stdin, selectors.EVENT_WRITE)
1711 if self.stdout:
1712 selector.register(self.stdout, selectors.EVENT_READ)
1713 if self.stderr:
1714 selector.register(self.stderr, selectors.EVENT_READ)
1715
1716 while selector.get_map():
1717 timeout = self._remaining_time(endtime)
1718 if timeout is not None and timeout < 0:
1719 raise TimeoutExpired(self.args, orig_timeout)
1720
1721 ready = selector.select(timeout)
1722 self._check_timeout(endtime, orig_timeout)
1723
1724 # XXX Rewrite these to use non-blocking I/O on the file
1725 # objects; they are no longer using C stdio!
1726
1727 for key, events in ready:
1728 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001729 chunk = input_view[self._input_offset :
1730 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001731 try:
1732 self._input_offset += os.write(key.fd, chunk)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001733 except BrokenPipeError:
1734 selector.unregister(key.fileobj)
1735 key.fileobj.close()
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001736 else:
1737 if self._input_offset >= len(self._input):
1738 selector.unregister(key.fileobj)
1739 key.fileobj.close()
1740 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08001741 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001742 if not data:
1743 selector.unregister(key.fileobj)
1744 key.fileobj.close()
1745 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001746
1747 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001748
1749 # All data exchanged. Translate lists into strings.
1750 if stdout is not None:
1751 stdout = b''.join(stdout)
1752 if stderr is not None:
1753 stderr = b''.join(stderr)
1754
1755 # Translate newlines, if requested.
1756 # This also turns bytes into strings.
1757 if self.universal_newlines:
1758 if stdout is not None:
1759 stdout = self._translate_newlines(stdout,
1760 self.stdout.encoding)
1761 if stderr is not None:
1762 stderr = self._translate_newlines(stderr,
1763 self.stderr.encoding)
1764
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001765 return (stdout, stderr)
1766
1767
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001768 def _save_input(self, input):
1769 # This method is called from the _communicate_with_*() methods
1770 # so that if we time out while communicating, we can continue
1771 # sending input if we retry.
1772 if self.stdin and self._input is None:
1773 self._input_offset = 0
1774 self._input = input
1775 if self.universal_newlines and input is not None:
1776 self._input = self._input.encode(self.stdin.encoding)
1777
1778
Christian Heimesa342c012008-04-20 21:01:16 +00001779 def send_signal(self, sig):
Gregory P. Smitha0c9caa2015-11-15 18:19:10 -08001780 """Send a signal to the process."""
1781 # Skip signalling a process that we know has already died.
1782 if self.returncode is None:
1783 os.kill(self.pid, sig)
Christian Heimesa342c012008-04-20 21:01:16 +00001784
1785 def terminate(self):
1786 """Terminate the process with SIGTERM
1787 """
1788 self.send_signal(signal.SIGTERM)
1789
1790 def kill(self):
1791 """Kill the process with SIGKILL
1792 """
1793 self.send_signal(signal.SIGKILL)