blob: b6c437438e4c649342d8f3bfb03c6183f0b7bc07 [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",
474 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200475
476 class Handle(int):
477 closed = False
478
479 def Close(self, CloseHandle=_winapi.CloseHandle):
480 if not self.closed:
481 self.closed = True
482 CloseHandle(self)
483
484 def Detach(self):
485 if not self.closed:
486 self.closed = True
487 return int(self)
488 raise ValueError("already closed")
489
490 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300491 return "%s(%d)" % (self.__class__.__name__, int(self))
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200492
493 __del__ = Close
494 __str__ = __repr__
495
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000496
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200497# This lists holds Popen instances for which the underlying process had not
498# exited at the time its __del__ method got called: those processes are wait()ed
499# for synchronously from _cleanup() when a new Popen object is created, to avoid
500# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000501_active = []
502
503def _cleanup():
504 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000505 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200506 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000507 try:
508 _active.remove(inst)
509 except ValueError:
510 # This can happen if two threads create a new Popen instance.
511 # It's harmless that it was already removed, so ignore.
512 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000513
514PIPE = -1
515STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200516DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000517
518
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200519# XXX This function is only used by multiprocessing and the test suite,
520# but it's here so that it can be imported when Python is compiled without
521# threads.
522
523def _args_from_interpreter_flags():
524 """Return a list of command-line arguments reproducing the current
525 settings in sys.flags and sys.warnoptions."""
526 flag_opt_map = {
527 'debug': 'd',
528 # 'inspect': 'i',
529 # 'interactive': 'i',
530 'optimize': 'O',
531 'dont_write_bytecode': 'B',
532 'no_user_site': 's',
533 'no_site': 'S',
534 'ignore_environment': 'E',
535 'verbose': 'v',
536 'bytes_warning': 'b',
537 'quiet': 'q',
538 'hash_randomization': 'R',
539 }
540 args = []
541 for flag, opt in flag_opt_map.items():
542 v = getattr(sys.flags, flag)
543 if v > 0:
Nick Coghlanac1a2482013-10-18 22:39:50 +1000544 if flag == 'hash_randomization':
545 v = 1 # Handle specification of an exact seed
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200546 args.append('-' + opt * v)
547 for opt in sys.warnoptions:
548 args.append('-W' + opt)
549 return args
550
551
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400552def call(*popenargs, timeout=None, **kwargs):
553 """Run command with arguments. Wait for command to complete or
554 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000555
556 The arguments are the same as for the Popen constructor. Example:
557
558 retcode = call(["ls", "-l"])
559 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200560 with Popen(*popenargs, **kwargs) as p:
561 try:
562 return p.wait(timeout=timeout)
563 except:
564 p.kill()
565 p.wait()
566 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000567
568
Peter Astrand454f7672005-01-01 09:36:35 +0000569def check_call(*popenargs, **kwargs):
570 """Run command with arguments. Wait for command to complete. If
571 the exit code was zero then return, otherwise raise
572 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000573 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000574
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400575 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000576
577 check_call(["ls", "-l"])
578 """
579 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000580 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000581 cmd = kwargs.get("args")
582 if cmd is None:
583 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000584 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000585 return 0
586
587
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400588def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700589 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000590
591 If the exit code was non-zero it raises a CalledProcessError. The
592 CalledProcessError object will have the return code in the returncode
593 attribute and output in the output attribute.
594
595 The arguments are the same as for the Popen constructor. Example:
596
597 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000598 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000599
600 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000601 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000602
603 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000604 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000605 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000606 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700607
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300608 There is an additional optional argument, "input", allowing you to
609 pass a string to the subprocess's stdin. If you use this argument
610 you may not also use the Popen constructor's "stdin" argument, as
611 it too will be used internally. Example:
612
613 >>> check_output(["sed", "-e", "s/foo/bar/"],
614 ... input=b"when in the course of fooman events\n")
615 b'when in the course of barman events\n'
616
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400617 If universal_newlines=True is passed, the "input" argument must be a
618 string and the return value will be a string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000619 """
620 if 'stdout' in kwargs:
621 raise ValueError('stdout argument not allowed, it will be overridden.')
Gregory P. Smith6e730002015-04-14 16:14:25 -0700622
623 if 'input' in kwargs and kwargs['input'] is None:
624 # Explicitly passing input=None was previously equivalent to passing an
625 # empty string. That is maintained here for backwards compatibility.
626 kwargs['input'] = '' if kwargs.get('universal_newlines', False) else b''
627
628 return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
629 **kwargs).stdout
630
631
632class CompletedProcess(object):
633 """A process that has finished running.
634
635 This is returned by run().
636
637 Attributes:
638 args: The list or str args passed to run().
639 returncode: The exit code of the process, negative for signals.
640 stdout: The standard output (None if not captured).
641 stderr: The standard error (None if not captured).
642 """
643 def __init__(self, args, returncode, stdout=None, stderr=None):
644 self.args = args
645 self.returncode = returncode
646 self.stdout = stdout
647 self.stderr = stderr
648
649 def __repr__(self):
650 args = ['args={!r}'.format(self.args),
651 'returncode={!r}'.format(self.returncode)]
652 if self.stdout is not None:
653 args.append('stdout={!r}'.format(self.stdout))
654 if self.stderr is not None:
655 args.append('stderr={!r}'.format(self.stderr))
656 return "{}({})".format(type(self).__name__, ', '.join(args))
657
658 def check_returncode(self):
659 """Raise CalledProcessError if the exit code is non-zero."""
660 if self.returncode:
661 raise CalledProcessError(self.returncode, self.args, self.stdout,
662 self.stderr)
663
664
665def run(*popenargs, input=None, timeout=None, check=False, **kwargs):
666 """Run command with arguments and return a CompletedProcess instance.
667
668 The returned instance will have attributes args, returncode, stdout and
669 stderr. By default, stdout and stderr are not captured, and those attributes
670 will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.
671
672 If check is True and the exit code was non-zero, it raises a
673 CalledProcessError. The CalledProcessError object will have the return code
674 in the returncode attribute, and output & stderr attributes if those streams
675 were captured.
676
677 If timeout is given, and the process takes too long, a TimeoutExpired
678 exception will be raised.
679
680 There is an optional argument "input", allowing you to
681 pass a string to the subprocess's stdin. If you use this argument
682 you may not also use the Popen constructor's "stdin" argument, as
683 it will be used internally.
684
685 The other arguments are the same as for the Popen constructor.
686
687 If universal_newlines=True is passed, the "input" argument must be a
688 string and stdout/stderr in the returned object will be strings rather than
689 bytes.
690 """
691 if input is not None:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300692 if 'stdin' in kwargs:
693 raise ValueError('stdin and input arguments may not both be used.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300694 kwargs['stdin'] = PIPE
Gregory P. Smith6e730002015-04-14 16:14:25 -0700695
696 with Popen(*popenargs, **kwargs) as process:
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200697 try:
Gregory P. Smith6e730002015-04-14 16:14:25 -0700698 stdout, stderr = process.communicate(input, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200699 except TimeoutExpired:
700 process.kill()
Gregory P. Smith6e730002015-04-14 16:14:25 -0700701 stdout, stderr = process.communicate()
702 raise TimeoutExpired(process.args, timeout, output=stdout,
703 stderr=stderr)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200704 except:
705 process.kill()
706 process.wait()
707 raise
708 retcode = process.poll()
Gregory P. Smith6e730002015-04-14 16:14:25 -0700709 if check and retcode:
710 raise CalledProcessError(retcode, process.args,
711 output=stdout, stderr=stderr)
712 return CompletedProcess(process.args, retcode, stdout, stderr)
Peter Astrand454f7672005-01-01 09:36:35 +0000713
714
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000715def list2cmdline(seq):
716 """
717 Translate a sequence of arguments into a command line
718 string, using the same rules as the MS C runtime:
719
720 1) Arguments are delimited by white space, which is either a
721 space or a tab.
722
723 2) A string surrounded by double quotation marks is
724 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000725 contained within. A quoted string can be embedded in an
726 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000727
728 3) A double quotation mark preceded by a backslash is
729 interpreted as a literal double quotation mark.
730
731 4) Backslashes are interpreted literally, unless they
732 immediately precede a double quotation mark.
733
734 5) If backslashes immediately precede a double quotation mark,
735 every pair of backslashes is interpreted as a literal
736 backslash. If the number of backslashes is odd, the last
737 backslash escapes the next double quotation mark as
738 described in rule 3.
739 """
740
741 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000742 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
743 # or search http://msdn.microsoft.com for
744 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000745 result = []
746 needquote = False
747 for arg in seq:
748 bs_buf = []
749
750 # Add a space to separate this argument from the others
751 if result:
752 result.append(' ')
753
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000754 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000755 if needquote:
756 result.append('"')
757
758 for c in arg:
759 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000760 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000761 bs_buf.append(c)
762 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000763 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000764 result.append('\\' * len(bs_buf)*2)
765 bs_buf = []
766 result.append('\\"')
767 else:
768 # Normal char
769 if bs_buf:
770 result.extend(bs_buf)
771 bs_buf = []
772 result.append(c)
773
Christian Heimesfdab48e2008-01-20 09:06:41 +0000774 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000775 if bs_buf:
776 result.extend(bs_buf)
777
778 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000779 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 result.append('"')
781
782 return ''.join(result)
783
784
Brett Cannona23810f2008-05-26 19:04:21 +0000785# Various tools for executing commands and looking at their output and status.
786#
Brett Cannona23810f2008-05-26 19:04:21 +0000787
788def getstatusoutput(cmd):
Tim Golden60798142013-11-05 12:57:25 +0000789 """ Return (status, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000790
Tim Golden60798142013-11-05 12:57:25 +0000791 Execute the string 'cmd' in a shell with 'check_output' and
792 return a 2-tuple (status, output). Universal newlines mode is used,
793 meaning that the result with be decoded to a string.
794
795 A trailing newline is stripped from the output.
796 The exit status for the command can be interpreted
797 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000798
799 >>> import subprocess
800 >>> subprocess.getstatusoutput('ls /bin/ls')
801 (0, '/bin/ls')
802 >>> subprocess.getstatusoutput('cat /bin/junk')
803 (256, 'cat: /bin/junk: No such file or directory')
804 >>> subprocess.getstatusoutput('/bin/junk')
805 (256, 'sh: /bin/junk: not found')
806 """
Tim Goldene0041752013-11-03 12:53:17 +0000807 try:
808 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
809 status = 0
810 except CalledProcessError as ex:
811 data = ex.output
812 status = ex.returncode
813 if data[-1:] == '\n':
814 data = data[:-1]
815 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000816
817def getoutput(cmd):
818 """Return output (stdout or stderr) of executing cmd in a shell.
819
820 Like getstatusoutput(), except the exit status is ignored and the return
821 value is a string containing the command's output. Example:
822
823 >>> import subprocess
824 >>> subprocess.getoutput('ls /bin/ls')
825 '/bin/ls'
826 """
827 return getstatusoutput(cmd)[1]
828
829
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000830_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000831
832
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000833class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200834
835 _child_created = False # Set here since __del__ checks it
836
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700837 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000838 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000839 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
840 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000841 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000842 restore_signals=True, start_new_session=False,
843 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000844 """Create new Popen instance."""
845 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700846 # Held while anything is calling waitpid before returncode has been
847 # updated to prevent clobbering returncode if wait() or poll() are
848 # called from multiple threads at once. After acquiring the lock,
849 # code must re-check self.returncode to see if another thread just
850 # finished a waitpid() call.
851 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000852
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400853 self._input = None
854 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000855 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700856 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000857 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000858 raise TypeError("bufsize must be an integer")
859
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700860 if _mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000861 if preexec_fn is not None:
862 raise ValueError("preexec_fn is not supported on Windows "
863 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000864 any_stdio_set = (stdin is not None or stdout is not None or
865 stderr is not None)
866 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
867 if any_stdio_set:
868 close_fds = False
869 else:
870 close_fds = True
871 elif close_fds and any_stdio_set:
872 raise ValueError(
873 "close_fds is not supported on Windows platforms"
874 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000875 else:
876 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000877 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
878 close_fds = True
879 if pass_fds and not close_fds:
880 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
881 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000882 if startupinfo is not None:
883 raise ValueError("startupinfo is only supported on Windows "
884 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000885 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000886 raise ValueError("creationflags is only supported on Windows "
887 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000888
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400889 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000890 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000891 self.stdout = None
892 self.stderr = None
893 self.pid = None
894 self.returncode = None
895 self.universal_newlines = universal_newlines
896
897 # Input and output objects. The general principle is like
898 # this:
899 #
900 # Parent Child
901 # ------ -----
902 # p2cwrite ---stdin---> p2cread
903 # c2pread <--stdout--- c2pwrite
904 # errread <--stderr--- errwrite
905 #
906 # On POSIX, the child objects are file descriptors. On
907 # Windows, these are Windows file handles. The parent objects
908 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000909 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000910 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000911
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000912 (p2cread, p2cwrite,
913 c2pread, c2pwrite,
914 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
915
Antoine Pitrouc9982322011-01-04 19:07:07 +0000916 # We wrap OS handles *before* launching the child, otherwise a
917 # quickly terminating child could make our fds unwrappable
918 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000919
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700920 if _mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000921 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000922 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000923 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000924 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000925 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000926 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000927
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000928 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000929 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300930 if universal_newlines:
Antoine Pitrouafe8d062014-09-21 21:10:56 +0200931 self.stdin = io.TextIOWrapper(self.stdin, write_through=True,
932 line_buffering=(bufsize == 1))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000933 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000934 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000935 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000936 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000937 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000938 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000939 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000940 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000941
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700942 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000943 try:
944 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300945 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000946 startupinfo, creationflags, shell,
947 p2cread, p2cwrite,
948 c2pread, c2pwrite,
949 errread, errwrite,
950 restore_signals, start_new_session)
951 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800952 # Cleanup if the child failed starting.
953 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000954 try:
955 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200956 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800957 pass # Ignore EBADF or other errors.
958
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700959 if not self._closed_child_pipe_fds:
960 to_close = []
961 if stdin == PIPE:
962 to_close.append(p2cread)
963 if stdout == PIPE:
964 to_close.append(c2pwrite)
965 if stderr == PIPE:
966 to_close.append(errwrite)
967 if hasattr(self, '_devnull'):
968 to_close.append(self._devnull)
969 for fd in to_close:
970 try:
971 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700972 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700973 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800974
Antoine Pitrouc9982322011-01-04 19:07:07 +0000975 raise
976
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000977
Guido van Rossum98297ee2007-11-06 21:34:58 +0000978 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300979 data = data.decode(encoding)
980 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000981
Brian Curtin79cdb662010-12-03 02:46:02 +0000982 def __enter__(self):
983 return self
984
985 def __exit__(self, type, value, traceback):
986 if self.stdout:
987 self.stdout.close()
988 if self.stderr:
989 self.stderr.close()
Serhiy Storchakaab900c22015-02-28 12:43:08 +0200990 try: # Flushing a BufferedWriter may raise an error
991 if self.stdin:
992 self.stdin.close()
993 finally:
994 # Wait for the process to terminate, to avoid zombies.
995 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000996
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200997 def __del__(self, _maxsize=sys.maxsize):
998 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000999 # We didn't get to successfully create a child process.
1000 return
1001 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +00001002 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001003 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001004 # Child is still running, keep us alive until we can wait on it.
1005 _active.append(self)
1006
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001007 def _get_devnull(self):
1008 if not hasattr(self, '_devnull'):
1009 self._devnull = os.open(os.devnull, os.O_RDWR)
1010 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001011
Victor Stinnera5e881d2015-01-14 17:07:59 +01001012 def _stdin_write(self, input):
1013 if input:
1014 try:
1015 self.stdin.write(input)
1016 except BrokenPipeError:
1017 # communicate() must ignore broken pipe error
1018 pass
1019 except OSError as e:
1020 if e.errno == errno.EINVAL and self.poll() is not None:
1021 # Issue #19612: On Windows, stdin.write() fails with EINVAL
1022 # if the process already exited before the write
1023 pass
1024 else:
1025 raise
1026 self.stdin.close()
1027
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001028 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +00001029 """Interact with process: Send data to stdin. Read data from
1030 stdout and stderr, until end-of-file is reached. Wait for
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001031 process to terminate.
Tim Peterseba28be2005-03-28 01:08:02 +00001032
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -04001033 The optional "input" argument should be data to be sent to the
1034 child process (if self.universal_newlines is True, this should
1035 be a string; if it is False, "input" should be bytes), or
1036 None, if no data should be sent to the child.
1037
1038 communicate() returns a tuple (stdout, stderr). These will be
1039 bytes or, if self.universal_newlines was True, a string.
1040 """
Peter Astrand23109f02005-03-03 20:28:59 +00001041
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001042 if self._communication_started and input:
1043 raise ValueError("Cannot send input after starting communication")
1044
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001045 # Optimization: If we are not worried about timeouts, we haven't
1046 # started communicating, and we have one or zero pipes, using select()
1047 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +02001048 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001049 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +00001050 stdout = None
1051 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +00001052 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001053 self._stdin_write(input)
Peter Astrand23109f02005-03-03 20:28:59 +00001054 elif self.stdout:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001055 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +00001056 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +00001057 elif self.stderr:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001058 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +00001059 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +00001060 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +02001061 else:
1062 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001063 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +02001064 else:
1065 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +00001066
Victor Stinner7a8d0812011-04-05 13:13:08 +02001067 try:
1068 stdout, stderr = self._communicate(input, endtime, timeout)
1069 finally:
1070 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001071
Victor Stinner7a8d0812011-04-05 13:13:08 +02001072 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001073
1074 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +00001075
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001076
Georg Brandl6aa2d1f2008-08-12 08:35:52 +00001077 def poll(self):
1078 return self._internal_poll()
1079
1080
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001081 def _remaining_time(self, endtime):
1082 """Convenience for _communicate when computing timeouts."""
1083 if endtime is None:
1084 return None
1085 else:
Victor Stinner949d8c92012-05-30 13:30:32 +02001086 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001087
1088
Reid Kleckner2b228f02011-03-16 16:57:54 -04001089 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001090 """Convenience for checking if a timeout has expired."""
1091 if endtime is None:
1092 return
Victor Stinner949d8c92012-05-30 13:30:32 +02001093 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001094 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001095
1096
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -07001097 if _mswindows:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001098 #
1099 # Windows methods
1100 #
1101 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001102 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001103 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1104 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001105 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001106 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +00001107
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001108 p2cread, p2cwrite = -1, -1
1109 c2pread, c2pwrite = -1, -1
1110 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001111
Peter Astrandd38ddf42005-02-10 08:32:50 +00001112 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001113 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001114 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001115 p2cread, _ = _winapi.CreatePipe(None, 0)
1116 p2cread = Handle(p2cread)
1117 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001118 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001119 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1120 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001121 elif stdin == DEVNULL:
1122 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001123 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001124 p2cread = msvcrt.get_osfhandle(stdin)
1125 else:
1126 # Assuming file-like object
1127 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1128 p2cread = self._make_inheritable(p2cread)
1129
Peter Astrandd38ddf42005-02-10 08:32:50 +00001130 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001131 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001132 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001133 _, c2pwrite = _winapi.CreatePipe(None, 0)
1134 c2pwrite = Handle(c2pwrite)
1135 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001136 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001137 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1138 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001139 elif stdout == DEVNULL:
1140 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001141 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001142 c2pwrite = msvcrt.get_osfhandle(stdout)
1143 else:
1144 # Assuming file-like object
1145 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1146 c2pwrite = self._make_inheritable(c2pwrite)
1147
Peter Astrandd38ddf42005-02-10 08:32:50 +00001148 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001149 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001150 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001151 _, errwrite = _winapi.CreatePipe(None, 0)
1152 errwrite = Handle(errwrite)
1153 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001154 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001155 errread, errwrite = _winapi.CreatePipe(None, 0)
1156 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001157 elif stderr == STDOUT:
1158 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001159 elif stderr == DEVNULL:
1160 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001161 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001162 errwrite = msvcrt.get_osfhandle(stderr)
1163 else:
1164 # Assuming file-like object
1165 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1166 errwrite = self._make_inheritable(errwrite)
1167
1168 return (p2cread, p2cwrite,
1169 c2pread, c2pwrite,
1170 errread, errwrite)
1171
1172
1173 def _make_inheritable(self, handle):
1174 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001175 h = _winapi.DuplicateHandle(
1176 _winapi.GetCurrentProcess(), handle,
1177 _winapi.GetCurrentProcess(), 0, 1,
1178 _winapi.DUPLICATE_SAME_ACCESS)
1179 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180
1181
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001182 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001183 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001184 startupinfo, creationflags, shell,
1185 p2cread, p2cwrite,
1186 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001187 errread, errwrite,
1188 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001189 """Execute program (MS Windows version)"""
1190
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001191 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001192
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001193 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001194 args = list2cmdline(args)
1195
Peter Astrandc1d65362004-11-07 14:30:34 +00001196 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001197 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001198 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001199 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001200 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001201 startupinfo.hStdInput = p2cread
1202 startupinfo.hStdOutput = c2pwrite
1203 startupinfo.hStdError = errwrite
1204
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001205 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001206 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1207 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001209 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001210
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211 # Start the process
1212 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001213 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001214 # no special security
1215 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001216 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001217 creationflags,
1218 env,
1219 cwd,
1220 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001221 finally:
1222 # Child is launched. Close the parent's copy of those pipe
1223 # handles that only the child should have open. You need
1224 # to make sure that no handles to the write end of the
1225 # output pipe are maintained in this process or else the
1226 # pipe will not close when the child process exits and the
1227 # ReadFile will hang.
1228 if p2cread != -1:
1229 p2cread.Close()
1230 if c2pwrite != -1:
1231 c2pwrite.Close()
1232 if errwrite != -1:
1233 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001234 if hasattr(self, '_devnull'):
1235 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001236
1237 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001238 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001239 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001240 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001241 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001242
Brett Cannon84df1e62010-05-14 00:33:40 +00001243 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001244 _WaitForSingleObject=_winapi.WaitForSingleObject,
1245 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1246 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001247 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001248 attribute.
1249
1250 This method is called by __del__, so it can only refer to objects
1251 in its local scope.
1252
1253 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001254 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001255 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1256 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001257 return self.returncode
1258
1259
Reid Kleckner2b228f02011-03-16 16:57:54 -04001260 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001261 """Wait for child process to terminate. Returns returncode
1262 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001263 if endtime is not None:
1264 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001265 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001266 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001267 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001268 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001269 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001270 result = _winapi.WaitForSingleObject(self._handle,
1271 timeout_millis)
1272 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001273 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001274 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001275 return self.returncode
1276
1277
1278 def _readerthread(self, fh, buffer):
1279 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001280 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001281
1282
Reid Kleckner2b228f02011-03-16 16:57:54 -04001283 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001284 # Start reader threads feeding into a list hanging off of this
1285 # object, unless they've already been started.
1286 if self.stdout and not hasattr(self, "_stdout_buff"):
1287 self._stdout_buff = []
1288 self.stdout_thread = \
1289 threading.Thread(target=self._readerthread,
1290 args=(self.stdout, self._stdout_buff))
1291 self.stdout_thread.daemon = True
1292 self.stdout_thread.start()
1293 if self.stderr and not hasattr(self, "_stderr_buff"):
1294 self._stderr_buff = []
1295 self.stderr_thread = \
1296 threading.Thread(target=self._readerthread,
1297 args=(self.stderr, self._stderr_buff))
1298 self.stderr_thread.daemon = True
1299 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001300
1301 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001302 self._stdin_write(input)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001304 # Wait for the reader threads, or time out. If we time out, the
1305 # threads remain reading and the fds left open in case the user
1306 # calls communicate again.
1307 if self.stdout is not None:
1308 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001309 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001310 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001311 if self.stderr is not None:
1312 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001313 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001314 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001315
1316 # Collect the output from and close both pipes, now that we know
1317 # both have been read successfully.
1318 stdout = None
1319 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001320 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001321 stdout = self._stdout_buff
1322 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001323 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001324 stderr = self._stderr_buff
1325 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001326
1327 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001328 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001329 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001330 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331 stderr = stderr[0]
1332
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333 return (stdout, stderr)
1334
Christian Heimesa342c012008-04-20 21:01:16 +00001335 def send_signal(self, sig):
1336 """Send a signal to the process
1337 """
1338 if sig == signal.SIGTERM:
1339 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001340 elif sig == signal.CTRL_C_EVENT:
1341 os.kill(self.pid, signal.CTRL_C_EVENT)
1342 elif sig == signal.CTRL_BREAK_EVENT:
1343 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001344 else:
Brian Curtin19651362010-09-07 13:24:38 +00001345 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001346
1347 def terminate(self):
1348 """Terminates the process
1349 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001350 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001351 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001352 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001353 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1354 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001355 rc = _winapi.GetExitCodeProcess(self._handle)
1356 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001357 raise
1358 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001359
1360 kill = terminate
1361
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001362 else:
1363 #
1364 # POSIX methods
1365 #
1366 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001367 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001368 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1369 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 p2cread, p2cwrite = -1, -1
1371 c2pread, c2pwrite = -1, -1
1372 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001373
Peter Astrandd38ddf42005-02-10 08:32:50 +00001374 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001375 pass
1376 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001377 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001378 elif stdin == DEVNULL:
1379 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001380 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001381 p2cread = stdin
1382 else:
1383 # Assuming file-like object
1384 p2cread = stdin.fileno()
1385
Peter Astrandd38ddf42005-02-10 08:32:50 +00001386 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001387 pass
1388 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001389 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001390 elif stdout == DEVNULL:
1391 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001392 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001393 c2pwrite = stdout
1394 else:
1395 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001396 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001397
Peter Astrandd38ddf42005-02-10 08:32:50 +00001398 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001399 pass
1400 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001401 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001402 elif stderr == STDOUT:
1403 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001404 elif stderr == DEVNULL:
1405 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001406 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001407 errwrite = stderr
1408 else:
1409 # Assuming file-like object
1410 errwrite = stderr.fileno()
1411
1412 return (p2cread, p2cwrite,
1413 c2pread, c2pwrite,
1414 errread, errwrite)
1415
1416
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001417 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001418 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001419 startupinfo, creationflags, shell,
1420 p2cread, p2cwrite,
1421 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001422 errread, errwrite,
1423 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001424 """Execute program (POSIX version)"""
1425
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001426 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001427 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001428 else:
1429 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001430
1431 if shell:
1432 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001433 if executable:
1434 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001435
Peter Astrandd38ddf42005-02-10 08:32:50 +00001436 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001437 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001438 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001439
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001440 # For transferring possible exec failure from child to parent.
1441 # Data format: "exception name:hex errno:description"
1442 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001443 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001444 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1445 low_fds_to_close = []
1446 while errpipe_write < 3:
1447 low_fds_to_close.append(errpipe_write)
1448 errpipe_write = os.dup(errpipe_write)
1449 for low_fd in low_fds_to_close:
1450 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001451 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001452 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001453 # We must avoid complex work that could involve
1454 # malloc or free in the child process to avoid
1455 # potential deadlocks, thus we do all this here.
1456 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457
Victor Stinner372b8382011-06-21 17:24:21 +02001458 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001459 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1460 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001461 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001462 env_list = None # Use execv instead of execve.
1463 executable = os.fsencode(executable)
1464 if os.path.dirname(executable):
1465 executable_list = (executable,)
1466 else:
1467 # This matches the behavior of os._execvpe().
1468 executable_list = tuple(
1469 os.path.join(os.fsencode(dir), executable)
1470 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001471 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001472 fds_to_keep.add(errpipe_write)
1473 self.pid = _posixsubprocess.fork_exec(
1474 args, executable_list,
1475 close_fds, sorted(fds_to_keep), cwd, env_list,
1476 p2cread, p2cwrite, c2pread, c2pwrite,
1477 errread, errwrite,
1478 errpipe_read, errpipe_write,
1479 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001480 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001481 finally:
1482 # be sure the FD is closed no matter what
1483 os.close(errpipe_write)
1484
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001485 # self._devnull is not always defined.
1486 devnull_fd = getattr(self, '_devnull', None)
1487 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001488 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001489 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001490 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001491 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001492 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001493 if devnull_fd is not None:
1494 os.close(devnull_fd)
1495 # Prevent a double close of these fds from __init__ on error.
1496 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001497
1498 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001499 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001500 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001501 while True:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001502 part = os.read(errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001503 errpipe_data += part
1504 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001505 break
Facundo Batista10706e22009-06-19 20:34:30 +00001506 finally:
1507 # be sure the FD is closed no matter what
1508 os.close(errpipe_read)
1509
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001510 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001511 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001512 os.waitpid(self.pid, 0)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001513 except ChildProcessError:
1514 pass
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001515 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001516 exception_name, hex_errno, err_msg = (
1517 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001518 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001519 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001520 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001521 err_msg = (b'Bad exception data from child: ' +
1522 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001523 child_exception_type = getattr(
1524 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001525 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001526 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001527 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001528 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001529 child_exec_never_called = (err_msg == "noexec")
1530 if child_exec_never_called:
1531 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001532 if errno_num != 0:
1533 err_msg = os.strerror(errno_num)
1534 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001535 if child_exec_never_called:
1536 # The error must be from chdir(cwd).
1537 err_msg += ': ' + repr(cwd)
1538 else:
1539 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001540 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001541 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001542
1543
Brett Cannon84df1e62010-05-14 00:33:40 +00001544 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1545 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1546 _WEXITSTATUS=os.WEXITSTATUS):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001547 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001548 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001549 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001550 if _WIFSIGNALED(sts):
1551 self.returncode = -_WTERMSIG(sts)
1552 elif _WIFEXITED(sts):
1553 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001554 else:
1555 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001556 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001557
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001558
Brett Cannon84df1e62010-05-14 00:33:40 +00001559 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001560 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001561 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001562 attribute.
1563
1564 This method is called by __del__, so it cannot reference anything
1565 outside of the local scope (nor can any methods it calls).
1566
1567 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001568 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001569 if not self._waitpid_lock.acquire(False):
1570 # Something else is busy calling waitpid. Don't allow two
1571 # at once. We know nothing yet.
1572 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001573 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001574 if self.returncode is not None:
1575 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001576 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001577 if pid == self.pid:
1578 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001579 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001580 if _deadstate is not None:
1581 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001582 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001583 # This happens if SIGCLD is set to be ignored or
1584 # waiting for child processes has otherwise been
1585 # disabled for our process. This child is dead, we
1586 # can't get the status.
1587 # http://bugs.python.org/issue15756
1588 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001589 finally:
1590 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001591 return self.returncode
1592
1593
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001594 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001595 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001597 (pid, sts) = os.waitpid(self.pid, wait_flags)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001598 except ChildProcessError:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001599 # This happens if SIGCLD is set to be ignored or waiting
1600 # for child processes has otherwise been disabled for our
1601 # process. This child is dead, we can't get the status.
1602 pid = self.pid
1603 sts = 0
1604 return (pid, sts)
1605
1606
1607 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001608 """Wait for child process to terminate. Returns returncode
1609 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001610 if self.returncode is not None:
1611 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001612
1613 # endtime is preferred to timeout. timeout is only used for
1614 # printing.
1615 if endtime is not None or timeout is not None:
1616 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001617 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001618 elif timeout is None:
1619 timeout = self._remaining_time(endtime)
1620
1621 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001622 # Enter a busy loop if we have a timeout. This busy loop was
1623 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1624 delay = 0.0005 # 500 us -> initial delay of 1 ms
1625 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001626 if self._waitpid_lock.acquire(False):
1627 try:
1628 if self.returncode is not None:
1629 break # Another thread waited.
1630 (pid, sts) = self._try_wait(os.WNOHANG)
1631 assert pid == self.pid or pid == 0
1632 if pid == self.pid:
1633 self._handle_exitstatus(sts)
1634 break
1635 finally:
1636 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001637 remaining = self._remaining_time(endtime)
1638 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001639 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001640 delay = min(delay * 2, remaining, .05)
1641 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001642 else:
1643 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001644 with self._waitpid_lock:
1645 if self.returncode is not None:
1646 break # Another thread waited.
1647 (pid, sts) = self._try_wait(0)
1648 # Check the pid and loop as waitpid has been known to
1649 # return 0 even without WNOHANG in odd situations.
1650 # http://bugs.python.org/issue14396.
1651 if pid == self.pid:
1652 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001653 return self.returncode
1654
1655
Reid Kleckner2b228f02011-03-16 16:57:54 -04001656 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001657 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001658 # Flush stdio buffer. This might block, if the user has
1659 # been writing to .stdin in an uncontrolled fashion.
1660 self.stdin.flush()
1661 if not input:
1662 self.stdin.close()
1663
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001664 stdout = None
1665 stderr = None
1666
1667 # Only create this mapping if we haven't already.
1668 if not self._communication_started:
1669 self._fileobj2output = {}
1670 if self.stdout:
1671 self._fileobj2output[self.stdout] = []
1672 if self.stderr:
1673 self._fileobj2output[self.stderr] = []
1674
1675 if self.stdout:
1676 stdout = self._fileobj2output[self.stdout]
1677 if self.stderr:
1678 stderr = self._fileobj2output[self.stderr]
1679
1680 self._save_input(input)
1681
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001682 if self._input:
1683 input_view = memoryview(self._input)
1684
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001685 with _PopenSelector() as selector:
1686 if self.stdin and input:
1687 selector.register(self.stdin, selectors.EVENT_WRITE)
1688 if self.stdout:
1689 selector.register(self.stdout, selectors.EVENT_READ)
1690 if self.stderr:
1691 selector.register(self.stderr, selectors.EVENT_READ)
1692
1693 while selector.get_map():
1694 timeout = self._remaining_time(endtime)
1695 if timeout is not None and timeout < 0:
1696 raise TimeoutExpired(self.args, orig_timeout)
1697
1698 ready = selector.select(timeout)
1699 self._check_timeout(endtime, orig_timeout)
1700
1701 # XXX Rewrite these to use non-blocking I/O on the file
1702 # objects; they are no longer using C stdio!
1703
1704 for key, events in ready:
1705 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001706 chunk = input_view[self._input_offset :
1707 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001708 try:
1709 self._input_offset += os.write(key.fd, chunk)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001710 except BrokenPipeError:
1711 selector.unregister(key.fileobj)
1712 key.fileobj.close()
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001713 else:
1714 if self._input_offset >= len(self._input):
1715 selector.unregister(key.fileobj)
1716 key.fileobj.close()
1717 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08001718 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001719 if not data:
1720 selector.unregister(key.fileobj)
1721 key.fileobj.close()
1722 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001723
1724 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001725
1726 # All data exchanged. Translate lists into strings.
1727 if stdout is not None:
1728 stdout = b''.join(stdout)
1729 if stderr is not None:
1730 stderr = b''.join(stderr)
1731
1732 # Translate newlines, if requested.
1733 # This also turns bytes into strings.
1734 if self.universal_newlines:
1735 if stdout is not None:
1736 stdout = self._translate_newlines(stdout,
1737 self.stdout.encoding)
1738 if stderr is not None:
1739 stderr = self._translate_newlines(stderr,
1740 self.stderr.encoding)
1741
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001742 return (stdout, stderr)
1743
1744
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001745 def _save_input(self, input):
1746 # This method is called from the _communicate_with_*() methods
1747 # so that if we time out while communicating, we can continue
1748 # sending input if we retry.
1749 if self.stdin and self._input is None:
1750 self._input_offset = 0
1751 self._input = input
1752 if self.universal_newlines and input is not None:
1753 self._input = self._input.encode(self.stdin.encoding)
1754
1755
Christian Heimesa342c012008-04-20 21:01:16 +00001756 def send_signal(self, sig):
1757 """Send a signal to the process
1758 """
1759 os.kill(self.pid, sig)
1760
1761 def terminate(self):
1762 """Terminate the process with SIGTERM
1763 """
1764 self.send_signal(signal.SIGTERM)
1765
1766 def kill(self):
1767 """Kill the process with SIGKILL
1768 """
1769 self.send_signal(signal.SIGKILL)