blob: f69b42a715fddc9eaf5b70945cfac84a182842bd [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
Brett Cannona23810f2008-05-26 19:04:21 +0000178
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000179Exceptions
180----------
181Exceptions raised in the child process, before the new program has
182started to execute, will be re-raised in the parent. Additionally,
183the exception object will have one extra attribute called
184'child_traceback', which is a string containing traceback information
185from the childs point of view.
186
187The most common exception raised is OSError. This occurs, for
188example, when trying to execute a non-existent file. Applications
189should prepare for OSErrors.
190
191A ValueError will be raised if Popen is called with invalid arguments.
192
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400193Exceptions defined within this module inherit from SubprocessError.
194check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400195called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400196be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000197
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000198
199Security
200--------
201Unlike some other popen functions, this implementation will never call
202/bin/sh implicitly. This means that all characters, including shell
203metacharacters, can safely be passed to child processes.
204
205
206Popen objects
207=============
208Instances of the Popen class have the following methods:
209
210poll()
211 Check if child process has terminated. Returns returncode
212 attribute.
213
214wait()
215 Wait for child process to terminate. Returns returncode attribute.
216
217communicate(input=None)
218 Interact with process: Send data to stdin. Read data from stdout
219 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000220 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000221 sent to the child process, or None, if no data should be sent to
222 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000223
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000224 communicate() returns a tuple (stdout, stderr).
225
226 Note: The data read is buffered in memory, so do not use this
227 method if the data size is large or unlimited.
228
229The following attributes are also available:
230
231stdin
232 If the stdin argument is PIPE, this attribute is a file object
233 that provides input to the child process. Otherwise, it is None.
234
235stdout
236 If the stdout argument is PIPE, this attribute is a file object
237 that provides output from the child process. Otherwise, it is
238 None.
239
240stderr
241 If the stderr argument is PIPE, this attribute is file object that
242 provides error output from the child process. Otherwise, it is
243 None.
244
245pid
246 The process ID of the child process.
247
248returncode
249 The child return code. A None value indicates that the process
250 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000251 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000252
253
254Replacing older functions with the subprocess module
255====================================================
256In this section, "a ==> b" means that b can be used as a replacement
257for a.
258
259Note: All functions in this section fail (more or less) silently if
260the executed program cannot be found; this module raises an OSError
261exception.
262
263In the following examples, we assume that the subprocess module is
264imported with "from subprocess import *".
265
266
267Replacing /bin/sh shell backquote
268---------------------------------
269output=`mycmd myarg`
270==>
271output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
272
273
274Replacing shell pipe line
275-------------------------
276output=`dmesg | grep hda`
277==>
278p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000279p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000280output = p2.communicate()[0]
281
282
283Replacing os.system()
284---------------------
285sts = os.system("mycmd" + " myarg")
286==>
287p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000288pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000289
290Note:
291
292* Calling the program through the shell is usually not required.
293
294* It's easier to look at the returncode attribute than the
295 exitstatus.
296
297A more real-world example would look like this:
298
299try:
300 retcode = call("mycmd" + " myarg", shell=True)
301 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000302 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000303 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000304 print("Child returned", retcode, file=sys.stderr)
305except OSError as e:
306 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000307
308
309Replacing os.spawn*
310-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000311P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000312
313pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
314==>
315pid = Popen(["/bin/mycmd", "myarg"]).pid
316
317
318P_WAIT example:
319
320retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
321==>
322retcode = call(["/bin/mycmd", "myarg"])
323
324
Tim Peterse718f612004-10-12 21:51:32 +0000325Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000326
327os.spawnvp(os.P_NOWAIT, path, args)
328==>
329Popen([path] + args[1:])
330
331
Tim Peterse718f612004-10-12 21:51:32 +0000332Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000333
334os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
335==>
336Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000337"""
338
339import sys
340mswindows = (sys.platform == "win32")
341
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000342import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000343import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400344import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000345import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000346import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000347import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000348import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000349import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200350import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200351try:
352 from time import monotonic as _time
353except ImportError:
354 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000355
Peter Astrand454f7672005-01-01 09:36:35 +0000356# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400357class SubprocessError(Exception): pass
358
359
360class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000361 """This exception is raised when a process run by check_call() or
362 check_output() returns a non-zero exit status.
363 The exit status will be stored in the returncode attribute;
364 check_output() will also store the output in the output attribute.
365 """
366 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000367 self.returncode = returncode
368 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000369 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000370 def __str__(self):
371 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
372
Peter Astrand454f7672005-01-01 09:36:35 +0000373
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400374class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400375 """This exception is raised when the timeout expires while waiting for a
376 child process.
377 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400378 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400379 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400380 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400381 self.output = output
382
383 def __str__(self):
384 return ("Command '%s' timed out after %s seconds" %
385 (self.cmd, self.timeout))
386
387
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000388if mswindows:
389 import threading
390 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200391 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000392 class STARTUPINFO:
393 dwFlags = 0
394 hStdInput = None
395 hStdOutput = None
396 hStdError = None
397 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000398else:
399 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000400 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700401 import _posixsubprocess
402 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000403
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000404 # When select or poll has indicated that the file is writable,
405 # we can write up to _PIPE_BUF bytes without risk of blocking.
406 # POSIX defines PIPE_BUF as >= 512.
407 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
408
409
Brett Cannona23810f2008-05-26 19:04:21 +0000410__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200411 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000412
Brian Curtin1ce6b582010-04-24 16:19:22 +0000413if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200414 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
415 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
416 STD_ERROR_HANDLE, SW_HIDE,
417 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500418
Brian Curtin08fd8d92011-04-29 16:11:30 -0500419 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500420 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
421 "STD_ERROR_HANDLE", "SW_HIDE",
422 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200423
424 class Handle(int):
425 closed = False
426
427 def Close(self, CloseHandle=_winapi.CloseHandle):
428 if not self.closed:
429 self.closed = True
430 CloseHandle(self)
431
432 def Detach(self):
433 if not self.closed:
434 self.closed = True
435 return int(self)
436 raise ValueError("already closed")
437
438 def __repr__(self):
439 return "Handle(%d)" % int(self)
440
441 __del__ = Close
442 __str__ = __repr__
443
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000444try:
445 MAXFD = os.sysconf("SC_OPEN_MAX")
446except:
447 MAXFD = 256
448
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200449# This lists holds Popen instances for which the underlying process had not
450# exited at the time its __del__ method got called: those processes are wait()ed
451# for synchronously from _cleanup() when a new Popen object is created, to avoid
452# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000453_active = []
454
455def _cleanup():
456 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000457 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200458 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000459 try:
460 _active.remove(inst)
461 except ValueError:
462 # This can happen if two threads create a new Popen instance.
463 # It's harmless that it was already removed, so ignore.
464 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000465
466PIPE = -1
467STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200468DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000469
470
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000471def _eintr_retry_call(func, *args):
472 while True:
473 try:
474 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200475 except InterruptedError:
476 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000477
478
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200479# XXX This function is only used by multiprocessing and the test suite,
480# but it's here so that it can be imported when Python is compiled without
481# threads.
482
483def _args_from_interpreter_flags():
484 """Return a list of command-line arguments reproducing the current
485 settings in sys.flags and sys.warnoptions."""
486 flag_opt_map = {
487 'debug': 'd',
488 # 'inspect': 'i',
489 # 'interactive': 'i',
490 'optimize': 'O',
491 'dont_write_bytecode': 'B',
492 'no_user_site': 's',
493 'no_site': 'S',
494 'ignore_environment': 'E',
495 'verbose': 'v',
496 'bytes_warning': 'b',
497 'quiet': 'q',
498 'hash_randomization': 'R',
499 }
500 args = []
501 for flag, opt in flag_opt_map.items():
502 v = getattr(sys.flags, flag)
503 if v > 0:
504 args.append('-' + opt * v)
505 for opt in sys.warnoptions:
506 args.append('-W' + opt)
507 return args
508
509
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400510def call(*popenargs, timeout=None, **kwargs):
511 """Run command with arguments. Wait for command to complete or
512 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000513
514 The arguments are the same as for the Popen constructor. Example:
515
516 retcode = call(["ls", "-l"])
517 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200518 with Popen(*popenargs, **kwargs) as p:
519 try:
520 return p.wait(timeout=timeout)
521 except:
522 p.kill()
523 p.wait()
524 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000525
526
Peter Astrand454f7672005-01-01 09:36:35 +0000527def check_call(*popenargs, **kwargs):
528 """Run command with arguments. Wait for command to complete. If
529 the exit code was zero then return, otherwise raise
530 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000531 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000532
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400533 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000534
535 check_call(["ls", "-l"])
536 """
537 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000538 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000539 cmd = kwargs.get("args")
540 if cmd is None:
541 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000542 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000543 return 0
544
545
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400546def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700547 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000548
549 If the exit code was non-zero it raises a CalledProcessError. The
550 CalledProcessError object will have the return code in the returncode
551 attribute and output in the output attribute.
552
553 The arguments are the same as for the Popen constructor. Example:
554
555 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000556 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000557
558 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000559 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000560
561 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000562 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000563 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000564 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700565
566 If universal_newlines=True is passed, the return value will be a
567 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000568 """
569 if 'stdout' in kwargs:
570 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200571 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
572 try:
573 output, unused_err = process.communicate(timeout=timeout)
574 except TimeoutExpired:
575 process.kill()
576 output, unused_err = process.communicate()
577 raise TimeoutExpired(process.args, timeout, output=output)
578 except:
579 process.kill()
580 process.wait()
581 raise
582 retcode = process.poll()
583 if retcode:
584 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000585 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000586
587
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000588def list2cmdline(seq):
589 """
590 Translate a sequence of arguments into a command line
591 string, using the same rules as the MS C runtime:
592
593 1) Arguments are delimited by white space, which is either a
594 space or a tab.
595
596 2) A string surrounded by double quotation marks is
597 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000598 contained within. A quoted string can be embedded in an
599 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000600
601 3) A double quotation mark preceded by a backslash is
602 interpreted as a literal double quotation mark.
603
604 4) Backslashes are interpreted literally, unless they
605 immediately precede a double quotation mark.
606
607 5) If backslashes immediately precede a double quotation mark,
608 every pair of backslashes is interpreted as a literal
609 backslash. If the number of backslashes is odd, the last
610 backslash escapes the next double quotation mark as
611 described in rule 3.
612 """
613
614 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000615 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
616 # or search http://msdn.microsoft.com for
617 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000618 result = []
619 needquote = False
620 for arg in seq:
621 bs_buf = []
622
623 # Add a space to separate this argument from the others
624 if result:
625 result.append(' ')
626
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000627 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000628 if needquote:
629 result.append('"')
630
631 for c in arg:
632 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000633 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000634 bs_buf.append(c)
635 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000636 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000637 result.append('\\' * len(bs_buf)*2)
638 bs_buf = []
639 result.append('\\"')
640 else:
641 # Normal char
642 if bs_buf:
643 result.extend(bs_buf)
644 bs_buf = []
645 result.append(c)
646
Christian Heimesfdab48e2008-01-20 09:06:41 +0000647 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000648 if bs_buf:
649 result.extend(bs_buf)
650
651 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000652 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000653 result.append('"')
654
655 return ''.join(result)
656
657
Brett Cannona23810f2008-05-26 19:04:21 +0000658# Various tools for executing commands and looking at their output and status.
659#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000660# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000661
662def getstatusoutput(cmd):
663 """Return (status, output) of executing cmd in a shell.
664
665 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
666 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
667 returned output will contain output or error messages. A trailing newline
668 is stripped from the output. The exit status for the command can be
669 interpreted according to the rules for the C function wait(). Example:
670
671 >>> import subprocess
672 >>> subprocess.getstatusoutput('ls /bin/ls')
673 (0, '/bin/ls')
674 >>> subprocess.getstatusoutput('cat /bin/junk')
675 (256, 'cat: /bin/junk: No such file or directory')
676 >>> subprocess.getstatusoutput('/bin/junk')
677 (256, 'sh: /bin/junk: not found')
678 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200679 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
680 try:
681 text = pipe.read()
682 sts = pipe.close()
683 except:
684 process = pipe._proc
685 process.kill()
686 process.wait()
687 raise
688 if sts is None:
689 sts = 0
690 if text[-1:] == '\n':
691 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000692 return sts, text
693
694
695def getoutput(cmd):
696 """Return output (stdout or stderr) of executing cmd in a shell.
697
698 Like getstatusoutput(), except the exit status is ignored and the return
699 value is a string containing the command's output. Example:
700
701 >>> import subprocess
702 >>> subprocess.getoutput('ls /bin/ls')
703 '/bin/ls'
704 """
705 return getstatusoutput(cmd)[1]
706
707
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000708_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000709
710
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000711class Popen(object):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700712 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000713 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000714 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
715 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000716 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000717 restore_signals=True, start_new_session=False,
718 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000719 """Create new Popen instance."""
720 _cleanup()
721
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000722 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400723 self._input = None
724 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000725 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700726 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000727 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000728 raise TypeError("bufsize must be an integer")
729
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000730 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000731 if preexec_fn is not None:
732 raise ValueError("preexec_fn is not supported on Windows "
733 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000734 any_stdio_set = (stdin is not None or stdout is not None or
735 stderr is not None)
736 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
737 if any_stdio_set:
738 close_fds = False
739 else:
740 close_fds = True
741 elif close_fds and any_stdio_set:
742 raise ValueError(
743 "close_fds is not supported on Windows platforms"
744 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000745 else:
746 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000747 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
748 close_fds = True
749 if pass_fds and not close_fds:
750 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
751 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000752 if startupinfo is not None:
753 raise ValueError("startupinfo is only supported on Windows "
754 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000755 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000756 raise ValueError("creationflags is only supported on Windows "
757 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000758
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400759 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000760 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000761 self.stdout = None
762 self.stderr = None
763 self.pid = None
764 self.returncode = None
765 self.universal_newlines = universal_newlines
766
767 # Input and output objects. The general principle is like
768 # this:
769 #
770 # Parent Child
771 # ------ -----
772 # p2cwrite ---stdin---> p2cread
773 # c2pread <--stdout--- c2pwrite
774 # errread <--stderr--- errwrite
775 #
776 # On POSIX, the child objects are file descriptors. On
777 # Windows, these are Windows file handles. The parent objects
778 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000779 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000781
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000782 (p2cread, p2cwrite,
783 c2pread, c2pwrite,
784 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
785
Antoine Pitrouc9982322011-01-04 19:07:07 +0000786 # We wrap OS handles *before* launching the child, otherwise a
787 # quickly terminating child could make our fds unwrappable
788 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000789
Thomas Wouterscf297e42007-02-23 15:07:44 +0000790 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000791 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000792 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000793 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000794 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000795 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000796 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000797
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000798 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000799 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300800 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200801 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000802 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000803 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000805 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000806 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000807 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000808 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000809 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000810
Antoine Pitrouc9982322011-01-04 19:07:07 +0000811 try:
812 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300813 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000814 startupinfo, creationflags, shell,
815 p2cread, p2cwrite,
816 c2pread, c2pwrite,
817 errread, errwrite,
818 restore_signals, start_new_session)
819 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800820 # Cleanup if the child failed starting.
821 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000822 try:
823 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200824 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800825 pass # Ignore EBADF or other errors.
826
827 # Make sure the child pipes are closed as well.
828 to_close = []
829 if stdin == PIPE:
830 to_close.append(p2cread)
831 if stdout == PIPE:
832 to_close.append(c2pwrite)
833 if stderr == PIPE:
834 to_close.append(errwrite)
835 for fd in to_close:
836 try:
837 os.close(fd)
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200838 except OSError:
Antoine Pitrouc9982322011-01-04 19:07:07 +0000839 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800840
Antoine Pitrouc9982322011-01-04 19:07:07 +0000841 raise
842
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000843
Guido van Rossum98297ee2007-11-06 21:34:58 +0000844 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300845 data = data.decode(encoding)
846 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000847
Brian Curtin79cdb662010-12-03 02:46:02 +0000848 def __enter__(self):
849 return self
850
851 def __exit__(self, type, value, traceback):
852 if self.stdout:
853 self.stdout.close()
854 if self.stderr:
855 self.stderr.close()
856 if self.stdin:
857 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700858 # Wait for the process to terminate, to avoid zombies.
859 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000860
Brett Cannon84df1e62010-05-14 00:33:40 +0000861 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200862 # If __init__ hasn't had a chance to execute (e.g. if it
863 # was passed an undeclared keyword argument), we don't
864 # have a _child_created attribute at all.
865 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000866 # We didn't get to successfully create a child process.
867 return
868 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000869 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000870 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000871 # Child is still running, keep us alive until we can wait on it.
872 _active.append(self)
873
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200874 def _get_devnull(self):
875 if not hasattr(self, '_devnull'):
876 self._devnull = os.open(os.devnull, os.O_RDWR)
877 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000878
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400879 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000880 """Interact with process: Send data to stdin. Read data from
881 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700882 process to terminate. The optional input argument should be
883 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000884 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000885
Peter Astrand23109f02005-03-03 20:28:59 +0000886 communicate() returns a tuple (stdout, stderr)."""
887
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400888 if self._communication_started and input:
889 raise ValueError("Cannot send input after starting communication")
890
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400891 # Optimization: If we are not worried about timeouts, we haven't
892 # started communicating, and we have one or zero pipes, using select()
893 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200894 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400895 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000896 stdout = None
897 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000898 if self.stdin:
899 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200900 try:
901 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200902 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200903 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
904 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000905 self.stdin.close()
906 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200907 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000908 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000909 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200910 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000911 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000912 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200913 else:
914 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200915 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200916 else:
917 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000918
Victor Stinner7a8d0812011-04-05 13:13:08 +0200919 try:
920 stdout, stderr = self._communicate(input, endtime, timeout)
921 finally:
922 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400923
Victor Stinner7a8d0812011-04-05 13:13:08 +0200924 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400925
926 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000927
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000928
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000929 def poll(self):
930 return self._internal_poll()
931
932
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400933 def _remaining_time(self, endtime):
934 """Convenience for _communicate when computing timeouts."""
935 if endtime is None:
936 return None
937 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200938 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400939
940
Reid Kleckner2b228f02011-03-16 16:57:54 -0400941 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400942 """Convenience for checking if a timeout has expired."""
943 if endtime is None:
944 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200945 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400946 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400947
948
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000949 if mswindows:
950 #
951 # Windows methods
952 #
953 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000954 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000955 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
956 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000957 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000958 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000959
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000960 p2cread, p2cwrite = -1, -1
961 c2pread, c2pwrite = -1, -1
962 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000963
Peter Astrandd38ddf42005-02-10 08:32:50 +0000964 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200965 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000966 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200967 p2cread, _ = _winapi.CreatePipe(None, 0)
968 p2cread = Handle(p2cread)
969 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000970 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200971 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
972 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200973 elif stdin == DEVNULL:
974 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000975 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000976 p2cread = msvcrt.get_osfhandle(stdin)
977 else:
978 # Assuming file-like object
979 p2cread = msvcrt.get_osfhandle(stdin.fileno())
980 p2cread = self._make_inheritable(p2cread)
981
Peter Astrandd38ddf42005-02-10 08:32:50 +0000982 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200983 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000984 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200985 _, c2pwrite = _winapi.CreatePipe(None, 0)
986 c2pwrite = Handle(c2pwrite)
987 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000988 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200989 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
990 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200991 elif stdout == DEVNULL:
992 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000993 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000994 c2pwrite = msvcrt.get_osfhandle(stdout)
995 else:
996 # Assuming file-like object
997 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
998 c2pwrite = self._make_inheritable(c2pwrite)
999
Peter Astrandd38ddf42005-02-10 08:32:50 +00001000 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001001 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001002 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001003 _, errwrite = _winapi.CreatePipe(None, 0)
1004 errwrite = Handle(errwrite)
1005 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001006 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001007 errread, errwrite = _winapi.CreatePipe(None, 0)
1008 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001009 elif stderr == STDOUT:
1010 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001011 elif stderr == DEVNULL:
1012 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001013 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001014 errwrite = msvcrt.get_osfhandle(stderr)
1015 else:
1016 # Assuming file-like object
1017 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1018 errwrite = self._make_inheritable(errwrite)
1019
1020 return (p2cread, p2cwrite,
1021 c2pread, c2pwrite,
1022 errread, errwrite)
1023
1024
1025 def _make_inheritable(self, handle):
1026 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001027 h = _winapi.DuplicateHandle(
1028 _winapi.GetCurrentProcess(), handle,
1029 _winapi.GetCurrentProcess(), 0, 1,
1030 _winapi.DUPLICATE_SAME_ACCESS)
1031 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001032
1033
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001034 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001035 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001036 startupinfo, creationflags, shell,
1037 p2cread, p2cwrite,
1038 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001039 errread, errwrite,
1040 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001041 """Execute program (MS Windows version)"""
1042
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001043 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001044
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001045 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001046 args = list2cmdline(args)
1047
Peter Astrandc1d65362004-11-07 14:30:34 +00001048 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001049 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001050 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001051 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001052 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001053 startupinfo.hStdInput = p2cread
1054 startupinfo.hStdOutput = c2pwrite
1055 startupinfo.hStdError = errwrite
1056
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001057 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001058 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1059 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001060 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001061 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001062
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001063 # Start the process
1064 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001065 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001066 # no special security
1067 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001068 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001069 creationflags,
1070 env,
1071 cwd,
1072 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001073 finally:
1074 # Child is launched. Close the parent's copy of those pipe
1075 # handles that only the child should have open. You need
1076 # to make sure that no handles to the write end of the
1077 # output pipe are maintained in this process or else the
1078 # pipe will not close when the child process exits and the
1079 # ReadFile will hang.
1080 if p2cread != -1:
1081 p2cread.Close()
1082 if c2pwrite != -1:
1083 c2pwrite.Close()
1084 if errwrite != -1:
1085 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001086 if hasattr(self, '_devnull'):
1087 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001088
1089 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001090 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001091 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001093 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001094
Brett Cannon84df1e62010-05-14 00:33:40 +00001095 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001096 _WaitForSingleObject=_winapi.WaitForSingleObject,
1097 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1098 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001099 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001100 attribute.
1101
1102 This method is called by __del__, so it can only refer to objects
1103 in its local scope.
1104
1105 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001106 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001107 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1108 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109 return self.returncode
1110
1111
Reid Kleckner2b228f02011-03-16 16:57:54 -04001112 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001113 """Wait for child process to terminate. Returns returncode
1114 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001115 if endtime is not None:
1116 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001117 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001118 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001119 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001120 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001121 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001122 result = _winapi.WaitForSingleObject(self._handle,
1123 timeout_millis)
1124 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001125 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001126 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001127 return self.returncode
1128
1129
1130 def _readerthread(self, fh, buffer):
1131 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001132 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133
1134
Reid Kleckner2b228f02011-03-16 16:57:54 -04001135 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001136 # Start reader threads feeding into a list hanging off of this
1137 # object, unless they've already been started.
1138 if self.stdout and not hasattr(self, "_stdout_buff"):
1139 self._stdout_buff = []
1140 self.stdout_thread = \
1141 threading.Thread(target=self._readerthread,
1142 args=(self.stdout, self._stdout_buff))
1143 self.stdout_thread.daemon = True
1144 self.stdout_thread.start()
1145 if self.stderr and not hasattr(self, "_stderr_buff"):
1146 self._stderr_buff = []
1147 self.stderr_thread = \
1148 threading.Thread(target=self._readerthread,
1149 args=(self.stderr, self._stderr_buff))
1150 self.stderr_thread.daemon = True
1151 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152
1153 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001154 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001155 try:
1156 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001157 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001158 if e.errno != errno.EPIPE:
1159 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001160 self.stdin.close()
1161
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001162 # Wait for the reader threads, or time out. If we time out, the
1163 # threads remain reading and the fds left open in case the user
1164 # calls communicate again.
1165 if self.stdout is not None:
1166 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001167 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001168 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001169 if self.stderr is not None:
1170 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001171 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001172 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001173
1174 # Collect the output from and close both pipes, now that we know
1175 # both have been read successfully.
1176 stdout = None
1177 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001178 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001179 stdout = self._stdout_buff
1180 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001181 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001182 stderr = self._stderr_buff
1183 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001184
1185 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001186 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001187 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001188 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001189 stderr = stderr[0]
1190
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001191 return (stdout, stderr)
1192
Christian Heimesa342c012008-04-20 21:01:16 +00001193 def send_signal(self, sig):
1194 """Send a signal to the process
1195 """
1196 if sig == signal.SIGTERM:
1197 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001198 elif sig == signal.CTRL_C_EVENT:
1199 os.kill(self.pid, signal.CTRL_C_EVENT)
1200 elif sig == signal.CTRL_BREAK_EVENT:
1201 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001202 else:
Brian Curtin19651362010-09-07 13:24:38 +00001203 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001204
1205 def terminate(self):
1206 """Terminates the process
1207 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001208 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001209 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001210 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001211 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1212 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001213 rc = _winapi.GetExitCodeProcess(self._handle)
1214 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001215 raise
1216 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001217
1218 kill = terminate
1219
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001220 else:
1221 #
1222 # POSIX methods
1223 #
1224 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001225 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001226 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1227 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001228 p2cread, p2cwrite = -1, -1
1229 c2pread, c2pwrite = -1, -1
1230 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001231
Peter Astrandd38ddf42005-02-10 08:32:50 +00001232 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001233 pass
1234 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001235 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001236 elif stdin == DEVNULL:
1237 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001238 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001239 p2cread = stdin
1240 else:
1241 # Assuming file-like object
1242 p2cread = stdin.fileno()
1243
Peter Astrandd38ddf42005-02-10 08:32:50 +00001244 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001245 pass
1246 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001247 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001248 elif stdout == DEVNULL:
1249 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001250 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251 c2pwrite = stdout
1252 else:
1253 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001254 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001255
Peter Astrandd38ddf42005-02-10 08:32:50 +00001256 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001257 pass
1258 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001259 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001260 elif stderr == STDOUT:
1261 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001262 elif stderr == DEVNULL:
1263 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001264 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001265 errwrite = stderr
1266 else:
1267 # Assuming file-like object
1268 errwrite = stderr.fileno()
1269
1270 return (p2cread, p2cwrite,
1271 c2pread, c2pwrite,
1272 errread, errwrite)
1273
1274
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001275 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001276 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001277 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001278 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001279 os.closerange(start_fd, fd)
1280 start_fd = fd + 1
1281 if start_fd <= MAXFD:
1282 os.closerange(start_fd, MAXFD)
1283
1284
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001286 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001287 startupinfo, creationflags, shell,
1288 p2cread, p2cwrite,
1289 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001290 errread, errwrite,
1291 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001292 """Execute program (POSIX version)"""
1293
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001294 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001295 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001296 else:
1297 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001298
1299 if shell:
1300 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001301 if executable:
1302 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303
Peter Astrandd38ddf42005-02-10 08:32:50 +00001304 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001305 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001306 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001307
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001308 # For transferring possible exec failure from child to parent.
1309 # Data format: "exception name:hex errno:description"
1310 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001311 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001312 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001313 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001314 # We must avoid complex work that could involve
1315 # malloc or free in the child process to avoid
1316 # potential deadlocks, thus we do all this here.
1317 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001318
Victor Stinner372b8382011-06-21 17:24:21 +02001319 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001320 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1321 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001322 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001323 env_list = None # Use execv instead of execve.
1324 executable = os.fsencode(executable)
1325 if os.path.dirname(executable):
1326 executable_list = (executable,)
1327 else:
1328 # This matches the behavior of os._execvpe().
1329 executable_list = tuple(
1330 os.path.join(os.fsencode(dir), executable)
1331 for dir in os.get_exec_path(env))
1332 fds_to_keep = set(pass_fds)
1333 fds_to_keep.add(errpipe_write)
1334 self.pid = _posixsubprocess.fork_exec(
1335 args, executable_list,
1336 close_fds, sorted(fds_to_keep), cwd, env_list,
1337 p2cread, p2cwrite, c2pread, c2pwrite,
1338 errread, errwrite,
1339 errpipe_read, errpipe_write,
1340 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001341 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001342 finally:
1343 # be sure the FD is closed no matter what
1344 os.close(errpipe_write)
1345
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001346 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001347 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001348 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001349 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001350 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001351 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001352 if hasattr(self, '_devnull'):
1353 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001354
1355 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001356 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001357 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001358 while True:
1359 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001360 errpipe_data += part
1361 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001362 break
Facundo Batista10706e22009-06-19 20:34:30 +00001363 finally:
1364 # be sure the FD is closed no matter what
1365 os.close(errpipe_read)
1366
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001367 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001368 try:
1369 _eintr_retry_call(os.waitpid, self.pid, 0)
1370 except OSError as e:
1371 if e.errno != errno.ECHILD:
1372 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001373 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001374 exception_name, hex_errno, err_msg = (
1375 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001376 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001377 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001378 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001379 err_msg = (b'Bad exception data from child: ' +
1380 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001381 child_exception_type = getattr(
1382 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001383 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001384 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001385 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001386 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001387 child_exec_never_called = (err_msg == "noexec")
1388 if child_exec_never_called:
1389 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001390 if errno_num != 0:
1391 err_msg = os.strerror(errno_num)
1392 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001393 if child_exec_never_called:
1394 # The error must be from chdir(cwd).
1395 err_msg += ': ' + repr(cwd)
1396 else:
1397 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001398 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001399 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001400
1401
Brett Cannon84df1e62010-05-14 00:33:40 +00001402 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1403 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1404 _WEXITSTATUS=os.WEXITSTATUS):
1405 # This method is called (indirectly) by __del__, so it cannot
1406 # refer to anything outside of its local scope."""
1407 if _WIFSIGNALED(sts):
1408 self.returncode = -_WTERMSIG(sts)
1409 elif _WIFEXITED(sts):
1410 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001411 else:
1412 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001413 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001414
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001415
Brett Cannon84df1e62010-05-14 00:33:40 +00001416 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001417 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001418 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001419 attribute.
1420
1421 This method is called by __del__, so it cannot reference anything
1422 outside of the local scope (nor can any methods it calls).
1423
1424 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001425 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001426 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001427 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001428 if pid == self.pid:
1429 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001430 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001431 if _deadstate is not None:
1432 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001433 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001434 # This happens if SIGCLD is set to be ignored or
1435 # waiting for child processes has otherwise been
1436 # disabled for our process. This child is dead, we
1437 # can't get the status.
1438 # http://bugs.python.org/issue15756
1439 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001440 return self.returncode
1441
1442
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001443 def _try_wait(self, wait_flags):
1444 try:
1445 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1446 except OSError as e:
1447 if e.errno != errno.ECHILD:
1448 raise
1449 # This happens if SIGCLD is set to be ignored or waiting
1450 # for child processes has otherwise been disabled for our
1451 # process. This child is dead, we can't get the status.
1452 pid = self.pid
1453 sts = 0
1454 return (pid, sts)
1455
1456
1457 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001458 """Wait for child process to terminate. Returns returncode
1459 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001460 if self.returncode is not None:
1461 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001462
1463 # endtime is preferred to timeout. timeout is only used for
1464 # printing.
1465 if endtime is not None or timeout is not None:
1466 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001467 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001468 elif timeout is None:
1469 timeout = self._remaining_time(endtime)
1470
1471 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001472 # Enter a busy loop if we have a timeout. This busy loop was
1473 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1474 delay = 0.0005 # 500 us -> initial delay of 1 ms
1475 while True:
1476 (pid, sts) = self._try_wait(os.WNOHANG)
1477 assert pid == self.pid or pid == 0
1478 if pid == self.pid:
1479 self._handle_exitstatus(sts)
1480 break
1481 remaining = self._remaining_time(endtime)
1482 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001483 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001484 delay = min(delay * 2, remaining, .05)
1485 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001486 else:
1487 while self.returncode is None:
1488 (pid, sts) = self._try_wait(0)
1489 # Check the pid and loop as waitpid has been known to return
1490 # 0 even without WNOHANG in odd situations. issue14396.
1491 if pid == self.pid:
1492 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001493 return self.returncode
1494
1495
Reid Kleckner2b228f02011-03-16 16:57:54 -04001496 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001497 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001498 # Flush stdio buffer. This might block, if the user has
1499 # been writing to .stdin in an uncontrolled fashion.
1500 self.stdin.flush()
1501 if not input:
1502 self.stdin.close()
1503
1504 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001505 stdout, stderr = self._communicate_with_poll(input, endtime,
1506 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001507 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001508 stdout, stderr = self._communicate_with_select(input, endtime,
1509 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001510
1511 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001512
1513 # All data exchanged. Translate lists into strings.
1514 if stdout is not None:
1515 stdout = b''.join(stdout)
1516 if stderr is not None:
1517 stderr = b''.join(stderr)
1518
1519 # Translate newlines, if requested.
1520 # This also turns bytes into strings.
1521 if self.universal_newlines:
1522 if stdout is not None:
1523 stdout = self._translate_newlines(stdout,
1524 self.stdout.encoding)
1525 if stderr is not None:
1526 stderr = self._translate_newlines(stderr,
1527 self.stderr.encoding)
1528
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001529 return (stdout, stderr)
1530
1531
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001532 def _save_input(self, input):
1533 # This method is called from the _communicate_with_*() methods
1534 # so that if we time out while communicating, we can continue
1535 # sending input if we retry.
1536 if self.stdin and self._input is None:
1537 self._input_offset = 0
1538 self._input = input
1539 if self.universal_newlines and input is not None:
1540 self._input = self._input.encode(self.stdin.encoding)
1541
1542
Reid Kleckner2b228f02011-03-16 16:57:54 -04001543 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001544 stdout = None # Return
1545 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001546
1547 if not self._communication_started:
1548 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001549
1550 poller = select.poll()
1551 def register_and_append(file_obj, eventmask):
1552 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001553 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001554
1555 def close_unregister_and_remove(fd):
1556 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001557 self._fd2file[fd].close()
1558 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001559
1560 if self.stdin and input:
1561 register_and_append(self.stdin, select.POLLOUT)
1562
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001563 # Only create this mapping if we haven't already.
1564 if not self._communication_started:
1565 self._fd2output = {}
1566 if self.stdout:
1567 self._fd2output[self.stdout.fileno()] = []
1568 if self.stderr:
1569 self._fd2output[self.stderr.fileno()] = []
1570
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001571 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1572 if self.stdout:
1573 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001574 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001575 if self.stderr:
1576 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001577 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001578
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001579 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001580
1581 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001582 timeout = self._remaining_time(endtime)
1583 if timeout is not None and timeout < 0:
1584 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001585 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001586 ready = poller.poll(timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001587 except OSError as e:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001588 if e.args[0] == errno.EINTR:
1589 continue
1590 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001591 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001592
1593 # XXX Rewrite these to use non-blocking I/O on the
1594 # file objects; they are no longer using C stdio!
1595
1596 for fd, mode in ready:
1597 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001598 chunk = self._input[self._input_offset :
1599 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001600 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001601 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001602 except OSError as e:
1603 if e.errno == errno.EPIPE:
1604 close_unregister_and_remove(fd)
1605 else:
1606 raise
1607 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001608 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001609 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001610 elif mode & select_POLLIN_POLLPRI:
1611 data = os.read(fd, 4096)
1612 if not data:
1613 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001614 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001615 else:
1616 # Ignore hang up or errors.
1617 close_unregister_and_remove(fd)
1618
1619 return (stdout, stderr)
1620
1621
Reid Kleckner2b228f02011-03-16 16:57:54 -04001622 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001623 if not self._communication_started:
1624 self._read_set = []
1625 self._write_set = []
1626 if self.stdin and input:
1627 self._write_set.append(self.stdin)
1628 if self.stdout:
1629 self._read_set.append(self.stdout)
1630 if self.stderr:
1631 self._read_set.append(self.stderr)
1632
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001633 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001634
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001635 stdout = None # Return
1636 stderr = None # Return
1637
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001638 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001639 if not self._communication_started:
1640 self._stdout_buff = []
1641 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001642 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001643 if not self._communication_started:
1644 self._stderr_buff = []
1645 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001646
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001647 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001648 timeout = self._remaining_time(endtime)
1649 if timeout is not None and timeout < 0:
1650 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001651 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001652 (rlist, wlist, xlist) = \
1653 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001654 timeout)
Andrew Svetlov6d8a1222012-12-17 22:23:46 +02001655 except OSError as e:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001656 if e.args[0] == errno.EINTR:
1657 continue
1658 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001659
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001660 # According to the docs, returning three empty lists indicates
1661 # that the timeout expired.
1662 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001663 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001664 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001665 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001666
Guido van Rossum98297ee2007-11-06 21:34:58 +00001667 # XXX Rewrite these to use non-blocking I/O on the
1668 # file objects; they are no longer using C stdio!
1669
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001670 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001671 chunk = self._input[self._input_offset :
1672 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001673 try:
1674 bytes_written = os.write(self.stdin.fileno(), chunk)
1675 except OSError as e:
1676 if e.errno == errno.EPIPE:
1677 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001678 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001679 else:
1680 raise
1681 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001682 self._input_offset += bytes_written
1683 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001684 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001685 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001686
1687 if self.stdout in rlist:
1688 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001689 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001690 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001691 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001692 stdout.append(data)
1693
1694 if self.stderr in rlist:
1695 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001696 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001697 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001698 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001699 stderr.append(data)
1700
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001701 return (stdout, stderr)
1702
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001703
Christian Heimesa342c012008-04-20 21:01:16 +00001704 def send_signal(self, sig):
1705 """Send a signal to the process
1706 """
1707 os.kill(self.pid, sig)
1708
1709 def terminate(self):
1710 """Terminate the process with SIGTERM
1711 """
1712 self.send_signal(signal.SIGTERM)
1713
1714 def kill(self):
1715 """Kill the process with SIGKILL
1716 """
1717 self.send_signal(signal.SIGKILL)