blob: 57cc1a4a7d562298bc642e311bf8d19a29fd1ddd [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
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):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000550 r"""Run command with arguments and return its output as a byte string.
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'
Georg Brandlf9734072008-12-07 15:30:06 +0000568 """
569 if 'stdout' in kwargs:
570 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200571 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
572 try:
573 output, unused_err = process.communicate(timeout=timeout)
574 except TimeoutExpired:
575 process.kill()
576 output, unused_err = process.communicate()
577 raise TimeoutExpired(process.args, timeout, output=output)
578 except:
579 process.kill()
580 process.wait()
581 raise
582 retcode = process.poll()
583 if retcode:
584 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000585 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000586
587
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000588def list2cmdline(seq):
589 """
590 Translate a sequence of arguments into a command line
591 string, using the same rules as the MS C runtime:
592
593 1) Arguments are delimited by white space, which is either a
594 space or a tab.
595
596 2) A string surrounded by double quotation marks is
597 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000598 contained within. A quoted string can be embedded in an
599 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000600
601 3) A double quotation mark preceded by a backslash is
602 interpreted as a literal double quotation mark.
603
604 4) Backslashes are interpreted literally, unless they
605 immediately precede a double quotation mark.
606
607 5) If backslashes immediately precede a double quotation mark,
608 every pair of backslashes is interpreted as a literal
609 backslash. If the number of backslashes is odd, the last
610 backslash escapes the next double quotation mark as
611 described in rule 3.
612 """
613
614 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000615 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
616 # or search http://msdn.microsoft.com for
617 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000618 result = []
619 needquote = False
620 for arg in seq:
621 bs_buf = []
622
623 # Add a space to separate this argument from the others
624 if result:
625 result.append(' ')
626
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000627 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000628 if needquote:
629 result.append('"')
630
631 for c in arg:
632 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000633 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000634 bs_buf.append(c)
635 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000636 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000637 result.append('\\' * len(bs_buf)*2)
638 bs_buf = []
639 result.append('\\"')
640 else:
641 # Normal char
642 if bs_buf:
643 result.extend(bs_buf)
644 bs_buf = []
645 result.append(c)
646
Christian Heimesfdab48e2008-01-20 09:06:41 +0000647 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000648 if bs_buf:
649 result.extend(bs_buf)
650
651 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000652 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000653 result.append('"')
654
655 return ''.join(result)
656
657
Brett Cannona23810f2008-05-26 19:04:21 +0000658# Various tools for executing commands and looking at their output and status.
659#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000660# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000661
662def getstatusoutput(cmd):
663 """Return (status, output) of executing cmd in a shell.
664
665 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
666 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
667 returned output will contain output or error messages. A trailing newline
668 is stripped from the output. The exit status for the command can be
669 interpreted according to the rules for the C function wait(). Example:
670
671 >>> import subprocess
672 >>> subprocess.getstatusoutput('ls /bin/ls')
673 (0, '/bin/ls')
674 >>> subprocess.getstatusoutput('cat /bin/junk')
675 (256, 'cat: /bin/junk: No such file or directory')
676 >>> subprocess.getstatusoutput('/bin/junk')
677 (256, 'sh: /bin/junk: not found')
678 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200679 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
680 try:
681 text = pipe.read()
682 sts = pipe.close()
683 except:
684 process = pipe._proc
685 process.kill()
686 process.wait()
687 raise
688 if sts is None:
689 sts = 0
690 if text[-1:] == '\n':
691 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000692 return sts, text
693
694
695def getoutput(cmd):
696 """Return output (stdout or stderr) of executing cmd in a shell.
697
698 Like getstatusoutput(), except the exit status is ignored and the return
699 value is a string containing the command's output. Example:
700
701 >>> import subprocess
702 >>> subprocess.getoutput('ls /bin/ls')
703 '/bin/ls'
704 """
705 return getstatusoutput(cmd)[1]
706
707
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000708_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000709
710
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000711class Popen(object):
712 def __init__(self, args, bufsize=0, executable=None,
713 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000714 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
715 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000716 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000717 restore_signals=True, start_new_session=False,
718 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000719 """Create new Popen instance."""
720 _cleanup()
721
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000722 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400723 self._input = None
724 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000725 if bufsize is None:
726 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000727 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000728 raise TypeError("bufsize must be an integer")
729
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000730 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000731 if preexec_fn is not None:
732 raise ValueError("preexec_fn is not supported on Windows "
733 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000734 any_stdio_set = (stdin is not None or stdout is not None or
735 stderr is not None)
736 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
737 if any_stdio_set:
738 close_fds = False
739 else:
740 close_fds = True
741 elif close_fds and any_stdio_set:
742 raise ValueError(
743 "close_fds is not supported on Windows platforms"
744 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000745 else:
746 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000747 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
748 close_fds = True
749 if pass_fds and not close_fds:
750 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
751 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000752 if startupinfo is not None:
753 raise ValueError("startupinfo is only supported on Windows "
754 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000755 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000756 raise ValueError("creationflags is only supported on Windows "
757 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000758
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400759 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000760 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000761 self.stdout = None
762 self.stderr = None
763 self.pid = None
764 self.returncode = None
765 self.universal_newlines = universal_newlines
766
767 # Input and output objects. The general principle is like
768 # this:
769 #
770 # Parent Child
771 # ------ -----
772 # p2cwrite ---stdin---> p2cread
773 # c2pread <--stdout--- c2pwrite
774 # errread <--stderr--- errwrite
775 #
776 # On POSIX, the child objects are file descriptors. On
777 # Windows, these are Windows file handles. The parent objects
778 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000779 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000781
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000782 (p2cread, p2cwrite,
783 c2pread, c2pwrite,
784 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
785
Antoine Pitrouc9982322011-01-04 19:07:07 +0000786 # We wrap OS handles *before* launching the child, otherwise a
787 # quickly terminating child could make our fds unwrappable
788 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000789
Thomas Wouterscf297e42007-02-23 15:07:44 +0000790 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000791 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000792 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000793 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000794 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000795 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000796 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000797
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000798 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000799 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300800 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200801 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000802 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000803 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000805 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000806 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000807 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000808 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000809 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000810
Antoine Pitrouc9982322011-01-04 19:07:07 +0000811 try:
812 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300813 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000814 startupinfo, creationflags, shell,
815 p2cread, p2cwrite,
816 c2pread, c2pwrite,
817 errread, errwrite,
818 restore_signals, start_new_session)
819 except:
820 # Cleanup if the child failed starting
821 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
822 try:
823 f.close()
824 except EnvironmentError:
825 # Ignore EBADF or other errors
826 pass
827 raise
828
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000829
Guido van Rossum98297ee2007-11-06 21:34:58 +0000830 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300831 data = data.decode(encoding)
832 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000833
Brian Curtin79cdb662010-12-03 02:46:02 +0000834 def __enter__(self):
835 return self
836
837 def __exit__(self, type, value, traceback):
838 if self.stdout:
839 self.stdout.close()
840 if self.stderr:
841 self.stderr.close()
842 if self.stdin:
843 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700844 # Wait for the process to terminate, to avoid zombies.
845 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000846
Brett Cannon84df1e62010-05-14 00:33:40 +0000847 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200848 # If __init__ hasn't had a chance to execute (e.g. if it
849 # was passed an undeclared keyword argument), we don't
850 # have a _child_created attribute at all.
851 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000852 # We didn't get to successfully create a child process.
853 return
854 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000855 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000856 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000857 # Child is still running, keep us alive until we can wait on it.
858 _active.append(self)
859
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200860 def _get_devnull(self):
861 if not hasattr(self, '_devnull'):
862 self._devnull = os.open(os.devnull, os.O_RDWR)
863 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000864
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400865 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000866 """Interact with process: Send data to stdin. Read data from
867 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700868 process to terminate. The optional input argument should be
869 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000870 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000871
Peter Astrand23109f02005-03-03 20:28:59 +0000872 communicate() returns a tuple (stdout, stderr)."""
873
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400874 if self._communication_started and input:
875 raise ValueError("Cannot send input after starting communication")
876
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400877 # Optimization: If we are not worried about timeouts, we haven't
878 # started communicating, and we have one or zero pipes, using select()
879 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200880 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400881 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000882 stdout = None
883 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000884 if self.stdin:
885 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200886 try:
887 self.stdin.write(input)
888 except IOError as e:
889 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
890 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000891 self.stdin.close()
892 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200893 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000894 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000895 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200896 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000897 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000898 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200899 else:
900 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200901 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200902 else:
903 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000904
Victor Stinner7a8d0812011-04-05 13:13:08 +0200905 try:
906 stdout, stderr = self._communicate(input, endtime, timeout)
907 finally:
908 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400909
Victor Stinner7a8d0812011-04-05 13:13:08 +0200910 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400911
912 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000913
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000914
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000915 def poll(self):
916 return self._internal_poll()
917
918
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400919 def _remaining_time(self, endtime):
920 """Convenience for _communicate when computing timeouts."""
921 if endtime is None:
922 return None
923 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200924 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400925
926
Reid Kleckner2b228f02011-03-16 16:57:54 -0400927 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400928 """Convenience for checking if a timeout has expired."""
929 if endtime is None:
930 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200931 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400932 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400933
934
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000935 if mswindows:
936 #
937 # Windows methods
938 #
939 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000940 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000941 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
942 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000943 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000944 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000945
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000946 p2cread, p2cwrite = -1, -1
947 c2pread, c2pwrite = -1, -1
948 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000949
Peter Astrandd38ddf42005-02-10 08:32:50 +0000950 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200951 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000952 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200953 p2cread, _ = _winapi.CreatePipe(None, 0)
954 p2cread = Handle(p2cread)
955 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000956 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200957 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
958 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200959 elif stdin == DEVNULL:
960 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000961 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000962 p2cread = msvcrt.get_osfhandle(stdin)
963 else:
964 # Assuming file-like object
965 p2cread = msvcrt.get_osfhandle(stdin.fileno())
966 p2cread = self._make_inheritable(p2cread)
967
Peter Astrandd38ddf42005-02-10 08:32:50 +0000968 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200969 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000970 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200971 _, c2pwrite = _winapi.CreatePipe(None, 0)
972 c2pwrite = Handle(c2pwrite)
973 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000974 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200975 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
976 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200977 elif stdout == DEVNULL:
978 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000979 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000980 c2pwrite = msvcrt.get_osfhandle(stdout)
981 else:
982 # Assuming file-like object
983 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
984 c2pwrite = self._make_inheritable(c2pwrite)
985
Peter Astrandd38ddf42005-02-10 08:32:50 +0000986 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200987 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000988 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200989 _, errwrite = _winapi.CreatePipe(None, 0)
990 errwrite = Handle(errwrite)
991 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000992 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200993 errread, errwrite = _winapi.CreatePipe(None, 0)
994 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000995 elif stderr == STDOUT:
996 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200997 elif stderr == DEVNULL:
998 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000999 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001000 errwrite = msvcrt.get_osfhandle(stderr)
1001 else:
1002 # Assuming file-like object
1003 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1004 errwrite = self._make_inheritable(errwrite)
1005
1006 return (p2cread, p2cwrite,
1007 c2pread, c2pwrite,
1008 errread, errwrite)
1009
1010
1011 def _make_inheritable(self, handle):
1012 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001013 h = _winapi.DuplicateHandle(
1014 _winapi.GetCurrentProcess(), handle,
1015 _winapi.GetCurrentProcess(), 0, 1,
1016 _winapi.DUPLICATE_SAME_ACCESS)
1017 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001018
1019
1020 def _find_w9xpopen(self):
1021 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001022 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001023 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001024 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001025 if not os.path.exists(w9xpopen):
1026 # Eeek - file-not-found - possibly an embedding
1027 # situation - see if we can locate it in sys.exec_prefix
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001028 w9xpopen = os.path.join(os.path.dirname(sys.base_exec_prefix),
Tim Peterse8374a52004-10-13 03:15:00 +00001029 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001030 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +00001031 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1032 "needed for Popen to work with your "
1033 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001034 return w9xpopen
1035
Tim Peterse718f612004-10-12 21:51:32 +00001036
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001037 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001038 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001039 startupinfo, creationflags, shell,
1040 p2cread, p2cwrite,
1041 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001042 errread, errwrite,
1043 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001044 """Execute program (MS Windows version)"""
1045
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001046 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001047
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001048 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001049 args = list2cmdline(args)
1050
Peter Astrandc1d65362004-11-07 14:30:34 +00001051 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001052 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001053 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001054 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001055 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001056 startupinfo.hStdInput = p2cread
1057 startupinfo.hStdOutput = c2pwrite
1058 startupinfo.hStdError = errwrite
1059
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001060 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001061 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1062 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001063 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001064 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001065 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001066 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001067 # Win9x, or using command.com on NT. We need to
1068 # use the w9xpopen intermediate program. For more
1069 # information, see KB Q150956
1070 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1071 w9xpopen = self._find_w9xpopen()
1072 args = '"%s" %s' % (w9xpopen, args)
1073 # Not passing CREATE_NEW_CONSOLE has been known to
1074 # cause random failures on win9x. Specifically a
1075 # dialog: "Your program accessed mem currently in
1076 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001077 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001078 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001079 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001080
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001081 # Start the process
1082 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001083 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001084 # no special security
1085 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001086 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001087 creationflags,
1088 env,
1089 cwd,
1090 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001091 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092 # Translate pywintypes.error to WindowsError, which is
1093 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001094 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001095 # how can this be done from Python?
1096 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001097 finally:
1098 # Child is launched. Close the parent's copy of those pipe
1099 # handles that only the child should have open. You need
1100 # to make sure that no handles to the write end of the
1101 # output pipe are maintained in this process or else the
1102 # pipe will not close when the child process exits and the
1103 # ReadFile will hang.
1104 if p2cread != -1:
1105 p2cread.Close()
1106 if c2pwrite != -1:
1107 c2pwrite.Close()
1108 if errwrite != -1:
1109 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001110 if hasattr(self, '_devnull'):
1111 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001112
1113 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001114 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001115 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001116 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001117 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001118
Brett Cannon84df1e62010-05-14 00:33:40 +00001119 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001120 _WaitForSingleObject=_winapi.WaitForSingleObject,
1121 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1122 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001123 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001124 attribute.
1125
1126 This method is called by __del__, so it can only refer to objects
1127 in its local scope.
1128
1129 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001130 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001131 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1132 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133 return self.returncode
1134
1135
Reid Kleckner2b228f02011-03-16 16:57:54 -04001136 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001137 """Wait for child process to terminate. Returns returncode
1138 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001139 if endtime is not None:
1140 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001141 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001142 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001143 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001144 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001145 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001146 result = _winapi.WaitForSingleObject(self._handle,
1147 timeout_millis)
1148 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001149 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001150 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001151 return self.returncode
1152
1153
1154 def _readerthread(self, fh, buffer):
1155 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001156 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001157
1158
Reid Kleckner2b228f02011-03-16 16:57:54 -04001159 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001160 # Start reader threads feeding into a list hanging off of this
1161 # object, unless they've already been started.
1162 if self.stdout and not hasattr(self, "_stdout_buff"):
1163 self._stdout_buff = []
1164 self.stdout_thread = \
1165 threading.Thread(target=self._readerthread,
1166 args=(self.stdout, self._stdout_buff))
1167 self.stdout_thread.daemon = True
1168 self.stdout_thread.start()
1169 if self.stderr and not hasattr(self, "_stderr_buff"):
1170 self._stderr_buff = []
1171 self.stderr_thread = \
1172 threading.Thread(target=self._readerthread,
1173 args=(self.stderr, self._stderr_buff))
1174 self.stderr_thread.daemon = True
1175 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001176
1177 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001178 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001179 try:
1180 self.stdin.write(input)
1181 except IOError as e:
1182 if e.errno != errno.EPIPE:
1183 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001184 self.stdin.close()
1185
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001186 # Wait for the reader threads, or time out. If we time out, the
1187 # threads remain reading and the fds left open in case the user
1188 # calls communicate again.
1189 if self.stdout is not None:
1190 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001191 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001192 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001193 if self.stderr is not None:
1194 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001195 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001196 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001197
1198 # Collect the output from and close both pipes, now that we know
1199 # both have been read successfully.
1200 stdout = None
1201 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001202 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001203 stdout = self._stdout_buff
1204 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001205 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001206 stderr = self._stderr_buff
1207 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208
1209 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001210 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001212 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001213 stderr = stderr[0]
1214
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001215 return (stdout, stderr)
1216
Christian Heimesa342c012008-04-20 21:01:16 +00001217 def send_signal(self, sig):
1218 """Send a signal to the process
1219 """
1220 if sig == signal.SIGTERM:
1221 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001222 elif sig == signal.CTRL_C_EVENT:
1223 os.kill(self.pid, signal.CTRL_C_EVENT)
1224 elif sig == signal.CTRL_BREAK_EVENT:
1225 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001226 else:
Brian Curtin19651362010-09-07 13:24:38 +00001227 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001228
1229 def terminate(self):
1230 """Terminates the process
1231 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001232 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001233 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001234 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001235 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1236 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001237 rc = _winapi.GetExitCodeProcess(self._handle)
1238 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001239 raise
1240 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001241
1242 kill = terminate
1243
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244 else:
1245 #
1246 # POSIX methods
1247 #
1248 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001249 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001250 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1251 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001252 p2cread, p2cwrite = -1, -1
1253 c2pread, c2pwrite = -1, -1
1254 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001255
Peter Astrandd38ddf42005-02-10 08:32:50 +00001256 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001257 pass
1258 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001259 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001260 elif stdin == DEVNULL:
1261 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001262 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001263 p2cread = stdin
1264 else:
1265 # Assuming file-like object
1266 p2cread = stdin.fileno()
1267
Peter Astrandd38ddf42005-02-10 08:32:50 +00001268 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001269 pass
1270 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001271 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001272 elif stdout == DEVNULL:
1273 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001274 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001275 c2pwrite = stdout
1276 else:
1277 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001278 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001279
Peter Astrandd38ddf42005-02-10 08:32:50 +00001280 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001281 pass
1282 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001283 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001284 elif stderr == STDOUT:
1285 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001286 elif stderr == DEVNULL:
1287 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001288 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001289 errwrite = stderr
1290 else:
1291 # Assuming file-like object
1292 errwrite = stderr.fileno()
1293
1294 return (p2cread, p2cwrite,
1295 c2pread, c2pwrite,
1296 errread, errwrite)
1297
1298
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001299 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001300 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001301 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001302 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001303 os.closerange(start_fd, fd)
1304 start_fd = fd + 1
1305 if start_fd <= MAXFD:
1306 os.closerange(start_fd, MAXFD)
1307
1308
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001309 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001310 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001311 startupinfo, creationflags, shell,
1312 p2cread, p2cwrite,
1313 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001314 errread, errwrite,
1315 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001316 """Execute program (POSIX version)"""
1317
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001318 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001319 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001320 else:
1321 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001322
1323 if shell:
1324 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001325 if executable:
1326 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001327
Peter Astrandd38ddf42005-02-10 08:32:50 +00001328 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001329 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001330 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001332 # For transferring possible exec failure from child to parent.
1333 # Data format: "exception name:hex errno:description"
1334 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001335 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001336 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001337 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001338 # We must avoid complex work that could involve
1339 # malloc or free in the child process to avoid
1340 # potential deadlocks, thus we do all this here.
1341 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001342
Victor Stinner372b8382011-06-21 17:24:21 +02001343 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001344 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1345 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001346 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001347 env_list = None # Use execv instead of execve.
1348 executable = os.fsencode(executable)
1349 if os.path.dirname(executable):
1350 executable_list = (executable,)
1351 else:
1352 # This matches the behavior of os._execvpe().
1353 executable_list = tuple(
1354 os.path.join(os.fsencode(dir), executable)
1355 for dir in os.get_exec_path(env))
1356 fds_to_keep = set(pass_fds)
1357 fds_to_keep.add(errpipe_write)
1358 self.pid = _posixsubprocess.fork_exec(
1359 args, executable_list,
1360 close_fds, sorted(fds_to_keep), cwd, env_list,
1361 p2cread, p2cwrite, c2pread, c2pwrite,
1362 errread, errwrite,
1363 errpipe_read, errpipe_write,
1364 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001365 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001366 finally:
1367 # be sure the FD is closed no matter what
1368 os.close(errpipe_write)
1369
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001371 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001372 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001373 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001374 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001375 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001376 if hasattr(self, '_devnull'):
1377 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001378
1379 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001380 # exception (limited in size)
1381 data = bytearray()
1382 while True:
1383 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1384 data += part
1385 if not part or len(data) > 50000:
1386 break
Facundo Batista10706e22009-06-19 20:34:30 +00001387 finally:
1388 # be sure the FD is closed no matter what
1389 os.close(errpipe_read)
1390
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001391 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001392 try:
1393 _eintr_retry_call(os.waitpid, self.pid, 0)
1394 except OSError as e:
1395 if e.errno != errno.ECHILD:
1396 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001397 try:
1398 exception_name, hex_errno, err_msg = data.split(b':', 2)
1399 except ValueError:
1400 print('Bad exception data:', repr(data))
1401 exception_name = b'RuntimeError'
1402 hex_errno = b'0'
1403 err_msg = b'Unknown'
1404 child_exception_type = getattr(
1405 builtins, exception_name.decode('ascii'),
1406 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001407 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001408 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001409 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001410 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001411 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001412 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001413 child_exec_never_called = (err_msg == "noexec")
1414 if child_exec_never_called:
1415 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001416 if errno_num != 0:
1417 err_msg = os.strerror(errno_num)
1418 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001419 if child_exec_never_called:
1420 # The error must be from chdir(cwd).
1421 err_msg += ': ' + repr(cwd)
1422 else:
1423 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001424 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001425 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001426
1427
Brett Cannon84df1e62010-05-14 00:33:40 +00001428 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1429 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1430 _WEXITSTATUS=os.WEXITSTATUS):
1431 # This method is called (indirectly) by __del__, so it cannot
1432 # refer to anything outside of its local scope."""
1433 if _WIFSIGNALED(sts):
1434 self.returncode = -_WTERMSIG(sts)
1435 elif _WIFEXITED(sts):
1436 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001437 else:
1438 # Should never happen
1439 raise RuntimeError("Unknown child exit status!")
1440
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001441
Brett Cannon84df1e62010-05-14 00:33:40 +00001442 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1443 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001444 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001445 attribute.
1446
1447 This method is called by __del__, so it cannot reference anything
1448 outside of the local scope (nor can any methods it calls).
1449
1450 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001451 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001452 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001453 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001454 if pid == self.pid:
1455 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001456 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001457 if _deadstate is not None:
1458 self.returncode = _deadstate
Gregory P. Smith39051712012-09-29 11:40:38 -07001459 elif e.errno == errno.ECHILD:
1460 # This happens if SIGCLD is set to be ignored or
1461 # waiting for child processes has otherwise been
1462 # disabled for our process. This child is dead, we
1463 # can't get the status.
1464 # http://bugs.python.org/issue15756
1465 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001466 return self.returncode
1467
1468
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001469 def _try_wait(self, wait_flags):
1470 try:
1471 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1472 except OSError as e:
1473 if e.errno != errno.ECHILD:
1474 raise
1475 # This happens if SIGCLD is set to be ignored or waiting
1476 # for child processes has otherwise been disabled for our
1477 # process. This child is dead, we can't get the status.
1478 pid = self.pid
1479 sts = 0
1480 return (pid, sts)
1481
1482
1483 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001484 """Wait for child process to terminate. Returns returncode
1485 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001486 if self.returncode is not None:
1487 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001488
1489 # endtime is preferred to timeout. timeout is only used for
1490 # printing.
1491 if endtime is not None or timeout is not None:
1492 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001493 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001494 elif timeout is None:
1495 timeout = self._remaining_time(endtime)
1496
1497 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001498 # Enter a busy loop if we have a timeout. This busy loop was
1499 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1500 delay = 0.0005 # 500 us -> initial delay of 1 ms
1501 while True:
1502 (pid, sts) = self._try_wait(os.WNOHANG)
1503 assert pid == self.pid or pid == 0
1504 if pid == self.pid:
1505 self._handle_exitstatus(sts)
1506 break
1507 remaining = self._remaining_time(endtime)
1508 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001509 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001510 delay = min(delay * 2, remaining, .05)
1511 time.sleep(delay)
1512 elif self.returncode is None:
1513 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001514 self._handle_exitstatus(sts)
1515 return self.returncode
1516
1517
Reid Kleckner2b228f02011-03-16 16:57:54 -04001518 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001519 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001520 # Flush stdio buffer. This might block, if the user has
1521 # been writing to .stdin in an uncontrolled fashion.
1522 self.stdin.flush()
1523 if not input:
1524 self.stdin.close()
1525
1526 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001527 stdout, stderr = self._communicate_with_poll(input, endtime,
1528 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001529 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001530 stdout, stderr = self._communicate_with_select(input, endtime,
1531 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001532
1533 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001534
1535 # All data exchanged. Translate lists into strings.
1536 if stdout is not None:
1537 stdout = b''.join(stdout)
1538 if stderr is not None:
1539 stderr = b''.join(stderr)
1540
1541 # Translate newlines, if requested.
1542 # This also turns bytes into strings.
1543 if self.universal_newlines:
1544 if stdout is not None:
1545 stdout = self._translate_newlines(stdout,
1546 self.stdout.encoding)
1547 if stderr is not None:
1548 stderr = self._translate_newlines(stderr,
1549 self.stderr.encoding)
1550
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001551 return (stdout, stderr)
1552
1553
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001554 def _save_input(self, input):
1555 # This method is called from the _communicate_with_*() methods
1556 # so that if we time out while communicating, we can continue
1557 # sending input if we retry.
1558 if self.stdin and self._input is None:
1559 self._input_offset = 0
1560 self._input = input
1561 if self.universal_newlines and input is not None:
1562 self._input = self._input.encode(self.stdin.encoding)
1563
1564
Reid Kleckner2b228f02011-03-16 16:57:54 -04001565 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001566 stdout = None # Return
1567 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001568
1569 if not self._communication_started:
1570 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001571
1572 poller = select.poll()
1573 def register_and_append(file_obj, eventmask):
1574 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001575 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001576
1577 def close_unregister_and_remove(fd):
1578 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001579 self._fd2file[fd].close()
1580 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001581
1582 if self.stdin and input:
1583 register_and_append(self.stdin, select.POLLOUT)
1584
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001585 # Only create this mapping if we haven't already.
1586 if not self._communication_started:
1587 self._fd2output = {}
1588 if self.stdout:
1589 self._fd2output[self.stdout.fileno()] = []
1590 if self.stderr:
1591 self._fd2output[self.stderr.fileno()] = []
1592
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001593 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1594 if self.stdout:
1595 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001597 if self.stderr:
1598 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001599 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001600
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001601 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001602
1603 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001604 timeout = self._remaining_time(endtime)
1605 if timeout is not None and timeout < 0:
1606 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001607 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001608 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001609 except select.error as e:
1610 if e.args[0] == errno.EINTR:
1611 continue
1612 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001613 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001614
1615 # XXX Rewrite these to use non-blocking I/O on the
1616 # file objects; they are no longer using C stdio!
1617
1618 for fd, mode in ready:
1619 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001620 chunk = self._input[self._input_offset :
1621 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001622 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001623 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001624 except OSError as e:
1625 if e.errno == errno.EPIPE:
1626 close_unregister_and_remove(fd)
1627 else:
1628 raise
1629 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001630 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001631 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001632 elif mode & select_POLLIN_POLLPRI:
1633 data = os.read(fd, 4096)
1634 if not data:
1635 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001636 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001637 else:
1638 # Ignore hang up or errors.
1639 close_unregister_and_remove(fd)
1640
1641 return (stdout, stderr)
1642
1643
Reid Kleckner2b228f02011-03-16 16:57:54 -04001644 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001645 if not self._communication_started:
1646 self._read_set = []
1647 self._write_set = []
1648 if self.stdin and input:
1649 self._write_set.append(self.stdin)
1650 if self.stdout:
1651 self._read_set.append(self.stdout)
1652 if self.stderr:
1653 self._read_set.append(self.stderr)
1654
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001655 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001656
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001657 stdout = None # Return
1658 stderr = None # Return
1659
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001660 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001661 if not self._communication_started:
1662 self._stdout_buff = []
1663 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001664 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001665 if not self._communication_started:
1666 self._stderr_buff = []
1667 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001668
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001669 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001670 timeout = self._remaining_time(endtime)
1671 if timeout is not None and timeout < 0:
1672 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001673 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001674 (rlist, wlist, xlist) = \
1675 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001676 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001677 except select.error as e:
1678 if e.args[0] == errno.EINTR:
1679 continue
1680 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001681
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001682 # According to the docs, returning three empty lists indicates
1683 # that the timeout expired.
1684 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001685 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001686 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001687 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001688
Guido van Rossum98297ee2007-11-06 21:34:58 +00001689 # XXX Rewrite these to use non-blocking I/O on the
1690 # file objects; they are no longer using C stdio!
1691
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001692 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001693 chunk = self._input[self._input_offset :
1694 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001695 try:
1696 bytes_written = os.write(self.stdin.fileno(), chunk)
1697 except OSError as e:
1698 if e.errno == errno.EPIPE:
1699 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001700 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001701 else:
1702 raise
1703 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001704 self._input_offset += bytes_written
1705 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001706 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001707 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001708
1709 if self.stdout in rlist:
1710 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001711 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001712 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001713 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001714 stdout.append(data)
1715
1716 if self.stderr in rlist:
1717 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001718 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001719 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001720 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001721 stderr.append(data)
1722
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001723 return (stdout, stderr)
1724
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001725
Christian Heimesa342c012008-04-20 21:01:16 +00001726 def send_signal(self, sig):
1727 """Send a signal to the process
1728 """
1729 os.kill(self.pid, sig)
1730
1731 def terminate(self):
1732 """Terminate the process with SIGTERM
1733 """
1734 self.send_signal(signal.SIGTERM)
1735
1736 def kill(self):
1737 """Kill the process with SIGKILL
1738 """
1739 self.send_signal(signal.SIGKILL)