blob: a7c68a5d6ef4f11258c2aac1cb61fe9484756a74 [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()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000799
Brett Cannon84df1e62010-05-14 00:33:40 +0000800 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000801 if not self._child_created:
802 # We didn't get to successfully create a child process.
803 return
804 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000805 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000806 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000807 # Child is still running, keep us alive until we can wait on it.
808 _active.append(self)
809
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200810 def _get_devnull(self):
811 if not hasattr(self, '_devnull'):
812 self._devnull = os.open(os.devnull, os.O_RDWR)
813 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000814
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400815 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000816 """Interact with process: Send data to stdin. Read data from
817 stdout and stderr, until end-of-file is reached. Wait for
818 process to terminate. The optional input argument should be a
819 string to be sent to the child process, or None, if no data
820 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000821
Peter Astrand23109f02005-03-03 20:28:59 +0000822 communicate() returns a tuple (stdout, stderr)."""
823
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400824 if self._communication_started and input:
825 raise ValueError("Cannot send input after starting communication")
826
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400827 # Optimization: If we are not worried about timeouts, we haven't
828 # started communicating, and we have one or zero pipes, using select()
829 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200830 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400831 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000832 stdout = None
833 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000834 if self.stdin:
835 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200836 try:
837 self.stdin.write(input)
838 except IOError as e:
839 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
840 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000841 self.stdin.close()
842 elif self.stdout:
843 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000844 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000845 elif self.stderr:
846 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000847 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000848 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200849 else:
850 if timeout is not None:
851 endtime = time.time() + timeout
852 else:
853 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000854
Victor Stinner7a8d0812011-04-05 13:13:08 +0200855 try:
856 stdout, stderr = self._communicate(input, endtime, timeout)
857 finally:
858 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400859
Victor Stinner7a8d0812011-04-05 13:13:08 +0200860 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400861
862 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000863
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000864
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000865 def poll(self):
866 return self._internal_poll()
867
868
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400869 def _remaining_time(self, endtime):
870 """Convenience for _communicate when computing timeouts."""
871 if endtime is None:
872 return None
873 else:
874 return endtime - time.time()
875
876
Reid Kleckner2b228f02011-03-16 16:57:54 -0400877 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400878 """Convenience for checking if a timeout has expired."""
879 if endtime is None:
880 return
881 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400882 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400883
884
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000885 if mswindows:
886 #
887 # Windows methods
888 #
889 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000890 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000891 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
892 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000893 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000894 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000895
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000896 p2cread, p2cwrite = -1, -1
897 c2pread, c2pwrite = -1, -1
898 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000899
Peter Astrandd38ddf42005-02-10 08:32:50 +0000900 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000901 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000902 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000903 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000904 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000905 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200906 elif stdin == DEVNULL:
907 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000908 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000909 p2cread = msvcrt.get_osfhandle(stdin)
910 else:
911 # Assuming file-like object
912 p2cread = msvcrt.get_osfhandle(stdin.fileno())
913 p2cread = self._make_inheritable(p2cread)
914
Peter Astrandd38ddf42005-02-10 08:32:50 +0000915 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000916 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000917 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000918 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000919 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000920 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200921 elif stdout == DEVNULL:
922 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000923 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000924 c2pwrite = msvcrt.get_osfhandle(stdout)
925 else:
926 # Assuming file-like object
927 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
928 c2pwrite = self._make_inheritable(c2pwrite)
929
Peter Astrandd38ddf42005-02-10 08:32:50 +0000930 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000931 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000932 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000933 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000934 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000935 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000936 elif stderr == STDOUT:
937 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200938 elif stderr == DEVNULL:
939 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000940 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000941 errwrite = msvcrt.get_osfhandle(stderr)
942 else:
943 # Assuming file-like object
944 errwrite = msvcrt.get_osfhandle(stderr.fileno())
945 errwrite = self._make_inheritable(errwrite)
946
947 return (p2cread, p2cwrite,
948 c2pread, c2pwrite,
949 errread, errwrite)
950
951
952 def _make_inheritable(self, handle):
953 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000954 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
955 handle, _subprocess.GetCurrentProcess(), 0, 1,
956 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000957
958
959 def _find_w9xpopen(self):
960 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000961 w9xpopen = os.path.join(
962 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000963 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000964 if not os.path.exists(w9xpopen):
965 # Eeek - file-not-found - possibly an embedding
966 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000967 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
968 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000969 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000970 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
971 "needed for Popen to work with your "
972 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000973 return w9xpopen
974
Tim Peterse718f612004-10-12 21:51:32 +0000975
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000976 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000977 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000978 startupinfo, creationflags, shell,
979 p2cread, p2cwrite,
980 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000981 errread, errwrite,
982 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000983 """Execute program (MS Windows version)"""
984
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000985 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000986
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000987 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000988 args = list2cmdline(args)
989
Peter Astrandc1d65362004-11-07 14:30:34 +0000990 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000991 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000992 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000993 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000994 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000995 startupinfo.hStdInput = p2cread
996 startupinfo.hStdOutput = c2pwrite
997 startupinfo.hStdError = errwrite
998
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000999 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001000 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
1001 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001002 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001003 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001004 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001005 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001006 # Win9x, or using command.com on NT. We need to
1007 # use the w9xpopen intermediate program. For more
1008 # information, see KB Q150956
1009 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1010 w9xpopen = self._find_w9xpopen()
1011 args = '"%s" %s' % (w9xpopen, args)
1012 # Not passing CREATE_NEW_CONSOLE has been known to
1013 # cause random failures on win9x. Specifically a
1014 # dialog: "Your program accessed mem currently in
1015 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001016 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001017 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001018 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001019
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001020 # Start the process
1021 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001022 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001023 # no special security
1024 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001025 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001026 creationflags,
1027 env,
1028 cwd,
1029 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001030 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001031 # Translate pywintypes.error to WindowsError, which is
1032 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001033 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001034 # how can this be done from Python?
1035 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001036 finally:
1037 # Child is launched. Close the parent's copy of those pipe
1038 # handles that only the child should have open. You need
1039 # to make sure that no handles to the write end of the
1040 # output pipe are maintained in this process or else the
1041 # pipe will not close when the child process exits and the
1042 # ReadFile will hang.
1043 if p2cread != -1:
1044 p2cread.Close()
1045 if c2pwrite != -1:
1046 c2pwrite.Close()
1047 if errwrite != -1:
1048 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001049 if hasattr(self, '_devnull'):
1050 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001051
1052 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001053 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001054 self._handle = hp
1055 self.pid = pid
1056 ht.Close()
1057
Brett Cannon84df1e62010-05-14 00:33:40 +00001058 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001059 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1060 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1061 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001062 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001063 attribute.
1064
1065 This method is called by __del__, so it can only refer to objects
1066 in its local scope.
1067
1068 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001069 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001070 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1071 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001072 return self.returncode
1073
1074
Reid Kleckner2b228f02011-03-16 16:57:54 -04001075 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001076 """Wait for child process to terminate. Returns returncode
1077 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001078 if endtime is not None:
1079 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001080 if timeout is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001081 timeout_millis = _subprocess.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001082 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001083 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001084 if self.returncode is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001085 result = _subprocess.WaitForSingleObject(self._handle,
1086 timeout_millis)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001087 if result == _subprocess.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001088 raise TimeoutExpired(self.args, timeout)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001089 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001090 return self.returncode
1091
1092
1093 def _readerthread(self, fh, buffer):
1094 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001095 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001096
1097
Reid Kleckner2b228f02011-03-16 16:57:54 -04001098 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001099 # Start reader threads feeding into a list hanging off of this
1100 # object, unless they've already been started.
1101 if self.stdout and not hasattr(self, "_stdout_buff"):
1102 self._stdout_buff = []
1103 self.stdout_thread = \
1104 threading.Thread(target=self._readerthread,
1105 args=(self.stdout, self._stdout_buff))
1106 self.stdout_thread.daemon = True
1107 self.stdout_thread.start()
1108 if self.stderr and not hasattr(self, "_stderr_buff"):
1109 self._stderr_buff = []
1110 self.stderr_thread = \
1111 threading.Thread(target=self._readerthread,
1112 args=(self.stderr, self._stderr_buff))
1113 self.stderr_thread.daemon = True
1114 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001115
1116 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001117 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001118 try:
1119 self.stdin.write(input)
1120 except IOError as e:
1121 if e.errno != errno.EPIPE:
1122 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001123 self.stdin.close()
1124
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001125 # Wait for the reader threads, or time out. If we time out, the
1126 # threads remain reading and the fds left open in case the user
1127 # calls communicate again.
1128 if self.stdout is not None:
1129 self.stdout_thread.join(self._remaining_time(endtime))
1130 if self.stdout_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001131 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001132 if self.stderr is not None:
1133 self.stderr_thread.join(self._remaining_time(endtime))
1134 if self.stderr_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001135 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001136
1137 # Collect the output from and close both pipes, now that we know
1138 # both have been read successfully.
1139 stdout = None
1140 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001141 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001142 stdout = self._stdout_buff
1143 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001144 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001145 stderr = self._stderr_buff
1146 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001147
1148 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001149 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001150 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001151 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152 stderr = stderr[0]
1153
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001154 return (stdout, stderr)
1155
Christian Heimesa342c012008-04-20 21:01:16 +00001156 def send_signal(self, sig):
1157 """Send a signal to the process
1158 """
1159 if sig == signal.SIGTERM:
1160 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001161 elif sig == signal.CTRL_C_EVENT:
1162 os.kill(self.pid, signal.CTRL_C_EVENT)
1163 elif sig == signal.CTRL_BREAK_EVENT:
1164 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001165 else:
Brian Curtin19651362010-09-07 13:24:38 +00001166 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001167
1168 def terminate(self):
1169 """Terminates the process
1170 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001171 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001172
1173 kill = terminate
1174
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001175 else:
1176 #
1177 # POSIX methods
1178 #
1179 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001180 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001181 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1182 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001183 p2cread, p2cwrite = -1, -1
1184 c2pread, c2pwrite = -1, -1
1185 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001186
Peter Astrandd38ddf42005-02-10 08:32:50 +00001187 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001188 pass
1189 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001190 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001191 elif stdin == DEVNULL:
1192 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001193 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001194 p2cread = stdin
1195 else:
1196 # Assuming file-like object
1197 p2cread = stdin.fileno()
1198
Peter Astrandd38ddf42005-02-10 08:32:50 +00001199 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001200 pass
1201 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001202 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001203 elif stdout == DEVNULL:
1204 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001205 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001206 c2pwrite = stdout
1207 else:
1208 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001209 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001210
Peter Astrandd38ddf42005-02-10 08:32:50 +00001211 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001212 pass
1213 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001214 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001215 elif stderr == STDOUT:
1216 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001217 elif stderr == DEVNULL:
1218 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001219 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001220 errwrite = stderr
1221 else:
1222 # Assuming file-like object
1223 errwrite = stderr.fileno()
1224
1225 return (p2cread, p2cwrite,
1226 c2pread, c2pwrite,
1227 errread, errwrite)
1228
1229
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001230 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001231 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001232 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001233 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001234 os.closerange(start_fd, fd)
1235 start_fd = fd + 1
1236 if start_fd <= MAXFD:
1237 os.closerange(start_fd, MAXFD)
1238
1239
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001240 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001241 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001242 startupinfo, creationflags, shell,
1243 p2cread, p2cwrite,
1244 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001245 errread, errwrite,
1246 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001247 """Execute program (POSIX version)"""
1248
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001249 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001250 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001251 else:
1252 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001253
1254 if shell:
1255 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001256 if executable:
1257 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001258
Peter Astrandd38ddf42005-02-10 08:32:50 +00001259 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001260 executable = args[0]
1261
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001262 # For transferring possible exec failure from child to parent.
1263 # Data format: "exception name:hex errno:description"
1264 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001265 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001266 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001267 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001268
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001269 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001270 # We must avoid complex work that could involve
1271 # malloc or free in the child process to avoid
1272 # potential deadlocks, thus we do all this here.
1273 # and pass it to fork_exec()
1274
1275 if env:
Victor Stinner449c4662010-05-08 11:10:09 +00001276 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001277 for k, v in env.items()]
1278 else:
1279 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001280 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001281 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001282 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001283 else:
1284 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001285 executable_list = tuple(
1286 os.path.join(os.fsencode(dir), executable)
1287 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001288 fds_to_keep = set(pass_fds)
1289 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001290 self.pid = _posixsubprocess.fork_exec(
1291 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001292 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001293 p2cread, p2cwrite, c2pread, c2pwrite,
1294 errread, errwrite,
1295 errpipe_read, errpipe_write,
1296 restore_signals, start_new_session, preexec_fn)
1297 else:
1298 # Pure Python implementation: It is not thread safe.
1299 # This implementation may deadlock in the child if your
1300 # parent process has any other threads running.
1301
1302 gc_was_enabled = gc.isenabled()
1303 # Disable gc to avoid bug where gc -> file_dealloc ->
1304 # write to stderr -> hang. See issue1336
1305 gc.disable()
1306 try:
1307 self.pid = os.fork()
1308 except:
1309 if gc_was_enabled:
1310 gc.enable()
1311 raise
1312 self._child_created = True
1313 if self.pid == 0:
1314 # Child
1315 try:
1316 # Close parent's pipe ends
1317 if p2cwrite != -1:
1318 os.close(p2cwrite)
1319 if c2pread != -1:
1320 os.close(c2pread)
1321 if errread != -1:
1322 os.close(errread)
1323 os.close(errpipe_read)
1324
1325 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001326 def _dup2(a, b):
1327 # dup2() removes the CLOEXEC flag but
1328 # we must do it ourselves if dup2()
1329 # would be a no-op (issue #10806).
1330 if a == b:
1331 _set_cloexec(a, False)
1332 elif a != -1:
1333 os.dup2(a, b)
1334 _dup2(p2cread, 0)
1335 _dup2(c2pwrite, 1)
1336 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001337
1338 # Close pipe fds. Make sure we don't close the
1339 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001340 closed = set()
1341 for fd in [p2cread, c2pwrite, errwrite]:
1342 if fd > 2 and fd not in closed:
1343 os.close(fd)
1344 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001345
1346 # Close all other fds, if asked for
1347 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001348 fds_to_keep = set(pass_fds)
1349 fds_to_keep.add(errpipe_write)
1350 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001351
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001352
1353 if cwd is not None:
1354 os.chdir(cwd)
1355
1356 # This is a copy of Python/pythonrun.c
1357 # _Py_RestoreSignals(). If that were exposed
1358 # as a sys._py_restoresignals func it would be
1359 # better.. but this pure python implementation
1360 # isn't likely to be used much anymore.
1361 if restore_signals:
1362 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1363 for sig in signals:
1364 if hasattr(signal, sig):
1365 signal.signal(getattr(signal, sig),
1366 signal.SIG_DFL)
1367
1368 if start_new_session and hasattr(os, 'setsid'):
1369 os.setsid()
1370
1371 if preexec_fn:
1372 preexec_fn()
1373
1374 if env is None:
1375 os.execvp(executable, args)
1376 else:
1377 os.execvpe(executable, args, env)
1378
1379 except:
1380 try:
1381 exc_type, exc_value = sys.exc_info()[:2]
1382 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001383 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001384 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001385 errno_num = 0
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001386 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001387 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001388 message = message.encode(errors="surrogatepass")
1389 os.write(errpipe_write, message)
1390 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001391 # We MUST not allow anything odd happening
1392 # above to prevent us from exiting below.
1393 pass
1394
1395 # This exitcode won't be reported to applications
1396 # so it really doesn't matter what we return.
1397 os._exit(255)
1398
1399 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001400 if gc_was_enabled:
1401 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001402 finally:
1403 # be sure the FD is closed no matter what
1404 os.close(errpipe_write)
1405
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001406 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001407 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001408 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001409 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001410 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001411 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001412 if hasattr(self, '_devnull'):
1413 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001414
1415 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001416 # exception (limited in size)
1417 data = bytearray()
1418 while True:
1419 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1420 data += part
1421 if not part or len(data) > 50000:
1422 break
Facundo Batista10706e22009-06-19 20:34:30 +00001423 finally:
1424 # be sure the FD is closed no matter what
1425 os.close(errpipe_read)
1426
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001427 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001428 try:
1429 _eintr_retry_call(os.waitpid, self.pid, 0)
1430 except OSError as e:
1431 if e.errno != errno.ECHILD:
1432 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001433 try:
1434 exception_name, hex_errno, err_msg = data.split(b':', 2)
1435 except ValueError:
1436 print('Bad exception data:', repr(data))
1437 exception_name = b'RuntimeError'
1438 hex_errno = b'0'
1439 err_msg = b'Unknown'
1440 child_exception_type = getattr(
1441 builtins, exception_name.decode('ascii'),
1442 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001443 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001444 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001445 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001446 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001447 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001448 errno_num = int(hex_errno, 16)
1449 if errno_num != 0:
1450 err_msg = os.strerror(errno_num)
1451 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001452 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001453 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001454 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001455
1456
Brett Cannon84df1e62010-05-14 00:33:40 +00001457 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1458 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1459 _WEXITSTATUS=os.WEXITSTATUS):
1460 # This method is called (indirectly) by __del__, so it cannot
1461 # refer to anything outside of its local scope."""
1462 if _WIFSIGNALED(sts):
1463 self.returncode = -_WTERMSIG(sts)
1464 elif _WIFEXITED(sts):
1465 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001466 else:
1467 # Should never happen
1468 raise RuntimeError("Unknown child exit status!")
1469
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001470
Brett Cannon84df1e62010-05-14 00:33:40 +00001471 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1472 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001473 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001474 attribute.
1475
1476 This method is called by __del__, so it cannot reference anything
1477 outside of the local scope (nor can any methods it calls).
1478
1479 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001480 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001481 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001482 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001483 if pid == self.pid:
1484 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001485 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001486 if _deadstate is not None:
1487 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001488 return self.returncode
1489
1490
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001491 def _try_wait(self, wait_flags):
1492 try:
1493 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1494 except OSError as e:
1495 if e.errno != errno.ECHILD:
1496 raise
1497 # This happens if SIGCLD is set to be ignored or waiting
1498 # for child processes has otherwise been disabled for our
1499 # process. This child is dead, we can't get the status.
1500 pid = self.pid
1501 sts = 0
1502 return (pid, sts)
1503
1504
1505 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001506 """Wait for child process to terminate. Returns returncode
1507 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001508 if self.returncode is not None:
1509 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001510
1511 # endtime is preferred to timeout. timeout is only used for
1512 # printing.
1513 if endtime is not None or timeout is not None:
1514 if endtime is None:
1515 endtime = time.time() + timeout
1516 elif timeout is None:
1517 timeout = self._remaining_time(endtime)
1518
1519 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001520 # Enter a busy loop if we have a timeout. This busy loop was
1521 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1522 delay = 0.0005 # 500 us -> initial delay of 1 ms
1523 while True:
1524 (pid, sts) = self._try_wait(os.WNOHANG)
1525 assert pid == self.pid or pid == 0
1526 if pid == self.pid:
1527 self._handle_exitstatus(sts)
1528 break
1529 remaining = self._remaining_time(endtime)
1530 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001531 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001532 delay = min(delay * 2, remaining, .05)
1533 time.sleep(delay)
1534 elif self.returncode is None:
1535 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001536 self._handle_exitstatus(sts)
1537 return self.returncode
1538
1539
Reid Kleckner2b228f02011-03-16 16:57:54 -04001540 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001541 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001542 # Flush stdio buffer. This might block, if the user has
1543 # been writing to .stdin in an uncontrolled fashion.
1544 self.stdin.flush()
1545 if not input:
1546 self.stdin.close()
1547
1548 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001549 stdout, stderr = self._communicate_with_poll(input, endtime,
1550 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001551 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001552 stdout, stderr = self._communicate_with_select(input, endtime,
1553 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001554
1555 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001556
1557 # All data exchanged. Translate lists into strings.
1558 if stdout is not None:
1559 stdout = b''.join(stdout)
1560 if stderr is not None:
1561 stderr = b''.join(stderr)
1562
1563 # Translate newlines, if requested.
1564 # This also turns bytes into strings.
1565 if self.universal_newlines:
1566 if stdout is not None:
1567 stdout = self._translate_newlines(stdout,
1568 self.stdout.encoding)
1569 if stderr is not None:
1570 stderr = self._translate_newlines(stderr,
1571 self.stderr.encoding)
1572
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001573 return (stdout, stderr)
1574
1575
Reid Kleckner2b228f02011-03-16 16:57:54 -04001576 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001577 stdout = None # Return
1578 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001579
1580 if not self._communication_started:
1581 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001582
1583 poller = select.poll()
1584 def register_and_append(file_obj, eventmask):
1585 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001586 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001587
1588 def close_unregister_and_remove(fd):
1589 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001590 self._fd2file[fd].close()
1591 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001592
1593 if self.stdin and input:
1594 register_and_append(self.stdin, select.POLLOUT)
1595
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596 # Only create this mapping if we haven't already.
1597 if not self._communication_started:
1598 self._fd2output = {}
1599 if self.stdout:
1600 self._fd2output[self.stdout.fileno()] = []
1601 if self.stderr:
1602 self._fd2output[self.stderr.fileno()] = []
1603
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001604 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1605 if self.stdout:
1606 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001607 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001608 if self.stderr:
1609 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001610 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001611
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001612 # Save the input here so that if we time out while communicating,
1613 # we can continue sending input if we retry.
1614 if self.stdin and self._input is None:
1615 self._input_offset = 0
1616 self._input = input
1617 if self.universal_newlines:
1618 self._input = self._input.encode(self.stdin.encoding)
1619
1620 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001621 timeout = self._remaining_time(endtime)
1622 if timeout is not None and timeout < 0:
1623 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001624 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001625 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001626 except select.error as e:
1627 if e.args[0] == errno.EINTR:
1628 continue
1629 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001630 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001631
1632 # XXX Rewrite these to use non-blocking I/O on the
1633 # file objects; they are no longer using C stdio!
1634
1635 for fd, mode in ready:
1636 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001637 chunk = self._input[self._input_offset :
1638 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001639 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001640 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001641 except OSError as e:
1642 if e.errno == errno.EPIPE:
1643 close_unregister_and_remove(fd)
1644 else:
1645 raise
1646 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001647 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001648 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001649 elif mode & select_POLLIN_POLLPRI:
1650 data = os.read(fd, 4096)
1651 if not data:
1652 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001653 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001654 else:
1655 # Ignore hang up or errors.
1656 close_unregister_and_remove(fd)
1657
1658 return (stdout, stderr)
1659
1660
Reid Kleckner2b228f02011-03-16 16:57:54 -04001661 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001662 if not self._communication_started:
1663 self._read_set = []
1664 self._write_set = []
1665 if self.stdin and input:
1666 self._write_set.append(self.stdin)
1667 if self.stdout:
1668 self._read_set.append(self.stdout)
1669 if self.stderr:
1670 self._read_set.append(self.stderr)
1671
1672 if self.stdin and self._input is None:
1673 self._input_offset = 0
1674 self._input = input
1675 if self.universal_newlines:
1676 self._input = self._input.encode(self.stdin.encoding)
1677
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001678 stdout = None # Return
1679 stderr = None # Return
1680
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001681 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001682 if not self._communication_started:
1683 self._stdout_buff = []
1684 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001685 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001686 if not self._communication_started:
1687 self._stderr_buff = []
1688 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001689
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001690 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001691 timeout = self._remaining_time(endtime)
1692 if timeout is not None and timeout < 0:
1693 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001694 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001695 (rlist, wlist, xlist) = \
1696 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001697 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001698 except select.error as e:
1699 if e.args[0] == errno.EINTR:
1700 continue
1701 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001702
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001703 # According to the docs, returning three empty lists indicates
1704 # that the timeout expired.
1705 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001706 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001707 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001708 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001709
Guido van Rossum98297ee2007-11-06 21:34:58 +00001710 # XXX Rewrite these to use non-blocking I/O on the
1711 # file objects; they are no longer using C stdio!
1712
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001713 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001714 chunk = self._input[self._input_offset :
1715 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001716 try:
1717 bytes_written = os.write(self.stdin.fileno(), chunk)
1718 except OSError as e:
1719 if e.errno == errno.EPIPE:
1720 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001721 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001722 else:
1723 raise
1724 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001725 self._input_offset += bytes_written
1726 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001727 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001728 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001729
1730 if self.stdout in rlist:
1731 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001732 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001733 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001734 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001735 stdout.append(data)
1736
1737 if self.stderr in rlist:
1738 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001739 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001740 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001741 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 stderr.append(data)
1743
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001744 return (stdout, stderr)
1745
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001746
Christian Heimesa342c012008-04-20 21:01:16 +00001747 def send_signal(self, sig):
1748 """Send a signal to the process
1749 """
1750 os.kill(self.pid, sig)
1751
1752 def terminate(self):
1753 """Terminate the process with SIGTERM
1754 """
1755 self.send_signal(signal.SIGTERM)
1756
1757 def kill(self):
1758 """Kill the process with SIGKILL
1759 """
1760 self.send_signal(signal.SIGKILL)