blob: e01cbd7223faeaefb76c69da6c9b6d7f4ef3f761 [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):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700169 Run command with arguments and return its output.
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
Victor Stinner949d8c92012-05-30 13:30:32 +0200352try:
353 from time import monotonic as _time
354except ImportError:
355 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000356
Peter Astrand454f7672005-01-01 09:36:35 +0000357# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400358class SubprocessError(Exception): pass
359
360
361class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000362 """This exception is raised when a process run by check_call() or
363 check_output() returns a non-zero exit status.
364 The exit status will be stored in the returncode attribute;
365 check_output() will also store the output in the output attribute.
366 """
367 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000368 self.returncode = returncode
369 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000370 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000371 def __str__(self):
372 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
373
Peter Astrand454f7672005-01-01 09:36:35 +0000374
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400375class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400376 """This exception is raised when the timeout expires while waiting for a
377 child process.
378 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400379 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400380 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400381 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400382 self.output = output
383
384 def __str__(self):
385 return ("Command '%s' timed out after %s seconds" %
386 (self.cmd, self.timeout))
387
388
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000389if mswindows:
390 import threading
391 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200392 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000393 class STARTUPINFO:
394 dwFlags = 0
395 hStdInput = None
396 hStdOutput = None
397 hStdError = None
398 wShowWindow = 0
399 class pywintypes:
400 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000401else:
402 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000403 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700404 import _posixsubprocess
405 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000406
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000407 # When select or poll has indicated that the file is writable,
408 # we can write up to _PIPE_BUF bytes without risk of blocking.
409 # POSIX defines PIPE_BUF as >= 512.
410 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
411
412
Brett Cannona23810f2008-05-26 19:04:21 +0000413__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200414 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000415
Brian Curtin1ce6b582010-04-24 16:19:22 +0000416if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200417 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
418 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
419 STD_ERROR_HANDLE, SW_HIDE,
420 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500421
Brian Curtin08fd8d92011-04-29 16:11:30 -0500422 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500423 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
424 "STD_ERROR_HANDLE", "SW_HIDE",
425 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200426
427 class Handle(int):
428 closed = False
429
430 def Close(self, CloseHandle=_winapi.CloseHandle):
431 if not self.closed:
432 self.closed = True
433 CloseHandle(self)
434
435 def Detach(self):
436 if not self.closed:
437 self.closed = True
438 return int(self)
439 raise ValueError("already closed")
440
441 def __repr__(self):
442 return "Handle(%d)" % int(self)
443
444 __del__ = Close
445 __str__ = __repr__
446
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000447try:
448 MAXFD = os.sysconf("SC_OPEN_MAX")
449except:
450 MAXFD = 256
451
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200452# This lists holds Popen instances for which the underlying process had not
453# exited at the time its __del__ method got called: those processes are wait()ed
454# for synchronously from _cleanup() when a new Popen object is created, to avoid
455# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000456_active = []
457
458def _cleanup():
459 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000460 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200461 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000462 try:
463 _active.remove(inst)
464 except ValueError:
465 # This can happen if two threads create a new Popen instance.
466 # It's harmless that it was already removed, so ignore.
467 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000468
469PIPE = -1
470STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200471DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000472
473
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000474def _eintr_retry_call(func, *args):
475 while True:
476 try:
477 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200478 except InterruptedError:
479 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000480
481
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200482# XXX This function is only used by multiprocessing and the test suite,
483# but it's here so that it can be imported when Python is compiled without
484# threads.
485
486def _args_from_interpreter_flags():
487 """Return a list of command-line arguments reproducing the current
488 settings in sys.flags and sys.warnoptions."""
489 flag_opt_map = {
490 'debug': 'd',
491 # 'inspect': 'i',
492 # 'interactive': 'i',
493 'optimize': 'O',
494 'dont_write_bytecode': 'B',
495 'no_user_site': 's',
496 'no_site': 'S',
497 'ignore_environment': 'E',
498 'verbose': 'v',
499 'bytes_warning': 'b',
500 'quiet': 'q',
501 'hash_randomization': 'R',
502 }
503 args = []
504 for flag, opt in flag_opt_map.items():
505 v = getattr(sys.flags, flag)
506 if v > 0:
507 args.append('-' + opt * v)
508 for opt in sys.warnoptions:
509 args.append('-W' + opt)
510 return args
511
512
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400513def call(*popenargs, timeout=None, **kwargs):
514 """Run command with arguments. Wait for command to complete or
515 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000516
517 The arguments are the same as for the Popen constructor. Example:
518
519 retcode = call(["ls", "-l"])
520 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200521 with Popen(*popenargs, **kwargs) as p:
522 try:
523 return p.wait(timeout=timeout)
524 except:
525 p.kill()
526 p.wait()
527 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000528
529
Peter Astrand454f7672005-01-01 09:36:35 +0000530def check_call(*popenargs, **kwargs):
531 """Run command with arguments. Wait for command to complete. If
532 the exit code was zero then return, otherwise raise
533 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000534 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000535
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400536 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000537
538 check_call(["ls", "-l"])
539 """
540 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000541 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000542 cmd = kwargs.get("args")
543 if cmd is None:
544 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000545 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000546 return 0
547
548
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400549def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700550 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000551
552 If the exit code was non-zero it raises a CalledProcessError. The
553 CalledProcessError object will have the return code in the returncode
554 attribute and output in the output attribute.
555
556 The arguments are the same as for the Popen constructor. Example:
557
558 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000559 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000560
561 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000562 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000563
564 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000565 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000566 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000567 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700568
569 If universal_newlines=True is passed, the return value will be a
570 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000571 """
572 if 'stdout' in kwargs:
573 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200574 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
575 try:
576 output, unused_err = process.communicate(timeout=timeout)
577 except TimeoutExpired:
578 process.kill()
579 output, unused_err = process.communicate()
580 raise TimeoutExpired(process.args, timeout, output=output)
581 except:
582 process.kill()
583 process.wait()
584 raise
585 retcode = process.poll()
586 if retcode:
587 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000588 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000589
590
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000591def list2cmdline(seq):
592 """
593 Translate a sequence of arguments into a command line
594 string, using the same rules as the MS C runtime:
595
596 1) Arguments are delimited by white space, which is either a
597 space or a tab.
598
599 2) A string surrounded by double quotation marks is
600 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000601 contained within. A quoted string can be embedded in an
602 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000603
604 3) A double quotation mark preceded by a backslash is
605 interpreted as a literal double quotation mark.
606
607 4) Backslashes are interpreted literally, unless they
608 immediately precede a double quotation mark.
609
610 5) If backslashes immediately precede a double quotation mark,
611 every pair of backslashes is interpreted as a literal
612 backslash. If the number of backslashes is odd, the last
613 backslash escapes the next double quotation mark as
614 described in rule 3.
615 """
616
617 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000618 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
619 # or search http://msdn.microsoft.com for
620 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000621 result = []
622 needquote = False
623 for arg in seq:
624 bs_buf = []
625
626 # Add a space to separate this argument from the others
627 if result:
628 result.append(' ')
629
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000630 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000631 if needquote:
632 result.append('"')
633
634 for c in arg:
635 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000636 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000637 bs_buf.append(c)
638 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000639 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000640 result.append('\\' * len(bs_buf)*2)
641 bs_buf = []
642 result.append('\\"')
643 else:
644 # Normal char
645 if bs_buf:
646 result.extend(bs_buf)
647 bs_buf = []
648 result.append(c)
649
Christian Heimesfdab48e2008-01-20 09:06:41 +0000650 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000651 if bs_buf:
652 result.extend(bs_buf)
653
654 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000655 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000656 result.append('"')
657
658 return ''.join(result)
659
660
Brett Cannona23810f2008-05-26 19:04:21 +0000661# Various tools for executing commands and looking at their output and status.
662#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000663# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000664
665def getstatusoutput(cmd):
666 """Return (status, output) of executing cmd in a shell.
667
668 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
669 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
670 returned output will contain output or error messages. A trailing newline
671 is stripped from the output. The exit status for the command can be
672 interpreted according to the rules for the C function wait(). Example:
673
674 >>> import subprocess
675 >>> subprocess.getstatusoutput('ls /bin/ls')
676 (0, '/bin/ls')
677 >>> subprocess.getstatusoutput('cat /bin/junk')
678 (256, 'cat: /bin/junk: No such file or directory')
679 >>> subprocess.getstatusoutput('/bin/junk')
680 (256, 'sh: /bin/junk: not found')
681 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200682 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
683 try:
684 text = pipe.read()
685 sts = pipe.close()
686 except:
687 process = pipe._proc
688 process.kill()
689 process.wait()
690 raise
691 if sts is None:
692 sts = 0
693 if text[-1:] == '\n':
694 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000695 return sts, text
696
697
698def getoutput(cmd):
699 """Return output (stdout or stderr) of executing cmd in a shell.
700
701 Like getstatusoutput(), except the exit status is ignored and the return
702 value is a string containing the command's output. Example:
703
704 >>> import subprocess
705 >>> subprocess.getoutput('ls /bin/ls')
706 '/bin/ls'
707 """
708 return getstatusoutput(cmd)[1]
709
710
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000711_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000712
713
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000714class Popen(object):
715 def __init__(self, args, bufsize=0, executable=None,
716 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000717 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
718 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000719 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000720 restore_signals=True, start_new_session=False,
721 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000722 """Create new Popen instance."""
723 _cleanup()
724
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000725 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400726 self._input = None
727 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000728 if bufsize is None:
729 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000730 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000731 raise TypeError("bufsize must be an integer")
732
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000733 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000734 if preexec_fn is not None:
735 raise ValueError("preexec_fn is not supported on Windows "
736 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000737 any_stdio_set = (stdin is not None or stdout is not None or
738 stderr is not None)
739 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
740 if any_stdio_set:
741 close_fds = False
742 else:
743 close_fds = True
744 elif close_fds and any_stdio_set:
745 raise ValueError(
746 "close_fds is not supported on Windows platforms"
747 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000748 else:
749 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000750 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
751 close_fds = True
752 if pass_fds and not close_fds:
753 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
754 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000755 if startupinfo is not None:
756 raise ValueError("startupinfo is only supported on Windows "
757 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000758 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000759 raise ValueError("creationflags is only supported on Windows "
760 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000761
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400762 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000763 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000764 self.stdout = None
765 self.stderr = None
766 self.pid = None
767 self.returncode = None
768 self.universal_newlines = universal_newlines
769
770 # Input and output objects. The general principle is like
771 # this:
772 #
773 # Parent Child
774 # ------ -----
775 # p2cwrite ---stdin---> p2cread
776 # c2pread <--stdout--- c2pwrite
777 # errread <--stderr--- errwrite
778 #
779 # On POSIX, the child objects are file descriptors. On
780 # Windows, these are Windows file handles. The parent objects
781 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000782 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000783 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000784
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000785 (p2cread, p2cwrite,
786 c2pread, c2pwrite,
787 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
788
Antoine Pitrouc9982322011-01-04 19:07:07 +0000789 # We wrap OS handles *before* launching the child, otherwise a
790 # quickly terminating child could make our fds unwrappable
791 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000792
Thomas Wouterscf297e42007-02-23 15:07:44 +0000793 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000794 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000795 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000796 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000797 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000798 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000799 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000800
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000801 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000802 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300803 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200804 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000805 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000806 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000807 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000808 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000809 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000810 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000811 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000812 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000813
Antoine Pitrouc9982322011-01-04 19:07:07 +0000814 try:
815 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300816 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000817 startupinfo, creationflags, shell,
818 p2cread, p2cwrite,
819 c2pread, c2pwrite,
820 errread, errwrite,
821 restore_signals, start_new_session)
822 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800823 # Cleanup if the child failed starting.
824 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000825 try:
826 f.close()
827 except EnvironmentError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800828 pass # Ignore EBADF or other errors.
829
830 # Make sure the child pipes are closed as well.
831 to_close = []
832 if stdin == PIPE:
833 to_close.append(p2cread)
834 if stdout == PIPE:
835 to_close.append(c2pwrite)
836 if stderr == PIPE:
837 to_close.append(errwrite)
838 for fd in to_close:
839 try:
840 os.close(fd)
841 except EnvironmentError:
Antoine Pitrouc9982322011-01-04 19:07:07 +0000842 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800843
Antoine Pitrouc9982322011-01-04 19:07:07 +0000844 raise
845
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000846
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300848 data = data.decode(encoding)
849 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000850
Brian Curtin79cdb662010-12-03 02:46:02 +0000851 def __enter__(self):
852 return self
853
854 def __exit__(self, type, value, traceback):
855 if self.stdout:
856 self.stdout.close()
857 if self.stderr:
858 self.stderr.close()
859 if self.stdin:
860 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700861 # Wait for the process to terminate, to avoid zombies.
862 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000863
Brett Cannon84df1e62010-05-14 00:33:40 +0000864 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200865 # If __init__ hasn't had a chance to execute (e.g. if it
866 # was passed an undeclared keyword argument), we don't
867 # have a _child_created attribute at all.
868 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000869 # We didn't get to successfully create a child process.
870 return
871 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000872 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000873 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000874 # Child is still running, keep us alive until we can wait on it.
875 _active.append(self)
876
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200877 def _get_devnull(self):
878 if not hasattr(self, '_devnull'):
879 self._devnull = os.open(os.devnull, os.O_RDWR)
880 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000881
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400882 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000883 """Interact with process: Send data to stdin. Read data from
884 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700885 process to terminate. The optional input argument should be
886 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000887 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000888
Peter Astrand23109f02005-03-03 20:28:59 +0000889 communicate() returns a tuple (stdout, stderr)."""
890
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400891 if self._communication_started and input:
892 raise ValueError("Cannot send input after starting communication")
893
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400894 # Optimization: If we are not worried about timeouts, we haven't
895 # started communicating, and we have one or zero pipes, using select()
896 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200897 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400898 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000899 stdout = None
900 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000901 if self.stdin:
902 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200903 try:
904 self.stdin.write(input)
905 except IOError as e:
906 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
907 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000908 self.stdin.close()
909 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200910 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000911 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000912 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200913 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000914 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000915 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200916 else:
917 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200918 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200919 else:
920 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000921
Victor Stinner7a8d0812011-04-05 13:13:08 +0200922 try:
923 stdout, stderr = self._communicate(input, endtime, timeout)
924 finally:
925 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400926
Victor Stinner7a8d0812011-04-05 13:13:08 +0200927 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400928
929 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000930
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000931
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000932 def poll(self):
933 return self._internal_poll()
934
935
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400936 def _remaining_time(self, endtime):
937 """Convenience for _communicate when computing timeouts."""
938 if endtime is None:
939 return None
940 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200941 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400942
943
Reid Kleckner2b228f02011-03-16 16:57:54 -0400944 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400945 """Convenience for checking if a timeout has expired."""
946 if endtime is None:
947 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200948 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400949 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400950
951
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000952 if mswindows:
953 #
954 # Windows methods
955 #
956 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000957 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000958 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
959 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000960 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000961 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000962
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000963 p2cread, p2cwrite = -1, -1
964 c2pread, c2pwrite = -1, -1
965 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000966
Peter Astrandd38ddf42005-02-10 08:32:50 +0000967 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200968 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000969 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200970 p2cread, _ = _winapi.CreatePipe(None, 0)
971 p2cread = Handle(p2cread)
972 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000973 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200974 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
975 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200976 elif stdin == DEVNULL:
977 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000978 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000979 p2cread = msvcrt.get_osfhandle(stdin)
980 else:
981 # Assuming file-like object
982 p2cread = msvcrt.get_osfhandle(stdin.fileno())
983 p2cread = self._make_inheritable(p2cread)
984
Peter Astrandd38ddf42005-02-10 08:32:50 +0000985 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200986 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000987 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200988 _, c2pwrite = _winapi.CreatePipe(None, 0)
989 c2pwrite = Handle(c2pwrite)
990 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000991 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200992 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
993 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200994 elif stdout == DEVNULL:
995 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000996 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000997 c2pwrite = msvcrt.get_osfhandle(stdout)
998 else:
999 # Assuming file-like object
1000 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1001 c2pwrite = self._make_inheritable(c2pwrite)
1002
Peter Astrandd38ddf42005-02-10 08:32:50 +00001003 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001004 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001005 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001006 _, errwrite = _winapi.CreatePipe(None, 0)
1007 errwrite = Handle(errwrite)
1008 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001009 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001010 errread, errwrite = _winapi.CreatePipe(None, 0)
1011 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001012 elif stderr == STDOUT:
1013 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001014 elif stderr == DEVNULL:
1015 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001016 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001017 errwrite = msvcrt.get_osfhandle(stderr)
1018 else:
1019 # Assuming file-like object
1020 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1021 errwrite = self._make_inheritable(errwrite)
1022
1023 return (p2cread, p2cwrite,
1024 c2pread, c2pwrite,
1025 errread, errwrite)
1026
1027
1028 def _make_inheritable(self, handle):
1029 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001030 h = _winapi.DuplicateHandle(
1031 _winapi.GetCurrentProcess(), handle,
1032 _winapi.GetCurrentProcess(), 0, 1,
1033 _winapi.DUPLICATE_SAME_ACCESS)
1034 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001035
1036
1037 def _find_w9xpopen(self):
1038 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001039 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001040 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001041 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001042 if not os.path.exists(w9xpopen):
1043 # Eeek - file-not-found - possibly an embedding
1044 # situation - see if we can locate it in sys.exec_prefix
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001045 w9xpopen = os.path.join(os.path.dirname(sys.base_exec_prefix),
Tim Peterse8374a52004-10-13 03:15:00 +00001046 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001047 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +00001048 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1049 "needed for Popen to work with your "
1050 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001051 return w9xpopen
1052
Tim Peterse718f612004-10-12 21:51:32 +00001053
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001054 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001055 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 startupinfo, creationflags, shell,
1057 p2cread, p2cwrite,
1058 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001059 errread, errwrite,
1060 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 """Execute program (MS Windows version)"""
1062
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001063 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001064
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001065 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066 args = list2cmdline(args)
1067
Peter Astrandc1d65362004-11-07 14:30:34 +00001068 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001069 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001070 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001071 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001072 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001073 startupinfo.hStdInput = p2cread
1074 startupinfo.hStdOutput = c2pwrite
1075 startupinfo.hStdError = errwrite
1076
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001077 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001078 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1079 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001080 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001081 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001082 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001083 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001084 # Win9x, or using command.com on NT. We need to
1085 # use the w9xpopen intermediate program. For more
1086 # information, see KB Q150956
1087 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1088 w9xpopen = self._find_w9xpopen()
1089 args = '"%s" %s' % (w9xpopen, args)
1090 # Not passing CREATE_NEW_CONSOLE has been known to
1091 # cause random failures on win9x. Specifically a
1092 # dialog: "Your program accessed mem currently in
1093 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001094 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001095 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001096 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001097
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001098 # Start the process
1099 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001100 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001101 # no special security
1102 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001103 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001104 creationflags,
1105 env,
1106 cwd,
1107 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001108 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109 # Translate pywintypes.error to WindowsError, which is
1110 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001111 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001112 # how can this be done from Python?
1113 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001114 finally:
1115 # Child is launched. Close the parent's copy of those pipe
1116 # handles that only the child should have open. You need
1117 # to make sure that no handles to the write end of the
1118 # output pipe are maintained in this process or else the
1119 # pipe will not close when the child process exits and the
1120 # ReadFile will hang.
1121 if p2cread != -1:
1122 p2cread.Close()
1123 if c2pwrite != -1:
1124 c2pwrite.Close()
1125 if errwrite != -1:
1126 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001127 if hasattr(self, '_devnull'):
1128 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001129
1130 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001131 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001132 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001134 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001135
Brett Cannon84df1e62010-05-14 00:33:40 +00001136 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001137 _WaitForSingleObject=_winapi.WaitForSingleObject,
1138 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1139 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001140 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001141 attribute.
1142
1143 This method is called by __del__, so it can only refer to objects
1144 in its local scope.
1145
1146 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001147 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001148 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1149 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001150 return self.returncode
1151
1152
Reid Kleckner2b228f02011-03-16 16:57:54 -04001153 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001154 """Wait for child process to terminate. Returns returncode
1155 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001156 if endtime is not None:
1157 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001158 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001159 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001160 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001161 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001162 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001163 result = _winapi.WaitForSingleObject(self._handle,
1164 timeout_millis)
1165 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001166 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001167 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001168 return self.returncode
1169
1170
1171 def _readerthread(self, fh, buffer):
1172 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001173 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001174
1175
Reid Kleckner2b228f02011-03-16 16:57:54 -04001176 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001177 # Start reader threads feeding into a list hanging off of this
1178 # object, unless they've already been started.
1179 if self.stdout and not hasattr(self, "_stdout_buff"):
1180 self._stdout_buff = []
1181 self.stdout_thread = \
1182 threading.Thread(target=self._readerthread,
1183 args=(self.stdout, self._stdout_buff))
1184 self.stdout_thread.daemon = True
1185 self.stdout_thread.start()
1186 if self.stderr and not hasattr(self, "_stderr_buff"):
1187 self._stderr_buff = []
1188 self.stderr_thread = \
1189 threading.Thread(target=self._readerthread,
1190 args=(self.stderr, self._stderr_buff))
1191 self.stderr_thread.daemon = True
1192 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001193
1194 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001195 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001196 try:
1197 self.stdin.write(input)
1198 except IOError as e:
1199 if e.errno != errno.EPIPE:
1200 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001201 self.stdin.close()
1202
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001203 # Wait for the reader threads, or time out. If we time out, the
1204 # threads remain reading and the fds left open in case the user
1205 # calls communicate again.
1206 if self.stdout is not None:
1207 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001208 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001209 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001210 if self.stderr is not None:
1211 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001212 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001213 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001214
1215 # Collect the output from and close both pipes, now that we know
1216 # both have been read successfully.
1217 stdout = None
1218 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001219 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001220 stdout = self._stdout_buff
1221 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001222 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001223 stderr = self._stderr_buff
1224 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001225
1226 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001227 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001228 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001229 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001230 stderr = stderr[0]
1231
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001232 return (stdout, stderr)
1233
Christian Heimesa342c012008-04-20 21:01:16 +00001234 def send_signal(self, sig):
1235 """Send a signal to the process
1236 """
1237 if sig == signal.SIGTERM:
1238 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001239 elif sig == signal.CTRL_C_EVENT:
1240 os.kill(self.pid, signal.CTRL_C_EVENT)
1241 elif sig == signal.CTRL_BREAK_EVENT:
1242 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001243 else:
Brian Curtin19651362010-09-07 13:24:38 +00001244 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001245
1246 def terminate(self):
1247 """Terminates the process
1248 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001249 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001250 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001251 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001252 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1253 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001254 rc = _winapi.GetExitCodeProcess(self._handle)
1255 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001256 raise
1257 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001258
1259 kill = terminate
1260
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001261 else:
1262 #
1263 # POSIX methods
1264 #
1265 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001266 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001267 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1268 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001269 p2cread, p2cwrite = -1, -1
1270 c2pread, c2pwrite = -1, -1
1271 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001272
Peter Astrandd38ddf42005-02-10 08:32:50 +00001273 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001274 pass
1275 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001276 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001277 elif stdin == DEVNULL:
1278 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001279 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001280 p2cread = stdin
1281 else:
1282 # Assuming file-like object
1283 p2cread = stdin.fileno()
1284
Peter Astrandd38ddf42005-02-10 08:32:50 +00001285 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001286 pass
1287 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001288 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001289 elif stdout == DEVNULL:
1290 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001291 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001292 c2pwrite = stdout
1293 else:
1294 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001295 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001296
Peter Astrandd38ddf42005-02-10 08:32:50 +00001297 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001298 pass
1299 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001300 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001301 elif stderr == STDOUT:
1302 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001303 elif stderr == DEVNULL:
1304 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001305 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001306 errwrite = stderr
1307 else:
1308 # Assuming file-like object
1309 errwrite = stderr.fileno()
1310
1311 return (p2cread, p2cwrite,
1312 c2pread, c2pwrite,
1313 errread, errwrite)
1314
1315
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001316 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001317 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001318 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001319 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001320 os.closerange(start_fd, fd)
1321 start_fd = fd + 1
1322 if start_fd <= MAXFD:
1323 os.closerange(start_fd, MAXFD)
1324
1325
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001326 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001327 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001328 startupinfo, creationflags, shell,
1329 p2cread, p2cwrite,
1330 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001331 errread, errwrite,
1332 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333 """Execute program (POSIX version)"""
1334
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001335 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001336 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001337 else:
1338 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001339
1340 if shell:
1341 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001342 if executable:
1343 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344
Peter Astrandd38ddf42005-02-10 08:32:50 +00001345 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001346 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001347 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001348
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001349 # For transferring possible exec failure from child to parent.
1350 # Data format: "exception name:hex errno:description"
1351 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001352 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001353 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001354 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001355 # We must avoid complex work that could involve
1356 # malloc or free in the child process to avoid
1357 # potential deadlocks, thus we do all this here.
1358 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001359
Victor Stinner372b8382011-06-21 17:24:21 +02001360 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001361 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1362 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001363 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001364 env_list = None # Use execv instead of execve.
1365 executable = os.fsencode(executable)
1366 if os.path.dirname(executable):
1367 executable_list = (executable,)
1368 else:
1369 # This matches the behavior of os._execvpe().
1370 executable_list = tuple(
1371 os.path.join(os.fsencode(dir), executable)
1372 for dir in os.get_exec_path(env))
1373 fds_to_keep = set(pass_fds)
1374 fds_to_keep.add(errpipe_write)
1375 self.pid = _posixsubprocess.fork_exec(
1376 args, executable_list,
1377 close_fds, sorted(fds_to_keep), cwd, env_list,
1378 p2cread, p2cwrite, c2pread, c2pwrite,
1379 errread, errwrite,
1380 errpipe_read, errpipe_write,
1381 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001382 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001383 finally:
1384 # be sure the FD is closed no matter what
1385 os.close(errpipe_write)
1386
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001387 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001388 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001389 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001390 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001391 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001392 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001393 if hasattr(self, '_devnull'):
1394 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001395
1396 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001397 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001398 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001399 while True:
1400 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001401 errpipe_data += part
1402 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001403 break
Facundo Batista10706e22009-06-19 20:34:30 +00001404 finally:
1405 # be sure the FD is closed no matter what
1406 os.close(errpipe_read)
1407
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001408 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001409 try:
1410 _eintr_retry_call(os.waitpid, self.pid, 0)
1411 except OSError as e:
1412 if e.errno != errno.ECHILD:
1413 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001414 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001415 exception_name, hex_errno, err_msg = (
1416 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001417 except ValueError:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001418 exception_name = b'RuntimeError'
1419 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001420 err_msg = (b'Bad exception data from child: ' +
1421 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001422 child_exception_type = getattr(
1423 builtins, exception_name.decode('ascii'),
1424 RuntimeError)
Victor Stinner4d078042010-04-23 19:28:32 +00001425 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001426 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001427 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001428 child_exec_never_called = (err_msg == "noexec")
1429 if child_exec_never_called:
1430 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001431 if errno_num != 0:
1432 err_msg = os.strerror(errno_num)
1433 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001434 if child_exec_never_called:
1435 # The error must be from chdir(cwd).
1436 err_msg += ': ' + repr(cwd)
1437 else:
1438 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001439 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001440 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001441
1442
Brett Cannon84df1e62010-05-14 00:33:40 +00001443 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1444 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1445 _WEXITSTATUS=os.WEXITSTATUS):
1446 # This method is called (indirectly) by __del__, so it cannot
1447 # refer to anything outside of its local scope."""
1448 if _WIFSIGNALED(sts):
1449 self.returncode = -_WTERMSIG(sts)
1450 elif _WIFEXITED(sts):
1451 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001452 else:
1453 # Should never happen
1454 raise RuntimeError("Unknown child exit status!")
1455
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001456
Brett Cannon84df1e62010-05-14 00:33:40 +00001457 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov08bab072012-12-24 20:06:35 +02001458 _WNOHANG=os.WNOHANG, _os_error=os.error, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001459 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001460 attribute.
1461
1462 This method is called by __del__, so it cannot reference anything
1463 outside of the local scope (nor can any methods it calls).
1464
1465 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001466 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001467 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001468 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001469 if pid == self.pid:
1470 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001471 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001472 if _deadstate is not None:
1473 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001474 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001475 # This happens if SIGCLD is set to be ignored or
1476 # waiting for child processes has otherwise been
1477 # disabled for our process. This child is dead, we
1478 # can't get the status.
1479 # http://bugs.python.org/issue15756
1480 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001481 return self.returncode
1482
1483
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001484 def _try_wait(self, wait_flags):
1485 try:
1486 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1487 except OSError as e:
1488 if e.errno != errno.ECHILD:
1489 raise
1490 # This happens if SIGCLD is set to be ignored or waiting
1491 # for child processes has otherwise been disabled for our
1492 # process. This child is dead, we can't get the status.
1493 pid = self.pid
1494 sts = 0
1495 return (pid, sts)
1496
1497
1498 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001499 """Wait for child process to terminate. Returns returncode
1500 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001501 if self.returncode is not None:
1502 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001503
1504 # endtime is preferred to timeout. timeout is only used for
1505 # printing.
1506 if endtime is not None or timeout is not None:
1507 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001508 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001509 elif timeout is None:
1510 timeout = self._remaining_time(endtime)
1511
1512 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001513 # Enter a busy loop if we have a timeout. This busy loop was
1514 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1515 delay = 0.0005 # 500 us -> initial delay of 1 ms
1516 while True:
1517 (pid, sts) = self._try_wait(os.WNOHANG)
1518 assert pid == self.pid or pid == 0
1519 if pid == self.pid:
1520 self._handle_exitstatus(sts)
1521 break
1522 remaining = self._remaining_time(endtime)
1523 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001524 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001525 delay = min(delay * 2, remaining, .05)
1526 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001527 else:
1528 while self.returncode is None:
1529 (pid, sts) = self._try_wait(0)
1530 # Check the pid and loop as waitpid has been known to return
1531 # 0 even without WNOHANG in odd situations. issue14396.
1532 if pid == self.pid:
1533 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001534 return self.returncode
1535
1536
Reid Kleckner2b228f02011-03-16 16:57:54 -04001537 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001538 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001539 # Flush stdio buffer. This might block, if the user has
1540 # been writing to .stdin in an uncontrolled fashion.
1541 self.stdin.flush()
1542 if not input:
1543 self.stdin.close()
1544
1545 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001546 stdout, stderr = self._communicate_with_poll(input, endtime,
1547 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001548 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001549 stdout, stderr = self._communicate_with_select(input, endtime,
1550 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001551
1552 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001553
1554 # All data exchanged. Translate lists into strings.
1555 if stdout is not None:
1556 stdout = b''.join(stdout)
1557 if stderr is not None:
1558 stderr = b''.join(stderr)
1559
1560 # Translate newlines, if requested.
1561 # This also turns bytes into strings.
1562 if self.universal_newlines:
1563 if stdout is not None:
1564 stdout = self._translate_newlines(stdout,
1565 self.stdout.encoding)
1566 if stderr is not None:
1567 stderr = self._translate_newlines(stderr,
1568 self.stderr.encoding)
1569
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001570 return (stdout, stderr)
1571
1572
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001573 def _save_input(self, input):
1574 # This method is called from the _communicate_with_*() methods
1575 # so that if we time out while communicating, we can continue
1576 # sending input if we retry.
1577 if self.stdin and self._input is None:
1578 self._input_offset = 0
1579 self._input = input
1580 if self.universal_newlines and input is not None:
1581 self._input = self._input.encode(self.stdin.encoding)
1582
1583
Reid Kleckner2b228f02011-03-16 16:57:54 -04001584 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001585 stdout = None # Return
1586 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001587
1588 if not self._communication_started:
1589 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001590
1591 poller = select.poll()
1592 def register_and_append(file_obj, eventmask):
1593 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001594 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001595
1596 def close_unregister_and_remove(fd):
1597 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001598 self._fd2file[fd].close()
1599 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001600
1601 if self.stdin and input:
1602 register_and_append(self.stdin, select.POLLOUT)
1603
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001604 # Only create this mapping if we haven't already.
1605 if not self._communication_started:
1606 self._fd2output = {}
1607 if self.stdout:
1608 self._fd2output[self.stdout.fileno()] = []
1609 if self.stderr:
1610 self._fd2output[self.stderr.fileno()] = []
1611
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001612 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1613 if self.stdout:
1614 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001615 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001616 if self.stderr:
1617 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001618 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001619
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001620 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001621
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
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001674 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001675
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001676 stdout = None # Return
1677 stderr = None # Return
1678
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001679 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001680 if not self._communication_started:
1681 self._stdout_buff = []
1682 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001683 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001684 if not self._communication_started:
1685 self._stderr_buff = []
1686 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001687
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001688 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001689 timeout = self._remaining_time(endtime)
1690 if timeout is not None and timeout < 0:
1691 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001692 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001693 (rlist, wlist, xlist) = \
1694 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001695 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001696 except select.error as e:
1697 if e.args[0] == errno.EINTR:
1698 continue
1699 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001700
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001701 # According to the docs, returning three empty lists indicates
1702 # that the timeout expired.
1703 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001704 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001705 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001706 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001707
Guido van Rossum98297ee2007-11-06 21:34:58 +00001708 # XXX Rewrite these to use non-blocking I/O on the
1709 # file objects; they are no longer using C stdio!
1710
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001711 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001712 chunk = self._input[self._input_offset :
1713 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001714 try:
1715 bytes_written = os.write(self.stdin.fileno(), chunk)
1716 except OSError as e:
1717 if e.errno == errno.EPIPE:
1718 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001719 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001720 else:
1721 raise
1722 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001723 self._input_offset += bytes_written
1724 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001725 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001726 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001727
1728 if self.stdout in rlist:
1729 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001730 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001731 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001732 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001733 stdout.append(data)
1734
1735 if self.stderr in rlist:
1736 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001737 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001738 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001739 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001740 stderr.append(data)
1741
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 return (stdout, stderr)
1743
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001744
Christian Heimesa342c012008-04-20 21:01:16 +00001745 def send_signal(self, sig):
1746 """Send a signal to the process
1747 """
1748 os.kill(self.pid, sig)
1749
1750 def terminate(self):
1751 """Terminate the process with SIGTERM
1752 """
1753 self.send_signal(signal.SIGTERM)
1754
1755 def kill(self):
1756 """Kill the process with SIGKILL
1757 """
1758 self.send_signal(signal.SIGKILL)