blob: cd8aa6bc56c590c747ce331f45cbdefb48a6e835 [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
28class Popen(args, bufsize=0, executable=None,
29 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
59bufsize, if given, has the same meaning as the corresponding argument
60to the built-in open() function: 0 means unbuffered, 1 means line
61buffered, any other positive value means use a buffer of
62(approximately) that size. A negative bufsize means to use the system
63default, which usually means fully buffered. The default value for
64bufsize is 0 (unbuffered).
65
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
111are seen as '\n' by the Python program. Note: This feature is only
112available if Python is built with universal newline support (the
113default). Also, the newlines attribute of the file objects stdout,
114stdin and stderr are not updated by the communicate() method.
115
116The startupinfo and creationflags, if given, will be passed to the
117underlying CreateProcess() function. They can specify things such as
118appearance of the main window and priority for the new process.
119(Windows only)
120
121
Georg Brandlf9734072008-12-07 15:30:06 +0000122This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000123
Peter Astrand5f5e1412004-12-05 20:15:36 +0000124call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125 Run command with arguments. Wait for command to complete, then
126 return the returncode attribute.
127
128 The arguments are the same as for the Popen constructor. Example:
129
Florent Xicluna4886d242010-03-08 13:27:26 +0000130 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131
Peter Astrand454f7672005-01-01 09:36:35 +0000132check_call(*popenargs, **kwargs):
133 Run command with arguments. Wait for command to complete. If the
134 exit code was zero then return, otherwise raise
135 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000136 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000137
138 The arguments are the same as for the Popen constructor. Example:
139
Florent Xicluna4886d242010-03-08 13:27:26 +0000140 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000141 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000142
Brett Cannona23810f2008-05-26 19:04:21 +0000143getstatusoutput(cmd):
144 Return (status, output) of executing cmd in a shell.
145
146 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
147 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
148 returned output will contain output or error messages. A trailing newline
149 is stripped from the output. The exit status for the command can be
150 interpreted according to the rules for the C function wait(). Example:
151
Brett Cannona23810f2008-05-26 19:04:21 +0000152 >>> subprocess.getstatusoutput('ls /bin/ls')
153 (0, '/bin/ls')
154 >>> subprocess.getstatusoutput('cat /bin/junk')
155 (256, 'cat: /bin/junk: No such file or directory')
156 >>> subprocess.getstatusoutput('/bin/junk')
157 (256, 'sh: /bin/junk: not found')
158
159getoutput(cmd):
160 Return output (stdout or stderr) of executing cmd in a shell.
161
162 Like getstatusoutput(), except the exit status is ignored and the return
163 value is a string containing the command's output. Example:
164
Brett Cannona23810f2008-05-26 19:04:21 +0000165 >>> subprocess.getoutput('ls /bin/ls')
166 '/bin/ls'
167
Georg Brandlf9734072008-12-07 15:30:06 +0000168check_output(*popenargs, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000169 Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000170
Georg Brandl2708f3a2009-12-20 14:38:23 +0000171 If the exit code was non-zero it raises a CalledProcessError. The
172 CalledProcessError object will have the return code in the returncode
173 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000174
Georg Brandl2708f3a2009-12-20 14:38:23 +0000175 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Brett Cannona23810f2008-05-26 19:04:21 +0000179
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000180Exceptions
181----------
182Exceptions raised in the child process, before the new program has
183started to execute, will be re-raised in the parent. Additionally,
184the exception object will have one extra attribute called
185'child_traceback', which is a string containing traceback information
186from the childs point of view.
187
188The most common exception raised is OSError. This occurs, for
189example, when trying to execute a non-existent file. Applications
190should prepare for OSErrors.
191
192A ValueError will be raised if Popen is called with invalid arguments.
193
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400194Exceptions defined within this module inherit from SubprocessError.
195check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400196called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400197be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000198
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000199
200Security
201--------
202Unlike some other popen functions, this implementation will never call
203/bin/sh implicitly. This means that all characters, including shell
204metacharacters, can safely be passed to child processes.
205
206
207Popen objects
208=============
209Instances of the Popen class have the following methods:
210
211poll()
212 Check if child process has terminated. Returns returncode
213 attribute.
214
215wait()
216 Wait for child process to terminate. Returns returncode attribute.
217
218communicate(input=None)
219 Interact with process: Send data to stdin. Read data from stdout
220 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000221 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000222 sent to the child process, or None, if no data should be sent to
223 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000224
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225 communicate() returns a tuple (stdout, stderr).
226
227 Note: The data read is buffered in memory, so do not use this
228 method if the data size is large or unlimited.
229
230The following attributes are also available:
231
232stdin
233 If the stdin argument is PIPE, this attribute is a file object
234 that provides input to the child process. Otherwise, it is None.
235
236stdout
237 If the stdout argument is PIPE, this attribute is a file object
238 that provides output from the child process. Otherwise, it is
239 None.
240
241stderr
242 If the stderr argument is PIPE, this attribute is file object that
243 provides error output from the child process. Otherwise, it is
244 None.
245
246pid
247 The process ID of the child process.
248
249returncode
250 The child return code. A None value indicates that the process
251 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000252 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000253
254
255Replacing older functions with the subprocess module
256====================================================
257In this section, "a ==> b" means that b can be used as a replacement
258for a.
259
260Note: All functions in this section fail (more or less) silently if
261the executed program cannot be found; this module raises an OSError
262exception.
263
264In the following examples, we assume that the subprocess module is
265imported with "from subprocess import *".
266
267
268Replacing /bin/sh shell backquote
269---------------------------------
270output=`mycmd myarg`
271==>
272output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
273
274
275Replacing shell pipe line
276-------------------------
277output=`dmesg | grep hda`
278==>
279p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000280p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000281output = p2.communicate()[0]
282
283
284Replacing os.system()
285---------------------
286sts = os.system("mycmd" + " myarg")
287==>
288p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000289pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000290
291Note:
292
293* Calling the program through the shell is usually not required.
294
295* It's easier to look at the returncode attribute than the
296 exitstatus.
297
298A more real-world example would look like this:
299
300try:
301 retcode = call("mycmd" + " myarg", shell=True)
302 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000303 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000304 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000305 print("Child returned", retcode, file=sys.stderr)
306except OSError as e:
307 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000308
309
310Replacing os.spawn*
311-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000312P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000313
314pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
315==>
316pid = Popen(["/bin/mycmd", "myarg"]).pid
317
318
319P_WAIT example:
320
321retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
322==>
323retcode = call(["/bin/mycmd", "myarg"])
324
325
Tim Peterse718f612004-10-12 21:51:32 +0000326Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000327
328os.spawnvp(os.P_NOWAIT, path, args)
329==>
330Popen([path] + args[1:])
331
332
Tim Peterse718f612004-10-12 21:51:32 +0000333Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000334
335os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
336==>
337Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000338"""
339
340import sys
341mswindows = (sys.platform == "win32")
342
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000343import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000344import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400345import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000346import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000347import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000348import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000349import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000350import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200351import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000352
Peter Astrand454f7672005-01-01 09:36:35 +0000353# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400354class SubprocessError(Exception): pass
355
356
357class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000358 """This exception is raised when a process run by check_call() or
359 check_output() returns a non-zero exit status.
360 The exit status will be stored in the returncode attribute;
361 check_output() will also store the output in the output attribute.
362 """
363 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000364 self.returncode = returncode
365 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000366 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000367 def __str__(self):
368 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
369
Peter Astrand454f7672005-01-01 09:36:35 +0000370
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400371class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400372 """This exception is raised when the timeout expires while waiting for a
373 child process.
374 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400375 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400376 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400377 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400378 self.output = output
379
380 def __str__(self):
381 return ("Command '%s' timed out after %s seconds" %
382 (self.cmd, self.timeout))
383
384
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000385if mswindows:
386 import threading
387 import msvcrt
Brian Curtin1ce6b582010-04-24 16:19:22 +0000388 import _subprocess
389 class STARTUPINFO:
390 dwFlags = 0
391 hStdInput = None
392 hStdOutput = None
393 hStdError = None
394 wShowWindow = 0
395 class pywintypes:
396 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000397else:
398 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000399 _has_poll = hasattr(select, 'poll')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000400 import fcntl
401 import pickle
402
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000403 try:
404 import _posixsubprocess
405 except ImportError:
406 _posixsubprocess = None
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000407 warnings.warn("The _posixsubprocess module is not being used. "
408 "Child process reliability may suffer if your "
409 "program uses threads.", RuntimeWarning)
410
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000411 # When select or poll has indicated that the file is writable,
412 # we can write up to _PIPE_BUF bytes without risk of blocking.
413 # POSIX defines PIPE_BUF as >= 512.
414 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
415
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000416 _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1)
417
418 def _set_cloexec(fd, cloexec):
419 old = fcntl.fcntl(fd, fcntl.F_GETFD)
420 if cloexec:
421 fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC)
422 else:
423 fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC)
424
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000425 if _posixsubprocess:
426 _create_pipe = _posixsubprocess.cloexec_pipe
427 else:
428 def _create_pipe():
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000429 fds = os.pipe()
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000430 _set_cloexec(fds[0], True)
431 _set_cloexec(fds[1], True)
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000432 return fds
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000433
Brett Cannona23810f2008-05-26 19:04:21 +0000434__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200435 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000436
Brian Curtin1ce6b582010-04-24 16:19:22 +0000437if mswindows:
Brian Curtin08fd8d92011-04-29 16:11:30 -0500438 from _subprocess import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500439 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
440 STD_ERROR_HANDLE, SW_HIDE,
441 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500442
Brian Curtin08fd8d92011-04-29 16:11:30 -0500443 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500444 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
445 "STD_ERROR_HANDLE", "SW_HIDE",
446 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000447try:
448 MAXFD = os.sysconf("SC_OPEN_MAX")
449except:
450 MAXFD = 256
451
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000452_active = []
453
454def _cleanup():
455 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000456 res = inst._internal_poll(_deadstate=sys.maxsize)
Guido van Rossumb5d47ef2006-08-24 02:27:45 +0000457 if res is not None and res >= 0:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000458 try:
459 _active.remove(inst)
460 except ValueError:
461 # This can happen if two threads create a new Popen instance.
462 # It's harmless that it was already removed, so ignore.
463 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000464
465PIPE = -1
466STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200467DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000468
469
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000470def _eintr_retry_call(func, *args):
471 while True:
472 try:
473 return func(*args)
474 except OSError as e:
475 if e.errno == errno.EINTR:
476 continue
477 raise
478
479
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400480def call(*popenargs, timeout=None, **kwargs):
481 """Run command with arguments. Wait for command to complete or
482 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000483
484 The arguments are the same as for the Popen constructor. Example:
485
486 retcode = call(["ls", "-l"])
487 """
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400488 p = Popen(*popenargs, **kwargs)
489 try:
490 return p.wait(timeout=timeout)
491 except TimeoutExpired:
492 p.kill()
493 p.wait()
494 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000495
496
Peter Astrand454f7672005-01-01 09:36:35 +0000497def check_call(*popenargs, **kwargs):
498 """Run command with arguments. Wait for command to complete. If
499 the exit code was zero then return, otherwise raise
500 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000501 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000502
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400503 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000504
505 check_call(["ls", "-l"])
506 """
507 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000508 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000509 cmd = kwargs.get("args")
510 if cmd is None:
511 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000512 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000513 return 0
514
515
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400516def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000517 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000518
519 If the exit code was non-zero it raises a CalledProcessError. The
520 CalledProcessError object will have the return code in the returncode
521 attribute and output in the output attribute.
522
523 The arguments are the same as for the Popen constructor. Example:
524
525 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000526 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000527
528 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000529 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000530
531 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000532 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000533 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000534 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000535 """
536 if 'stdout' in kwargs:
537 raise ValueError('stdout argument not allowed, it will be overridden.')
538 process = Popen(*popenargs, stdout=PIPE, **kwargs)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400539 try:
540 output, unused_err = process.communicate(timeout=timeout)
541 except TimeoutExpired:
542 process.kill()
543 output, unused_err = process.communicate()
Reid Kleckner2b228f02011-03-16 16:57:54 -0400544 raise TimeoutExpired(process.args, timeout, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000545 retcode = process.poll()
546 if retcode:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400547 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000548 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000549
550
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000551def list2cmdline(seq):
552 """
553 Translate a sequence of arguments into a command line
554 string, using the same rules as the MS C runtime:
555
556 1) Arguments are delimited by white space, which is either a
557 space or a tab.
558
559 2) A string surrounded by double quotation marks is
560 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000561 contained within. A quoted string can be embedded in an
562 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000563
564 3) A double quotation mark preceded by a backslash is
565 interpreted as a literal double quotation mark.
566
567 4) Backslashes are interpreted literally, unless they
568 immediately precede a double quotation mark.
569
570 5) If backslashes immediately precede a double quotation mark,
571 every pair of backslashes is interpreted as a literal
572 backslash. If the number of backslashes is odd, the last
573 backslash escapes the next double quotation mark as
574 described in rule 3.
575 """
576
577 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000578 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
579 # or search http://msdn.microsoft.com for
580 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000581 result = []
582 needquote = False
583 for arg in seq:
584 bs_buf = []
585
586 # Add a space to separate this argument from the others
587 if result:
588 result.append(' ')
589
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000590 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000591 if needquote:
592 result.append('"')
593
594 for c in arg:
595 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000596 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000597 bs_buf.append(c)
598 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000599 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000600 result.append('\\' * len(bs_buf)*2)
601 bs_buf = []
602 result.append('\\"')
603 else:
604 # Normal char
605 if bs_buf:
606 result.extend(bs_buf)
607 bs_buf = []
608 result.append(c)
609
Christian Heimesfdab48e2008-01-20 09:06:41 +0000610 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000611 if bs_buf:
612 result.extend(bs_buf)
613
614 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000615 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000616 result.append('"')
617
618 return ''.join(result)
619
620
Brett Cannona23810f2008-05-26 19:04:21 +0000621# Various tools for executing commands and looking at their output and status.
622#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000623# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000624
625def getstatusoutput(cmd):
626 """Return (status, output) of executing cmd in a shell.
627
628 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
629 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
630 returned output will contain output or error messages. A trailing newline
631 is stripped from the output. The exit status for the command can be
632 interpreted according to the rules for the C function wait(). Example:
633
634 >>> import subprocess
635 >>> subprocess.getstatusoutput('ls /bin/ls')
636 (0, '/bin/ls')
637 >>> subprocess.getstatusoutput('cat /bin/junk')
638 (256, 'cat: /bin/junk: No such file or directory')
639 >>> subprocess.getstatusoutput('/bin/junk')
640 (256, 'sh: /bin/junk: not found')
641 """
642 pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
643 text = pipe.read()
644 sts = pipe.close()
645 if sts is None: sts = 0
646 if text[-1:] == '\n': text = text[:-1]
647 return sts, text
648
649
650def getoutput(cmd):
651 """Return output (stdout or stderr) of executing cmd in a shell.
652
653 Like getstatusoutput(), except the exit status is ignored and the return
654 value is a string containing the command's output. Example:
655
656 >>> import subprocess
657 >>> subprocess.getoutput('ls /bin/ls')
658 '/bin/ls'
659 """
660 return getstatusoutput(cmd)[1]
661
662
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000663_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000664
665
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000666class Popen(object):
667 def __init__(self, args, bufsize=0, executable=None,
668 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000669 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
670 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000671 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000672 restore_signals=True, start_new_session=False,
673 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000674 """Create new Popen instance."""
675 _cleanup()
676
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000677 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400678 self._input = None
679 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000680 if bufsize is None:
681 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000682 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000683 raise TypeError("bufsize must be an integer")
684
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000685 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000686 if preexec_fn is not None:
687 raise ValueError("preexec_fn is not supported on Windows "
688 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000689 any_stdio_set = (stdin is not None or stdout is not None or
690 stderr is not None)
691 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
692 if any_stdio_set:
693 close_fds = False
694 else:
695 close_fds = True
696 elif close_fds and any_stdio_set:
697 raise ValueError(
698 "close_fds is not supported on Windows platforms"
699 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000700 else:
701 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000702 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
703 close_fds = True
704 if pass_fds and not close_fds:
705 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
706 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000707 if startupinfo is not None:
708 raise ValueError("startupinfo is only supported on Windows "
709 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000710 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000711 raise ValueError("creationflags is only supported on Windows "
712 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000713
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400714 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000715 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000716 self.stdout = None
717 self.stderr = None
718 self.pid = None
719 self.returncode = None
720 self.universal_newlines = universal_newlines
721
722 # Input and output objects. The general principle is like
723 # this:
724 #
725 # Parent Child
726 # ------ -----
727 # p2cwrite ---stdin---> p2cread
728 # c2pread <--stdout--- c2pwrite
729 # errread <--stderr--- errwrite
730 #
731 # On POSIX, the child objects are file descriptors. On
732 # Windows, these are Windows file handles. The parent objects
733 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000734 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000735 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000736
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000737 (p2cread, p2cwrite,
738 c2pread, c2pwrite,
739 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
740
Antoine Pitrouc9982322011-01-04 19:07:07 +0000741 # We wrap OS handles *before* launching the child, otherwise a
742 # quickly terminating child could make our fds unwrappable
743 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000744
Thomas Wouterscf297e42007-02-23 15:07:44 +0000745 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000746 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000747 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000748 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000749 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000750 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000751 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000752
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000753 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000754 self.stdin = io.open(p2cwrite, 'wb', bufsize)
755 if self.universal_newlines:
756 self.stdin = io.TextIOWrapper(self.stdin)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000757 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000758 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000759 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000760 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000761 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000762 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000763 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000764 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000765
Antoine Pitrouc9982322011-01-04 19:07:07 +0000766 try:
767 self._execute_child(args, executable, preexec_fn, close_fds,
768 pass_fds, cwd, env, universal_newlines,
769 startupinfo, creationflags, shell,
770 p2cread, p2cwrite,
771 c2pread, c2pwrite,
772 errread, errwrite,
773 restore_signals, start_new_session)
774 except:
775 # Cleanup if the child failed starting
776 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
777 try:
778 f.close()
779 except EnvironmentError:
780 # Ignore EBADF or other errors
781 pass
782 raise
783
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000784
Guido van Rossum98297ee2007-11-06 21:34:58 +0000785 def _translate_newlines(self, data, encoding):
786 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
787 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000788
Brian Curtin79cdb662010-12-03 02:46:02 +0000789 def __enter__(self):
790 return self
791
792 def __exit__(self, type, value, traceback):
793 if self.stdout:
794 self.stdout.close()
795 if self.stderr:
796 self.stderr.close()
797 if self.stdin:
798 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700799 # Wait for the process to terminate, to avoid zombies.
800 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000801
Brett Cannon84df1e62010-05-14 00:33:40 +0000802 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000803 if not self._child_created:
804 # We didn't get to successfully create a child process.
805 return
806 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000807 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000808 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000809 # Child is still running, keep us alive until we can wait on it.
810 _active.append(self)
811
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200812 def _get_devnull(self):
813 if not hasattr(self, '_devnull'):
814 self._devnull = os.open(os.devnull, os.O_RDWR)
815 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000816
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400817 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000818 """Interact with process: Send data to stdin. Read data from
819 stdout and stderr, until end-of-file is reached. Wait for
820 process to terminate. The optional input argument should be a
821 string to be sent to the child process, or None, if no data
822 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000823
Peter Astrand23109f02005-03-03 20:28:59 +0000824 communicate() returns a tuple (stdout, stderr)."""
825
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400826 if self._communication_started and input:
827 raise ValueError("Cannot send input after starting communication")
828
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400829 # Optimization: If we are not worried about timeouts, we haven't
830 # started communicating, and we have one or zero pipes, using select()
831 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200832 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400833 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000834 stdout = None
835 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000836 if self.stdin:
837 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200838 try:
839 self.stdin.write(input)
840 except IOError as e:
841 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
842 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000843 self.stdin.close()
844 elif self.stdout:
845 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000846 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000847 elif self.stderr:
848 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000849 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000850 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200851 else:
852 if timeout is not None:
853 endtime = time.time() + timeout
854 else:
855 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000856
Victor Stinner7a8d0812011-04-05 13:13:08 +0200857 try:
858 stdout, stderr = self._communicate(input, endtime, timeout)
859 finally:
860 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400861
Victor Stinner7a8d0812011-04-05 13:13:08 +0200862 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400863
864 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000865
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000866
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000867 def poll(self):
868 return self._internal_poll()
869
870
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400871 def _remaining_time(self, endtime):
872 """Convenience for _communicate when computing timeouts."""
873 if endtime is None:
874 return None
875 else:
876 return endtime - time.time()
877
878
Reid Kleckner2b228f02011-03-16 16:57:54 -0400879 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400880 """Convenience for checking if a timeout has expired."""
881 if endtime is None:
882 return
883 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400884 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400885
886
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000887 if mswindows:
888 #
889 # Windows methods
890 #
891 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000892 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000893 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
894 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000895 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000896 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000897
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000898 p2cread, p2cwrite = -1, -1
899 c2pread, c2pwrite = -1, -1
900 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000901
Peter Astrandd38ddf42005-02-10 08:32:50 +0000902 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000903 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000904 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000905 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000906 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000907 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200908 elif stdin == DEVNULL:
909 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000910 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000911 p2cread = msvcrt.get_osfhandle(stdin)
912 else:
913 # Assuming file-like object
914 p2cread = msvcrt.get_osfhandle(stdin.fileno())
915 p2cread = self._make_inheritable(p2cread)
916
Peter Astrandd38ddf42005-02-10 08:32:50 +0000917 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000918 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000919 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000920 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000921 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000922 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200923 elif stdout == DEVNULL:
924 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000925 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000926 c2pwrite = msvcrt.get_osfhandle(stdout)
927 else:
928 # Assuming file-like object
929 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
930 c2pwrite = self._make_inheritable(c2pwrite)
931
Peter Astrandd38ddf42005-02-10 08:32:50 +0000932 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000933 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000934 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000935 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000936 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000937 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000938 elif stderr == STDOUT:
939 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200940 elif stderr == DEVNULL:
941 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000942 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000943 errwrite = msvcrt.get_osfhandle(stderr)
944 else:
945 # Assuming file-like object
946 errwrite = msvcrt.get_osfhandle(stderr.fileno())
947 errwrite = self._make_inheritable(errwrite)
948
949 return (p2cread, p2cwrite,
950 c2pread, c2pwrite,
951 errread, errwrite)
952
953
954 def _make_inheritable(self, handle):
955 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000956 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
957 handle, _subprocess.GetCurrentProcess(), 0, 1,
958 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000959
960
961 def _find_w9xpopen(self):
962 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000963 w9xpopen = os.path.join(
964 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000965 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000966 if not os.path.exists(w9xpopen):
967 # Eeek - file-not-found - possibly an embedding
968 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000969 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
970 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000971 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000972 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
973 "needed for Popen to work with your "
974 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000975 return w9xpopen
976
Tim Peterse718f612004-10-12 21:51:32 +0000977
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000978 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000979 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000980 startupinfo, creationflags, shell,
981 p2cread, p2cwrite,
982 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000983 errread, errwrite,
984 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000985 """Execute program (MS Windows version)"""
986
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000987 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000988
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000989 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000990 args = list2cmdline(args)
991
Peter Astrandc1d65362004-11-07 14:30:34 +0000992 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000993 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000994 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000995 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000996 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000997 startupinfo.hStdInput = p2cread
998 startupinfo.hStdOutput = c2pwrite
999 startupinfo.hStdError = errwrite
1000
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001001 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001002 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
1003 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001004 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001005 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001006 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001007 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001008 # Win9x, or using command.com on NT. We need to
1009 # use the w9xpopen intermediate program. For more
1010 # information, see KB Q150956
1011 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1012 w9xpopen = self._find_w9xpopen()
1013 args = '"%s" %s' % (w9xpopen, args)
1014 # Not passing CREATE_NEW_CONSOLE has been known to
1015 # cause random failures on win9x. Specifically a
1016 # dialog: "Your program accessed mem currently in
1017 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001018 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001019 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001020 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001021
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001022 # Start the process
1023 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001024 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001025 # no special security
1026 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001027 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001028 creationflags,
1029 env,
1030 cwd,
1031 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001032 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001033 # Translate pywintypes.error to WindowsError, which is
1034 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001035 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001036 # how can this be done from Python?
1037 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001038 finally:
1039 # Child is launched. Close the parent's copy of those pipe
1040 # handles that only the child should have open. You need
1041 # to make sure that no handles to the write end of the
1042 # output pipe are maintained in this process or else the
1043 # pipe will not close when the child process exits and the
1044 # ReadFile will hang.
1045 if p2cread != -1:
1046 p2cread.Close()
1047 if c2pwrite != -1:
1048 c2pwrite.Close()
1049 if errwrite != -1:
1050 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001051 if hasattr(self, '_devnull'):
1052 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001053
1054 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001055 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 self._handle = hp
1057 self.pid = pid
1058 ht.Close()
1059
Brett Cannon84df1e62010-05-14 00:33:40 +00001060 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001061 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1062 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1063 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001064 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001065 attribute.
1066
1067 This method is called by __del__, so it can only refer to objects
1068 in its local scope.
1069
1070 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001071 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001072 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1073 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001074 return self.returncode
1075
1076
Reid Kleckner2b228f02011-03-16 16:57:54 -04001077 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001078 """Wait for child process to terminate. Returns returncode
1079 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001080 if endtime is not None:
1081 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001082 if timeout is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001083 timeout_millis = _subprocess.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001084 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001085 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001086 if self.returncode is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001087 result = _subprocess.WaitForSingleObject(self._handle,
1088 timeout_millis)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001089 if result == _subprocess.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001090 raise TimeoutExpired(self.args, timeout)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001091 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092 return self.returncode
1093
1094
1095 def _readerthread(self, fh, buffer):
1096 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001097 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001098
1099
Reid Kleckner2b228f02011-03-16 16:57:54 -04001100 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001101 # Start reader threads feeding into a list hanging off of this
1102 # object, unless they've already been started.
1103 if self.stdout and not hasattr(self, "_stdout_buff"):
1104 self._stdout_buff = []
1105 self.stdout_thread = \
1106 threading.Thread(target=self._readerthread,
1107 args=(self.stdout, self._stdout_buff))
1108 self.stdout_thread.daemon = True
1109 self.stdout_thread.start()
1110 if self.stderr and not hasattr(self, "_stderr_buff"):
1111 self._stderr_buff = []
1112 self.stderr_thread = \
1113 threading.Thread(target=self._readerthread,
1114 args=(self.stderr, self._stderr_buff))
1115 self.stderr_thread.daemon = True
1116 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001117
1118 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001119 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001120 try:
1121 self.stdin.write(input)
1122 except IOError as e:
1123 if e.errno != errno.EPIPE:
1124 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001125 self.stdin.close()
1126
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001127 # Wait for the reader threads, or time out. If we time out, the
1128 # threads remain reading and the fds left open in case the user
1129 # calls communicate again.
1130 if self.stdout is not None:
1131 self.stdout_thread.join(self._remaining_time(endtime))
1132 if self.stdout_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001133 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001134 if self.stderr is not None:
1135 self.stderr_thread.join(self._remaining_time(endtime))
1136 if self.stderr_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001137 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001138
1139 # Collect the output from and close both pipes, now that we know
1140 # both have been read successfully.
1141 stdout = None
1142 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001143 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001144 stdout = self._stdout_buff
1145 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001146 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001147 stderr = self._stderr_buff
1148 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001149
1150 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001151 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001153 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001154 stderr = stderr[0]
1155
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001156 return (stdout, stderr)
1157
Christian Heimesa342c012008-04-20 21:01:16 +00001158 def send_signal(self, sig):
1159 """Send a signal to the process
1160 """
1161 if sig == signal.SIGTERM:
1162 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001163 elif sig == signal.CTRL_C_EVENT:
1164 os.kill(self.pid, signal.CTRL_C_EVENT)
1165 elif sig == signal.CTRL_BREAK_EVENT:
1166 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001167 else:
Brian Curtin19651362010-09-07 13:24:38 +00001168 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001169
1170 def terminate(self):
1171 """Terminates the process
1172 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001173 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001174
1175 kill = terminate
1176
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001177 else:
1178 #
1179 # POSIX methods
1180 #
1181 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001182 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001183 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1184 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001185 p2cread, p2cwrite = -1, -1
1186 c2pread, c2pwrite = -1, -1
1187 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001188
Peter Astrandd38ddf42005-02-10 08:32:50 +00001189 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001190 pass
1191 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001192 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001193 elif stdin == DEVNULL:
1194 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001195 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001196 p2cread = stdin
1197 else:
1198 # Assuming file-like object
1199 p2cread = stdin.fileno()
1200
Peter Astrandd38ddf42005-02-10 08:32:50 +00001201 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001202 pass
1203 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001204 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001205 elif stdout == DEVNULL:
1206 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001207 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208 c2pwrite = stdout
1209 else:
1210 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001211 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001212
Peter Astrandd38ddf42005-02-10 08:32:50 +00001213 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001214 pass
1215 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001216 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001217 elif stderr == STDOUT:
1218 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001219 elif stderr == DEVNULL:
1220 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001221 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001222 errwrite = stderr
1223 else:
1224 # Assuming file-like object
1225 errwrite = stderr.fileno()
1226
1227 return (p2cread, p2cwrite,
1228 c2pread, c2pwrite,
1229 errread, errwrite)
1230
1231
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001232 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001233 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001234 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001235 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001236 os.closerange(start_fd, fd)
1237 start_fd = fd + 1
1238 if start_fd <= MAXFD:
1239 os.closerange(start_fd, MAXFD)
1240
1241
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001242 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001243 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244 startupinfo, creationflags, shell,
1245 p2cread, p2cwrite,
1246 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001247 errread, errwrite,
1248 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001249 """Execute program (POSIX version)"""
1250
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001251 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001252 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001253 else:
1254 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001255
1256 if shell:
1257 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001258 if executable:
1259 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001260
Peter Astrandd38ddf42005-02-10 08:32:50 +00001261 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001262 executable = args[0]
1263
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001264 # For transferring possible exec failure from child to parent.
1265 # Data format: "exception name:hex errno:description"
1266 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001267 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001268 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001269 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001270
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001271 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001272 # We must avoid complex work that could involve
1273 # malloc or free in the child process to avoid
1274 # potential deadlocks, thus we do all this here.
1275 # and pass it to fork_exec()
1276
1277 if env:
Victor Stinner449c4662010-05-08 11:10:09 +00001278 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001279 for k, v in env.items()]
1280 else:
1281 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001282 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001283 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001284 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001285 else:
1286 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001287 executable_list = tuple(
1288 os.path.join(os.fsencode(dir), executable)
1289 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001290 fds_to_keep = set(pass_fds)
1291 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001292 self.pid = _posixsubprocess.fork_exec(
1293 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001294 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001295 p2cread, p2cwrite, c2pread, c2pwrite,
1296 errread, errwrite,
1297 errpipe_read, errpipe_write,
1298 restore_signals, start_new_session, preexec_fn)
1299 else:
1300 # Pure Python implementation: It is not thread safe.
1301 # This implementation may deadlock in the child if your
1302 # parent process has any other threads running.
1303
1304 gc_was_enabled = gc.isenabled()
1305 # Disable gc to avoid bug where gc -> file_dealloc ->
1306 # write to stderr -> hang. See issue1336
1307 gc.disable()
1308 try:
1309 self.pid = os.fork()
1310 except:
1311 if gc_was_enabled:
1312 gc.enable()
1313 raise
1314 self._child_created = True
1315 if self.pid == 0:
1316 # Child
1317 try:
1318 # Close parent's pipe ends
1319 if p2cwrite != -1:
1320 os.close(p2cwrite)
1321 if c2pread != -1:
1322 os.close(c2pread)
1323 if errread != -1:
1324 os.close(errread)
1325 os.close(errpipe_read)
1326
1327 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001328 def _dup2(a, b):
1329 # dup2() removes the CLOEXEC flag but
1330 # we must do it ourselves if dup2()
1331 # would be a no-op (issue #10806).
1332 if a == b:
1333 _set_cloexec(a, False)
1334 elif a != -1:
1335 os.dup2(a, b)
1336 _dup2(p2cread, 0)
1337 _dup2(c2pwrite, 1)
1338 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001339
1340 # Close pipe fds. Make sure we don't close the
1341 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001342 closed = set()
1343 for fd in [p2cread, c2pwrite, errwrite]:
1344 if fd > 2 and fd not in closed:
1345 os.close(fd)
1346 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001347
1348 # Close all other fds, if asked for
1349 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001350 fds_to_keep = set(pass_fds)
1351 fds_to_keep.add(errpipe_write)
1352 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001353
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001354
1355 if cwd is not None:
1356 os.chdir(cwd)
1357
1358 # This is a copy of Python/pythonrun.c
1359 # _Py_RestoreSignals(). If that were exposed
1360 # as a sys._py_restoresignals func it would be
1361 # better.. but this pure python implementation
1362 # isn't likely to be used much anymore.
1363 if restore_signals:
1364 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1365 for sig in signals:
1366 if hasattr(signal, sig):
1367 signal.signal(getattr(signal, sig),
1368 signal.SIG_DFL)
1369
1370 if start_new_session and hasattr(os, 'setsid'):
1371 os.setsid()
1372
1373 if preexec_fn:
1374 preexec_fn()
1375
1376 if env is None:
1377 os.execvp(executable, args)
1378 else:
1379 os.execvpe(executable, args, env)
1380
1381 except:
1382 try:
1383 exc_type, exc_value = sys.exc_info()[:2]
1384 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001385 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001386 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001387 errno_num = 0
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001388 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001389 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001390 message = message.encode(errors="surrogatepass")
1391 os.write(errpipe_write, message)
1392 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001393 # We MUST not allow anything odd happening
1394 # above to prevent us from exiting below.
1395 pass
1396
1397 # This exitcode won't be reported to applications
1398 # so it really doesn't matter what we return.
1399 os._exit(255)
1400
1401 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001402 if gc_was_enabled:
1403 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001404 finally:
1405 # be sure the FD is closed no matter what
1406 os.close(errpipe_write)
1407
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001408 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001409 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001410 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001411 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001412 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001413 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001414 if hasattr(self, '_devnull'):
1415 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001416
1417 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001418 # exception (limited in size)
1419 data = bytearray()
1420 while True:
1421 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1422 data += part
1423 if not part or len(data) > 50000:
1424 break
Facundo Batista10706e22009-06-19 20:34:30 +00001425 finally:
1426 # be sure the FD is closed no matter what
1427 os.close(errpipe_read)
1428
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001429 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001430 try:
1431 _eintr_retry_call(os.waitpid, self.pid, 0)
1432 except OSError as e:
1433 if e.errno != errno.ECHILD:
1434 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001435 try:
1436 exception_name, hex_errno, err_msg = data.split(b':', 2)
1437 except ValueError:
1438 print('Bad exception data:', repr(data))
1439 exception_name = b'RuntimeError'
1440 hex_errno = b'0'
1441 err_msg = b'Unknown'
1442 child_exception_type = getattr(
1443 builtins, exception_name.decode('ascii'),
1444 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001445 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001446 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001447 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001448 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001449 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001450 errno_num = int(hex_errno, 16)
1451 if errno_num != 0:
1452 err_msg = os.strerror(errno_num)
1453 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001454 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001455 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001456 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457
1458
Brett Cannon84df1e62010-05-14 00:33:40 +00001459 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1460 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1461 _WEXITSTATUS=os.WEXITSTATUS):
1462 # This method is called (indirectly) by __del__, so it cannot
1463 # refer to anything outside of its local scope."""
1464 if _WIFSIGNALED(sts):
1465 self.returncode = -_WTERMSIG(sts)
1466 elif _WIFEXITED(sts):
1467 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001468 else:
1469 # Should never happen
1470 raise RuntimeError("Unknown child exit status!")
1471
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001472
Brett Cannon84df1e62010-05-14 00:33:40 +00001473 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1474 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001475 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001476 attribute.
1477
1478 This method is called by __del__, so it cannot reference anything
1479 outside of the local scope (nor can any methods it calls).
1480
1481 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001482 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001483 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001484 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001485 if pid == self.pid:
1486 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001487 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001488 if _deadstate is not None:
1489 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001490 return self.returncode
1491
1492
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001493 def _try_wait(self, wait_flags):
1494 try:
1495 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1496 except OSError as e:
1497 if e.errno != errno.ECHILD:
1498 raise
1499 # This happens if SIGCLD is set to be ignored or waiting
1500 # for child processes has otherwise been disabled for our
1501 # process. This child is dead, we can't get the status.
1502 pid = self.pid
1503 sts = 0
1504 return (pid, sts)
1505
1506
1507 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001508 """Wait for child process to terminate. Returns returncode
1509 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001510 if self.returncode is not None:
1511 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001512
1513 # endtime is preferred to timeout. timeout is only used for
1514 # printing.
1515 if endtime is not None or timeout is not None:
1516 if endtime is None:
1517 endtime = time.time() + timeout
1518 elif timeout is None:
1519 timeout = self._remaining_time(endtime)
1520
1521 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001522 # Enter a busy loop if we have a timeout. This busy loop was
1523 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1524 delay = 0.0005 # 500 us -> initial delay of 1 ms
1525 while True:
1526 (pid, sts) = self._try_wait(os.WNOHANG)
1527 assert pid == self.pid or pid == 0
1528 if pid == self.pid:
1529 self._handle_exitstatus(sts)
1530 break
1531 remaining = self._remaining_time(endtime)
1532 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001533 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001534 delay = min(delay * 2, remaining, .05)
1535 time.sleep(delay)
1536 elif self.returncode is None:
1537 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001538 self._handle_exitstatus(sts)
1539 return self.returncode
1540
1541
Reid Kleckner2b228f02011-03-16 16:57:54 -04001542 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001543 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001544 # Flush stdio buffer. This might block, if the user has
1545 # been writing to .stdin in an uncontrolled fashion.
1546 self.stdin.flush()
1547 if not input:
1548 self.stdin.close()
1549
1550 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001551 stdout, stderr = self._communicate_with_poll(input, endtime,
1552 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001553 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001554 stdout, stderr = self._communicate_with_select(input, endtime,
1555 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001556
1557 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001558
1559 # All data exchanged. Translate lists into strings.
1560 if stdout is not None:
1561 stdout = b''.join(stdout)
1562 if stderr is not None:
1563 stderr = b''.join(stderr)
1564
1565 # Translate newlines, if requested.
1566 # This also turns bytes into strings.
1567 if self.universal_newlines:
1568 if stdout is not None:
1569 stdout = self._translate_newlines(stdout,
1570 self.stdout.encoding)
1571 if stderr is not None:
1572 stderr = self._translate_newlines(stderr,
1573 self.stderr.encoding)
1574
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001575 return (stdout, stderr)
1576
1577
Reid Kleckner2b228f02011-03-16 16:57:54 -04001578 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001579 stdout = None # Return
1580 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001581
1582 if not self._communication_started:
1583 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001584
1585 poller = select.poll()
1586 def register_and_append(file_obj, eventmask):
1587 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001588 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001589
1590 def close_unregister_and_remove(fd):
1591 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001592 self._fd2file[fd].close()
1593 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001594
1595 if self.stdin and input:
1596 register_and_append(self.stdin, select.POLLOUT)
1597
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001598 # Only create this mapping if we haven't already.
1599 if not self._communication_started:
1600 self._fd2output = {}
1601 if self.stdout:
1602 self._fd2output[self.stdout.fileno()] = []
1603 if self.stderr:
1604 self._fd2output[self.stderr.fileno()] = []
1605
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001606 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1607 if self.stdout:
1608 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001609 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001610 if self.stderr:
1611 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001612 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001613
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001614 # Save the input here so that if we time out while communicating,
1615 # we can continue sending input if we retry.
1616 if self.stdin and self._input is None:
1617 self._input_offset = 0
1618 self._input = input
1619 if self.universal_newlines:
1620 self._input = self._input.encode(self.stdin.encoding)
1621
1622 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001623 timeout = self._remaining_time(endtime)
1624 if timeout is not None and timeout < 0:
1625 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001626 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001627 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001628 except select.error as e:
1629 if e.args[0] == errno.EINTR:
1630 continue
1631 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001632 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001633
1634 # XXX Rewrite these to use non-blocking I/O on the
1635 # file objects; they are no longer using C stdio!
1636
1637 for fd, mode in ready:
1638 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001639 chunk = self._input[self._input_offset :
1640 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001641 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001642 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001643 except OSError as e:
1644 if e.errno == errno.EPIPE:
1645 close_unregister_and_remove(fd)
1646 else:
1647 raise
1648 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001649 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001650 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001651 elif mode & select_POLLIN_POLLPRI:
1652 data = os.read(fd, 4096)
1653 if not data:
1654 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001655 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001656 else:
1657 # Ignore hang up or errors.
1658 close_unregister_and_remove(fd)
1659
1660 return (stdout, stderr)
1661
1662
Reid Kleckner2b228f02011-03-16 16:57:54 -04001663 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001664 if not self._communication_started:
1665 self._read_set = []
1666 self._write_set = []
1667 if self.stdin and input:
1668 self._write_set.append(self.stdin)
1669 if self.stdout:
1670 self._read_set.append(self.stdout)
1671 if self.stderr:
1672 self._read_set.append(self.stderr)
1673
1674 if self.stdin and self._input is None:
1675 self._input_offset = 0
1676 self._input = input
1677 if self.universal_newlines:
1678 self._input = self._input.encode(self.stdin.encoding)
1679
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001680 stdout = None # Return
1681 stderr = None # Return
1682
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001683 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001684 if not self._communication_started:
1685 self._stdout_buff = []
1686 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001687 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001688 if not self._communication_started:
1689 self._stderr_buff = []
1690 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001691
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001692 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001693 timeout = self._remaining_time(endtime)
1694 if timeout is not None and timeout < 0:
1695 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001696 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001697 (rlist, wlist, xlist) = \
1698 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001699 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001700 except select.error as e:
1701 if e.args[0] == errno.EINTR:
1702 continue
1703 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001704
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001705 # According to the docs, returning three empty lists indicates
1706 # that the timeout expired.
1707 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001708 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001709 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001710 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001711
Guido van Rossum98297ee2007-11-06 21:34:58 +00001712 # XXX Rewrite these to use non-blocking I/O on the
1713 # file objects; they are no longer using C stdio!
1714
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001715 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001716 chunk = self._input[self._input_offset :
1717 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001718 try:
1719 bytes_written = os.write(self.stdin.fileno(), chunk)
1720 except OSError as e:
1721 if e.errno == errno.EPIPE:
1722 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001723 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001724 else:
1725 raise
1726 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001727 self._input_offset += bytes_written
1728 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001729 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001730 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001731
1732 if self.stdout in rlist:
1733 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001734 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001735 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001736 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001737 stdout.append(data)
1738
1739 if self.stderr in rlist:
1740 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001741 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001743 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001744 stderr.append(data)
1745
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001746 return (stdout, stderr)
1747
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001748
Christian Heimesa342c012008-04-20 21:01:16 +00001749 def send_signal(self, sig):
1750 """Send a signal to the process
1751 """
1752 os.kill(self.pid, sig)
1753
1754 def terminate(self):
1755 """Terminate the process with SIGTERM
1756 """
1757 self.send_signal(signal.SIGTERM)
1758
1759 def kill(self):
1760 """Kill the process with SIGKILL
1761 """
1762 self.send_signal(signal.SIGKILL)