blob: 50d7cfdcdf57be7f4e2c173bd4c492d91533eb34 [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
14intends to replace several other, older modules and functions, like:
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
28class Popen(args, bufsize=0, executable=None,
29 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
59bufsize, if given, has the same meaning as the corresponding argument
60to the built-in open() function: 0 means unbuffered, 1 means line
61buffered, any other positive value means use a buffer of
62(approximately) that size. A negative bufsize means to use the system
63default, which usually means fully buffered. The default value for
64bufsize is 0 (unbuffered).
65
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
107If universal_newlines is true, the file objects stdout and stderr are
108opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000109the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110'\r\n', the Windows convention. All of these external representations
111are seen as '\n' by the Python program. Note: This feature is only
112available if Python is built with universal newline support (the
113default). Also, the newlines attribute of the file objects stdout,
114stdin and stderr are not updated by the communicate() method.
115
116The startupinfo and creationflags, if given, will be passed to the
117underlying CreateProcess() function. They can specify things such as
118appearance of the main window and priority for the new process.
119(Windows only)
120
121
Georg Brandlf9734072008-12-07 15:30:06 +0000122This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000123
Peter Astrand5f5e1412004-12-05 20:15:36 +0000124call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125 Run command with arguments. Wait for command to complete, then
126 return the returncode attribute.
127
128 The arguments are the same as for the Popen constructor. Example:
129
Florent Xicluna4886d242010-03-08 13:27:26 +0000130 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131
Peter Astrand454f7672005-01-01 09:36:35 +0000132check_call(*popenargs, **kwargs):
133 Run command with arguments. Wait for command to complete. If the
134 exit code was zero then return, otherwise raise
135 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000136 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000137
138 The arguments are the same as for the Popen constructor. Example:
139
Florent Xicluna4886d242010-03-08 13:27:26 +0000140 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000141 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000142
Brett Cannona23810f2008-05-26 19:04:21 +0000143getstatusoutput(cmd):
144 Return (status, output) of executing cmd in a shell.
145
146 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
147 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
148 returned output will contain output or error messages. A trailing newline
149 is stripped from the output. The exit status for the command can be
150 interpreted according to the rules for the C function wait(). Example:
151
Brett Cannona23810f2008-05-26 19:04:21 +0000152 >>> subprocess.getstatusoutput('ls /bin/ls')
153 (0, '/bin/ls')
154 >>> subprocess.getstatusoutput('cat /bin/junk')
155 (256, 'cat: /bin/junk: No such file or directory')
156 >>> subprocess.getstatusoutput('/bin/junk')
157 (256, 'sh: /bin/junk: not found')
158
159getoutput(cmd):
160 Return output (stdout or stderr) of executing cmd in a shell.
161
162 Like getstatusoutput(), except the exit status is ignored and the return
163 value is a string containing the command's output. Example:
164
Brett Cannona23810f2008-05-26 19:04:21 +0000165 >>> subprocess.getoutput('ls /bin/ls')
166 '/bin/ls'
167
Georg Brandlf9734072008-12-07 15:30:06 +0000168check_output(*popenargs, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000169 Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000170
Georg Brandl2708f3a2009-12-20 14:38:23 +0000171 If the exit code was non-zero it raises a CalledProcessError. The
172 CalledProcessError object will have the return code in the returncode
173 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000174
Georg Brandl2708f3a2009-12-20 14:38:23 +0000175 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Brett Cannona23810f2008-05-26 19:04:21 +0000179
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000180Exceptions
181----------
182Exceptions raised in the child process, before the new program has
183started to execute, will be re-raised in the parent. Additionally,
184the exception object will have one extra attribute called
185'child_traceback', which is a string containing traceback information
186from the childs point of view.
187
188The most common exception raised is OSError. This occurs, for
189example, when trying to execute a non-existent file. Applications
190should prepare for OSErrors.
191
192A ValueError will be raised if Popen is called with invalid arguments.
193
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400194Exceptions defined within this module inherit from SubprocessError.
195check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400196called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400197be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000198
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000199
200Security
201--------
202Unlike some other popen functions, this implementation will never call
203/bin/sh implicitly. This means that all characters, including shell
204metacharacters, can safely be passed to child processes.
205
206
207Popen objects
208=============
209Instances of the Popen class have the following methods:
210
211poll()
212 Check if child process has terminated. Returns returncode
213 attribute.
214
215wait()
216 Wait for child process to terminate. Returns returncode attribute.
217
218communicate(input=None)
219 Interact with process: Send data to stdin. Read data from stdout
220 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000221 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000222 sent to the child process, or None, if no data should be sent to
223 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000224
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225 communicate() returns a tuple (stdout, stderr).
226
227 Note: The data read is buffered in memory, so do not use this
228 method if the data size is large or unlimited.
229
230The following attributes are also available:
231
232stdin
233 If the stdin argument is PIPE, this attribute is a file object
234 that provides input to the child process. Otherwise, it is None.
235
236stdout
237 If the stdout argument is PIPE, this attribute is a file object
238 that provides output from the child process. Otherwise, it is
239 None.
240
241stderr
242 If the stderr argument is PIPE, this attribute is file object that
243 provides error output from the child process. Otherwise, it is
244 None.
245
246pid
247 The process ID of the child process.
248
249returncode
250 The child return code. A None value indicates that the process
251 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000252 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000253
254
255Replacing older functions with the subprocess module
256====================================================
257In this section, "a ==> b" means that b can be used as a replacement
258for a.
259
260Note: All functions in this section fail (more or less) silently if
261the executed program cannot be found; this module raises an OSError
262exception.
263
264In the following examples, we assume that the subprocess module is
265imported with "from subprocess import *".
266
267
268Replacing /bin/sh shell backquote
269---------------------------------
270output=`mycmd myarg`
271==>
272output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
273
274
275Replacing shell pipe line
276-------------------------
277output=`dmesg | grep hda`
278==>
279p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000280p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000281output = p2.communicate()[0]
282
283
284Replacing os.system()
285---------------------
286sts = os.system("mycmd" + " myarg")
287==>
288p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000289pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000290
291Note:
292
293* Calling the program through the shell is usually not required.
294
295* It's easier to look at the returncode attribute than the
296 exitstatus.
297
298A more real-world example would look like this:
299
300try:
301 retcode = call("mycmd" + " myarg", shell=True)
302 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000303 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000304 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000305 print("Child returned", retcode, file=sys.stderr)
306except OSError as e:
307 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000308
309
310Replacing os.spawn*
311-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000312P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000313
314pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
315==>
316pid = Popen(["/bin/mycmd", "myarg"]).pid
317
318
319P_WAIT example:
320
321retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
322==>
323retcode = call(["/bin/mycmd", "myarg"])
324
325
Tim Peterse718f612004-10-12 21:51:32 +0000326Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000327
328os.spawnvp(os.P_NOWAIT, path, args)
329==>
330Popen([path] + args[1:])
331
332
Tim Peterse718f612004-10-12 21:51:32 +0000333Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000334
335os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
336==>
337Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000338"""
339
340import sys
341mswindows = (sys.platform == "win32")
342
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000343import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000344import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400345import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000346import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000347import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000348import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000349import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000350import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200351import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200352try:
353 from time import monotonic as _time
354except ImportError:
355 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000356
Peter Astrand454f7672005-01-01 09:36:35 +0000357# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400358class SubprocessError(Exception): pass
359
360
361class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000362 """This exception is raised when a process run by check_call() or
363 check_output() returns a non-zero exit status.
364 The exit status will be stored in the returncode attribute;
365 check_output() will also store the output in the output attribute.
366 """
367 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000368 self.returncode = returncode
369 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000370 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000371 def __str__(self):
372 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
373
Peter Astrand454f7672005-01-01 09:36:35 +0000374
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400375class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400376 """This exception is raised when the timeout expires while waiting for a
377 child process.
378 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400379 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400380 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400381 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400382 self.output = output
383
384 def __str__(self):
385 return ("Command '%s' timed out after %s seconds" %
386 (self.cmd, self.timeout))
387
388
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000389if mswindows:
390 import threading
391 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200392 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000393 class STARTUPINFO:
394 dwFlags = 0
395 hStdInput = None
396 hStdOutput = None
397 hStdError = None
398 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000399else:
400 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000401 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700402 import _posixsubprocess
403 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000404
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000405 # When select or poll has indicated that the file is writable,
406 # we can write up to _PIPE_BUF bytes without risk of blocking.
407 # POSIX defines PIPE_BUF as >= 512.
408 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
409
410
Brett Cannona23810f2008-05-26 19:04:21 +0000411__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200412 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000413
Brian Curtin1ce6b582010-04-24 16:19:22 +0000414if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200415 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
416 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
417 STD_ERROR_HANDLE, SW_HIDE,
418 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500419
Brian Curtin08fd8d92011-04-29 16:11:30 -0500420 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500421 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
422 "STD_ERROR_HANDLE", "SW_HIDE",
423 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200424
425 class Handle(int):
426 closed = False
427
428 def Close(self, CloseHandle=_winapi.CloseHandle):
429 if not self.closed:
430 self.closed = True
431 CloseHandle(self)
432
433 def Detach(self):
434 if not self.closed:
435 self.closed = True
436 return int(self)
437 raise ValueError("already closed")
438
439 def __repr__(self):
440 return "Handle(%d)" % int(self)
441
442 __del__ = Close
443 __str__ = __repr__
444
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000445try:
446 MAXFD = os.sysconf("SC_OPEN_MAX")
447except:
448 MAXFD = 256
449
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200450# This lists holds Popen instances for which the underlying process had not
451# exited at the time its __del__ method got called: those processes are wait()ed
452# for synchronously from _cleanup() when a new Popen object is created, to avoid
453# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000454_active = []
455
456def _cleanup():
457 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000458 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200459 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000460 try:
461 _active.remove(inst)
462 except ValueError:
463 # This can happen if two threads create a new Popen instance.
464 # It's harmless that it was already removed, so ignore.
465 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000466
467PIPE = -1
468STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200469DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000470
471
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000472def _eintr_retry_call(func, *args):
473 while True:
474 try:
475 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200476 except InterruptedError:
477 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000478
479
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200480# XXX This function is only used by multiprocessing and the test suite,
481# but it's here so that it can be imported when Python is compiled without
482# threads.
483
484def _args_from_interpreter_flags():
485 """Return a list of command-line arguments reproducing the current
486 settings in sys.flags and sys.warnoptions."""
487 flag_opt_map = {
488 'debug': 'd',
489 # 'inspect': 'i',
490 # 'interactive': 'i',
491 'optimize': 'O',
492 'dont_write_bytecode': 'B',
493 'no_user_site': 's',
494 'no_site': 'S',
495 'ignore_environment': 'E',
496 'verbose': 'v',
497 'bytes_warning': 'b',
498 'quiet': 'q',
499 'hash_randomization': 'R',
500 }
501 args = []
502 for flag, opt in flag_opt_map.items():
503 v = getattr(sys.flags, flag)
504 if v > 0:
505 args.append('-' + opt * v)
506 for opt in sys.warnoptions:
507 args.append('-W' + opt)
508 return args
509
510
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400511def call(*popenargs, timeout=None, **kwargs):
512 """Run command with arguments. Wait for command to complete or
513 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000514
515 The arguments are the same as for the Popen constructor. Example:
516
517 retcode = call(["ls", "-l"])
518 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200519 with Popen(*popenargs, **kwargs) as p:
520 try:
521 return p.wait(timeout=timeout)
522 except:
523 p.kill()
524 p.wait()
525 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000526
527
Peter Astrand454f7672005-01-01 09:36:35 +0000528def check_call(*popenargs, **kwargs):
529 """Run command with arguments. Wait for command to complete. If
530 the exit code was zero then return, otherwise raise
531 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000532 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000533
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400534 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000535
536 check_call(["ls", "-l"])
537 """
538 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000539 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000540 cmd = kwargs.get("args")
541 if cmd is None:
542 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000543 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000544 return 0
545
546
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400547def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000548 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000549
550 If the exit code was non-zero it raises a CalledProcessError. The
551 CalledProcessError object will have the return code in the returncode
552 attribute and output in the output attribute.
553
554 The arguments are the same as for the Popen constructor. Example:
555
556 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000557 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000558
559 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000560 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000561
562 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000563 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000564 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000565 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000566 """
567 if 'stdout' in kwargs:
568 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200569 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
570 try:
571 output, unused_err = process.communicate(timeout=timeout)
572 except TimeoutExpired:
573 process.kill()
574 output, unused_err = process.communicate()
575 raise TimeoutExpired(process.args, timeout, output=output)
576 except:
577 process.kill()
578 process.wait()
579 raise
580 retcode = process.poll()
581 if retcode:
582 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000583 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000584
585
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000586def list2cmdline(seq):
587 """
588 Translate a sequence of arguments into a command line
589 string, using the same rules as the MS C runtime:
590
591 1) Arguments are delimited by white space, which is either a
592 space or a tab.
593
594 2) A string surrounded by double quotation marks is
595 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000596 contained within. A quoted string can be embedded in an
597 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000598
599 3) A double quotation mark preceded by a backslash is
600 interpreted as a literal double quotation mark.
601
602 4) Backslashes are interpreted literally, unless they
603 immediately precede a double quotation mark.
604
605 5) If backslashes immediately precede a double quotation mark,
606 every pair of backslashes is interpreted as a literal
607 backslash. If the number of backslashes is odd, the last
608 backslash escapes the next double quotation mark as
609 described in rule 3.
610 """
611
612 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000613 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
614 # or search http://msdn.microsoft.com for
615 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000616 result = []
617 needquote = False
618 for arg in seq:
619 bs_buf = []
620
621 # Add a space to separate this argument from the others
622 if result:
623 result.append(' ')
624
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000625 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000626 if needquote:
627 result.append('"')
628
629 for c in arg:
630 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000631 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000632 bs_buf.append(c)
633 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000634 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000635 result.append('\\' * len(bs_buf)*2)
636 bs_buf = []
637 result.append('\\"')
638 else:
639 # Normal char
640 if bs_buf:
641 result.extend(bs_buf)
642 bs_buf = []
643 result.append(c)
644
Christian Heimesfdab48e2008-01-20 09:06:41 +0000645 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000646 if bs_buf:
647 result.extend(bs_buf)
648
649 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000650 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000651 result.append('"')
652
653 return ''.join(result)
654
655
Brett Cannona23810f2008-05-26 19:04:21 +0000656# Various tools for executing commands and looking at their output and status.
657#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000658# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000659
660def getstatusoutput(cmd):
661 """Return (status, output) of executing cmd in a shell.
662
663 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
664 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
665 returned output will contain output or error messages. A trailing newline
666 is stripped from the output. The exit status for the command can be
667 interpreted according to the rules for the C function wait(). Example:
668
669 >>> import subprocess
670 >>> subprocess.getstatusoutput('ls /bin/ls')
671 (0, '/bin/ls')
672 >>> subprocess.getstatusoutput('cat /bin/junk')
673 (256, 'cat: /bin/junk: No such file or directory')
674 >>> subprocess.getstatusoutput('/bin/junk')
675 (256, 'sh: /bin/junk: not found')
676 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200677 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
678 try:
679 text = pipe.read()
680 sts = pipe.close()
681 except:
682 process = pipe._proc
683 process.kill()
684 process.wait()
685 raise
686 if sts is None:
687 sts = 0
688 if text[-1:] == '\n':
689 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000690 return sts, text
691
692
693def getoutput(cmd):
694 """Return output (stdout or stderr) of executing cmd in a shell.
695
696 Like getstatusoutput(), except the exit status is ignored and the return
697 value is a string containing the command's output. Example:
698
699 >>> import subprocess
700 >>> subprocess.getoutput('ls /bin/ls')
701 '/bin/ls'
702 """
703 return getstatusoutput(cmd)[1]
704
705
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000706_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000707
708
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000709class Popen(object):
710 def __init__(self, args, bufsize=0, executable=None,
711 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000712 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
713 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000714 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000715 restore_signals=True, start_new_session=False,
716 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000717 """Create new Popen instance."""
718 _cleanup()
719
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000720 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400721 self._input = None
722 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000723 if bufsize is None:
724 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000725 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000726 raise TypeError("bufsize must be an integer")
727
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000728 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000729 if preexec_fn is not None:
730 raise ValueError("preexec_fn is not supported on Windows "
731 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000732 any_stdio_set = (stdin is not None or stdout is not None or
733 stderr is not None)
734 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
735 if any_stdio_set:
736 close_fds = False
737 else:
738 close_fds = True
739 elif close_fds and any_stdio_set:
740 raise ValueError(
741 "close_fds is not supported on Windows platforms"
742 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000743 else:
744 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000745 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
746 close_fds = True
747 if pass_fds and not close_fds:
748 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
749 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000750 if startupinfo is not None:
751 raise ValueError("startupinfo is only supported on Windows "
752 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000754 raise ValueError("creationflags is only supported on Windows "
755 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000756
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400757 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000758 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000759 self.stdout = None
760 self.stderr = None
761 self.pid = None
762 self.returncode = None
763 self.universal_newlines = universal_newlines
764
765 # Input and output objects. The general principle is like
766 # this:
767 #
768 # Parent Child
769 # ------ -----
770 # p2cwrite ---stdin---> p2cread
771 # c2pread <--stdout--- c2pwrite
772 # errread <--stderr--- errwrite
773 #
774 # On POSIX, the child objects are file descriptors. On
775 # Windows, these are Windows file handles. The parent objects
776 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000777 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000778 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000779
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 (p2cread, p2cwrite,
781 c2pread, c2pwrite,
782 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
783
Antoine Pitrouc9982322011-01-04 19:07:07 +0000784 # We wrap OS handles *before* launching the child, otherwise a
785 # quickly terminating child could make our fds unwrappable
786 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000787
Thomas Wouterscf297e42007-02-23 15:07:44 +0000788 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000789 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000790 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000791 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000792 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000793 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000794 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000795
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000796 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000797 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300798 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200799 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000800 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000801 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000802 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000803 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000804 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000805 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000806 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000807 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000808
Antoine Pitrouc9982322011-01-04 19:07:07 +0000809 try:
810 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300811 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000812 startupinfo, creationflags, shell,
813 p2cread, p2cwrite,
814 c2pread, c2pwrite,
815 errread, errwrite,
816 restore_signals, start_new_session)
817 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800818 # Cleanup if the child failed starting.
819 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000820 try:
821 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200822 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800823 pass # Ignore EBADF or other errors.
824
825 # Make sure the child pipes are closed as well.
826 to_close = []
827 if stdin == PIPE:
828 to_close.append(p2cread)
829 if stdout == PIPE:
830 to_close.append(c2pwrite)
831 if stderr == PIPE:
832 to_close.append(errwrite)
833 for fd in to_close:
834 try:
835 os.close(fd)
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200836 except OSError:
Antoine Pitrouc9982322011-01-04 19:07:07 +0000837 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800838
Antoine Pitrouc9982322011-01-04 19:07:07 +0000839 raise
840
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000841
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300843 data = data.decode(encoding)
844 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000845
Brian Curtin79cdb662010-12-03 02:46:02 +0000846 def __enter__(self):
847 return self
848
849 def __exit__(self, type, value, traceback):
850 if self.stdout:
851 self.stdout.close()
852 if self.stderr:
853 self.stderr.close()
854 if self.stdin:
855 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700856 # Wait for the process to terminate, to avoid zombies.
857 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000858
Brett Cannon84df1e62010-05-14 00:33:40 +0000859 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200860 # If __init__ hasn't had a chance to execute (e.g. if it
861 # was passed an undeclared keyword argument), we don't
862 # have a _child_created attribute at all.
863 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000864 # We didn't get to successfully create a child process.
865 return
866 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000867 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000868 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000869 # Child is still running, keep us alive until we can wait on it.
870 _active.append(self)
871
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200872 def _get_devnull(self):
873 if not hasattr(self, '_devnull'):
874 self._devnull = os.open(os.devnull, os.O_RDWR)
875 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000876
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400877 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000878 """Interact with process: Send data to stdin. Read data from
879 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700880 process to terminate. The optional input argument should be
881 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000882 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000883
Peter Astrand23109f02005-03-03 20:28:59 +0000884 communicate() returns a tuple (stdout, stderr)."""
885
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400886 if self._communication_started and input:
887 raise ValueError("Cannot send input after starting communication")
888
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400889 # Optimization: If we are not worried about timeouts, we haven't
890 # started communicating, and we have one or zero pipes, using select()
891 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200892 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400893 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000894 stdout = None
895 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000896 if self.stdin:
897 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200898 try:
899 self.stdin.write(input)
900 except IOError as e:
901 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
902 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000903 self.stdin.close()
904 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200905 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000906 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000907 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200908 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000909 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000910 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200911 else:
912 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200913 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200914 else:
915 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000916
Victor Stinner7a8d0812011-04-05 13:13:08 +0200917 try:
918 stdout, stderr = self._communicate(input, endtime, timeout)
919 finally:
920 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400921
Victor Stinner7a8d0812011-04-05 13:13:08 +0200922 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400923
924 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000925
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000926
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000927 def poll(self):
928 return self._internal_poll()
929
930
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400931 def _remaining_time(self, endtime):
932 """Convenience for _communicate when computing timeouts."""
933 if endtime is None:
934 return None
935 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200936 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400937
938
Reid Kleckner2b228f02011-03-16 16:57:54 -0400939 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400940 """Convenience for checking if a timeout has expired."""
941 if endtime is None:
942 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200943 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400944 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400945
946
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000947 if mswindows:
948 #
949 # Windows methods
950 #
951 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000952 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000953 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
954 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000955 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000956 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000957
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000958 p2cread, p2cwrite = -1, -1
959 c2pread, c2pwrite = -1, -1
960 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000961
Peter Astrandd38ddf42005-02-10 08:32:50 +0000962 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200963 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000964 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200965 p2cread, _ = _winapi.CreatePipe(None, 0)
966 p2cread = Handle(p2cread)
967 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000968 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200969 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
970 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200971 elif stdin == DEVNULL:
972 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000973 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000974 p2cread = msvcrt.get_osfhandle(stdin)
975 else:
976 # Assuming file-like object
977 p2cread = msvcrt.get_osfhandle(stdin.fileno())
978 p2cread = self._make_inheritable(p2cread)
979
Peter Astrandd38ddf42005-02-10 08:32:50 +0000980 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200981 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000982 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200983 _, c2pwrite = _winapi.CreatePipe(None, 0)
984 c2pwrite = Handle(c2pwrite)
985 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000986 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200987 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
988 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200989 elif stdout == DEVNULL:
990 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000991 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000992 c2pwrite = msvcrt.get_osfhandle(stdout)
993 else:
994 # Assuming file-like object
995 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
996 c2pwrite = self._make_inheritable(c2pwrite)
997
Peter Astrandd38ddf42005-02-10 08:32:50 +0000998 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200999 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001000 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001001 _, errwrite = _winapi.CreatePipe(None, 0)
1002 errwrite = Handle(errwrite)
1003 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001004 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001005 errread, errwrite = _winapi.CreatePipe(None, 0)
1006 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001007 elif stderr == STDOUT:
1008 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001009 elif stderr == DEVNULL:
1010 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001011 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001012 errwrite = msvcrt.get_osfhandle(stderr)
1013 else:
1014 # Assuming file-like object
1015 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1016 errwrite = self._make_inheritable(errwrite)
1017
1018 return (p2cread, p2cwrite,
1019 c2pread, c2pwrite,
1020 errread, errwrite)
1021
1022
1023 def _make_inheritable(self, handle):
1024 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001025 h = _winapi.DuplicateHandle(
1026 _winapi.GetCurrentProcess(), handle,
1027 _winapi.GetCurrentProcess(), 0, 1,
1028 _winapi.DUPLICATE_SAME_ACCESS)
1029 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001030
1031
1032 def _find_w9xpopen(self):
1033 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001034 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001035 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001036 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001037 if not os.path.exists(w9xpopen):
1038 # Eeek - file-not-found - possibly an embedding
1039 # situation - see if we can locate it in sys.exec_prefix
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001040 w9xpopen = os.path.join(os.path.dirname(sys.base_exec_prefix),
Tim Peterse8374a52004-10-13 03:15:00 +00001041 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001042 if not os.path.exists(w9xpopen):
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001043 raise SubprocessError(
1044 "Cannot locate w9xpopen.exe, which is needed for "
1045 "Popen to work with your shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001046 return w9xpopen
1047
Tim Peterse718f612004-10-12 21:51:32 +00001048
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001049 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001050 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001051 startupinfo, creationflags, shell,
1052 p2cread, p2cwrite,
1053 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001054 errread, errwrite,
1055 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 """Execute program (MS Windows version)"""
1057
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001058 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001059
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001060 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 args = list2cmdline(args)
1062
Peter Astrandc1d65362004-11-07 14:30:34 +00001063 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001064 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001065 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001066 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001067 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001068 startupinfo.hStdInput = p2cread
1069 startupinfo.hStdOutput = c2pwrite
1070 startupinfo.hStdError = errwrite
1071
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001072 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001073 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1074 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001075 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001076 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001077 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001078 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001079 # Win9x, or using command.com on NT. We need to
1080 # use the w9xpopen intermediate program. For more
1081 # information, see KB Q150956
1082 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1083 w9xpopen = self._find_w9xpopen()
1084 args = '"%s" %s' % (w9xpopen, args)
1085 # Not passing CREATE_NEW_CONSOLE has been known to
1086 # cause random failures on win9x. Specifically a
1087 # dialog: "Your program accessed mem currently in
1088 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001089 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001090 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001091 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001093 # Start the process
1094 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001095 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001096 # no special security
1097 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001098 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001099 creationflags,
1100 env,
1101 cwd,
1102 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001103 finally:
1104 # Child is launched. Close the parent's copy of those pipe
1105 # handles that only the child should have open. You need
1106 # to make sure that no handles to the write end of the
1107 # output pipe are maintained in this process or else the
1108 # pipe will not close when the child process exits and the
1109 # ReadFile will hang.
1110 if p2cread != -1:
1111 p2cread.Close()
1112 if c2pwrite != -1:
1113 c2pwrite.Close()
1114 if errwrite != -1:
1115 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001116 if hasattr(self, '_devnull'):
1117 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001118
1119 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001120 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001121 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001122 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001123 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001124
Brett Cannon84df1e62010-05-14 00:33:40 +00001125 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001126 _WaitForSingleObject=_winapi.WaitForSingleObject,
1127 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1128 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001129 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001130 attribute.
1131
1132 This method is called by __del__, so it can only refer to objects
1133 in its local scope.
1134
1135 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001136 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001137 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1138 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001139 return self.returncode
1140
1141
Reid Kleckner2b228f02011-03-16 16:57:54 -04001142 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001143 """Wait for child process to terminate. Returns returncode
1144 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001145 if endtime is not None:
1146 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001147 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001148 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001149 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001150 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001151 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001152 result = _winapi.WaitForSingleObject(self._handle,
1153 timeout_millis)
1154 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001155 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001156 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001157 return self.returncode
1158
1159
1160 def _readerthread(self, fh, buffer):
1161 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001162 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001163
1164
Reid Kleckner2b228f02011-03-16 16:57:54 -04001165 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001166 # Start reader threads feeding into a list hanging off of this
1167 # object, unless they've already been started.
1168 if self.stdout and not hasattr(self, "_stdout_buff"):
1169 self._stdout_buff = []
1170 self.stdout_thread = \
1171 threading.Thread(target=self._readerthread,
1172 args=(self.stdout, self._stdout_buff))
1173 self.stdout_thread.daemon = True
1174 self.stdout_thread.start()
1175 if self.stderr and not hasattr(self, "_stderr_buff"):
1176 self._stderr_buff = []
1177 self.stderr_thread = \
1178 threading.Thread(target=self._readerthread,
1179 args=(self.stderr, self._stderr_buff))
1180 self.stderr_thread.daemon = True
1181 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001182
1183 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001184 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001185 try:
1186 self.stdin.write(input)
1187 except IOError as e:
1188 if e.errno != errno.EPIPE:
1189 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001190 self.stdin.close()
1191
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001192 # Wait for the reader threads, or time out. If we time out, the
1193 # threads remain reading and the fds left open in case the user
1194 # calls communicate again.
1195 if self.stdout is not None:
1196 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001197 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001198 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001199 if self.stderr is not None:
1200 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001201 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001202 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001203
1204 # Collect the output from and close both pipes, now that we know
1205 # both have been read successfully.
1206 stdout = None
1207 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001209 stdout = self._stdout_buff
1210 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001212 stderr = self._stderr_buff
1213 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001214
1215 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001216 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001217 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001218 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001219 stderr = stderr[0]
1220
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001221 return (stdout, stderr)
1222
Christian Heimesa342c012008-04-20 21:01:16 +00001223 def send_signal(self, sig):
1224 """Send a signal to the process
1225 """
1226 if sig == signal.SIGTERM:
1227 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001228 elif sig == signal.CTRL_C_EVENT:
1229 os.kill(self.pid, signal.CTRL_C_EVENT)
1230 elif sig == signal.CTRL_BREAK_EVENT:
1231 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001232 else:
Brian Curtin19651362010-09-07 13:24:38 +00001233 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001234
1235 def terminate(self):
1236 """Terminates the process
1237 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001238 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001239 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001240 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001241 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1242 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001243 rc = _winapi.GetExitCodeProcess(self._handle)
1244 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001245 raise
1246 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001247
1248 kill = terminate
1249
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001250 else:
1251 #
1252 # POSIX methods
1253 #
1254 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001255 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001256 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1257 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001258 p2cread, p2cwrite = -1, -1
1259 c2pread, c2pwrite = -1, -1
1260 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001261
Peter Astrandd38ddf42005-02-10 08:32:50 +00001262 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001263 pass
1264 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001265 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001266 elif stdin == DEVNULL:
1267 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001268 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001269 p2cread = stdin
1270 else:
1271 # Assuming file-like object
1272 p2cread = stdin.fileno()
1273
Peter Astrandd38ddf42005-02-10 08:32:50 +00001274 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001275 pass
1276 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001277 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001278 elif stdout == DEVNULL:
1279 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001280 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001281 c2pwrite = stdout
1282 else:
1283 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001284 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285
Peter Astrandd38ddf42005-02-10 08:32:50 +00001286 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001287 pass
1288 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001289 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001290 elif stderr == STDOUT:
1291 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001292 elif stderr == DEVNULL:
1293 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001294 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001295 errwrite = stderr
1296 else:
1297 # Assuming file-like object
1298 errwrite = stderr.fileno()
1299
1300 return (p2cread, p2cwrite,
1301 c2pread, c2pwrite,
1302 errread, errwrite)
1303
1304
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001305 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001306 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001307 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001308 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001309 os.closerange(start_fd, fd)
1310 start_fd = fd + 1
1311 if start_fd <= MAXFD:
1312 os.closerange(start_fd, MAXFD)
1313
1314
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001315 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001316 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001317 startupinfo, creationflags, shell,
1318 p2cread, p2cwrite,
1319 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001320 errread, errwrite,
1321 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001322 """Execute program (POSIX version)"""
1323
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001324 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001325 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001326 else:
1327 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001328
1329 if shell:
1330 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001331 if executable:
1332 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333
Peter Astrandd38ddf42005-02-10 08:32:50 +00001334 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001335 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001336 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001337
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001338 # For transferring possible exec failure from child to parent.
1339 # Data format: "exception name:hex errno:description"
1340 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001341 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001342 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001344 # We must avoid complex work that could involve
1345 # malloc or free in the child process to avoid
1346 # potential deadlocks, thus we do all this here.
1347 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001348
Victor Stinner372b8382011-06-21 17:24:21 +02001349 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001350 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1351 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001352 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001353 env_list = None # Use execv instead of execve.
1354 executable = os.fsencode(executable)
1355 if os.path.dirname(executable):
1356 executable_list = (executable,)
1357 else:
1358 # This matches the behavior of os._execvpe().
1359 executable_list = tuple(
1360 os.path.join(os.fsencode(dir), executable)
1361 for dir in os.get_exec_path(env))
1362 fds_to_keep = set(pass_fds)
1363 fds_to_keep.add(errpipe_write)
1364 self.pid = _posixsubprocess.fork_exec(
1365 args, executable_list,
1366 close_fds, sorted(fds_to_keep), cwd, env_list,
1367 p2cread, p2cwrite, c2pread, c2pwrite,
1368 errread, errwrite,
1369 errpipe_read, errpipe_write,
1370 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001371 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001372 finally:
1373 # be sure the FD is closed no matter what
1374 os.close(errpipe_write)
1375
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001376 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001377 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001378 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001379 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001380 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001381 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001382 if hasattr(self, '_devnull'):
1383 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001384
1385 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001386 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001387 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001388 while True:
1389 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001390 errpipe_data += part
1391 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001392 break
Facundo Batista10706e22009-06-19 20:34:30 +00001393 finally:
1394 # be sure the FD is closed no matter what
1395 os.close(errpipe_read)
1396
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001397 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001398 try:
1399 _eintr_retry_call(os.waitpid, self.pid, 0)
1400 except OSError as e:
1401 if e.errno != errno.ECHILD:
1402 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001403 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001404 exception_name, hex_errno, err_msg = (
1405 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001406 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001407 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001408 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001409 err_msg = (b'Bad exception data from child: ' +
1410 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001411 child_exception_type = getattr(
1412 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001413 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001414 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001415 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001416 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001417 child_exec_never_called = (err_msg == "noexec")
1418 if child_exec_never_called:
1419 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001420 if errno_num != 0:
1421 err_msg = os.strerror(errno_num)
1422 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001423 if child_exec_never_called:
1424 # The error must be from chdir(cwd).
1425 err_msg += ': ' + repr(cwd)
1426 else:
1427 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001428 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001429 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001430
1431
Brett Cannon84df1e62010-05-14 00:33:40 +00001432 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1433 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1434 _WEXITSTATUS=os.WEXITSTATUS):
1435 # This method is called (indirectly) by __del__, so it cannot
1436 # refer to anything outside of its local scope."""
1437 if _WIFSIGNALED(sts):
1438 self.returncode = -_WTERMSIG(sts)
1439 elif _WIFEXITED(sts):
1440 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001441 else:
1442 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001443 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001444
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001445
Brett Cannon84df1e62010-05-14 00:33:40 +00001446 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1447 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001448 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001449 attribute.
1450
1451 This method is called by __del__, so it cannot reference anything
1452 outside of the local scope (nor can any methods it calls).
1453
1454 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001455 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001456 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001457 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001458 if pid == self.pid:
1459 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001460 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001461 if _deadstate is not None:
1462 self.returncode = _deadstate
Gregory P. Smith39051712012-09-29 11:40:38 -07001463 elif e.errno == errno.ECHILD:
1464 # This happens if SIGCLD is set to be ignored or
1465 # waiting for child processes has otherwise been
1466 # disabled for our process. This child is dead, we
1467 # can't get the status.
1468 # http://bugs.python.org/issue15756
1469 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001470 return self.returncode
1471
1472
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001473 def _try_wait(self, wait_flags):
1474 try:
1475 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1476 except OSError as e:
1477 if e.errno != errno.ECHILD:
1478 raise
1479 # This happens if SIGCLD is set to be ignored or waiting
1480 # for child processes has otherwise been disabled for our
1481 # process. This child is dead, we can't get the status.
1482 pid = self.pid
1483 sts = 0
1484 return (pid, sts)
1485
1486
1487 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001488 """Wait for child process to terminate. Returns returncode
1489 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001490 if self.returncode is not None:
1491 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001492
1493 # endtime is preferred to timeout. timeout is only used for
1494 # printing.
1495 if endtime is not None or timeout is not None:
1496 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001497 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001498 elif timeout is None:
1499 timeout = self._remaining_time(endtime)
1500
1501 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001502 # Enter a busy loop if we have a timeout. This busy loop was
1503 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1504 delay = 0.0005 # 500 us -> initial delay of 1 ms
1505 while True:
1506 (pid, sts) = self._try_wait(os.WNOHANG)
1507 assert pid == self.pid or pid == 0
1508 if pid == self.pid:
1509 self._handle_exitstatus(sts)
1510 break
1511 remaining = self._remaining_time(endtime)
1512 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001513 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001514 delay = min(delay * 2, remaining, .05)
1515 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001516 else:
1517 while self.returncode is None:
1518 (pid, sts) = self._try_wait(0)
1519 # Check the pid and loop as waitpid has been known to return
1520 # 0 even without WNOHANG in odd situations. issue14396.
1521 if pid == self.pid:
1522 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001523 return self.returncode
1524
1525
Reid Kleckner2b228f02011-03-16 16:57:54 -04001526 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001527 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001528 # Flush stdio buffer. This might block, if the user has
1529 # been writing to .stdin in an uncontrolled fashion.
1530 self.stdin.flush()
1531 if not input:
1532 self.stdin.close()
1533
1534 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001535 stdout, stderr = self._communicate_with_poll(input, endtime,
1536 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001537 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001538 stdout, stderr = self._communicate_with_select(input, endtime,
1539 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001540
1541 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001542
1543 # All data exchanged. Translate lists into strings.
1544 if stdout is not None:
1545 stdout = b''.join(stdout)
1546 if stderr is not None:
1547 stderr = b''.join(stderr)
1548
1549 # Translate newlines, if requested.
1550 # This also turns bytes into strings.
1551 if self.universal_newlines:
1552 if stdout is not None:
1553 stdout = self._translate_newlines(stdout,
1554 self.stdout.encoding)
1555 if stderr is not None:
1556 stderr = self._translate_newlines(stderr,
1557 self.stderr.encoding)
1558
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001559 return (stdout, stderr)
1560
1561
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001562 def _save_input(self, input):
1563 # This method is called from the _communicate_with_*() methods
1564 # so that if we time out while communicating, we can continue
1565 # sending input if we retry.
1566 if self.stdin and self._input is None:
1567 self._input_offset = 0
1568 self._input = input
1569 if self.universal_newlines and input is not None:
1570 self._input = self._input.encode(self.stdin.encoding)
1571
1572
Reid Kleckner2b228f02011-03-16 16:57:54 -04001573 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001574 stdout = None # Return
1575 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001576
1577 if not self._communication_started:
1578 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001579
1580 poller = select.poll()
1581 def register_and_append(file_obj, eventmask):
1582 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001583 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001584
1585 def close_unregister_and_remove(fd):
1586 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001587 self._fd2file[fd].close()
1588 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001589
1590 if self.stdin and input:
1591 register_and_append(self.stdin, select.POLLOUT)
1592
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001593 # Only create this mapping if we haven't already.
1594 if not self._communication_started:
1595 self._fd2output = {}
1596 if self.stdout:
1597 self._fd2output[self.stdout.fileno()] = []
1598 if self.stderr:
1599 self._fd2output[self.stderr.fileno()] = []
1600
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001601 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1602 if self.stdout:
1603 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001604 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001605 if self.stderr:
1606 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001607 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001608
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001609 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001610
1611 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001612 timeout = self._remaining_time(endtime)
1613 if timeout is not None and timeout < 0:
1614 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001615 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001616 ready = poller.poll(timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001617 except OSError as e:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001618 if e.args[0] == errno.EINTR:
1619 continue
1620 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001621 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001622
1623 # XXX Rewrite these to use non-blocking I/O on the
1624 # file objects; they are no longer using C stdio!
1625
1626 for fd, mode in ready:
1627 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001628 chunk = self._input[self._input_offset :
1629 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001630 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001631 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001632 except OSError as e:
1633 if e.errno == errno.EPIPE:
1634 close_unregister_and_remove(fd)
1635 else:
1636 raise
1637 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001638 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001639 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001640 elif mode & select_POLLIN_POLLPRI:
1641 data = os.read(fd, 4096)
1642 if not data:
1643 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001644 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001645 else:
1646 # Ignore hang up or errors.
1647 close_unregister_and_remove(fd)
1648
1649 return (stdout, stderr)
1650
1651
Reid Kleckner2b228f02011-03-16 16:57:54 -04001652 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001653 if not self._communication_started:
1654 self._read_set = []
1655 self._write_set = []
1656 if self.stdin and input:
1657 self._write_set.append(self.stdin)
1658 if self.stdout:
1659 self._read_set.append(self.stdout)
1660 if self.stderr:
1661 self._read_set.append(self.stderr)
1662
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001663 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001664
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001665 stdout = None # Return
1666 stderr = None # Return
1667
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001668 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001669 if not self._communication_started:
1670 self._stdout_buff = []
1671 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001672 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001673 if not self._communication_started:
1674 self._stderr_buff = []
1675 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001676
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001677 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001678 timeout = self._remaining_time(endtime)
1679 if timeout is not None and timeout < 0:
1680 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001681 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001682 (rlist, wlist, xlist) = \
1683 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001684 timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001685 except OSError as e:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001686 if e.args[0] == errno.EINTR:
1687 continue
1688 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001689
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001690 # According to the docs, returning three empty lists indicates
1691 # that the timeout expired.
1692 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001693 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001694 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001695 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001696
Guido van Rossum98297ee2007-11-06 21:34:58 +00001697 # XXX Rewrite these to use non-blocking I/O on the
1698 # file objects; they are no longer using C stdio!
1699
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001700 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001701 chunk = self._input[self._input_offset :
1702 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001703 try:
1704 bytes_written = os.write(self.stdin.fileno(), chunk)
1705 except OSError as e:
1706 if e.errno == errno.EPIPE:
1707 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001708 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001709 else:
1710 raise
1711 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001712 self._input_offset += bytes_written
1713 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001714 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001715 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001716
1717 if self.stdout in rlist:
1718 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001719 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001720 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001721 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001722 stdout.append(data)
1723
1724 if self.stderr in rlist:
1725 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001726 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001727 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001728 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001729 stderr.append(data)
1730
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001731 return (stdout, stderr)
1732
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001733
Christian Heimesa342c012008-04-20 21:01:16 +00001734 def send_signal(self, sig):
1735 """Send a signal to the process
1736 """
1737 os.kill(self.pid, sig)
1738
1739 def terminate(self):
1740 """Terminate the process with SIGTERM
1741 """
1742 self.send_signal(signal.SIGTERM)
1743
1744 def kill(self):
1745 """Kill the process with SIGKILL
1746 """
1747 self.send_signal(signal.SIGKILL)