blob: 3d77b263f53e646a916cabdc386165c92d973d6e [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
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
Ronald Oussoren385521c2013-07-07 09:26:45 +0200107If universal_newlines is false, the file objects stdin, stdout and stderr
108are opened as binary files, and no line ending conversion is done.
109
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110If universal_newlines is true, the file objects stdout and stderr are
111opened as a text files, 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
118The startupinfo and creationflags, if given, will be passed to the
119underlying CreateProcess() function. They can specify things such as
120appearance of the main window and priority for the new process.
121(Windows only)
122
123
Georg Brandlf9734072008-12-07 15:30:06 +0000124This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125
Peter Astrand5f5e1412004-12-05 20:15:36 +0000126call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000127 Run command with arguments. Wait for command to complete, then
128 return the returncode attribute.
129
130 The arguments are the same as for the Popen constructor. Example:
131
Florent Xicluna4886d242010-03-08 13:27:26 +0000132 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000133
Peter Astrand454f7672005-01-01 09:36:35 +0000134check_call(*popenargs, **kwargs):
135 Run command with arguments. Wait for command to complete. If the
136 exit code was zero then return, otherwise raise
137 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000138 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000139
140 The arguments are the same as for the Popen constructor. Example:
141
Florent Xicluna4886d242010-03-08 13:27:26 +0000142 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000143 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000144
Brett Cannona23810f2008-05-26 19:04:21 +0000145getstatusoutput(cmd):
146 Return (status, output) of executing cmd in a shell.
147
148 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
149 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
150 returned output will contain output or error messages. A trailing newline
151 is stripped from the output. The exit status for the command can be
152 interpreted according to the rules for the C function wait(). Example:
153
Brett Cannona23810f2008-05-26 19:04:21 +0000154 >>> subprocess.getstatusoutput('ls /bin/ls')
155 (0, '/bin/ls')
156 >>> subprocess.getstatusoutput('cat /bin/junk')
157 (256, 'cat: /bin/junk: No such file or directory')
158 >>> subprocess.getstatusoutput('/bin/junk')
159 (256, 'sh: /bin/junk: not found')
160
161getoutput(cmd):
162 Return output (stdout or stderr) of executing cmd in a shell.
163
164 Like getstatusoutput(), except the exit status is ignored and the return
165 value is a string containing the command's output. Example:
166
Brett Cannona23810f2008-05-26 19:04:21 +0000167 >>> subprocess.getoutput('ls /bin/ls')
168 '/bin/ls'
169
Georg Brandlf9734072008-12-07 15:30:06 +0000170check_output(*popenargs, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700171 Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000172
Georg Brandl2708f3a2009-12-20 14:38:23 +0000173 If the exit code was non-zero it raises a CalledProcessError. The
174 CalledProcessError object will have the return code in the returncode
175 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Georg Brandl2708f3a2009-12-20 14:38:23 +0000179 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000180
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300181 There is an additional optional argument, "input", allowing you to
182 pass a string to the subprocess's stdin. If you use this argument
183 you may not also use the Popen constructor's "stdin" argument.
Brett Cannona23810f2008-05-26 19:04:21 +0000184
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000185Exceptions
186----------
187Exceptions raised in the child process, before the new program has
188started to execute, will be re-raised in the parent. Additionally,
189the exception object will have one extra attribute called
190'child_traceback', which is a string containing traceback information
191from the childs point of view.
192
193The most common exception raised is OSError. This occurs, for
194example, when trying to execute a non-existent file. Applications
195should prepare for OSErrors.
196
197A ValueError will be raised if Popen is called with invalid arguments.
198
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400199Exceptions defined within this module inherit from SubprocessError.
200check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400201called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400202be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000203
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000204
205Security
206--------
207Unlike some other popen functions, this implementation will never call
208/bin/sh implicitly. This means that all characters, including shell
209metacharacters, can safely be passed to child processes.
210
211
212Popen objects
213=============
214Instances of the Popen class have the following methods:
215
216poll()
217 Check if child process has terminated. Returns returncode
218 attribute.
219
220wait()
221 Wait for child process to terminate. Returns returncode attribute.
222
223communicate(input=None)
224 Interact with process: Send data to stdin. Read data from stdout
225 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000226 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000227 sent to the child process, or None, if no data should be sent to
228 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000229
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000230 communicate() returns a tuple (stdout, stderr).
231
232 Note: The data read is buffered in memory, so do not use this
233 method if the data size is large or unlimited.
234
235The following attributes are also available:
236
237stdin
238 If the stdin argument is PIPE, this attribute is a file object
239 that provides input to the child process. Otherwise, it is None.
240
241stdout
242 If the stdout argument is PIPE, this attribute is a file object
243 that provides output from the child process. Otherwise, it is
244 None.
245
246stderr
247 If the stderr argument is PIPE, this attribute is file object that
248 provides error output from the child process. Otherwise, it is
249 None.
250
251pid
252 The process ID of the child process.
253
254returncode
255 The child return code. A None value indicates that the process
256 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000257 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000258
259
260Replacing older functions with the subprocess module
261====================================================
262In this section, "a ==> b" means that b can be used as a replacement
263for a.
264
265Note: All functions in this section fail (more or less) silently if
266the executed program cannot be found; this module raises an OSError
267exception.
268
269In the following examples, we assume that the subprocess module is
270imported with "from subprocess import *".
271
272
273Replacing /bin/sh shell backquote
274---------------------------------
275output=`mycmd myarg`
276==>
277output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
278
279
280Replacing shell pipe line
281-------------------------
282output=`dmesg | grep hda`
283==>
284p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000285p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000286output = p2.communicate()[0]
287
288
289Replacing os.system()
290---------------------
291sts = os.system("mycmd" + " myarg")
292==>
293p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000294pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000295
296Note:
297
298* Calling the program through the shell is usually not required.
299
300* It's easier to look at the returncode attribute than the
301 exitstatus.
302
303A more real-world example would look like this:
304
305try:
306 retcode = call("mycmd" + " myarg", shell=True)
307 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000308 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000309 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000310 print("Child returned", retcode, file=sys.stderr)
311except OSError as e:
312 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000313
314
315Replacing os.spawn*
316-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000317P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000318
319pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
320==>
321pid = Popen(["/bin/mycmd", "myarg"]).pid
322
323
324P_WAIT example:
325
326retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
327==>
328retcode = call(["/bin/mycmd", "myarg"])
329
330
Tim Peterse718f612004-10-12 21:51:32 +0000331Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000332
333os.spawnvp(os.P_NOWAIT, path, args)
334==>
335Popen([path] + args[1:])
336
337
Tim Peterse718f612004-10-12 21:51:32 +0000338Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000339
340os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
341==>
342Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000343"""
344
345import sys
346mswindows = (sys.platform == "win32")
347
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000348import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000349import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400350import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000351import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000352import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000353import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000354import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000355import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200356import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200357try:
358 from time import monotonic as _time
Brett Cannoncd171c82013-07-04 17:43:24 -0400359except ImportError:
Victor Stinner949d8c92012-05-30 13:30:32 +0200360 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000361
Peter Astrand454f7672005-01-01 09:36:35 +0000362# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400363class SubprocessError(Exception): pass
364
365
366class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000367 """This exception is raised when a process run by check_call() or
368 check_output() returns a non-zero exit status.
369 The exit status will be stored in the returncode attribute;
370 check_output() will also store the output in the output attribute.
371 """
372 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000373 self.returncode = returncode
374 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000375 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000376 def __str__(self):
377 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
378
Peter Astrand454f7672005-01-01 09:36:35 +0000379
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400380class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400381 """This exception is raised when the timeout expires while waiting for a
382 child process.
383 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400384 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400385 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400386 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400387 self.output = output
388
389 def __str__(self):
390 return ("Command '%s' timed out after %s seconds" %
391 (self.cmd, self.timeout))
392
393
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000394if mswindows:
395 import threading
396 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200397 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000398 class STARTUPINFO:
399 dwFlags = 0
400 hStdInput = None
401 hStdOutput = None
402 hStdError = None
403 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000404else:
405 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000406 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700407 import _posixsubprocess
408 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000409
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000410 # When select or poll has indicated that the file is writable,
411 # we can write up to _PIPE_BUF bytes without risk of blocking.
412 # POSIX defines PIPE_BUF as >= 512.
413 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
414
415
Brett Cannona23810f2008-05-26 19:04:21 +0000416__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200417 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000418
Brian Curtin1ce6b582010-04-24 16:19:22 +0000419if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200420 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
421 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
422 STD_ERROR_HANDLE, SW_HIDE,
423 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500424
Brian Curtin08fd8d92011-04-29 16:11:30 -0500425 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500426 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
427 "STD_ERROR_HANDLE", "SW_HIDE",
428 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200429
430 class Handle(int):
431 closed = False
432
433 def Close(self, CloseHandle=_winapi.CloseHandle):
434 if not self.closed:
435 self.closed = True
436 CloseHandle(self)
437
438 def Detach(self):
439 if not self.closed:
440 self.closed = True
441 return int(self)
442 raise ValueError("already closed")
443
444 def __repr__(self):
445 return "Handle(%d)" % int(self)
446
447 __del__ = Close
448 __str__ = __repr__
449
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000450try:
451 MAXFD = os.sysconf("SC_OPEN_MAX")
452except:
453 MAXFD = 256
454
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200455# This lists holds Popen instances for which the underlying process had not
456# exited at the time its __del__ method got called: those processes are wait()ed
457# for synchronously from _cleanup() when a new Popen object is created, to avoid
458# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000459_active = []
460
461def _cleanup():
462 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000463 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200464 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000465 try:
466 _active.remove(inst)
467 except ValueError:
468 # This can happen if two threads create a new Popen instance.
469 # It's harmless that it was already removed, so ignore.
470 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000471
472PIPE = -1
473STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200474DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000475
476
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000477def _eintr_retry_call(func, *args):
478 while True:
479 try:
480 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200481 except InterruptedError:
482 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000483
484
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200485# XXX This function is only used by multiprocessing and the test suite,
486# but it's here so that it can be imported when Python is compiled without
487# threads.
488
489def _args_from_interpreter_flags():
490 """Return a list of command-line arguments reproducing the current
491 settings in sys.flags and sys.warnoptions."""
492 flag_opt_map = {
493 'debug': 'd',
494 # 'inspect': 'i',
495 # 'interactive': 'i',
496 'optimize': 'O',
497 'dont_write_bytecode': 'B',
498 'no_user_site': 's',
499 'no_site': 'S',
500 'ignore_environment': 'E',
501 'verbose': 'v',
502 'bytes_warning': 'b',
503 'quiet': 'q',
504 'hash_randomization': 'R',
505 }
506 args = []
507 for flag, opt in flag_opt_map.items():
508 v = getattr(sys.flags, flag)
509 if v > 0:
510 args.append('-' + opt * v)
511 for opt in sys.warnoptions:
512 args.append('-W' + opt)
513 return args
514
515
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400516def call(*popenargs, timeout=None, **kwargs):
517 """Run command with arguments. Wait for command to complete or
518 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000519
520 The arguments are the same as for the Popen constructor. Example:
521
522 retcode = call(["ls", "-l"])
523 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200524 with Popen(*popenargs, **kwargs) as p:
525 try:
526 return p.wait(timeout=timeout)
527 except:
528 p.kill()
529 p.wait()
530 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000531
532
Peter Astrand454f7672005-01-01 09:36:35 +0000533def check_call(*popenargs, **kwargs):
534 """Run command with arguments. Wait for command to complete. If
535 the exit code was zero then return, otherwise raise
536 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000537 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000538
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400539 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000540
541 check_call(["ls", "-l"])
542 """
543 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000544 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000545 cmd = kwargs.get("args")
546 if cmd is None:
547 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000548 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000549 return 0
550
551
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400552def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700553 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000554
555 If the exit code was non-zero it raises a CalledProcessError. The
556 CalledProcessError object will have the return code in the returncode
557 attribute and output in the output attribute.
558
559 The arguments are the same as for the Popen constructor. Example:
560
561 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000562 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000563
564 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000565 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000566
567 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000568 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000569 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000570 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700571
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300572 There is an additional optional argument, "input", allowing you to
573 pass a string to the subprocess's stdin. If you use this argument
574 you may not also use the Popen constructor's "stdin" argument, as
575 it too will be used internally. Example:
576
577 >>> check_output(["sed", "-e", "s/foo/bar/"],
578 ... input=b"when in the course of fooman events\n")
579 b'when in the course of barman events\n'
580
Gregory P. Smith91110f52013-03-19 23:25:16 -0700581 If universal_newlines=True is passed, the return value will be a
582 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000583 """
584 if 'stdout' in kwargs:
585 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300586 if 'input' in kwargs:
587 if 'stdin' in kwargs:
588 raise ValueError('stdin and input arguments may not both be used.')
589 inputdata = kwargs['input']
590 del kwargs['input']
591 kwargs['stdin'] = PIPE
592 else:
593 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200594 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
595 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300596 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200597 except TimeoutExpired:
598 process.kill()
599 output, unused_err = process.communicate()
600 raise TimeoutExpired(process.args, timeout, output=output)
601 except:
602 process.kill()
603 process.wait()
604 raise
605 retcode = process.poll()
606 if retcode:
607 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000608 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000609
610
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000611def list2cmdline(seq):
612 """
613 Translate a sequence of arguments into a command line
614 string, using the same rules as the MS C runtime:
615
616 1) Arguments are delimited by white space, which is either a
617 space or a tab.
618
619 2) A string surrounded by double quotation marks is
620 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000621 contained within. A quoted string can be embedded in an
622 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000623
624 3) A double quotation mark preceded by a backslash is
625 interpreted as a literal double quotation mark.
626
627 4) Backslashes are interpreted literally, unless they
628 immediately precede a double quotation mark.
629
630 5) If backslashes immediately precede a double quotation mark,
631 every pair of backslashes is interpreted as a literal
632 backslash. If the number of backslashes is odd, the last
633 backslash escapes the next double quotation mark as
634 described in rule 3.
635 """
636
637 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000638 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
639 # or search http://msdn.microsoft.com for
640 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000641 result = []
642 needquote = False
643 for arg in seq:
644 bs_buf = []
645
646 # Add a space to separate this argument from the others
647 if result:
648 result.append(' ')
649
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000650 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000651 if needquote:
652 result.append('"')
653
654 for c in arg:
655 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000656 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000657 bs_buf.append(c)
658 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000659 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000660 result.append('\\' * len(bs_buf)*2)
661 bs_buf = []
662 result.append('\\"')
663 else:
664 # Normal char
665 if bs_buf:
666 result.extend(bs_buf)
667 bs_buf = []
668 result.append(c)
669
Christian Heimesfdab48e2008-01-20 09:06:41 +0000670 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000671 if bs_buf:
672 result.extend(bs_buf)
673
674 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000675 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000676 result.append('"')
677
678 return ''.join(result)
679
680
Brett Cannona23810f2008-05-26 19:04:21 +0000681# Various tools for executing commands and looking at their output and status.
682#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000683# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000684
685def getstatusoutput(cmd):
686 """Return (status, output) of executing cmd in a shell.
687
688 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
689 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
690 returned output will contain output or error messages. A trailing newline
691 is stripped from the output. The exit status for the command can be
692 interpreted according to the rules for the C function wait(). Example:
693
694 >>> import subprocess
695 >>> subprocess.getstatusoutput('ls /bin/ls')
696 (0, '/bin/ls')
697 >>> subprocess.getstatusoutput('cat /bin/junk')
698 (256, 'cat: /bin/junk: No such file or directory')
699 >>> subprocess.getstatusoutput('/bin/junk')
700 (256, 'sh: /bin/junk: not found')
701 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200702 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
703 try:
704 text = pipe.read()
705 sts = pipe.close()
706 except:
707 process = pipe._proc
708 process.kill()
709 process.wait()
710 raise
711 if sts is None:
712 sts = 0
713 if text[-1:] == '\n':
714 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000715 return sts, text
716
717
718def getoutput(cmd):
719 """Return output (stdout or stderr) of executing cmd in a shell.
720
721 Like getstatusoutput(), except the exit status is ignored and the return
722 value is a string containing the command's output. Example:
723
724 >>> import subprocess
725 >>> subprocess.getoutput('ls /bin/ls')
726 '/bin/ls'
727 """
728 return getstatusoutput(cmd)[1]
729
730
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000731_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000732
733
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000734class Popen(object):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700735 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000736 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000737 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
738 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000739 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000740 restore_signals=True, start_new_session=False,
741 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000742 """Create new Popen instance."""
743 _cleanup()
744
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000745 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400746 self._input = None
747 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000748 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700749 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000750 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000751 raise TypeError("bufsize must be an integer")
752
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000754 if preexec_fn is not None:
755 raise ValueError("preexec_fn is not supported on Windows "
756 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000757 any_stdio_set = (stdin is not None or stdout is not None or
758 stderr is not None)
759 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
760 if any_stdio_set:
761 close_fds = False
762 else:
763 close_fds = True
764 elif close_fds and any_stdio_set:
765 raise ValueError(
766 "close_fds is not supported on Windows platforms"
767 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000768 else:
769 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000770 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
771 close_fds = True
772 if pass_fds and not close_fds:
773 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
774 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000775 if startupinfo is not None:
776 raise ValueError("startupinfo is only supported on Windows "
777 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000778 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000779 raise ValueError("creationflags is only supported on Windows "
780 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000781
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400782 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000783 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000784 self.stdout = None
785 self.stderr = None
786 self.pid = None
787 self.returncode = None
788 self.universal_newlines = universal_newlines
789
790 # Input and output objects. The general principle is like
791 # this:
792 #
793 # Parent Child
794 # ------ -----
795 # p2cwrite ---stdin---> p2cread
796 # c2pread <--stdout--- c2pwrite
797 # errread <--stderr--- errwrite
798 #
799 # On POSIX, the child objects are file descriptors. On
800 # Windows, these are Windows file handles. The parent objects
801 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000802 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000803 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000804
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000805 (p2cread, p2cwrite,
806 c2pread, c2pwrite,
807 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
808
Antoine Pitrouc9982322011-01-04 19:07:07 +0000809 # We wrap OS handles *before* launching the child, otherwise a
810 # quickly terminating child could make our fds unwrappable
811 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000812
Thomas Wouterscf297e42007-02-23 15:07:44 +0000813 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000814 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000815 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000816 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000817 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000818 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000819 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000820
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000821 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000822 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300823 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200824 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000825 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000826 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000827 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000828 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000829 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000830 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000831 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000832 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000833
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700834 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000835 try:
836 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300837 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000838 startupinfo, creationflags, shell,
839 p2cread, p2cwrite,
840 c2pread, c2pwrite,
841 errread, errwrite,
842 restore_signals, start_new_session)
843 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800844 # Cleanup if the child failed starting.
845 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000846 try:
847 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200848 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800849 pass # Ignore EBADF or other errors.
850
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700851 if not self._closed_child_pipe_fds:
852 to_close = []
853 if stdin == PIPE:
854 to_close.append(p2cread)
855 if stdout == PIPE:
856 to_close.append(c2pwrite)
857 if stderr == PIPE:
858 to_close.append(errwrite)
859 if hasattr(self, '_devnull'):
860 to_close.append(self._devnull)
861 for fd in to_close:
862 try:
863 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700864 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700865 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800866
Antoine Pitrouc9982322011-01-04 19:07:07 +0000867 raise
868
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000869
Guido van Rossum98297ee2007-11-06 21:34:58 +0000870 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300871 data = data.decode(encoding)
872 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000873
Brian Curtin79cdb662010-12-03 02:46:02 +0000874 def __enter__(self):
875 return self
876
877 def __exit__(self, type, value, traceback):
878 if self.stdout:
879 self.stdout.close()
880 if self.stderr:
881 self.stderr.close()
882 if self.stdin:
883 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700884 # Wait for the process to terminate, to avoid zombies.
885 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000886
Brett Cannon84df1e62010-05-14 00:33:40 +0000887 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200888 # If __init__ hasn't had a chance to execute (e.g. if it
889 # was passed an undeclared keyword argument), we don't
890 # have a _child_created attribute at all.
891 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000892 # We didn't get to successfully create a child process.
893 return
894 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000895 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000896 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000897 # Child is still running, keep us alive until we can wait on it.
898 _active.append(self)
899
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200900 def _get_devnull(self):
901 if not hasattr(self, '_devnull'):
902 self._devnull = os.open(os.devnull, os.O_RDWR)
903 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000904
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400905 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000906 """Interact with process: Send data to stdin. Read data from
907 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700908 process to terminate. The optional input argument should be
909 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000910 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000911
Peter Astrand23109f02005-03-03 20:28:59 +0000912 communicate() returns a tuple (stdout, stderr)."""
913
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400914 if self._communication_started and input:
915 raise ValueError("Cannot send input after starting communication")
916
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400917 # Optimization: If we are not worried about timeouts, we haven't
918 # started communicating, and we have one or zero pipes, using select()
919 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200920 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400921 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000922 stdout = None
923 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000924 if self.stdin:
925 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200926 try:
927 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200928 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200929 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
930 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000931 self.stdin.close()
932 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200933 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000934 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000935 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200936 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000937 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000938 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200939 else:
940 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200941 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200942 else:
943 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000944
Victor Stinner7a8d0812011-04-05 13:13:08 +0200945 try:
946 stdout, stderr = self._communicate(input, endtime, timeout)
947 finally:
948 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400949
Victor Stinner7a8d0812011-04-05 13:13:08 +0200950 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400951
952 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000953
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000954
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000955 def poll(self):
956 return self._internal_poll()
957
958
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400959 def _remaining_time(self, endtime):
960 """Convenience for _communicate when computing timeouts."""
961 if endtime is None:
962 return None
963 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200964 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400965
966
Reid Kleckner2b228f02011-03-16 16:57:54 -0400967 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400968 """Convenience for checking if a timeout has expired."""
969 if endtime is None:
970 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200971 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400972 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400973
974
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000975 if mswindows:
976 #
977 # Windows methods
978 #
979 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000980 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000981 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
982 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000983 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000984 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000985
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000986 p2cread, p2cwrite = -1, -1
987 c2pread, c2pwrite = -1, -1
988 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000989
Peter Astrandd38ddf42005-02-10 08:32:50 +0000990 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200991 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000992 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200993 p2cread, _ = _winapi.CreatePipe(None, 0)
994 p2cread = Handle(p2cread)
995 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000996 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200997 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
998 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200999 elif stdin == DEVNULL:
1000 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001001 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001002 p2cread = msvcrt.get_osfhandle(stdin)
1003 else:
1004 # Assuming file-like object
1005 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1006 p2cread = self._make_inheritable(p2cread)
1007
Peter Astrandd38ddf42005-02-10 08:32:50 +00001008 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001009 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001010 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001011 _, c2pwrite = _winapi.CreatePipe(None, 0)
1012 c2pwrite = Handle(c2pwrite)
1013 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001014 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001015 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1016 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001017 elif stdout == DEVNULL:
1018 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001019 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001020 c2pwrite = msvcrt.get_osfhandle(stdout)
1021 else:
1022 # Assuming file-like object
1023 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1024 c2pwrite = self._make_inheritable(c2pwrite)
1025
Peter Astrandd38ddf42005-02-10 08:32:50 +00001026 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001027 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001028 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001029 _, errwrite = _winapi.CreatePipe(None, 0)
1030 errwrite = Handle(errwrite)
1031 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001032 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001033 errread, errwrite = _winapi.CreatePipe(None, 0)
1034 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001035 elif stderr == STDOUT:
1036 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001037 elif stderr == DEVNULL:
1038 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001039 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001040 errwrite = msvcrt.get_osfhandle(stderr)
1041 else:
1042 # Assuming file-like object
1043 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1044 errwrite = self._make_inheritable(errwrite)
1045
1046 return (p2cread, p2cwrite,
1047 c2pread, c2pwrite,
1048 errread, errwrite)
1049
1050
1051 def _make_inheritable(self, handle):
1052 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001053 h = _winapi.DuplicateHandle(
1054 _winapi.GetCurrentProcess(), handle,
1055 _winapi.GetCurrentProcess(), 0, 1,
1056 _winapi.DUPLICATE_SAME_ACCESS)
1057 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001058
1059
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001060 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001061 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001062 startupinfo, creationflags, shell,
1063 p2cread, p2cwrite,
1064 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001065 errread, errwrite,
1066 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001067 """Execute program (MS Windows version)"""
1068
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001069 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001070
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001071 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001072 args = list2cmdline(args)
1073
Peter Astrandc1d65362004-11-07 14:30:34 +00001074 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001075 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001076 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001077 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001078 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001079 startupinfo.hStdInput = p2cread
1080 startupinfo.hStdOutput = c2pwrite
1081 startupinfo.hStdError = errwrite
1082
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001083 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001084 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1085 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001086 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001087 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001088
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001089 # Start the process
1090 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001091 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001092 # no special security
1093 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001094 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001095 creationflags,
1096 env,
1097 cwd,
1098 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001099 finally:
1100 # Child is launched. Close the parent's copy of those pipe
1101 # handles that only the child should have open. You need
1102 # to make sure that no handles to the write end of the
1103 # output pipe are maintained in this process or else the
1104 # pipe will not close when the child process exits and the
1105 # ReadFile will hang.
1106 if p2cread != -1:
1107 p2cread.Close()
1108 if c2pwrite != -1:
1109 c2pwrite.Close()
1110 if errwrite != -1:
1111 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001112 if hasattr(self, '_devnull'):
1113 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114
1115 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001116 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001117 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001118 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001119 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001120
Brett Cannon84df1e62010-05-14 00:33:40 +00001121 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001122 _WaitForSingleObject=_winapi.WaitForSingleObject,
1123 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1124 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001125 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001126 attribute.
1127
1128 This method is called by __del__, so it can only refer to objects
1129 in its local scope.
1130
1131 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001132 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001133 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1134 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001135 return self.returncode
1136
1137
Reid Kleckner2b228f02011-03-16 16:57:54 -04001138 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001139 """Wait for child process to terminate. Returns returncode
1140 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001141 if endtime is not None:
1142 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001143 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001144 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001145 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001146 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001147 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001148 result = _winapi.WaitForSingleObject(self._handle,
1149 timeout_millis)
1150 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001151 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001152 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001153 return self.returncode
1154
1155
1156 def _readerthread(self, fh, buffer):
1157 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001158 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001159
1160
Reid Kleckner2b228f02011-03-16 16:57:54 -04001161 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001162 # Start reader threads feeding into a list hanging off of this
1163 # object, unless they've already been started.
1164 if self.stdout and not hasattr(self, "_stdout_buff"):
1165 self._stdout_buff = []
1166 self.stdout_thread = \
1167 threading.Thread(target=self._readerthread,
1168 args=(self.stdout, self._stdout_buff))
1169 self.stdout_thread.daemon = True
1170 self.stdout_thread.start()
1171 if self.stderr and not hasattr(self, "_stderr_buff"):
1172 self._stderr_buff = []
1173 self.stderr_thread = \
1174 threading.Thread(target=self._readerthread,
1175 args=(self.stderr, self._stderr_buff))
1176 self.stderr_thread.daemon = True
1177 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001178
1179 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001180 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001181 try:
1182 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001183 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001184 if e.errno != errno.EPIPE:
1185 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001186 self.stdin.close()
1187
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001188 # Wait for the reader threads, or time out. If we time out, the
1189 # threads remain reading and the fds left open in case the user
1190 # calls communicate again.
1191 if self.stdout is not None:
1192 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001193 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001194 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001195 if self.stderr is not None:
1196 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001197 if self.stderr_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
1200 # Collect the output from and close both pipes, now that we know
1201 # both have been read successfully.
1202 stdout = None
1203 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001204 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001205 stdout = self._stdout_buff
1206 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001207 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001208 stderr = self._stderr_buff
1209 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001210
1211 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001212 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001213 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001214 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001215 stderr = stderr[0]
1216
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001217 return (stdout, stderr)
1218
Christian Heimesa342c012008-04-20 21:01:16 +00001219 def send_signal(self, sig):
1220 """Send a signal to the process
1221 """
1222 if sig == signal.SIGTERM:
1223 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001224 elif sig == signal.CTRL_C_EVENT:
1225 os.kill(self.pid, signal.CTRL_C_EVENT)
1226 elif sig == signal.CTRL_BREAK_EVENT:
1227 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001228 else:
Brian Curtin19651362010-09-07 13:24:38 +00001229 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001230
1231 def terminate(self):
1232 """Terminates the process
1233 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001234 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001235 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001236 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001237 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1238 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001239 rc = _winapi.GetExitCodeProcess(self._handle)
1240 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001241 raise
1242 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001243
1244 kill = terminate
1245
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001246 else:
1247 #
1248 # POSIX methods
1249 #
1250 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001251 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001252 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1253 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001254 p2cread, p2cwrite = -1, -1
1255 c2pread, c2pwrite = -1, -1
1256 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001257
Peter Astrandd38ddf42005-02-10 08:32:50 +00001258 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001259 pass
1260 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001261 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001262 elif stdin == DEVNULL:
1263 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001264 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001265 p2cread = stdin
1266 else:
1267 # Assuming file-like object
1268 p2cread = stdin.fileno()
1269
Peter Astrandd38ddf42005-02-10 08:32:50 +00001270 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001271 pass
1272 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001273 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001274 elif stdout == DEVNULL:
1275 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001276 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001277 c2pwrite = stdout
1278 else:
1279 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001280 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001281
Peter Astrandd38ddf42005-02-10 08:32:50 +00001282 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001283 pass
1284 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001285 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001286 elif stderr == STDOUT:
1287 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001288 elif stderr == DEVNULL:
1289 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001290 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001291 errwrite = stderr
1292 else:
1293 # Assuming file-like object
1294 errwrite = stderr.fileno()
1295
1296 return (p2cread, p2cwrite,
1297 c2pread, c2pwrite,
1298 errread, errwrite)
1299
1300
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001301 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001302 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001303 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001304 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001305 os.closerange(start_fd, fd)
1306 start_fd = fd + 1
1307 if start_fd <= MAXFD:
1308 os.closerange(start_fd, MAXFD)
1309
1310
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001311 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001312 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001313 startupinfo, creationflags, shell,
1314 p2cread, p2cwrite,
1315 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001316 errread, errwrite,
1317 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001318 """Execute program (POSIX version)"""
1319
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001320 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001321 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001322 else:
1323 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001324
1325 if shell:
1326 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001327 if executable:
1328 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001329
Peter Astrandd38ddf42005-02-10 08:32:50 +00001330 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001332 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001334 # For transferring possible exec failure from child to parent.
1335 # Data format: "exception name:hex errno:description"
1336 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001337 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001338 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001339 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001340 # We must avoid complex work that could involve
1341 # malloc or free in the child process to avoid
1342 # potential deadlocks, thus we do all this here.
1343 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344
Victor Stinner372b8382011-06-21 17:24:21 +02001345 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001346 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1347 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001348 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001349 env_list = None # Use execv instead of execve.
1350 executable = os.fsencode(executable)
1351 if os.path.dirname(executable):
1352 executable_list = (executable,)
1353 else:
1354 # This matches the behavior of os._execvpe().
1355 executable_list = tuple(
1356 os.path.join(os.fsencode(dir), executable)
1357 for dir in os.get_exec_path(env))
1358 fds_to_keep = set(pass_fds)
1359 fds_to_keep.add(errpipe_write)
1360 self.pid = _posixsubprocess.fork_exec(
1361 args, executable_list,
1362 close_fds, sorted(fds_to_keep), cwd, env_list,
1363 p2cread, p2cwrite, c2pread, c2pwrite,
1364 errread, errwrite,
1365 errpipe_read, errpipe_write,
1366 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001367 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001368 finally:
1369 # be sure the FD is closed no matter what
1370 os.close(errpipe_write)
1371
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001372 # self._devnull is not always defined.
1373 devnull_fd = getattr(self, '_devnull', None)
1374 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001375 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001376 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001377 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001378 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001379 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001380 if devnull_fd is not None:
1381 os.close(devnull_fd)
1382 # Prevent a double close of these fds from __init__ on error.
1383 self._closed_child_pipe_fds = True
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,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001447 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
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)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001460 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001461 if _deadstate is not None:
1462 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001463 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001464 # 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)