blob: 4ce3c929d6b70ad082e47649cde19c72378854ce [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
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300191from the child's point of view.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000192
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
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000408
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000409 # When select or poll has indicated that the file is writable,
410 # we can write up to _PIPE_BUF bytes without risk of blocking.
411 # POSIX defines PIPE_BUF as >= 512.
412 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
413
414
Brett Cannona23810f2008-05-26 19:04:21 +0000415__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200416 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000417
Brian Curtin1ce6b582010-04-24 16:19:22 +0000418if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200419 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
420 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
421 STD_ERROR_HANDLE, SW_HIDE,
422 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500423
Brian Curtin08fd8d92011-04-29 16:11:30 -0500424 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500425 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
426 "STD_ERROR_HANDLE", "SW_HIDE",
427 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200428
429 class Handle(int):
430 closed = False
431
432 def Close(self, CloseHandle=_winapi.CloseHandle):
433 if not self.closed:
434 self.closed = True
435 CloseHandle(self)
436
437 def Detach(self):
438 if not self.closed:
439 self.closed = True
440 return int(self)
441 raise ValueError("already closed")
442
443 def __repr__(self):
444 return "Handle(%d)" % int(self)
445
446 __del__ = Close
447 __str__ = __repr__
448
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000449try:
450 MAXFD = os.sysconf("SC_OPEN_MAX")
451except:
452 MAXFD = 256
453
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200454# This lists holds Popen instances for which the underlying process had not
455# exited at the time its __del__ method got called: those processes are wait()ed
456# for synchronously from _cleanup() when a new Popen object is created, to avoid
457# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000458_active = []
459
460def _cleanup():
461 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000462 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200463 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000464 try:
465 _active.remove(inst)
466 except ValueError:
467 # This can happen if two threads create a new Popen instance.
468 # It's harmless that it was already removed, so ignore.
469 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000470
471PIPE = -1
472STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200473DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000474
475
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000476def _eintr_retry_call(func, *args):
477 while True:
478 try:
479 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200480 except InterruptedError:
481 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000482
483
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200484# XXX This function is only used by multiprocessing and the test suite,
485# but it's here so that it can be imported when Python is compiled without
486# threads.
487
488def _args_from_interpreter_flags():
489 """Return a list of command-line arguments reproducing the current
490 settings in sys.flags and sys.warnoptions."""
491 flag_opt_map = {
492 'debug': 'd',
493 # 'inspect': 'i',
494 # 'interactive': 'i',
495 'optimize': 'O',
496 'dont_write_bytecode': 'B',
497 'no_user_site': 's',
498 'no_site': 'S',
499 'ignore_environment': 'E',
500 'verbose': 'v',
501 'bytes_warning': 'b',
502 'quiet': 'q',
503 'hash_randomization': 'R',
504 }
505 args = []
506 for flag, opt in flag_opt_map.items():
507 v = getattr(sys.flags, flag)
508 if v > 0:
509 args.append('-' + opt * v)
510 for opt in sys.warnoptions:
511 args.append('-W' + opt)
512 return args
513
514
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400515def call(*popenargs, timeout=None, **kwargs):
516 """Run command with arguments. Wait for command to complete or
517 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000518
519 The arguments are the same as for the Popen constructor. Example:
520
521 retcode = call(["ls", "-l"])
522 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200523 with Popen(*popenargs, **kwargs) as p:
524 try:
525 return p.wait(timeout=timeout)
526 except:
527 p.kill()
528 p.wait()
529 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000530
531
Peter Astrand454f7672005-01-01 09:36:35 +0000532def check_call(*popenargs, **kwargs):
533 """Run command with arguments. Wait for command to complete. If
534 the exit code was zero then return, otherwise raise
535 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000536 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000537
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400538 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000539
540 check_call(["ls", "-l"])
541 """
542 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000543 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000544 cmd = kwargs.get("args")
545 if cmd is None:
546 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000547 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000548 return 0
549
550
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400551def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700552 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000553
554 If the exit code was non-zero it raises a CalledProcessError. The
555 CalledProcessError object will have the return code in the returncode
556 attribute and output in the output attribute.
557
558 The arguments are the same as for the Popen constructor. Example:
559
560 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000561 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000562
563 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000564 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000565
566 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000567 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000568 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000569 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700570
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300571 There is an additional optional argument, "input", allowing you to
572 pass a string to the subprocess's stdin. If you use this argument
573 you may not also use the Popen constructor's "stdin" argument, as
574 it too will be used internally. Example:
575
576 >>> check_output(["sed", "-e", "s/foo/bar/"],
577 ... input=b"when in the course of fooman events\n")
578 b'when in the course of barman events\n'
579
Gregory P. Smith91110f52013-03-19 23:25:16 -0700580 If universal_newlines=True is passed, the return value will be a
581 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000582 """
583 if 'stdout' in kwargs:
584 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300585 if 'input' in kwargs:
586 if 'stdin' in kwargs:
587 raise ValueError('stdin and input arguments may not both be used.')
588 inputdata = kwargs['input']
589 del kwargs['input']
590 kwargs['stdin'] = PIPE
591 else:
592 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200593 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
594 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300595 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200596 except TimeoutExpired:
597 process.kill()
598 output, unused_err = process.communicate()
599 raise TimeoutExpired(process.args, timeout, output=output)
600 except:
601 process.kill()
602 process.wait()
603 raise
604 retcode = process.poll()
605 if retcode:
606 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000607 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000608
609
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000610def list2cmdline(seq):
611 """
612 Translate a sequence of arguments into a command line
613 string, using the same rules as the MS C runtime:
614
615 1) Arguments are delimited by white space, which is either a
616 space or a tab.
617
618 2) A string surrounded by double quotation marks is
619 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000620 contained within. A quoted string can be embedded in an
621 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000622
623 3) A double quotation mark preceded by a backslash is
624 interpreted as a literal double quotation mark.
625
626 4) Backslashes are interpreted literally, unless they
627 immediately precede a double quotation mark.
628
629 5) If backslashes immediately precede a double quotation mark,
630 every pair of backslashes is interpreted as a literal
631 backslash. If the number of backslashes is odd, the last
632 backslash escapes the next double quotation mark as
633 described in rule 3.
634 """
635
636 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000637 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
638 # or search http://msdn.microsoft.com for
639 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000640 result = []
641 needquote = False
642 for arg in seq:
643 bs_buf = []
644
645 # Add a space to separate this argument from the others
646 if result:
647 result.append(' ')
648
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000649 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000650 if needquote:
651 result.append('"')
652
653 for c in arg:
654 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000655 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000656 bs_buf.append(c)
657 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000658 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000659 result.append('\\' * len(bs_buf)*2)
660 bs_buf = []
661 result.append('\\"')
662 else:
663 # Normal char
664 if bs_buf:
665 result.extend(bs_buf)
666 bs_buf = []
667 result.append(c)
668
Christian Heimesfdab48e2008-01-20 09:06:41 +0000669 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000670 if bs_buf:
671 result.extend(bs_buf)
672
673 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000674 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000675 result.append('"')
676
677 return ''.join(result)
678
679
Brett Cannona23810f2008-05-26 19:04:21 +0000680# Various tools for executing commands and looking at their output and status.
681#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000682# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000683
684def getstatusoutput(cmd):
685 """Return (status, output) of executing cmd in a shell.
686
687 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
688 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
689 returned output will contain output or error messages. A trailing newline
690 is stripped from the output. The exit status for the command can be
691 interpreted according to the rules for the C function wait(). Example:
692
693 >>> import subprocess
694 >>> subprocess.getstatusoutput('ls /bin/ls')
695 (0, '/bin/ls')
696 >>> subprocess.getstatusoutput('cat /bin/junk')
697 (256, 'cat: /bin/junk: No such file or directory')
698 >>> subprocess.getstatusoutput('/bin/junk')
699 (256, 'sh: /bin/junk: not found')
700 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200701 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
702 try:
703 text = pipe.read()
704 sts = pipe.close()
705 except:
706 process = pipe._proc
707 process.kill()
708 process.wait()
709 raise
710 if sts is None:
711 sts = 0
712 if text[-1:] == '\n':
713 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000714 return sts, text
715
716
717def getoutput(cmd):
718 """Return output (stdout or stderr) of executing cmd in a shell.
719
720 Like getstatusoutput(), except the exit status is ignored and the return
721 value is a string containing the command's output. Example:
722
723 >>> import subprocess
724 >>> subprocess.getoutput('ls /bin/ls')
725 '/bin/ls'
726 """
727 return getstatusoutput(cmd)[1]
728
729
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000730_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000731
732
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000733class Popen(object):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700734 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000735 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000736 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
737 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000738 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000739 restore_signals=True, start_new_session=False,
740 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000741 """Create new Popen instance."""
742 _cleanup()
743
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000744 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400745 self._input = None
746 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000747 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700748 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000749 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000750 raise TypeError("bufsize must be an integer")
751
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000752 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000753 if preexec_fn is not None:
754 raise ValueError("preexec_fn is not supported on Windows "
755 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000756 any_stdio_set = (stdin is not None or stdout is not None or
757 stderr is not None)
758 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
759 if any_stdio_set:
760 close_fds = False
761 else:
762 close_fds = True
763 elif close_fds and any_stdio_set:
764 raise ValueError(
765 "close_fds is not supported on Windows platforms"
766 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000767 else:
768 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000769 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
770 close_fds = True
771 if pass_fds and not close_fds:
772 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
773 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000774 if startupinfo is not None:
775 raise ValueError("startupinfo is only supported on Windows "
776 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000777 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000778 raise ValueError("creationflags is only supported on Windows "
779 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400781 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000782 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000783 self.stdout = None
784 self.stderr = None
785 self.pid = None
786 self.returncode = None
787 self.universal_newlines = universal_newlines
788
789 # Input and output objects. The general principle is like
790 # this:
791 #
792 # Parent Child
793 # ------ -----
794 # p2cwrite ---stdin---> p2cread
795 # c2pread <--stdout--- c2pwrite
796 # errread <--stderr--- errwrite
797 #
798 # On POSIX, the child objects are file descriptors. On
799 # Windows, these are Windows file handles. The parent objects
800 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000801 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000802 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000803
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804 (p2cread, p2cwrite,
805 c2pread, c2pwrite,
806 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
807
Antoine Pitrouc9982322011-01-04 19:07:07 +0000808 # We wrap OS handles *before* launching the child, otherwise a
809 # quickly terminating child could make our fds unwrappable
810 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000811
Thomas Wouterscf297e42007-02-23 15:07:44 +0000812 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000813 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000814 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000815 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000816 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000817 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000818 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000819
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000820 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000821 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300822 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200823 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000824 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000825 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000826 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000827 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000828 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000829 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000830 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000831 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000832
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700833 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000834 try:
835 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300836 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000837 startupinfo, creationflags, shell,
838 p2cread, p2cwrite,
839 c2pread, c2pwrite,
840 errread, errwrite,
841 restore_signals, start_new_session)
842 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800843 # Cleanup if the child failed starting.
844 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000845 try:
846 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200847 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800848 pass # Ignore EBADF or other errors.
849
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700850 if not self._closed_child_pipe_fds:
851 to_close = []
852 if stdin == PIPE:
853 to_close.append(p2cread)
854 if stdout == PIPE:
855 to_close.append(c2pwrite)
856 if stderr == PIPE:
857 to_close.append(errwrite)
858 if hasattr(self, '_devnull'):
859 to_close.append(self._devnull)
860 for fd in to_close:
861 try:
862 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700863 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700864 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800865
Antoine Pitrouc9982322011-01-04 19:07:07 +0000866 raise
867
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000868
Guido van Rossum98297ee2007-11-06 21:34:58 +0000869 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300870 data = data.decode(encoding)
871 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000872
Brian Curtin79cdb662010-12-03 02:46:02 +0000873 def __enter__(self):
874 return self
875
876 def __exit__(self, type, value, traceback):
877 if self.stdout:
878 self.stdout.close()
879 if self.stderr:
880 self.stderr.close()
881 if self.stdin:
882 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700883 # Wait for the process to terminate, to avoid zombies.
884 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000885
Brett Cannon84df1e62010-05-14 00:33:40 +0000886 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200887 # If __init__ hasn't had a chance to execute (e.g. if it
888 # was passed an undeclared keyword argument), we don't
889 # have a _child_created attribute at all.
890 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000891 # We didn't get to successfully create a child process.
892 return
893 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000894 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000895 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000896 # Child is still running, keep us alive until we can wait on it.
897 _active.append(self)
898
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200899 def _get_devnull(self):
900 if not hasattr(self, '_devnull'):
901 self._devnull = os.open(os.devnull, os.O_RDWR)
902 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000903
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400904 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000905 """Interact with process: Send data to stdin. Read data from
906 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700907 process to terminate. The optional input argument should be
908 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000909 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000910
Peter Astrand23109f02005-03-03 20:28:59 +0000911 communicate() returns a tuple (stdout, stderr)."""
912
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400913 if self._communication_started and input:
914 raise ValueError("Cannot send input after starting communication")
915
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400916 # Optimization: If we are not worried about timeouts, we haven't
917 # started communicating, and we have one or zero pipes, using select()
918 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200919 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400920 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000921 stdout = None
922 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000923 if self.stdin:
924 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200925 try:
926 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200927 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200928 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
929 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000930 self.stdin.close()
931 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200932 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000933 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000934 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200935 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000936 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000937 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200938 else:
939 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200940 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200941 else:
942 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000943
Victor Stinner7a8d0812011-04-05 13:13:08 +0200944 try:
945 stdout, stderr = self._communicate(input, endtime, timeout)
946 finally:
947 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400948
Victor Stinner7a8d0812011-04-05 13:13:08 +0200949 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400950
951 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000952
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000953
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000954 def poll(self):
955 return self._internal_poll()
956
957
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400958 def _remaining_time(self, endtime):
959 """Convenience for _communicate when computing timeouts."""
960 if endtime is None:
961 return None
962 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200963 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400964
965
Reid Kleckner2b228f02011-03-16 16:57:54 -0400966 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400967 """Convenience for checking if a timeout has expired."""
968 if endtime is None:
969 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200970 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400971 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400972
973
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000974 if mswindows:
975 #
976 # Windows methods
977 #
978 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000979 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000980 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
981 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000982 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000983 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000984
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000985 p2cread, p2cwrite = -1, -1
986 c2pread, c2pwrite = -1, -1
987 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000988
Peter Astrandd38ddf42005-02-10 08:32:50 +0000989 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200990 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000991 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200992 p2cread, _ = _winapi.CreatePipe(None, 0)
993 p2cread = Handle(p2cread)
994 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000995 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200996 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
997 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200998 elif stdin == DEVNULL:
999 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001000 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001001 p2cread = msvcrt.get_osfhandle(stdin)
1002 else:
1003 # Assuming file-like object
1004 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1005 p2cread = self._make_inheritable(p2cread)
1006
Peter Astrandd38ddf42005-02-10 08:32:50 +00001007 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001008 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001009 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001010 _, c2pwrite = _winapi.CreatePipe(None, 0)
1011 c2pwrite = Handle(c2pwrite)
1012 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001013 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001014 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1015 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001016 elif stdout == DEVNULL:
1017 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001018 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001019 c2pwrite = msvcrt.get_osfhandle(stdout)
1020 else:
1021 # Assuming file-like object
1022 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1023 c2pwrite = self._make_inheritable(c2pwrite)
1024
Peter Astrandd38ddf42005-02-10 08:32:50 +00001025 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001026 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001027 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001028 _, errwrite = _winapi.CreatePipe(None, 0)
1029 errwrite = Handle(errwrite)
1030 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001031 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001032 errread, errwrite = _winapi.CreatePipe(None, 0)
1033 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001034 elif stderr == STDOUT:
1035 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001036 elif stderr == DEVNULL:
1037 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001038 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001039 errwrite = msvcrt.get_osfhandle(stderr)
1040 else:
1041 # Assuming file-like object
1042 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1043 errwrite = self._make_inheritable(errwrite)
1044
1045 return (p2cread, p2cwrite,
1046 c2pread, c2pwrite,
1047 errread, errwrite)
1048
1049
1050 def _make_inheritable(self, handle):
1051 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001052 h = _winapi.DuplicateHandle(
1053 _winapi.GetCurrentProcess(), handle,
1054 _winapi.GetCurrentProcess(), 0, 1,
1055 _winapi.DUPLICATE_SAME_ACCESS)
1056 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001057
1058
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001059 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001060 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 startupinfo, creationflags, shell,
1062 p2cread, p2cwrite,
1063 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001064 errread, errwrite,
1065 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066 """Execute program (MS Windows version)"""
1067
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001068 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001069
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001070 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001071 args = list2cmdline(args)
1072
Peter Astrandc1d65362004-11-07 14:30:34 +00001073 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001074 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001075 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001076 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001077 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001078 startupinfo.hStdInput = p2cread
1079 startupinfo.hStdOutput = c2pwrite
1080 startupinfo.hStdError = errwrite
1081
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001082 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001083 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1084 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001085 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001086 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001087
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001088 # Start the process
1089 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001090 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001091 # no special security
1092 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001093 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001094 creationflags,
1095 env,
1096 cwd,
1097 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001098 finally:
1099 # Child is launched. Close the parent's copy of those pipe
1100 # handles that only the child should have open. You need
1101 # to make sure that no handles to the write end of the
1102 # output pipe are maintained in this process or else the
1103 # pipe will not close when the child process exits and the
1104 # ReadFile will hang.
1105 if p2cread != -1:
1106 p2cread.Close()
1107 if c2pwrite != -1:
1108 c2pwrite.Close()
1109 if errwrite != -1:
1110 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001111 if hasattr(self, '_devnull'):
1112 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001113
1114 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001115 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001116 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001117 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001118 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001119
Brett Cannon84df1e62010-05-14 00:33:40 +00001120 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001121 _WaitForSingleObject=_winapi.WaitForSingleObject,
1122 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1123 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001124 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001125 attribute.
1126
1127 This method is called by __del__, so it can only refer to objects
1128 in its local scope.
1129
1130 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001131 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001132 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1133 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001134 return self.returncode
1135
1136
Reid Kleckner2b228f02011-03-16 16:57:54 -04001137 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 """Wait for child process to terminate. Returns returncode
1139 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001140 if endtime is not None:
1141 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001142 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001143 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001144 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001145 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001146 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001147 result = _winapi.WaitForSingleObject(self._handle,
1148 timeout_millis)
1149 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001150 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001151 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152 return self.returncode
1153
1154
1155 def _readerthread(self, fh, buffer):
1156 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001157 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001158
1159
Reid Kleckner2b228f02011-03-16 16:57:54 -04001160 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001161 # Start reader threads feeding into a list hanging off of this
1162 # object, unless they've already been started.
1163 if self.stdout and not hasattr(self, "_stdout_buff"):
1164 self._stdout_buff = []
1165 self.stdout_thread = \
1166 threading.Thread(target=self._readerthread,
1167 args=(self.stdout, self._stdout_buff))
1168 self.stdout_thread.daemon = True
1169 self.stdout_thread.start()
1170 if self.stderr and not hasattr(self, "_stderr_buff"):
1171 self._stderr_buff = []
1172 self.stderr_thread = \
1173 threading.Thread(target=self._readerthread,
1174 args=(self.stderr, self._stderr_buff))
1175 self.stderr_thread.daemon = True
1176 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001177
1178 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001179 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001180 try:
1181 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001182 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001183 if e.errno != errno.EPIPE:
1184 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001185 self.stdin.close()
1186
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001187 # Wait for the reader threads, or time out. If we time out, the
1188 # threads remain reading and the fds left open in case the user
1189 # calls communicate again.
1190 if self.stdout is not None:
1191 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001192 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001193 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001194 if self.stderr is not None:
1195 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001196 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001197 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001198
1199 # Collect the output from and close both pipes, now that we know
1200 # both have been read successfully.
1201 stdout = None
1202 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001203 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001204 stdout = self._stdout_buff
1205 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001206 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001207 stderr = self._stderr_buff
1208 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001209
1210 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001211 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001212 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001213 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001214 stderr = stderr[0]
1215
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001216 return (stdout, stderr)
1217
Christian Heimesa342c012008-04-20 21:01:16 +00001218 def send_signal(self, sig):
1219 """Send a signal to the process
1220 """
1221 if sig == signal.SIGTERM:
1222 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001223 elif sig == signal.CTRL_C_EVENT:
1224 os.kill(self.pid, signal.CTRL_C_EVENT)
1225 elif sig == signal.CTRL_BREAK_EVENT:
1226 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001227 else:
Brian Curtin19651362010-09-07 13:24:38 +00001228 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001229
1230 def terminate(self):
1231 """Terminates the process
1232 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001233 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001234 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001235 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001236 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1237 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001238 rc = _winapi.GetExitCodeProcess(self._handle)
1239 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001240 raise
1241 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001242
1243 kill = terminate
1244
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001245 else:
1246 #
1247 # POSIX methods
1248 #
1249 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001250 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1252 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001253 p2cread, p2cwrite = -1, -1
1254 c2pread, c2pwrite = -1, -1
1255 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001256
Peter Astrandd38ddf42005-02-10 08:32:50 +00001257 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001258 pass
1259 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001260 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001261 elif stdin == DEVNULL:
1262 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001263 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001264 p2cread = stdin
1265 else:
1266 # Assuming file-like object
1267 p2cread = stdin.fileno()
1268
Peter Astrandd38ddf42005-02-10 08:32:50 +00001269 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001270 pass
1271 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001272 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001273 elif stdout == DEVNULL:
1274 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001275 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001276 c2pwrite = stdout
1277 else:
1278 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001279 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001280
Peter Astrandd38ddf42005-02-10 08:32:50 +00001281 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001282 pass
1283 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001284 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285 elif stderr == STDOUT:
1286 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001287 elif stderr == DEVNULL:
1288 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001289 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001290 errwrite = stderr
1291 else:
1292 # Assuming file-like object
1293 errwrite = stderr.fileno()
1294
1295 return (p2cread, p2cwrite,
1296 c2pread, c2pwrite,
1297 errread, errwrite)
1298
1299
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001300 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001301 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001302 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001303 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001304 os.closerange(start_fd, fd)
1305 start_fd = fd + 1
1306 if start_fd <= MAXFD:
1307 os.closerange(start_fd, MAXFD)
1308
1309
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001310 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001311 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001312 startupinfo, creationflags, shell,
1313 p2cread, p2cwrite,
1314 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001315 errread, errwrite,
1316 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001317 """Execute program (POSIX version)"""
1318
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001319 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001320 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001321 else:
1322 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001323
1324 if shell:
1325 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001326 if executable:
1327 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001328
Peter Astrandd38ddf42005-02-10 08:32:50 +00001329 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001330 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001331 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001332
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001333 # For transferring possible exec failure from child to parent.
1334 # Data format: "exception name:hex errno:description"
1335 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001336 errpipe_read, errpipe_write = os.pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001337 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001338 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001339 # We must avoid complex work that could involve
1340 # malloc or free in the child process to avoid
1341 # potential deadlocks, thus we do all this here.
1342 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343
Victor Stinner372b8382011-06-21 17:24:21 +02001344 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001345 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1346 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001347 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001348 env_list = None # Use execv instead of execve.
1349 executable = os.fsencode(executable)
1350 if os.path.dirname(executable):
1351 executable_list = (executable,)
1352 else:
1353 # This matches the behavior of os._execvpe().
1354 executable_list = tuple(
1355 os.path.join(os.fsencode(dir), executable)
1356 for dir in os.get_exec_path(env))
1357 fds_to_keep = set(pass_fds)
1358 fds_to_keep.add(errpipe_write)
1359 self.pid = _posixsubprocess.fork_exec(
1360 args, executable_list,
1361 close_fds, sorted(fds_to_keep), cwd, env_list,
1362 p2cread, p2cwrite, c2pread, c2pwrite,
1363 errread, errwrite,
1364 errpipe_read, errpipe_write,
1365 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001366 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001367 finally:
1368 # be sure the FD is closed no matter what
1369 os.close(errpipe_write)
1370
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001371 # self._devnull is not always defined.
1372 devnull_fd = getattr(self, '_devnull', None)
1373 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001374 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001375 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001376 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001377 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001378 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001379 if devnull_fd is not None:
1380 os.close(devnull_fd)
1381 # Prevent a double close of these fds from __init__ on error.
1382 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001383
1384 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001385 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001386 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001387 while True:
1388 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001389 errpipe_data += part
1390 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001391 break
Facundo Batista10706e22009-06-19 20:34:30 +00001392 finally:
1393 # be sure the FD is closed no matter what
1394 os.close(errpipe_read)
1395
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001396 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001397 try:
1398 _eintr_retry_call(os.waitpid, self.pid, 0)
1399 except OSError as e:
1400 if e.errno != errno.ECHILD:
1401 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001402 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001403 exception_name, hex_errno, err_msg = (
1404 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001405 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001406 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001407 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001408 err_msg = (b'Bad exception data from child: ' +
1409 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001410 child_exception_type = getattr(
1411 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001412 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001413 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001414 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001415 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001416 child_exec_never_called = (err_msg == "noexec")
1417 if child_exec_never_called:
1418 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001419 if errno_num != 0:
1420 err_msg = os.strerror(errno_num)
1421 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001422 if child_exec_never_called:
1423 # The error must be from chdir(cwd).
1424 err_msg += ': ' + repr(cwd)
1425 else:
1426 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001427 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001428 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001429
1430
Brett Cannon84df1e62010-05-14 00:33:40 +00001431 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1432 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1433 _WEXITSTATUS=os.WEXITSTATUS):
1434 # This method is called (indirectly) by __del__, so it cannot
1435 # refer to anything outside of its local scope."""
1436 if _WIFSIGNALED(sts):
1437 self.returncode = -_WTERMSIG(sts)
1438 elif _WIFEXITED(sts):
1439 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001440 else:
1441 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001442 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001443
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001444
Brett Cannon84df1e62010-05-14 00:33:40 +00001445 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001446 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001447 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001448 attribute.
1449
1450 This method is called by __del__, so it cannot reference anything
1451 outside of the local scope (nor can any methods it calls).
1452
1453 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001454 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001455 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001456 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457 if pid == self.pid:
1458 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001459 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001460 if _deadstate is not None:
1461 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001462 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001463 # This happens if SIGCLD is set to be ignored or
1464 # waiting for child processes has otherwise been
1465 # disabled for our process. This child is dead, we
1466 # can't get the status.
1467 # http://bugs.python.org/issue15756
1468 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001469 return self.returncode
1470
1471
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001472 def _try_wait(self, wait_flags):
1473 try:
1474 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1475 except OSError as e:
1476 if e.errno != errno.ECHILD:
1477 raise
1478 # This happens if SIGCLD is set to be ignored or waiting
1479 # for child processes has otherwise been disabled for our
1480 # process. This child is dead, we can't get the status.
1481 pid = self.pid
1482 sts = 0
1483 return (pid, sts)
1484
1485
1486 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001487 """Wait for child process to terminate. Returns returncode
1488 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001489 if self.returncode is not None:
1490 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001491
1492 # endtime is preferred to timeout. timeout is only used for
1493 # printing.
1494 if endtime is not None or timeout is not None:
1495 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001496 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001497 elif timeout is None:
1498 timeout = self._remaining_time(endtime)
1499
1500 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001501 # Enter a busy loop if we have a timeout. This busy loop was
1502 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1503 delay = 0.0005 # 500 us -> initial delay of 1 ms
1504 while True:
1505 (pid, sts) = self._try_wait(os.WNOHANG)
1506 assert pid == self.pid or pid == 0
1507 if pid == self.pid:
1508 self._handle_exitstatus(sts)
1509 break
1510 remaining = self._remaining_time(endtime)
1511 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001512 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001513 delay = min(delay * 2, remaining, .05)
1514 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001515 else:
1516 while self.returncode is None:
1517 (pid, sts) = self._try_wait(0)
1518 # Check the pid and loop as waitpid has been known to return
1519 # 0 even without WNOHANG in odd situations. issue14396.
1520 if pid == self.pid:
1521 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001522 return self.returncode
1523
1524
Reid Kleckner2b228f02011-03-16 16:57:54 -04001525 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001526 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001527 # Flush stdio buffer. This might block, if the user has
1528 # been writing to .stdin in an uncontrolled fashion.
1529 self.stdin.flush()
1530 if not input:
1531 self.stdin.close()
1532
1533 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001534 stdout, stderr = self._communicate_with_poll(input, endtime,
1535 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001536 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001537 stdout, stderr = self._communicate_with_select(input, endtime,
1538 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001539
1540 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001541
1542 # All data exchanged. Translate lists into strings.
1543 if stdout is not None:
1544 stdout = b''.join(stdout)
1545 if stderr is not None:
1546 stderr = b''.join(stderr)
1547
1548 # Translate newlines, if requested.
1549 # This also turns bytes into strings.
1550 if self.universal_newlines:
1551 if stdout is not None:
1552 stdout = self._translate_newlines(stdout,
1553 self.stdout.encoding)
1554 if stderr is not None:
1555 stderr = self._translate_newlines(stderr,
1556 self.stderr.encoding)
1557
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001558 return (stdout, stderr)
1559
1560
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001561 def _save_input(self, input):
1562 # This method is called from the _communicate_with_*() methods
1563 # so that if we time out while communicating, we can continue
1564 # sending input if we retry.
1565 if self.stdin and self._input is None:
1566 self._input_offset = 0
1567 self._input = input
1568 if self.universal_newlines and input is not None:
1569 self._input = self._input.encode(self.stdin.encoding)
1570
1571
Reid Kleckner2b228f02011-03-16 16:57:54 -04001572 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001573 stdout = None # Return
1574 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001575
1576 if not self._communication_started:
1577 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001578
1579 poller = select.poll()
1580 def register_and_append(file_obj, eventmask):
1581 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001582 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001583
1584 def close_unregister_and_remove(fd):
1585 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001586 self._fd2file[fd].close()
1587 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001588
1589 if self.stdin and input:
1590 register_and_append(self.stdin, select.POLLOUT)
1591
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001592 # Only create this mapping if we haven't already.
1593 if not self._communication_started:
1594 self._fd2output = {}
1595 if self.stdout:
1596 self._fd2output[self.stdout.fileno()] = []
1597 if self.stderr:
1598 self._fd2output[self.stderr.fileno()] = []
1599
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001600 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1601 if self.stdout:
1602 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001603 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001604 if self.stderr:
1605 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001606 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001607
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001608 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001609
1610 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001611 timeout = self._remaining_time(endtime)
1612 if timeout is not None and timeout < 0:
1613 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001614 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001615 ready = poller.poll(timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001616 except OSError as e:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001617 if e.args[0] == errno.EINTR:
1618 continue
1619 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001620 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001621
1622 # XXX Rewrite these to use non-blocking I/O on the
1623 # file objects; they are no longer using C stdio!
1624
1625 for fd, mode in ready:
1626 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001627 chunk = self._input[self._input_offset :
1628 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001629 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001630 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001631 except OSError as e:
1632 if e.errno == errno.EPIPE:
1633 close_unregister_and_remove(fd)
1634 else:
1635 raise
1636 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001637 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001638 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001639 elif mode & select_POLLIN_POLLPRI:
1640 data = os.read(fd, 4096)
1641 if not data:
1642 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001643 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001644 else:
1645 # Ignore hang up or errors.
1646 close_unregister_and_remove(fd)
1647
1648 return (stdout, stderr)
1649
1650
Reid Kleckner2b228f02011-03-16 16:57:54 -04001651 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001652 if not self._communication_started:
1653 self._read_set = []
1654 self._write_set = []
1655 if self.stdin and input:
1656 self._write_set.append(self.stdin)
1657 if self.stdout:
1658 self._read_set.append(self.stdout)
1659 if self.stderr:
1660 self._read_set.append(self.stderr)
1661
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001662 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001663
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001664 stdout = None # Return
1665 stderr = None # Return
1666
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001667 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001668 if not self._communication_started:
1669 self._stdout_buff = []
1670 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001671 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001672 if not self._communication_started:
1673 self._stderr_buff = []
1674 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001675
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001676 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001677 timeout = self._remaining_time(endtime)
1678 if timeout is not None and timeout < 0:
1679 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001680 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001681 (rlist, wlist, xlist) = \
1682 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001683 timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001684 except OSError as e:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001685 if e.args[0] == errno.EINTR:
1686 continue
1687 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001688
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001689 # According to the docs, returning three empty lists indicates
1690 # that the timeout expired.
1691 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001692 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001693 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001694 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001695
Guido van Rossum98297ee2007-11-06 21:34:58 +00001696 # XXX Rewrite these to use non-blocking I/O on the
1697 # file objects; they are no longer using C stdio!
1698
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001699 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001700 chunk = self._input[self._input_offset :
1701 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001702 try:
1703 bytes_written = os.write(self.stdin.fileno(), chunk)
1704 except OSError as e:
1705 if e.errno == errno.EPIPE:
1706 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001707 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001708 else:
1709 raise
1710 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001711 self._input_offset += bytes_written
1712 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001713 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001714 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001715
1716 if self.stdout in rlist:
1717 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001718 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001719 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001720 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001721 stdout.append(data)
1722
1723 if self.stderr in rlist:
1724 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001725 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001726 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001727 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001728 stderr.append(data)
1729
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001730 return (stdout, stderr)
1731
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001732
Christian Heimesa342c012008-04-20 21:01:16 +00001733 def send_signal(self, sig):
1734 """Send a signal to the process
1735 """
1736 os.kill(self.pid, sig)
1737
1738 def terminate(self):
1739 """Terminate the process with SIGTERM
1740 """
1741 self.send_signal(signal.SIGTERM)
1742
1743 def kill(self):
1744 """Kill the process with SIGKILL
1745 """
1746 self.send_signal(signal.SIGKILL)