blob: 78907e0e943c9c7db926a8cb7aa77ec4372b2829 [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
107If universal_newlines is true, the file objects stdout and stderr are
108opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000109the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110'\r\n', the Windows convention. All of these external representations
Gregory P. Smith1f8a40b2013-03-20 18:32:03 -0700111are seen as '\n' by the Python program. Also, the newlines attribute
112of the file objects stdout, stdin and stderr are not updated by the
113communicate() method.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000114
115The startupinfo and creationflags, if given, will be passed to the
116underlying CreateProcess() function. They can specify things such as
117appearance of the main window and priority for the new process.
118(Windows only)
119
120
Georg Brandlf9734072008-12-07 15:30:06 +0000121This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000122
Peter Astrand5f5e1412004-12-05 20:15:36 +0000123call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000124 Run command with arguments. Wait for command to complete, then
125 return the returncode attribute.
126
127 The arguments are the same as for the Popen constructor. Example:
128
Florent Xicluna4886d242010-03-08 13:27:26 +0000129 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000130
Peter Astrand454f7672005-01-01 09:36:35 +0000131check_call(*popenargs, **kwargs):
132 Run command with arguments. Wait for command to complete. If the
133 exit code was zero then return, otherwise raise
134 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000135 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000136
137 The arguments are the same as for the Popen constructor. Example:
138
Florent Xicluna4886d242010-03-08 13:27:26 +0000139 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000140 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000141
Brett Cannona23810f2008-05-26 19:04:21 +0000142getstatusoutput(cmd):
143 Return (status, output) of executing cmd in a shell.
144
145 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
146 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
147 returned output will contain output or error messages. A trailing newline
148 is stripped from the output. The exit status for the command can be
149 interpreted according to the rules for the C function wait(). Example:
150
Brett Cannona23810f2008-05-26 19:04:21 +0000151 >>> subprocess.getstatusoutput('ls /bin/ls')
152 (0, '/bin/ls')
153 >>> subprocess.getstatusoutput('cat /bin/junk')
154 (256, 'cat: /bin/junk: No such file or directory')
155 >>> subprocess.getstatusoutput('/bin/junk')
156 (256, 'sh: /bin/junk: not found')
157
158getoutput(cmd):
159 Return output (stdout or stderr) of executing cmd in a shell.
160
161 Like getstatusoutput(), except the exit status is ignored and the return
162 value is a string containing the command's output. Example:
163
Brett Cannona23810f2008-05-26 19:04:21 +0000164 >>> subprocess.getoutput('ls /bin/ls')
165 '/bin/ls'
166
Georg Brandlf9734072008-12-07 15:30:06 +0000167check_output(*popenargs, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700168 Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000169
Georg Brandl2708f3a2009-12-20 14:38:23 +0000170 If the exit code was non-zero it raises a CalledProcessError. The
171 CalledProcessError object will have the return code in the returncode
172 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000173
Georg Brandl2708f3a2009-12-20 14:38:23 +0000174 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000175
Georg Brandl2708f3a2009-12-20 14:38:23 +0000176 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000177
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300178 There is an additional optional argument, "input", allowing you to
179 pass a string to the subprocess's stdin. If you use this argument
180 you may not also use the Popen constructor's "stdin" argument.
Brett Cannona23810f2008-05-26 19:04:21 +0000181
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000182Exceptions
183----------
184Exceptions raised in the child process, before the new program has
185started to execute, will be re-raised in the parent. Additionally,
186the exception object will have one extra attribute called
187'child_traceback', which is a string containing traceback information
188from the childs point of view.
189
190The most common exception raised is OSError. This occurs, for
191example, when trying to execute a non-existent file. Applications
192should prepare for OSErrors.
193
194A ValueError will be raised if Popen is called with invalid arguments.
195
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400196Exceptions defined within this module inherit from SubprocessError.
197check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400198called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400199be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000200
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000201
202Security
203--------
204Unlike some other popen functions, this implementation will never call
205/bin/sh implicitly. This means that all characters, including shell
206metacharacters, can safely be passed to child processes.
207
208
209Popen objects
210=============
211Instances of the Popen class have the following methods:
212
213poll()
214 Check if child process has terminated. Returns returncode
215 attribute.
216
217wait()
218 Wait for child process to terminate. Returns returncode attribute.
219
220communicate(input=None)
221 Interact with process: Send data to stdin. Read data from stdout
222 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000223 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000224 sent to the child process, or None, if no data should be sent to
225 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000226
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000227 communicate() returns a tuple (stdout, stderr).
228
229 Note: The data read is buffered in memory, so do not use this
230 method if the data size is large or unlimited.
231
232The following attributes are also available:
233
234stdin
235 If the stdin argument is PIPE, this attribute is a file object
236 that provides input to the child process. Otherwise, it is None.
237
238stdout
239 If the stdout argument is PIPE, this attribute is a file object
240 that provides output from the child process. Otherwise, it is
241 None.
242
243stderr
244 If the stderr argument is PIPE, this attribute is file object that
245 provides error output from the child process. Otherwise, it is
246 None.
247
248pid
249 The process ID of the child process.
250
251returncode
252 The child return code. A None value indicates that the process
253 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000254 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000255
256
257Replacing older functions with the subprocess module
258====================================================
259In this section, "a ==> b" means that b can be used as a replacement
260for a.
261
262Note: All functions in this section fail (more or less) silently if
263the executed program cannot be found; this module raises an OSError
264exception.
265
266In the following examples, we assume that the subprocess module is
267imported with "from subprocess import *".
268
269
270Replacing /bin/sh shell backquote
271---------------------------------
272output=`mycmd myarg`
273==>
274output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
275
276
277Replacing shell pipe line
278-------------------------
279output=`dmesg | grep hda`
280==>
281p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000282p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000283output = p2.communicate()[0]
284
285
286Replacing os.system()
287---------------------
288sts = os.system("mycmd" + " myarg")
289==>
290p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000291pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000292
293Note:
294
295* Calling the program through the shell is usually not required.
296
297* It's easier to look at the returncode attribute than the
298 exitstatus.
299
300A more real-world example would look like this:
301
302try:
303 retcode = call("mycmd" + " myarg", shell=True)
304 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000305 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000306 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000307 print("Child returned", retcode, file=sys.stderr)
308except OSError as e:
309 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000310
311
312Replacing os.spawn*
313-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000314P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000315
316pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
317==>
318pid = Popen(["/bin/mycmd", "myarg"]).pid
319
320
321P_WAIT example:
322
323retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
324==>
325retcode = call(["/bin/mycmd", "myarg"])
326
327
Tim Peterse718f612004-10-12 21:51:32 +0000328Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000329
330os.spawnvp(os.P_NOWAIT, path, args)
331==>
332Popen([path] + args[1:])
333
334
Tim Peterse718f612004-10-12 21:51:32 +0000335Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000336
337os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
338==>
339Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000340"""
341
342import sys
343mswindows = (sys.platform == "win32")
344
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000345import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000346import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400347import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000348import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000349import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000350import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000351import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000352import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200353import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200354try:
355 from time import monotonic as _time
356except ImportError:
357 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000358
Peter Astrand454f7672005-01-01 09:36:35 +0000359# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400360class SubprocessError(Exception): pass
361
362
363class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000364 """This exception is raised when a process run by check_call() or
365 check_output() returns a non-zero exit status.
366 The exit status will be stored in the returncode attribute;
367 check_output() will also store the output in the output attribute.
368 """
369 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000370 self.returncode = returncode
371 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000372 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000373 def __str__(self):
374 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
375
Peter Astrand454f7672005-01-01 09:36:35 +0000376
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400377class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400378 """This exception is raised when the timeout expires while waiting for a
379 child process.
380 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400381 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400382 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400383 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400384 self.output = output
385
386 def __str__(self):
387 return ("Command '%s' timed out after %s seconds" %
388 (self.cmd, self.timeout))
389
390
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000391if mswindows:
392 import threading
393 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200394 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000395 class STARTUPINFO:
396 dwFlags = 0
397 hStdInput = None
398 hStdOutput = None
399 hStdError = None
400 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000401else:
402 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000403 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700404 import _posixsubprocess
405 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000406
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000407 # When select or poll has indicated that the file is writable,
408 # we can write up to _PIPE_BUF bytes without risk of blocking.
409 # POSIX defines PIPE_BUF as >= 512.
410 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
411
412
Brett Cannona23810f2008-05-26 19:04:21 +0000413__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200414 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000415
Brian Curtin1ce6b582010-04-24 16:19:22 +0000416if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200417 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
418 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
419 STD_ERROR_HANDLE, SW_HIDE,
420 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500421
Brian Curtin08fd8d92011-04-29 16:11:30 -0500422 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500423 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
424 "STD_ERROR_HANDLE", "SW_HIDE",
425 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200426
427 class Handle(int):
428 closed = False
429
430 def Close(self, CloseHandle=_winapi.CloseHandle):
431 if not self.closed:
432 self.closed = True
433 CloseHandle(self)
434
435 def Detach(self):
436 if not self.closed:
437 self.closed = True
438 return int(self)
439 raise ValueError("already closed")
440
441 def __repr__(self):
442 return "Handle(%d)" % int(self)
443
444 __del__ = Close
445 __str__ = __repr__
446
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000447try:
448 MAXFD = os.sysconf("SC_OPEN_MAX")
449except:
450 MAXFD = 256
451
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200452# This lists holds Popen instances for which the underlying process had not
453# exited at the time its __del__ method got called: those processes are wait()ed
454# for synchronously from _cleanup() when a new Popen object is created, to avoid
455# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000456_active = []
457
458def _cleanup():
459 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000460 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200461 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000462 try:
463 _active.remove(inst)
464 except ValueError:
465 # This can happen if two threads create a new Popen instance.
466 # It's harmless that it was already removed, so ignore.
467 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000468
469PIPE = -1
470STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200471DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000472
473
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000474def _eintr_retry_call(func, *args):
475 while True:
476 try:
477 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200478 except InterruptedError:
479 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000480
481
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200482# XXX This function is only used by multiprocessing and the test suite,
483# but it's here so that it can be imported when Python is compiled without
484# threads.
485
486def _args_from_interpreter_flags():
487 """Return a list of command-line arguments reproducing the current
488 settings in sys.flags and sys.warnoptions."""
489 flag_opt_map = {
490 'debug': 'd',
491 # 'inspect': 'i',
492 # 'interactive': 'i',
493 'optimize': 'O',
494 'dont_write_bytecode': 'B',
495 'no_user_site': 's',
496 'no_site': 'S',
497 'ignore_environment': 'E',
498 'verbose': 'v',
499 'bytes_warning': 'b',
500 'quiet': 'q',
501 'hash_randomization': 'R',
502 }
503 args = []
504 for flag, opt in flag_opt_map.items():
505 v = getattr(sys.flags, flag)
506 if v > 0:
507 args.append('-' + opt * v)
508 for opt in sys.warnoptions:
509 args.append('-W' + opt)
510 return args
511
512
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400513def call(*popenargs, timeout=None, **kwargs):
514 """Run command with arguments. Wait for command to complete or
515 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000516
517 The arguments are the same as for the Popen constructor. Example:
518
519 retcode = call(["ls", "-l"])
520 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200521 with Popen(*popenargs, **kwargs) as p:
522 try:
523 return p.wait(timeout=timeout)
524 except:
525 p.kill()
526 p.wait()
527 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000528
529
Peter Astrand454f7672005-01-01 09:36:35 +0000530def check_call(*popenargs, **kwargs):
531 """Run command with arguments. Wait for command to complete. If
532 the exit code was zero then return, otherwise raise
533 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000534 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000535
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400536 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000537
538 check_call(["ls", "-l"])
539 """
540 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000541 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000542 cmd = kwargs.get("args")
543 if cmd is None:
544 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000545 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000546 return 0
547
548
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400549def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700550 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000551
552 If the exit code was non-zero it raises a CalledProcessError. The
553 CalledProcessError object will have the return code in the returncode
554 attribute and output in the output attribute.
555
556 The arguments are the same as for the Popen constructor. Example:
557
558 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000559 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000560
561 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000562 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000563
564 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000565 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000566 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000567 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700568
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300569 There is an additional optional argument, "input", allowing you to
570 pass a string to the subprocess's stdin. If you use this argument
571 you may not also use the Popen constructor's "stdin" argument, as
572 it too will be used internally. Example:
573
574 >>> check_output(["sed", "-e", "s/foo/bar/"],
575 ... input=b"when in the course of fooman events\n")
576 b'when in the course of barman events\n'
577
Gregory P. Smith91110f52013-03-19 23:25:16 -0700578 If universal_newlines=True is passed, the return value will be a
579 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000580 """
581 if 'stdout' in kwargs:
582 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300583 if 'input' in kwargs:
584 if 'stdin' in kwargs:
585 raise ValueError('stdin and input arguments may not both be used.')
586 inputdata = kwargs['input']
587 del kwargs['input']
588 kwargs['stdin'] = PIPE
589 else:
590 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200591 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
592 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300593 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200594 except TimeoutExpired:
595 process.kill()
596 output, unused_err = process.communicate()
597 raise TimeoutExpired(process.args, timeout, output=output)
598 except:
599 process.kill()
600 process.wait()
601 raise
602 retcode = process.poll()
603 if retcode:
604 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000605 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000606
607
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000608def list2cmdline(seq):
609 """
610 Translate a sequence of arguments into a command line
611 string, using the same rules as the MS C runtime:
612
613 1) Arguments are delimited by white space, which is either a
614 space or a tab.
615
616 2) A string surrounded by double quotation marks is
617 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000618 contained within. A quoted string can be embedded in an
619 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000620
621 3) A double quotation mark preceded by a backslash is
622 interpreted as a literal double quotation mark.
623
624 4) Backslashes are interpreted literally, unless they
625 immediately precede a double quotation mark.
626
627 5) If backslashes immediately precede a double quotation mark,
628 every pair of backslashes is interpreted as a literal
629 backslash. If the number of backslashes is odd, the last
630 backslash escapes the next double quotation mark as
631 described in rule 3.
632 """
633
634 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000635 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
636 # or search http://msdn.microsoft.com for
637 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000638 result = []
639 needquote = False
640 for arg in seq:
641 bs_buf = []
642
643 # Add a space to separate this argument from the others
644 if result:
645 result.append(' ')
646
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000647 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000648 if needquote:
649 result.append('"')
650
651 for c in arg:
652 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000653 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000654 bs_buf.append(c)
655 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000656 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000657 result.append('\\' * len(bs_buf)*2)
658 bs_buf = []
659 result.append('\\"')
660 else:
661 # Normal char
662 if bs_buf:
663 result.extend(bs_buf)
664 bs_buf = []
665 result.append(c)
666
Christian Heimesfdab48e2008-01-20 09:06:41 +0000667 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000668 if bs_buf:
669 result.extend(bs_buf)
670
671 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000672 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000673 result.append('"')
674
675 return ''.join(result)
676
677
Brett Cannona23810f2008-05-26 19:04:21 +0000678# Various tools for executing commands and looking at their output and status.
679#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000680# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000681
682def getstatusoutput(cmd):
683 """Return (status, output) of executing cmd in a shell.
684
685 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
686 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
687 returned output will contain output or error messages. A trailing newline
688 is stripped from the output. The exit status for the command can be
689 interpreted according to the rules for the C function wait(). Example:
690
691 >>> import subprocess
692 >>> subprocess.getstatusoutput('ls /bin/ls')
693 (0, '/bin/ls')
694 >>> subprocess.getstatusoutput('cat /bin/junk')
695 (256, 'cat: /bin/junk: No such file or directory')
696 >>> subprocess.getstatusoutput('/bin/junk')
697 (256, 'sh: /bin/junk: not found')
698 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200699 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
700 try:
701 text = pipe.read()
702 sts = pipe.close()
703 except:
704 process = pipe._proc
705 process.kill()
706 process.wait()
707 raise
708 if sts is None:
709 sts = 0
710 if text[-1:] == '\n':
711 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000712 return sts, text
713
714
715def getoutput(cmd):
716 """Return output (stdout or stderr) of executing cmd in a shell.
717
718 Like getstatusoutput(), except the exit status is ignored and the return
719 value is a string containing the command's output. Example:
720
721 >>> import subprocess
722 >>> subprocess.getoutput('ls /bin/ls')
723 '/bin/ls'
724 """
725 return getstatusoutput(cmd)[1]
726
727
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000728_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000729
730
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000731class Popen(object):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700732 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000733 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000734 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
735 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000736 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000737 restore_signals=True, start_new_session=False,
738 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000739 """Create new Popen instance."""
740 _cleanup()
741
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000742 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400743 self._input = None
744 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000745 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700746 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000747 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000748 raise TypeError("bufsize must be an integer")
749
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000750 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000751 if preexec_fn is not None:
752 raise ValueError("preexec_fn is not supported on Windows "
753 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000754 any_stdio_set = (stdin is not None or stdout is not None or
755 stderr is not None)
756 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
757 if any_stdio_set:
758 close_fds = False
759 else:
760 close_fds = True
761 elif close_fds and any_stdio_set:
762 raise ValueError(
763 "close_fds is not supported on Windows platforms"
764 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000765 else:
766 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000767 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
768 close_fds = True
769 if pass_fds and not close_fds:
770 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
771 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000772 if startupinfo is not None:
773 raise ValueError("startupinfo is only supported on Windows "
774 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000775 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000776 raise ValueError("creationflags is only supported on Windows "
777 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000778
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400779 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000780 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000781 self.stdout = None
782 self.stderr = None
783 self.pid = None
784 self.returncode = None
785 self.universal_newlines = universal_newlines
786
787 # Input and output objects. The general principle is like
788 # this:
789 #
790 # Parent Child
791 # ------ -----
792 # p2cwrite ---stdin---> p2cread
793 # c2pread <--stdout--- c2pwrite
794 # errread <--stderr--- errwrite
795 #
796 # On POSIX, the child objects are file descriptors. On
797 # Windows, these are Windows file handles. The parent objects
798 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000799 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000800 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000801
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000802 (p2cread, p2cwrite,
803 c2pread, c2pwrite,
804 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
805
Antoine Pitrouc9982322011-01-04 19:07:07 +0000806 # We wrap OS handles *before* launching the child, otherwise a
807 # quickly terminating child could make our fds unwrappable
808 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000809
Thomas Wouterscf297e42007-02-23 15:07:44 +0000810 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000811 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000812 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000813 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000814 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000815 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000816 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000817
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000818 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000819 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300820 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200821 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000822 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000823 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000824 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000825 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000826 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000827 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000828 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000829 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000830
Antoine Pitrouc9982322011-01-04 19:07:07 +0000831 try:
832 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300833 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000834 startupinfo, creationflags, shell,
835 p2cread, p2cwrite,
836 c2pread, c2pwrite,
837 errread, errwrite,
838 restore_signals, start_new_session)
839 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800840 # Cleanup if the child failed starting.
841 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000842 try:
843 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200844 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800845 pass # Ignore EBADF or other errors.
846
847 # Make sure the child pipes are closed as well.
848 to_close = []
849 if stdin == PIPE:
850 to_close.append(p2cread)
851 if stdout == PIPE:
852 to_close.append(c2pwrite)
853 if stderr == PIPE:
854 to_close.append(errwrite)
855 for fd in to_close:
856 try:
857 os.close(fd)
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200858 except OSError:
Antoine Pitrouc9982322011-01-04 19:07:07 +0000859 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800860
Antoine Pitrouc9982322011-01-04 19:07:07 +0000861 raise
862
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000863
Guido van Rossum98297ee2007-11-06 21:34:58 +0000864 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300865 data = data.decode(encoding)
866 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000867
Brian Curtin79cdb662010-12-03 02:46:02 +0000868 def __enter__(self):
869 return self
870
871 def __exit__(self, type, value, traceback):
872 if self.stdout:
873 self.stdout.close()
874 if self.stderr:
875 self.stderr.close()
876 if self.stdin:
877 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700878 # Wait for the process to terminate, to avoid zombies.
879 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000880
Brett Cannon84df1e62010-05-14 00:33:40 +0000881 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200882 # If __init__ hasn't had a chance to execute (e.g. if it
883 # was passed an undeclared keyword argument), we don't
884 # have a _child_created attribute at all.
885 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000886 # We didn't get to successfully create a child process.
887 return
888 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000889 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000890 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000891 # Child is still running, keep us alive until we can wait on it.
892 _active.append(self)
893
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200894 def _get_devnull(self):
895 if not hasattr(self, '_devnull'):
896 self._devnull = os.open(os.devnull, os.O_RDWR)
897 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000898
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400899 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000900 """Interact with process: Send data to stdin. Read data from
901 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700902 process to terminate. The optional input argument should be
903 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000904 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000905
Peter Astrand23109f02005-03-03 20:28:59 +0000906 communicate() returns a tuple (stdout, stderr)."""
907
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400908 if self._communication_started and input:
909 raise ValueError("Cannot send input after starting communication")
910
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400911 # Optimization: If we are not worried about timeouts, we haven't
912 # started communicating, and we have one or zero pipes, using select()
913 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200914 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400915 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000916 stdout = None
917 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000918 if self.stdin:
919 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200920 try:
921 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200922 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200923 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
924 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000925 self.stdin.close()
926 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200927 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000928 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000929 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200930 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000931 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000932 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200933 else:
934 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200935 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200936 else:
937 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000938
Victor Stinner7a8d0812011-04-05 13:13:08 +0200939 try:
940 stdout, stderr = self._communicate(input, endtime, timeout)
941 finally:
942 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400943
Victor Stinner7a8d0812011-04-05 13:13:08 +0200944 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400945
946 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000947
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000948
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000949 def poll(self):
950 return self._internal_poll()
951
952
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400953 def _remaining_time(self, endtime):
954 """Convenience for _communicate when computing timeouts."""
955 if endtime is None:
956 return None
957 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200958 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400959
960
Reid Kleckner2b228f02011-03-16 16:57:54 -0400961 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400962 """Convenience for checking if a timeout has expired."""
963 if endtime is None:
964 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200965 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400966 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400967
968
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000969 if mswindows:
970 #
971 # Windows methods
972 #
973 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000974 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000975 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
976 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000977 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000978 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000979
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000980 p2cread, p2cwrite = -1, -1
981 c2pread, c2pwrite = -1, -1
982 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000983
Peter Astrandd38ddf42005-02-10 08:32:50 +0000984 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200985 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000986 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200987 p2cread, _ = _winapi.CreatePipe(None, 0)
988 p2cread = Handle(p2cread)
989 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000990 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200991 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
992 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200993 elif stdin == DEVNULL:
994 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000995 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000996 p2cread = msvcrt.get_osfhandle(stdin)
997 else:
998 # Assuming file-like object
999 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1000 p2cread = self._make_inheritable(p2cread)
1001
Peter Astrandd38ddf42005-02-10 08:32:50 +00001002 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001003 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001004 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001005 _, c2pwrite = _winapi.CreatePipe(None, 0)
1006 c2pwrite = Handle(c2pwrite)
1007 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001008 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001009 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1010 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001011 elif stdout == DEVNULL:
1012 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001013 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001014 c2pwrite = msvcrt.get_osfhandle(stdout)
1015 else:
1016 # Assuming file-like object
1017 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1018 c2pwrite = self._make_inheritable(c2pwrite)
1019
Peter Astrandd38ddf42005-02-10 08:32:50 +00001020 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001021 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001022 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001023 _, errwrite = _winapi.CreatePipe(None, 0)
1024 errwrite = Handle(errwrite)
1025 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001026 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001027 errread, errwrite = _winapi.CreatePipe(None, 0)
1028 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001029 elif stderr == STDOUT:
1030 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001031 elif stderr == DEVNULL:
1032 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001033 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001034 errwrite = msvcrt.get_osfhandle(stderr)
1035 else:
1036 # Assuming file-like object
1037 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1038 errwrite = self._make_inheritable(errwrite)
1039
1040 return (p2cread, p2cwrite,
1041 c2pread, c2pwrite,
1042 errread, errwrite)
1043
1044
1045 def _make_inheritable(self, handle):
1046 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001047 h = _winapi.DuplicateHandle(
1048 _winapi.GetCurrentProcess(), handle,
1049 _winapi.GetCurrentProcess(), 0, 1,
1050 _winapi.DUPLICATE_SAME_ACCESS)
1051 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001052
1053
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001054 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001055 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 startupinfo, creationflags, shell,
1057 p2cread, p2cwrite,
1058 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001059 errread, errwrite,
1060 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 """Execute program (MS Windows version)"""
1062
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001063 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001064
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001065 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066 args = list2cmdline(args)
1067
Peter Astrandc1d65362004-11-07 14:30:34 +00001068 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001069 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001070 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001071 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001072 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001073 startupinfo.hStdInput = p2cread
1074 startupinfo.hStdOutput = c2pwrite
1075 startupinfo.hStdError = errwrite
1076
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001077 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001078 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1079 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001080 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001081 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001082
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001083 # Start the process
1084 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001085 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001086 # no special security
1087 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001088 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001089 creationflags,
1090 env,
1091 cwd,
1092 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001093 finally:
1094 # Child is launched. Close the parent's copy of those pipe
1095 # handles that only the child should have open. You need
1096 # to make sure that no handles to the write end of the
1097 # output pipe are maintained in this process or else the
1098 # pipe will not close when the child process exits and the
1099 # ReadFile will hang.
1100 if p2cread != -1:
1101 p2cread.Close()
1102 if c2pwrite != -1:
1103 c2pwrite.Close()
1104 if errwrite != -1:
1105 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001106 if hasattr(self, '_devnull'):
1107 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001108
1109 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001110 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001111 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001112 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001113 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114
Brett Cannon84df1e62010-05-14 00:33:40 +00001115 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001116 _WaitForSingleObject=_winapi.WaitForSingleObject,
1117 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1118 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001119 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001120 attribute.
1121
1122 This method is called by __del__, so it can only refer to objects
1123 in its local scope.
1124
1125 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001126 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001127 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1128 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001129 return self.returncode
1130
1131
Reid Kleckner2b228f02011-03-16 16:57:54 -04001132 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133 """Wait for child process to terminate. Returns returncode
1134 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001135 if endtime is not None:
1136 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001137 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001138 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001139 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001140 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001141 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001142 result = _winapi.WaitForSingleObject(self._handle,
1143 timeout_millis)
1144 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001145 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001146 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001147 return self.returncode
1148
1149
1150 def _readerthread(self, fh, buffer):
1151 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001152 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001153
1154
Reid Kleckner2b228f02011-03-16 16:57:54 -04001155 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001156 # Start reader threads feeding into a list hanging off of this
1157 # object, unless they've already been started.
1158 if self.stdout and not hasattr(self, "_stdout_buff"):
1159 self._stdout_buff = []
1160 self.stdout_thread = \
1161 threading.Thread(target=self._readerthread,
1162 args=(self.stdout, self._stdout_buff))
1163 self.stdout_thread.daemon = True
1164 self.stdout_thread.start()
1165 if self.stderr and not hasattr(self, "_stderr_buff"):
1166 self._stderr_buff = []
1167 self.stderr_thread = \
1168 threading.Thread(target=self._readerthread,
1169 args=(self.stderr, self._stderr_buff))
1170 self.stderr_thread.daemon = True
1171 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172
1173 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001174 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001175 try:
1176 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001177 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001178 if e.errno != errno.EPIPE:
1179 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180 self.stdin.close()
1181
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001182 # Wait for the reader threads, or time out. If we time out, the
1183 # threads remain reading and the fds left open in case the user
1184 # calls communicate again.
1185 if self.stdout is not None:
1186 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001187 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001188 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001189 if self.stderr is not None:
1190 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001191 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001192 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001193
1194 # Collect the output from and close both pipes, now that we know
1195 # both have been read successfully.
1196 stdout = None
1197 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001198 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001199 stdout = self._stdout_buff
1200 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001201 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001202 stderr = self._stderr_buff
1203 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001204
1205 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001206 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001207 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001208 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001209 stderr = stderr[0]
1210
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211 return (stdout, stderr)
1212
Christian Heimesa342c012008-04-20 21:01:16 +00001213 def send_signal(self, sig):
1214 """Send a signal to the process
1215 """
1216 if sig == signal.SIGTERM:
1217 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001218 elif sig == signal.CTRL_C_EVENT:
1219 os.kill(self.pid, signal.CTRL_C_EVENT)
1220 elif sig == signal.CTRL_BREAK_EVENT:
1221 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001222 else:
Brian Curtin19651362010-09-07 13:24:38 +00001223 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001224
1225 def terminate(self):
1226 """Terminates the process
1227 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001228 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001229 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001230 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001231 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1232 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001233 rc = _winapi.GetExitCodeProcess(self._handle)
1234 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001235 raise
1236 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001237
1238 kill = terminate
1239
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001240 else:
1241 #
1242 # POSIX methods
1243 #
1244 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001245 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001246 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1247 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001248 p2cread, p2cwrite = -1, -1
1249 c2pread, c2pwrite = -1, -1
1250 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251
Peter Astrandd38ddf42005-02-10 08:32:50 +00001252 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001253 pass
1254 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001255 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001256 elif stdin == DEVNULL:
1257 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001258 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001259 p2cread = stdin
1260 else:
1261 # Assuming file-like object
1262 p2cread = stdin.fileno()
1263
Peter Astrandd38ddf42005-02-10 08:32:50 +00001264 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001265 pass
1266 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001267 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001268 elif stdout == DEVNULL:
1269 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001270 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001271 c2pwrite = stdout
1272 else:
1273 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001274 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001275
Peter Astrandd38ddf42005-02-10 08:32:50 +00001276 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001277 pass
1278 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001279 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001280 elif stderr == STDOUT:
1281 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001282 elif stderr == DEVNULL:
1283 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001284 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285 errwrite = stderr
1286 else:
1287 # Assuming file-like object
1288 errwrite = stderr.fileno()
1289
1290 return (p2cread, p2cwrite,
1291 c2pread, c2pwrite,
1292 errread, errwrite)
1293
1294
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001295 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001296 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001297 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001298 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001299 os.closerange(start_fd, fd)
1300 start_fd = fd + 1
1301 if start_fd <= MAXFD:
1302 os.closerange(start_fd, MAXFD)
1303
1304
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001305 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001306 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001307 startupinfo, creationflags, shell,
1308 p2cread, p2cwrite,
1309 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001310 errread, errwrite,
1311 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001312 """Execute program (POSIX version)"""
1313
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001314 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001315 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001316 else:
1317 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001318
1319 if shell:
1320 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001321 if executable:
1322 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001323
Peter Astrandd38ddf42005-02-10 08:32:50 +00001324 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001325 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001326 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001327
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001328 # For transferring possible exec failure from child to parent.
1329 # Data format: "exception name:hex errno:description"
1330 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001331 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001332 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001334 # We must avoid complex work that could involve
1335 # malloc or free in the child process to avoid
1336 # potential deadlocks, thus we do all this here.
1337 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001338
Victor Stinner372b8382011-06-21 17:24:21 +02001339 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001340 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1341 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001342 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001343 env_list = None # Use execv instead of execve.
1344 executable = os.fsencode(executable)
1345 if os.path.dirname(executable):
1346 executable_list = (executable,)
1347 else:
1348 # This matches the behavior of os._execvpe().
1349 executable_list = tuple(
1350 os.path.join(os.fsencode(dir), executable)
1351 for dir in os.get_exec_path(env))
1352 fds_to_keep = set(pass_fds)
1353 fds_to_keep.add(errpipe_write)
1354 self.pid = _posixsubprocess.fork_exec(
1355 args, executable_list,
1356 close_fds, sorted(fds_to_keep), cwd, env_list,
1357 p2cread, p2cwrite, c2pread, c2pwrite,
1358 errread, errwrite,
1359 errpipe_read, errpipe_write,
1360 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001361 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001362 finally:
1363 # be sure the FD is closed no matter what
1364 os.close(errpipe_write)
1365
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001366 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001367 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001368 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001369 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001371 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001372 if hasattr(self, '_devnull'):
1373 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001374
1375 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001376 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001377 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001378 while True:
1379 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001380 errpipe_data += part
1381 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001382 break
Facundo Batista10706e22009-06-19 20:34:30 +00001383 finally:
1384 # be sure the FD is closed no matter what
1385 os.close(errpipe_read)
1386
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001387 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001388 try:
1389 _eintr_retry_call(os.waitpid, self.pid, 0)
1390 except OSError as e:
1391 if e.errno != errno.ECHILD:
1392 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001393 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001394 exception_name, hex_errno, err_msg = (
1395 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001396 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001397 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001398 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001399 err_msg = (b'Bad exception data from child: ' +
1400 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001401 child_exception_type = getattr(
1402 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001403 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001404 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001405 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001406 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001407 child_exec_never_called = (err_msg == "noexec")
1408 if child_exec_never_called:
1409 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001410 if errno_num != 0:
1411 err_msg = os.strerror(errno_num)
1412 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001413 if child_exec_never_called:
1414 # The error must be from chdir(cwd).
1415 err_msg += ': ' + repr(cwd)
1416 else:
1417 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001418 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001419 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001420
1421
Brett Cannon84df1e62010-05-14 00:33:40 +00001422 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1423 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1424 _WEXITSTATUS=os.WEXITSTATUS):
1425 # This method is called (indirectly) by __del__, so it cannot
1426 # refer to anything outside of its local scope."""
1427 if _WIFSIGNALED(sts):
1428 self.returncode = -_WTERMSIG(sts)
1429 elif _WIFEXITED(sts):
1430 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001431 else:
1432 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001433 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001434
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001435
Brett Cannon84df1e62010-05-14 00:33:40 +00001436 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001437 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001438 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001439 attribute.
1440
1441 This method is called by __del__, so it cannot reference anything
1442 outside of the local scope (nor can any methods it calls).
1443
1444 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001445 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001446 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001447 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001448 if pid == self.pid:
1449 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001450 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001451 if _deadstate is not None:
1452 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001453 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001454 # This happens if SIGCLD is set to be ignored or
1455 # waiting for child processes has otherwise been
1456 # disabled for our process. This child is dead, we
1457 # can't get the status.
1458 # http://bugs.python.org/issue15756
1459 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001460 return self.returncode
1461
1462
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001463 def _try_wait(self, wait_flags):
1464 try:
1465 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1466 except OSError as e:
1467 if e.errno != errno.ECHILD:
1468 raise
1469 # This happens if SIGCLD is set to be ignored or waiting
1470 # for child processes has otherwise been disabled for our
1471 # process. This child is dead, we can't get the status.
1472 pid = self.pid
1473 sts = 0
1474 return (pid, sts)
1475
1476
1477 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001478 """Wait for child process to terminate. Returns returncode
1479 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001480 if self.returncode is not None:
1481 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001482
1483 # endtime is preferred to timeout. timeout is only used for
1484 # printing.
1485 if endtime is not None or timeout is not None:
1486 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001487 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001488 elif timeout is None:
1489 timeout = self._remaining_time(endtime)
1490
1491 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001492 # Enter a busy loop if we have a timeout. This busy loop was
1493 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1494 delay = 0.0005 # 500 us -> initial delay of 1 ms
1495 while True:
1496 (pid, sts) = self._try_wait(os.WNOHANG)
1497 assert pid == self.pid or pid == 0
1498 if pid == self.pid:
1499 self._handle_exitstatus(sts)
1500 break
1501 remaining = self._remaining_time(endtime)
1502 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001503 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001504 delay = min(delay * 2, remaining, .05)
1505 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001506 else:
1507 while self.returncode is None:
1508 (pid, sts) = self._try_wait(0)
1509 # Check the pid and loop as waitpid has been known to return
1510 # 0 even without WNOHANG in odd situations. issue14396.
1511 if pid == self.pid:
1512 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001513 return self.returncode
1514
1515
Reid Kleckner2b228f02011-03-16 16:57:54 -04001516 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001517 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001518 # Flush stdio buffer. This might block, if the user has
1519 # been writing to .stdin in an uncontrolled fashion.
1520 self.stdin.flush()
1521 if not input:
1522 self.stdin.close()
1523
1524 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001525 stdout, stderr = self._communicate_with_poll(input, endtime,
1526 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001527 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001528 stdout, stderr = self._communicate_with_select(input, endtime,
1529 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001530
1531 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001532
1533 # All data exchanged. Translate lists into strings.
1534 if stdout is not None:
1535 stdout = b''.join(stdout)
1536 if stderr is not None:
1537 stderr = b''.join(stderr)
1538
1539 # Translate newlines, if requested.
1540 # This also turns bytes into strings.
1541 if self.universal_newlines:
1542 if stdout is not None:
1543 stdout = self._translate_newlines(stdout,
1544 self.stdout.encoding)
1545 if stderr is not None:
1546 stderr = self._translate_newlines(stderr,
1547 self.stderr.encoding)
1548
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001549 return (stdout, stderr)
1550
1551
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001552 def _save_input(self, input):
1553 # This method is called from the _communicate_with_*() methods
1554 # so that if we time out while communicating, we can continue
1555 # sending input if we retry.
1556 if self.stdin and self._input is None:
1557 self._input_offset = 0
1558 self._input = input
1559 if self.universal_newlines and input is not None:
1560 self._input = self._input.encode(self.stdin.encoding)
1561
1562
Reid Kleckner2b228f02011-03-16 16:57:54 -04001563 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001564 stdout = None # Return
1565 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001566
1567 if not self._communication_started:
1568 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001569
1570 poller = select.poll()
1571 def register_and_append(file_obj, eventmask):
1572 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001573 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001574
1575 def close_unregister_and_remove(fd):
1576 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001577 self._fd2file[fd].close()
1578 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001579
1580 if self.stdin and input:
1581 register_and_append(self.stdin, select.POLLOUT)
1582
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001583 # Only create this mapping if we haven't already.
1584 if not self._communication_started:
1585 self._fd2output = {}
1586 if self.stdout:
1587 self._fd2output[self.stdout.fileno()] = []
1588 if self.stderr:
1589 self._fd2output[self.stderr.fileno()] = []
1590
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001591 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1592 if self.stdout:
1593 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001594 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001595 if self.stderr:
1596 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001597 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001598
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001599 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001600
1601 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001602 timeout = self._remaining_time(endtime)
1603 if timeout is not None and timeout < 0:
1604 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001605 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001606 ready = poller.poll(timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001607 except OSError as e:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001608 if e.args[0] == errno.EINTR:
1609 continue
1610 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001611 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001612
1613 # XXX Rewrite these to use non-blocking I/O on the
1614 # file objects; they are no longer using C stdio!
1615
1616 for fd, mode in ready:
1617 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001618 chunk = self._input[self._input_offset :
1619 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001620 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001621 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001622 except OSError as e:
1623 if e.errno == errno.EPIPE:
1624 close_unregister_and_remove(fd)
1625 else:
1626 raise
1627 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001628 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001629 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001630 elif mode & select_POLLIN_POLLPRI:
1631 data = os.read(fd, 4096)
1632 if not data:
1633 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001634 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001635 else:
1636 # Ignore hang up or errors.
1637 close_unregister_and_remove(fd)
1638
1639 return (stdout, stderr)
1640
1641
Reid Kleckner2b228f02011-03-16 16:57:54 -04001642 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001643 if not self._communication_started:
1644 self._read_set = []
1645 self._write_set = []
1646 if self.stdin and input:
1647 self._write_set.append(self.stdin)
1648 if self.stdout:
1649 self._read_set.append(self.stdout)
1650 if self.stderr:
1651 self._read_set.append(self.stderr)
1652
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001653 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001654
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001655 stdout = None # Return
1656 stderr = None # Return
1657
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001658 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001659 if not self._communication_started:
1660 self._stdout_buff = []
1661 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001662 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001663 if not self._communication_started:
1664 self._stderr_buff = []
1665 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001666
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001667 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001668 timeout = self._remaining_time(endtime)
1669 if timeout is not None and timeout < 0:
1670 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001671 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001672 (rlist, wlist, xlist) = \
1673 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001674 timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001675 except OSError as e:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001676 if e.args[0] == errno.EINTR:
1677 continue
1678 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001679
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001680 # According to the docs, returning three empty lists indicates
1681 # that the timeout expired.
1682 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001683 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001684 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001685 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001686
Guido van Rossum98297ee2007-11-06 21:34:58 +00001687 # XXX Rewrite these to use non-blocking I/O on the
1688 # file objects; they are no longer using C stdio!
1689
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001690 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001691 chunk = self._input[self._input_offset :
1692 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001693 try:
1694 bytes_written = os.write(self.stdin.fileno(), chunk)
1695 except OSError as e:
1696 if e.errno == errno.EPIPE:
1697 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001698 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001699 else:
1700 raise
1701 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001702 self._input_offset += bytes_written
1703 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001704 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001705 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001706
1707 if self.stdout in rlist:
1708 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001709 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001710 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001711 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001712 stdout.append(data)
1713
1714 if self.stderr in rlist:
1715 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001716 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001717 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001718 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001719 stderr.append(data)
1720
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001721 return (stdout, stderr)
1722
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001723
Christian Heimesa342c012008-04-20 21:01:16 +00001724 def send_signal(self, sig):
1725 """Send a signal to the process
1726 """
1727 os.kill(self.pid, sig)
1728
1729 def terminate(self):
1730 """Terminate the process with SIGTERM
1731 """
1732 self.send_signal(signal.SIGTERM)
1733
1734 def kill(self):
1735 """Kill the process with SIGKILL
1736 """
1737 self.send_signal(signal.SIGKILL)