blob: 23c9ea515b2d1f5632777b43507112f97507e54f [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:
Nick Coghlanac1a2482013-10-18 22:39:50 +1000509 if flag == 'hash_randomization':
510 v = 1 # Handle specification of an exact seed
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200511 args.append('-' + opt * v)
512 for opt in sys.warnoptions:
513 args.append('-W' + opt)
514 return args
515
516
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400517def call(*popenargs, timeout=None, **kwargs):
518 """Run command with arguments. Wait for command to complete or
519 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000520
521 The arguments are the same as for the Popen constructor. Example:
522
523 retcode = call(["ls", "-l"])
524 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200525 with Popen(*popenargs, **kwargs) as p:
526 try:
527 return p.wait(timeout=timeout)
528 except:
529 p.kill()
530 p.wait()
531 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000532
533
Peter Astrand454f7672005-01-01 09:36:35 +0000534def check_call(*popenargs, **kwargs):
535 """Run command with arguments. Wait for command to complete. If
536 the exit code was zero then return, otherwise raise
537 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000538 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000539
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400540 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000541
542 check_call(["ls", "-l"])
543 """
544 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000545 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000546 cmd = kwargs.get("args")
547 if cmd is None:
548 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000549 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000550 return 0
551
552
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400553def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700554 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000555
556 If the exit code was non-zero it raises a CalledProcessError. The
557 CalledProcessError object will have the return code in the returncode
558 attribute and output in the output attribute.
559
560 The arguments are the same as for the Popen constructor. Example:
561
562 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000563 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000564
565 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000566 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000567
568 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000569 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000570 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000571 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700572
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300573 There is an additional optional argument, "input", allowing you to
574 pass a string to the subprocess's stdin. If you use this argument
575 you may not also use the Popen constructor's "stdin" argument, as
576 it too will be used internally. Example:
577
578 >>> check_output(["sed", "-e", "s/foo/bar/"],
579 ... input=b"when in the course of fooman events\n")
580 b'when in the course of barman events\n'
581
Gregory P. Smith91110f52013-03-19 23:25:16 -0700582 If universal_newlines=True is passed, the return value will be a
583 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000584 """
585 if 'stdout' in kwargs:
586 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300587 if 'input' in kwargs:
588 if 'stdin' in kwargs:
589 raise ValueError('stdin and input arguments may not both be used.')
590 inputdata = kwargs['input']
591 del kwargs['input']
592 kwargs['stdin'] = PIPE
593 else:
594 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200595 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
596 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300597 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200598 except TimeoutExpired:
599 process.kill()
600 output, unused_err = process.communicate()
601 raise TimeoutExpired(process.args, timeout, output=output)
602 except:
603 process.kill()
604 process.wait()
605 raise
606 retcode = process.poll()
607 if retcode:
608 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000609 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000610
611
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000612def list2cmdline(seq):
613 """
614 Translate a sequence of arguments into a command line
615 string, using the same rules as the MS C runtime:
616
617 1) Arguments are delimited by white space, which is either a
618 space or a tab.
619
620 2) A string surrounded by double quotation marks is
621 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000622 contained within. A quoted string can be embedded in an
623 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000624
625 3) A double quotation mark preceded by a backslash is
626 interpreted as a literal double quotation mark.
627
628 4) Backslashes are interpreted literally, unless they
629 immediately precede a double quotation mark.
630
631 5) If backslashes immediately precede a double quotation mark,
632 every pair of backslashes is interpreted as a literal
633 backslash. If the number of backslashes is odd, the last
634 backslash escapes the next double quotation mark as
635 described in rule 3.
636 """
637
638 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000639 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
640 # or search http://msdn.microsoft.com for
641 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000642 result = []
643 needquote = False
644 for arg in seq:
645 bs_buf = []
646
647 # Add a space to separate this argument from the others
648 if result:
649 result.append(' ')
650
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000651 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000652 if needquote:
653 result.append('"')
654
655 for c in arg:
656 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000657 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000658 bs_buf.append(c)
659 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000660 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000661 result.append('\\' * len(bs_buf)*2)
662 bs_buf = []
663 result.append('\\"')
664 else:
665 # Normal char
666 if bs_buf:
667 result.extend(bs_buf)
668 bs_buf = []
669 result.append(c)
670
Christian Heimesfdab48e2008-01-20 09:06:41 +0000671 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000672 if bs_buf:
673 result.extend(bs_buf)
674
675 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000676 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000677 result.append('"')
678
679 return ''.join(result)
680
681
Brett Cannona23810f2008-05-26 19:04:21 +0000682# Various tools for executing commands and looking at their output and status.
683#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000684# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000685
686def getstatusoutput(cmd):
687 """Return (status, output) of executing cmd in a shell.
688
689 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
690 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
691 returned output will contain output or error messages. A trailing newline
692 is stripped from the output. The exit status for the command can be
693 interpreted according to the rules for the C function wait(). Example:
694
695 >>> import subprocess
696 >>> subprocess.getstatusoutput('ls /bin/ls')
697 (0, '/bin/ls')
698 >>> subprocess.getstatusoutput('cat /bin/junk')
699 (256, 'cat: /bin/junk: No such file or directory')
700 >>> subprocess.getstatusoutput('/bin/junk')
701 (256, 'sh: /bin/junk: not found')
702 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200703 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
704 try:
705 text = pipe.read()
706 sts = pipe.close()
707 except:
708 process = pipe._proc
709 process.kill()
710 process.wait()
711 raise
712 if sts is None:
713 sts = 0
714 if text[-1:] == '\n':
715 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000716 return sts, text
717
718
719def getoutput(cmd):
720 """Return output (stdout or stderr) of executing cmd in a shell.
721
722 Like getstatusoutput(), except the exit status is ignored and the return
723 value is a string containing the command's output. Example:
724
725 >>> import subprocess
726 >>> subprocess.getoutput('ls /bin/ls')
727 '/bin/ls'
728 """
729 return getstatusoutput(cmd)[1]
730
731
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000732_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000733
734
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000735class Popen(object):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700736 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000737 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000738 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
739 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000740 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000741 restore_signals=True, start_new_session=False,
742 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000743 """Create new Popen instance."""
744 _cleanup()
745
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000746 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400747 self._input = None
748 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000749 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700750 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000751 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000752 raise TypeError("bufsize must be an integer")
753
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000754 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000755 if preexec_fn is not None:
756 raise ValueError("preexec_fn is not supported on Windows "
757 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000758 any_stdio_set = (stdin is not None or stdout is not None or
759 stderr is not None)
760 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
761 if any_stdio_set:
762 close_fds = False
763 else:
764 close_fds = True
765 elif close_fds and any_stdio_set:
766 raise ValueError(
767 "close_fds is not supported on Windows platforms"
768 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000769 else:
770 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000771 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
772 close_fds = True
773 if pass_fds and not close_fds:
774 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
775 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000776 if startupinfo is not None:
777 raise ValueError("startupinfo is only supported on Windows "
778 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000779 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000780 raise ValueError("creationflags is only supported on Windows "
781 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000782
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400783 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000784 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000785 self.stdout = None
786 self.stderr = None
787 self.pid = None
788 self.returncode = None
789 self.universal_newlines = universal_newlines
790
791 # Input and output objects. The general principle is like
792 # this:
793 #
794 # Parent Child
795 # ------ -----
796 # p2cwrite ---stdin---> p2cread
797 # c2pread <--stdout--- c2pwrite
798 # errread <--stderr--- errwrite
799 #
800 # On POSIX, the child objects are file descriptors. On
801 # Windows, these are Windows file handles. The parent objects
802 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000803 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000805
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000806 (p2cread, p2cwrite,
807 c2pread, c2pwrite,
808 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
809
Antoine Pitrouc9982322011-01-04 19:07:07 +0000810 # We wrap OS handles *before* launching the child, otherwise a
811 # quickly terminating child could make our fds unwrappable
812 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000813
Thomas Wouterscf297e42007-02-23 15:07:44 +0000814 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000815 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000816 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000817 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000818 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000819 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000820 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000821
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000822 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000823 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300824 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200825 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000826 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000827 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000828 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000829 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000830 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000831 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000832 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000833 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000834
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700835 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000836 try:
837 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300838 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000839 startupinfo, creationflags, shell,
840 p2cread, p2cwrite,
841 c2pread, c2pwrite,
842 errread, errwrite,
843 restore_signals, start_new_session)
844 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800845 # Cleanup if the child failed starting.
846 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000847 try:
848 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200849 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800850 pass # Ignore EBADF or other errors.
851
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700852 if not self._closed_child_pipe_fds:
853 to_close = []
854 if stdin == PIPE:
855 to_close.append(p2cread)
856 if stdout == PIPE:
857 to_close.append(c2pwrite)
858 if stderr == PIPE:
859 to_close.append(errwrite)
860 if hasattr(self, '_devnull'):
861 to_close.append(self._devnull)
862 for fd in to_close:
863 try:
864 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700865 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700866 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800867
Antoine Pitrouc9982322011-01-04 19:07:07 +0000868 raise
869
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000870
Guido van Rossum98297ee2007-11-06 21:34:58 +0000871 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300872 data = data.decode(encoding)
873 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000874
Brian Curtin79cdb662010-12-03 02:46:02 +0000875 def __enter__(self):
876 return self
877
878 def __exit__(self, type, value, traceback):
879 if self.stdout:
880 self.stdout.close()
881 if self.stderr:
882 self.stderr.close()
883 if self.stdin:
884 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700885 # Wait for the process to terminate, to avoid zombies.
886 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000887
Brett Cannon84df1e62010-05-14 00:33:40 +0000888 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200889 # If __init__ hasn't had a chance to execute (e.g. if it
890 # was passed an undeclared keyword argument), we don't
891 # have a _child_created attribute at all.
892 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000893 # We didn't get to successfully create a child process.
894 return
895 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000896 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000897 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000898 # Child is still running, keep us alive until we can wait on it.
899 _active.append(self)
900
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200901 def _get_devnull(self):
902 if not hasattr(self, '_devnull'):
903 self._devnull = os.open(os.devnull, os.O_RDWR)
904 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000905
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400906 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000907 """Interact with process: Send data to stdin. Read data from
908 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700909 process to terminate. The optional input argument should be
910 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000911 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000912
Peter Astrand23109f02005-03-03 20:28:59 +0000913 communicate() returns a tuple (stdout, stderr)."""
914
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400915 if self._communication_started and input:
916 raise ValueError("Cannot send input after starting communication")
917
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400918 # Optimization: If we are not worried about timeouts, we haven't
919 # started communicating, and we have one or zero pipes, using select()
920 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200921 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400922 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000923 stdout = None
924 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000925 if self.stdin:
926 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200927 try:
928 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200929 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200930 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
931 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000932 self.stdin.close()
933 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200934 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000935 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000936 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200937 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000938 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000939 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200940 else:
941 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200942 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200943 else:
944 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000945
Victor Stinner7a8d0812011-04-05 13:13:08 +0200946 try:
947 stdout, stderr = self._communicate(input, endtime, timeout)
948 finally:
949 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400950
Victor Stinner7a8d0812011-04-05 13:13:08 +0200951 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400952
953 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000954
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000955
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000956 def poll(self):
957 return self._internal_poll()
958
959
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400960 def _remaining_time(self, endtime):
961 """Convenience for _communicate when computing timeouts."""
962 if endtime is None:
963 return None
964 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200965 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400966
967
Reid Kleckner2b228f02011-03-16 16:57:54 -0400968 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400969 """Convenience for checking if a timeout has expired."""
970 if endtime is None:
971 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200972 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400973 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400974
975
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000976 if mswindows:
977 #
978 # Windows methods
979 #
980 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000981 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000982 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
983 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000984 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000985 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000986
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000987 p2cread, p2cwrite = -1, -1
988 c2pread, c2pwrite = -1, -1
989 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000990
Peter Astrandd38ddf42005-02-10 08:32:50 +0000991 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200992 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000993 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200994 p2cread, _ = _winapi.CreatePipe(None, 0)
995 p2cread = Handle(p2cread)
996 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000997 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200998 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
999 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001000 elif stdin == DEVNULL:
1001 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001002 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001003 p2cread = msvcrt.get_osfhandle(stdin)
1004 else:
1005 # Assuming file-like object
1006 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1007 p2cread = self._make_inheritable(p2cread)
1008
Peter Astrandd38ddf42005-02-10 08:32:50 +00001009 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001010 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001011 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001012 _, c2pwrite = _winapi.CreatePipe(None, 0)
1013 c2pwrite = Handle(c2pwrite)
1014 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001015 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001016 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1017 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001018 elif stdout == DEVNULL:
1019 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001020 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001021 c2pwrite = msvcrt.get_osfhandle(stdout)
1022 else:
1023 # Assuming file-like object
1024 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1025 c2pwrite = self._make_inheritable(c2pwrite)
1026
Peter Astrandd38ddf42005-02-10 08:32:50 +00001027 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001028 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001029 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001030 _, errwrite = _winapi.CreatePipe(None, 0)
1031 errwrite = Handle(errwrite)
1032 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001033 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001034 errread, errwrite = _winapi.CreatePipe(None, 0)
1035 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001036 elif stderr == STDOUT:
1037 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001038 elif stderr == DEVNULL:
1039 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001040 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001041 errwrite = msvcrt.get_osfhandle(stderr)
1042 else:
1043 # Assuming file-like object
1044 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1045 errwrite = self._make_inheritable(errwrite)
1046
1047 return (p2cread, p2cwrite,
1048 c2pread, c2pwrite,
1049 errread, errwrite)
1050
1051
1052 def _make_inheritable(self, handle):
1053 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001054 h = _winapi.DuplicateHandle(
1055 _winapi.GetCurrentProcess(), handle,
1056 _winapi.GetCurrentProcess(), 0, 1,
1057 _winapi.DUPLICATE_SAME_ACCESS)
1058 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001059
1060
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001062 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001063 startupinfo, creationflags, shell,
1064 p2cread, p2cwrite,
1065 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001066 errread, errwrite,
1067 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001068 """Execute program (MS Windows version)"""
1069
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001070 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001071
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001072 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001073 args = list2cmdline(args)
1074
Peter Astrandc1d65362004-11-07 14:30:34 +00001075 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001076 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001077 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001078 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001079 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001080 startupinfo.hStdInput = p2cread
1081 startupinfo.hStdOutput = c2pwrite
1082 startupinfo.hStdError = errwrite
1083
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001084 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001085 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1086 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001087 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001088 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001089
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001090 # Start the process
1091 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001092 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001093 # no special security
1094 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001095 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001096 creationflags,
1097 env,
1098 cwd,
1099 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001100 finally:
1101 # Child is launched. Close the parent's copy of those pipe
1102 # handles that only the child should have open. You need
1103 # to make sure that no handles to the write end of the
1104 # output pipe are maintained in this process or else the
1105 # pipe will not close when the child process exits and the
1106 # ReadFile will hang.
1107 if p2cread != -1:
1108 p2cread.Close()
1109 if c2pwrite != -1:
1110 c2pwrite.Close()
1111 if errwrite != -1:
1112 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001113 if hasattr(self, '_devnull'):
1114 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001115
1116 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001117 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001118 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001119 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001120 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001121
Brett Cannon84df1e62010-05-14 00:33:40 +00001122 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001123 _WaitForSingleObject=_winapi.WaitForSingleObject,
1124 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1125 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001126 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001127 attribute.
1128
1129 This method is called by __del__, so it can only refer to objects
1130 in its local scope.
1131
1132 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001133 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001134 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1135 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001136 return self.returncode
1137
1138
Reid Kleckner2b228f02011-03-16 16:57:54 -04001139 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001140 """Wait for child process to terminate. Returns returncode
1141 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001142 if endtime is not None:
1143 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001144 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001145 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001146 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001147 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001148 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001149 result = _winapi.WaitForSingleObject(self._handle,
1150 timeout_millis)
1151 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001152 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001153 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001154 return self.returncode
1155
1156
1157 def _readerthread(self, fh, buffer):
1158 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001159 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001160
1161
Reid Kleckner2b228f02011-03-16 16:57:54 -04001162 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001163 # Start reader threads feeding into a list hanging off of this
1164 # object, unless they've already been started.
1165 if self.stdout and not hasattr(self, "_stdout_buff"):
1166 self._stdout_buff = []
1167 self.stdout_thread = \
1168 threading.Thread(target=self._readerthread,
1169 args=(self.stdout, self._stdout_buff))
1170 self.stdout_thread.daemon = True
1171 self.stdout_thread.start()
1172 if self.stderr and not hasattr(self, "_stderr_buff"):
1173 self._stderr_buff = []
1174 self.stderr_thread = \
1175 threading.Thread(target=self._readerthread,
1176 args=(self.stderr, self._stderr_buff))
1177 self.stderr_thread.daemon = True
1178 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001179
1180 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001181 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001182 try:
1183 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001184 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001185 if e.errno != errno.EPIPE:
1186 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001187 self.stdin.close()
1188
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001189 # Wait for the reader threads, or time out. If we time out, the
1190 # threads remain reading and the fds left open in case the user
1191 # calls communicate again.
1192 if self.stdout is not None:
1193 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001194 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001195 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001196 if self.stderr is not None:
1197 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001198 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001199 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001200
1201 # Collect the output from and close both pipes, now that we know
1202 # both have been read successfully.
1203 stdout = None
1204 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001205 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001206 stdout = self._stdout_buff
1207 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001209 stderr = self._stderr_buff
1210 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211
1212 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001213 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001214 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001215 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001216 stderr = stderr[0]
1217
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001218 return (stdout, stderr)
1219
Christian Heimesa342c012008-04-20 21:01:16 +00001220 def send_signal(self, sig):
1221 """Send a signal to the process
1222 """
1223 if sig == signal.SIGTERM:
1224 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001225 elif sig == signal.CTRL_C_EVENT:
1226 os.kill(self.pid, signal.CTRL_C_EVENT)
1227 elif sig == signal.CTRL_BREAK_EVENT:
1228 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001229 else:
Brian Curtin19651362010-09-07 13:24:38 +00001230 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001231
1232 def terminate(self):
1233 """Terminates the process
1234 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001235 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001236 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001237 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001238 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1239 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001240 rc = _winapi.GetExitCodeProcess(self._handle)
1241 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001242 raise
1243 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001244
1245 kill = terminate
1246
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001247 else:
1248 #
1249 # POSIX methods
1250 #
1251 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001252 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001253 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1254 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001255 p2cread, p2cwrite = -1, -1
1256 c2pread, c2pwrite = -1, -1
1257 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001258
Peter Astrandd38ddf42005-02-10 08:32:50 +00001259 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001260 pass
1261 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001262 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001263 elif stdin == DEVNULL:
1264 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001265 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001266 p2cread = stdin
1267 else:
1268 # Assuming file-like object
1269 p2cread = stdin.fileno()
1270
Peter Astrandd38ddf42005-02-10 08:32:50 +00001271 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001272 pass
1273 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001274 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001275 elif stdout == DEVNULL:
1276 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001277 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001278 c2pwrite = stdout
1279 else:
1280 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001281 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001282
Peter Astrandd38ddf42005-02-10 08:32:50 +00001283 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001284 pass
1285 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001286 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001287 elif stderr == STDOUT:
1288 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001289 elif stderr == DEVNULL:
1290 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001291 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001292 errwrite = stderr
1293 else:
1294 # Assuming file-like object
1295 errwrite = stderr.fileno()
1296
1297 return (p2cread, p2cwrite,
1298 c2pread, c2pwrite,
1299 errread, errwrite)
1300
1301
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001302 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001303 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001304 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001305 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001306 os.closerange(start_fd, fd)
1307 start_fd = fd + 1
1308 if start_fd <= MAXFD:
1309 os.closerange(start_fd, MAXFD)
1310
1311
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001312 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001313 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001314 startupinfo, creationflags, shell,
1315 p2cread, p2cwrite,
1316 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001317 errread, errwrite,
1318 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001319 """Execute program (POSIX version)"""
1320
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001321 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001322 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001323 else:
1324 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001325
1326 if shell:
1327 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001328 if executable:
1329 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001330
Peter Astrandd38ddf42005-02-10 08:32:50 +00001331 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001332 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001333 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001334
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001335 # For transferring possible exec failure from child to parent.
1336 # Data format: "exception name:hex errno:description"
1337 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001338 errpipe_read, errpipe_write = os.pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001339 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001340 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001341 # We must avoid complex work that could involve
1342 # malloc or free in the child process to avoid
1343 # potential deadlocks, thus we do all this here.
1344 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001345
Victor Stinner372b8382011-06-21 17:24:21 +02001346 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001347 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1348 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001349 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001350 env_list = None # Use execv instead of execve.
1351 executable = os.fsencode(executable)
1352 if os.path.dirname(executable):
1353 executable_list = (executable,)
1354 else:
1355 # This matches the behavior of os._execvpe().
1356 executable_list = tuple(
1357 os.path.join(os.fsencode(dir), executable)
1358 for dir in os.get_exec_path(env))
1359 fds_to_keep = set(pass_fds)
1360 fds_to_keep.add(errpipe_write)
1361 self.pid = _posixsubprocess.fork_exec(
1362 args, executable_list,
1363 close_fds, sorted(fds_to_keep), cwd, env_list,
1364 p2cread, p2cwrite, c2pread, c2pwrite,
1365 errread, errwrite,
1366 errpipe_read, errpipe_write,
1367 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001368 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001369 finally:
1370 # be sure the FD is closed no matter what
1371 os.close(errpipe_write)
1372
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001373 # self._devnull is not always defined.
1374 devnull_fd = getattr(self, '_devnull', None)
1375 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001376 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001377 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001378 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001379 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001380 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001381 if devnull_fd is not None:
1382 os.close(devnull_fd)
1383 # Prevent a double close of these fds from __init__ on error.
1384 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001385
1386 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001387 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001388 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001389 while True:
1390 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001391 errpipe_data += part
1392 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001393 break
Facundo Batista10706e22009-06-19 20:34:30 +00001394 finally:
1395 # be sure the FD is closed no matter what
1396 os.close(errpipe_read)
1397
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001398 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001399 try:
1400 _eintr_retry_call(os.waitpid, self.pid, 0)
1401 except OSError as e:
1402 if e.errno != errno.ECHILD:
1403 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001404 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001405 exception_name, hex_errno, err_msg = (
1406 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001407 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001408 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001409 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001410 err_msg = (b'Bad exception data from child: ' +
1411 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001412 child_exception_type = getattr(
1413 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001414 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001415 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001416 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001417 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001418 child_exec_never_called = (err_msg == "noexec")
1419 if child_exec_never_called:
1420 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001421 if errno_num != 0:
1422 err_msg = os.strerror(errno_num)
1423 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001424 if child_exec_never_called:
1425 # The error must be from chdir(cwd).
1426 err_msg += ': ' + repr(cwd)
1427 else:
1428 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001429 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001430 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001431
1432
Brett Cannon84df1e62010-05-14 00:33:40 +00001433 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1434 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1435 _WEXITSTATUS=os.WEXITSTATUS):
1436 # This method is called (indirectly) by __del__, so it cannot
1437 # refer to anything outside of its local scope."""
1438 if _WIFSIGNALED(sts):
1439 self.returncode = -_WTERMSIG(sts)
1440 elif _WIFEXITED(sts):
1441 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001442 else:
1443 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001444 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001445
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001446
Brett Cannon84df1e62010-05-14 00:33:40 +00001447 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001448 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001449 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001450 attribute.
1451
1452 This method is called by __del__, so it cannot reference anything
1453 outside of the local scope (nor can any methods it calls).
1454
1455 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001456 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001458 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001459 if pid == self.pid:
1460 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001461 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001462 if _deadstate is not None:
1463 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001464 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001465 # This happens if SIGCLD is set to be ignored or
1466 # waiting for child processes has otherwise been
1467 # disabled for our process. This child is dead, we
1468 # can't get the status.
1469 # http://bugs.python.org/issue15756
1470 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001471 return self.returncode
1472
1473
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001474 def _try_wait(self, wait_flags):
1475 try:
1476 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1477 except OSError as e:
1478 if e.errno != errno.ECHILD:
1479 raise
1480 # This happens if SIGCLD is set to be ignored or waiting
1481 # for child processes has otherwise been disabled for our
1482 # process. This child is dead, we can't get the status.
1483 pid = self.pid
1484 sts = 0
1485 return (pid, sts)
1486
1487
1488 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001489 """Wait for child process to terminate. Returns returncode
1490 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001491 if self.returncode is not None:
1492 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001493
1494 # endtime is preferred to timeout. timeout is only used for
1495 # printing.
1496 if endtime is not None or timeout is not None:
1497 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001498 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001499 elif timeout is None:
1500 timeout = self._remaining_time(endtime)
1501
1502 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001503 # Enter a busy loop if we have a timeout. This busy loop was
1504 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1505 delay = 0.0005 # 500 us -> initial delay of 1 ms
1506 while True:
1507 (pid, sts) = self._try_wait(os.WNOHANG)
1508 assert pid == self.pid or pid == 0
1509 if pid == self.pid:
1510 self._handle_exitstatus(sts)
1511 break
1512 remaining = self._remaining_time(endtime)
1513 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001514 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001515 delay = min(delay * 2, remaining, .05)
1516 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001517 else:
1518 while self.returncode is None:
1519 (pid, sts) = self._try_wait(0)
1520 # Check the pid and loop as waitpid has been known to return
1521 # 0 even without WNOHANG in odd situations. issue14396.
1522 if pid == self.pid:
1523 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001524 return self.returncode
1525
1526
Reid Kleckner2b228f02011-03-16 16:57:54 -04001527 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001528 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001529 # Flush stdio buffer. This might block, if the user has
1530 # been writing to .stdin in an uncontrolled fashion.
1531 self.stdin.flush()
1532 if not input:
1533 self.stdin.close()
1534
1535 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001536 stdout, stderr = self._communicate_with_poll(input, endtime,
1537 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001538 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001539 stdout, stderr = self._communicate_with_select(input, endtime,
1540 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001541
1542 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001543
1544 # All data exchanged. Translate lists into strings.
1545 if stdout is not None:
1546 stdout = b''.join(stdout)
1547 if stderr is not None:
1548 stderr = b''.join(stderr)
1549
1550 # Translate newlines, if requested.
1551 # This also turns bytes into strings.
1552 if self.universal_newlines:
1553 if stdout is not None:
1554 stdout = self._translate_newlines(stdout,
1555 self.stdout.encoding)
1556 if stderr is not None:
1557 stderr = self._translate_newlines(stderr,
1558 self.stderr.encoding)
1559
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001560 return (stdout, stderr)
1561
1562
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001563 def _save_input(self, input):
1564 # This method is called from the _communicate_with_*() methods
1565 # so that if we time out while communicating, we can continue
1566 # sending input if we retry.
1567 if self.stdin and self._input is None:
1568 self._input_offset = 0
1569 self._input = input
1570 if self.universal_newlines and input is not None:
1571 self._input = self._input.encode(self.stdin.encoding)
1572
1573
Reid Kleckner2b228f02011-03-16 16:57:54 -04001574 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001575 stdout = None # Return
1576 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001577
1578 if not self._communication_started:
1579 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001580
1581 poller = select.poll()
1582 def register_and_append(file_obj, eventmask):
1583 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001584 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001585
1586 def close_unregister_and_remove(fd):
1587 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001588 self._fd2file[fd].close()
1589 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001590
1591 if self.stdin and input:
1592 register_and_append(self.stdin, select.POLLOUT)
1593
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001594 # Only create this mapping if we haven't already.
1595 if not self._communication_started:
1596 self._fd2output = {}
1597 if self.stdout:
1598 self._fd2output[self.stdout.fileno()] = []
1599 if self.stderr:
1600 self._fd2output[self.stderr.fileno()] = []
1601
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001602 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1603 if self.stdout:
1604 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001605 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001606 if self.stderr:
1607 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001608 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001609
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001610 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001611
1612 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001613 timeout = self._remaining_time(endtime)
1614 if timeout is not None and timeout < 0:
1615 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001616 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001617 ready = poller.poll(timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001618 except OSError as e:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001619 if e.args[0] == errno.EINTR:
1620 continue
1621 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001622 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001623
1624 # XXX Rewrite these to use non-blocking I/O on the
1625 # file objects; they are no longer using C stdio!
1626
1627 for fd, mode in ready:
1628 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001629 chunk = self._input[self._input_offset :
1630 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001631 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001632 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001633 except OSError as e:
1634 if e.errno == errno.EPIPE:
1635 close_unregister_and_remove(fd)
1636 else:
1637 raise
1638 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001639 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001640 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001641 elif mode & select_POLLIN_POLLPRI:
1642 data = os.read(fd, 4096)
1643 if not data:
1644 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001645 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001646 else:
1647 # Ignore hang up or errors.
1648 close_unregister_and_remove(fd)
1649
1650 return (stdout, stderr)
1651
1652
Reid Kleckner2b228f02011-03-16 16:57:54 -04001653 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001654 if not self._communication_started:
1655 self._read_set = []
1656 self._write_set = []
1657 if self.stdin and input:
1658 self._write_set.append(self.stdin)
1659 if self.stdout:
1660 self._read_set.append(self.stdout)
1661 if self.stderr:
1662 self._read_set.append(self.stderr)
1663
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001664 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001665
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001666 stdout = None # Return
1667 stderr = None # Return
1668
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001669 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001670 if not self._communication_started:
1671 self._stdout_buff = []
1672 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001673 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001674 if not self._communication_started:
1675 self._stderr_buff = []
1676 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001677
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001678 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001679 timeout = self._remaining_time(endtime)
1680 if timeout is not None and timeout < 0:
1681 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001682 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001683 (rlist, wlist, xlist) = \
1684 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001685 timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001686 except OSError as e:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001687 if e.args[0] == errno.EINTR:
1688 continue
1689 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001690
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001691 # According to the docs, returning three empty lists indicates
1692 # that the timeout expired.
1693 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001694 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001695 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001696 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001697
Guido van Rossum98297ee2007-11-06 21:34:58 +00001698 # XXX Rewrite these to use non-blocking I/O on the
1699 # file objects; they are no longer using C stdio!
1700
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001701 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001702 chunk = self._input[self._input_offset :
1703 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001704 try:
1705 bytes_written = os.write(self.stdin.fileno(), chunk)
1706 except OSError as e:
1707 if e.errno == errno.EPIPE:
1708 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001709 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001710 else:
1711 raise
1712 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001713 self._input_offset += bytes_written
1714 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001715 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001716 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001717
1718 if self.stdout in rlist:
1719 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001720 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001721 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001722 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001723 stdout.append(data)
1724
1725 if self.stderr in rlist:
1726 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001727 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001728 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001729 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001730 stderr.append(data)
1731
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001732 return (stdout, stderr)
1733
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001734
Christian Heimesa342c012008-04-20 21:01:16 +00001735 def send_signal(self, sig):
1736 """Send a signal to the process
1737 """
1738 os.kill(self.pid, sig)
1739
1740 def terminate(self):
1741 """Terminate the process with SIGTERM
1742 """
1743 self.send_signal(signal.SIGTERM)
1744
1745 def kill(self):
1746 """Kill the process with SIGKILL
1747 """
1748 self.send_signal(signal.SIGKILL)