blob: d75a4e04044554c79aa8eb78ae9d8d03cc6ab4d7 [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001# subprocess - Subprocesses with accessible I/O streams
2#
Tim Peterse718f612004-10-12 21:51:32 +00003# For more information about this module, see PEP 324.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00004#
Peter Astrand3a708df2005-09-23 17:37:29 +00005# Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00006#
Peter Astrand69bf13f2005-02-14 08:56:32 +00007# Licensed to PSF under a Contributor Agreement.
Peter Astrand3a708df2005-09-23 17:37:29 +00008# See http://www.python.org/2.4/license for licensing details.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009
Raymond Hettinger837dd932004-10-17 16:36:53 +000010r"""subprocess - Subprocesses with accessible I/O streams
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000011
Fredrik Lundh15aaacc2004-10-17 14:47:05 +000012This module allows you to spawn processes, connect to their
13input/output/error pipes, and obtain their return codes. This module
14intends to replace several other, older modules and functions, like:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000015
16os.system
17os.spawn*
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000018
19Information about how the subprocess module can be used to replace these
20modules and functions can be found below.
21
22
23
24Using the subprocess module
25===========================
26This module defines one class called Popen:
27
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070028class Popen(args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000029 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000030 preexec_fn=None, close_fds=True, shell=False,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000031 cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000032 startupinfo=None, creationflags=0,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000033 restore_signals=True, start_new_session=False, pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000034
35
36Arguments are:
37
38args should be a string, or a sequence of program arguments. The
39program to execute is normally the first item in the args sequence or
40string, but can be explicitly set by using the executable argument.
41
Gregory P. Smithf5604852010-12-13 06:45:02 +000042On POSIX, with shell=False (default): In this case, the Popen class
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000043uses os.execvp() to execute the child program. args should normally
44be a sequence. A string will be treated as a sequence with the string
45as the only item (the program to execute).
46
Gregory P. Smithf5604852010-12-13 06:45:02 +000047On POSIX, with shell=True: If args is a string, it specifies the
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000048command string to execute through the shell. If args is a sequence,
49the first item specifies the command string, and any additional items
50will be treated as additional shell arguments.
51
52On Windows: the Popen class uses CreateProcess() to execute the child
53program, which operates on strings. If args is a sequence, it will be
54converted to a string using the list2cmdline method. Please note that
55not all MS Windows applications interpret the command line the same
56way: The list2cmdline is designed for applications using the same
57rules as the MS C runtime.
58
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070059bufsize will be supplied as the corresponding argument to the io.open()
60function when creating the stdin/stdout/stderr pipe file objects:
610 means unbuffered (read & write are one system call and can return short),
621 means line buffered, any other positive value means use a buffer of
63approximately that size. A negative bufsize, the default, means the system
64default of io.DEFAULT_BUFFER_SIZE will be used.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000065
66stdin, stdout and stderr specify the executed programs' standard
67input, standard output and standard error file handles, respectively.
68Valid values are PIPE, an existing file descriptor (a positive
69integer), an existing file object, and None. PIPE indicates that a
70new pipe to the child should be created. With None, no redirection
71will occur; the child's file handles will be inherited from the
72parent. Additionally, stderr can be STDOUT, which indicates that the
73stderr data from the applications should be captured into the same
74file handle as for stdout.
75
Gregory P. Smithf5604852010-12-13 06:45:02 +000076On POSIX, if preexec_fn is set to a callable object, this object will be
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000077called in the child process just before the child is executed. The use
78of preexec_fn is not thread safe, using it in the presence of threads
79could lead to a deadlock in the child process before the new executable
80is executed.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000081
82If close_fds is true, all file descriptors except 0, 1 and 2 will be
Gregory P. Smithf5604852010-12-13 06:45:02 +000083closed before the child process is executed. The default for close_fds
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000084varies by platform: Always true on POSIX. True when stdin/stdout/stderr
85are None on Windows, false otherwise.
86
87pass_fds is an optional sequence of file descriptors to keep open between the
88parent and child. Providing any pass_fds implicitly sets close_fds to true.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000089
90if shell is true, the specified command will be executed through the
91shell.
92
93If cwd is not None, the current directory will be changed to cwd
94before the child is executed.
95
Gregory P. Smithf5604852010-12-13 06:45:02 +000096On POSIX, if restore_signals is True all signals that Python sets to
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000097SIG_IGN are restored to SIG_DFL in the child process before the exec.
98Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. This
99parameter does nothing on Windows.
100
Gregory P. Smithf5604852010-12-13 06:45:02 +0000101On POSIX, if start_new_session is True, the setsid() system call will be made
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000102in the child process prior to executing the command.
103
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000104If env is not None, it defines the environment variables for the new
105process.
106
Ronald Oussoren385521c2013-07-07 09:26:45 +0200107If universal_newlines is false, the file objects stdin, stdout and stderr
108are opened as binary files, and no line ending conversion is done.
109
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110If universal_newlines is true, the file objects stdout and stderr are
111opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000112the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000113'\r\n', the Windows convention. All of these external representations
Gregory P. Smith1f8a40b2013-03-20 18:32:03 -0700114are seen as '\n' by the Python program. Also, the newlines attribute
115of the file objects stdout, stdin and stderr are not updated by the
116communicate() method.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000117
118The startupinfo and creationflags, if given, will be passed to the
119underlying CreateProcess() function. They can specify things such as
120appearance of the main window and priority for the new process.
121(Windows only)
122
123
Georg Brandlf9734072008-12-07 15:30:06 +0000124This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125
Peter Astrand5f5e1412004-12-05 20:15:36 +0000126call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000127 Run command with arguments. Wait for command to complete, then
128 return the returncode attribute.
129
130 The arguments are the same as for the Popen constructor. Example:
131
Florent Xicluna4886d242010-03-08 13:27:26 +0000132 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000133
Peter Astrand454f7672005-01-01 09:36:35 +0000134check_call(*popenargs, **kwargs):
135 Run command with arguments. Wait for command to complete. If the
136 exit code was zero then return, otherwise raise
137 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000138 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000139
140 The arguments are the same as for the Popen constructor. Example:
141
Florent Xicluna4886d242010-03-08 13:27:26 +0000142 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000143 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000144
Brett Cannona23810f2008-05-26 19:04:21 +0000145getstatusoutput(cmd):
146 Return (status, output) of executing cmd in a shell.
147
148 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
149 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
150 returned output will contain output or error messages. A trailing newline
151 is stripped from the output. The exit status for the command can be
152 interpreted according to the rules for the C function wait(). Example:
153
Brett Cannona23810f2008-05-26 19:04:21 +0000154 >>> subprocess.getstatusoutput('ls /bin/ls')
155 (0, '/bin/ls')
156 >>> subprocess.getstatusoutput('cat /bin/junk')
157 (256, 'cat: /bin/junk: No such file or directory')
158 >>> subprocess.getstatusoutput('/bin/junk')
159 (256, 'sh: /bin/junk: not found')
160
161getoutput(cmd):
162 Return output (stdout or stderr) of executing cmd in a shell.
163
164 Like getstatusoutput(), except the exit status is ignored and the return
165 value is a string containing the command's output. Example:
166
Brett Cannona23810f2008-05-26 19:04:21 +0000167 >>> subprocess.getoutput('ls /bin/ls')
168 '/bin/ls'
169
Georg Brandlf9734072008-12-07 15:30:06 +0000170check_output(*popenargs, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700171 Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000172
Georg Brandl2708f3a2009-12-20 14:38:23 +0000173 If the exit code was non-zero it raises a CalledProcessError. The
174 CalledProcessError object will have the return code in the returncode
175 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Georg Brandl2708f3a2009-12-20 14:38:23 +0000179 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000180
Brett Cannona23810f2008-05-26 19:04:21 +0000181
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000182Exceptions
183----------
184Exceptions raised in the child process, before the new program has
185started to execute, will be re-raised in the parent. Additionally,
186the exception object will have one extra attribute called
187'child_traceback', which is a string containing traceback information
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300188from the child's point of view.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000189
190The most common exception raised is OSError. This occurs, for
191example, when trying to execute a non-existent file. Applications
192should prepare for OSErrors.
193
194A ValueError will be raised if Popen is called with invalid arguments.
195
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400196Exceptions defined within this module inherit from SubprocessError.
197check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400198called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400199be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000200
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000201
202Security
203--------
204Unlike some other popen functions, this implementation will never call
205/bin/sh implicitly. This means that all characters, including shell
206metacharacters, can safely be passed to child processes.
207
208
209Popen objects
210=============
211Instances of the Popen class have the following methods:
212
213poll()
214 Check if child process has terminated. Returns returncode
215 attribute.
216
217wait()
218 Wait for child process to terminate. Returns returncode attribute.
219
220communicate(input=None)
221 Interact with process: Send data to stdin. Read data from stdout
222 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000223 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000224 sent to the child process, or None, if no data should be sent to
225 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000226
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000227 communicate() returns a tuple (stdout, stderr).
228
229 Note: The data read is buffered in memory, so do not use this
230 method if the data size is large or unlimited.
231
232The following attributes are also available:
233
234stdin
235 If the stdin argument is PIPE, this attribute is a file object
236 that provides input to the child process. Otherwise, it is None.
237
238stdout
239 If the stdout argument is PIPE, this attribute is a file object
240 that provides output from the child process. Otherwise, it is
241 None.
242
243stderr
244 If the stderr argument is PIPE, this attribute is file object that
245 provides error output from the child process. Otherwise, it is
246 None.
247
248pid
249 The process ID of the child process.
250
251returncode
252 The child return code. A None value indicates that the process
253 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000254 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000255
256
257Replacing older functions with the subprocess module
258====================================================
259In this section, "a ==> b" means that b can be used as a replacement
260for a.
261
262Note: All functions in this section fail (more or less) silently if
263the executed program cannot be found; this module raises an OSError
264exception.
265
266In the following examples, we assume that the subprocess module is
267imported with "from subprocess import *".
268
269
270Replacing /bin/sh shell backquote
271---------------------------------
272output=`mycmd myarg`
273==>
274output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
275
276
277Replacing shell pipe line
278-------------------------
279output=`dmesg | grep hda`
280==>
281p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000282p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000283output = p2.communicate()[0]
284
285
286Replacing os.system()
287---------------------
288sts = os.system("mycmd" + " myarg")
289==>
290p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000291pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000292
293Note:
294
295* Calling the program through the shell is usually not required.
296
297* It's easier to look at the returncode attribute than the
298 exitstatus.
299
300A more real-world example would look like this:
301
302try:
303 retcode = call("mycmd" + " myarg", shell=True)
304 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000305 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000306 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000307 print("Child returned", retcode, file=sys.stderr)
308except OSError as e:
309 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000310
311
312Replacing os.spawn*
313-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000314P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000315
316pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
317==>
318pid = Popen(["/bin/mycmd", "myarg"]).pid
319
320
321P_WAIT example:
322
323retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
324==>
325retcode = call(["/bin/mycmd", "myarg"])
326
327
Tim Peterse718f612004-10-12 21:51:32 +0000328Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000329
330os.spawnvp(os.P_NOWAIT, path, args)
331==>
332Popen([path] + args[1:])
333
334
Tim Peterse718f612004-10-12 21:51:32 +0000335Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000336
337os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
338==>
339Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000340"""
341
342import sys
343mswindows = (sys.platform == "win32")
344
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000345import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000346import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400347import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000348import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000349import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000350import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000351import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000352import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200353import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200354try:
355 from time import monotonic as _time
356except ImportError:
357 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000358
Peter Astrand454f7672005-01-01 09:36:35 +0000359# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400360class SubprocessError(Exception): pass
361
362
363class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000364 """This exception is raised when a process run by check_call() or
365 check_output() returns a non-zero exit status.
366 The exit status will be stored in the returncode attribute;
367 check_output() will also store the output in the output attribute.
368 """
369 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000370 self.returncode = returncode
371 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000372 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000373 def __str__(self):
374 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
375
Peter Astrand454f7672005-01-01 09:36:35 +0000376
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400377class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400378 """This exception is raised when the timeout expires while waiting for a
379 child process.
380 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400381 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400382 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400383 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400384 self.output = output
385
386 def __str__(self):
387 return ("Command '%s' timed out after %s seconds" %
388 (self.cmd, self.timeout))
389
390
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000391if mswindows:
392 import threading
393 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200394 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000395 class STARTUPINFO:
396 dwFlags = 0
397 hStdInput = None
398 hStdOutput = None
399 hStdError = None
400 wShowWindow = 0
401 class pywintypes:
402 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000403else:
404 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000405 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700406 import _posixsubprocess
407 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000408
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000409 # When select or poll has indicated that the file is writable,
410 # we can write up to _PIPE_BUF bytes without risk of blocking.
411 # POSIX defines PIPE_BUF as >= 512.
412 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
413
414
Brett Cannona23810f2008-05-26 19:04:21 +0000415__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200416 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000417
Brian Curtin1ce6b582010-04-24 16:19:22 +0000418if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200419 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
420 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
421 STD_ERROR_HANDLE, SW_HIDE,
422 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500423
Brian Curtin08fd8d92011-04-29 16:11:30 -0500424 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500425 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
426 "STD_ERROR_HANDLE", "SW_HIDE",
427 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200428
429 class Handle(int):
430 closed = False
431
432 def Close(self, CloseHandle=_winapi.CloseHandle):
433 if not self.closed:
434 self.closed = True
435 CloseHandle(self)
436
437 def Detach(self):
438 if not self.closed:
439 self.closed = True
440 return int(self)
441 raise ValueError("already closed")
442
443 def __repr__(self):
444 return "Handle(%d)" % int(self)
445
446 __del__ = Close
447 __str__ = __repr__
448
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000449try:
450 MAXFD = os.sysconf("SC_OPEN_MAX")
451except:
452 MAXFD = 256
453
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200454# This lists holds Popen instances for which the underlying process had not
455# exited at the time its __del__ method got called: those processes are wait()ed
456# for synchronously from _cleanup() when a new Popen object is created, to avoid
457# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000458_active = []
459
460def _cleanup():
461 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000462 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200463 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000464 try:
465 _active.remove(inst)
466 except ValueError:
467 # This can happen if two threads create a new Popen instance.
468 # It's harmless that it was already removed, so ignore.
469 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000470
471PIPE = -1
472STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200473DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000474
475
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000476def _eintr_retry_call(func, *args):
477 while True:
478 try:
479 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200480 except InterruptedError:
481 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000482
483
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200484# XXX This function is only used by multiprocessing and the test suite,
485# but it's here so that it can be imported when Python is compiled without
486# threads.
487
488def _args_from_interpreter_flags():
489 """Return a list of command-line arguments reproducing the current
490 settings in sys.flags and sys.warnoptions."""
491 flag_opt_map = {
492 'debug': 'd',
493 # 'inspect': 'i',
494 # 'interactive': 'i',
495 'optimize': 'O',
496 'dont_write_bytecode': 'B',
497 'no_user_site': 's',
498 'no_site': 'S',
499 'ignore_environment': 'E',
500 'verbose': 'v',
501 'bytes_warning': 'b',
502 'quiet': 'q',
503 'hash_randomization': 'R',
504 }
505 args = []
506 for flag, opt in flag_opt_map.items():
507 v = getattr(sys.flags, flag)
508 if v > 0:
509 args.append('-' + opt * v)
510 for opt in sys.warnoptions:
511 args.append('-W' + opt)
512 return args
513
514
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400515def call(*popenargs, timeout=None, **kwargs):
516 """Run command with arguments. Wait for command to complete or
517 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000518
519 The arguments are the same as for the Popen constructor. Example:
520
521 retcode = call(["ls", "-l"])
522 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200523 with Popen(*popenargs, **kwargs) as p:
524 try:
525 return p.wait(timeout=timeout)
526 except:
527 p.kill()
528 p.wait()
529 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000530
531
Peter Astrand454f7672005-01-01 09:36:35 +0000532def check_call(*popenargs, **kwargs):
533 """Run command with arguments. Wait for command to complete. If
534 the exit code was zero then return, otherwise raise
535 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000536 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000537
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400538 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000539
540 check_call(["ls", "-l"])
541 """
542 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000543 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000544 cmd = kwargs.get("args")
545 if cmd is None:
546 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000547 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000548 return 0
549
550
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400551def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700552 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000553
554 If the exit code was non-zero it raises a CalledProcessError. The
555 CalledProcessError object will have the return code in the returncode
556 attribute and output in the output attribute.
557
558 The arguments are the same as for the Popen constructor. Example:
559
560 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000561 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000562
563 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000564 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000565
566 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000567 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000568 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000569 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700570
571 If universal_newlines=True is passed, the return value will be a
572 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000573 """
574 if 'stdout' in kwargs:
575 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200576 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
577 try:
578 output, unused_err = process.communicate(timeout=timeout)
579 except TimeoutExpired:
580 process.kill()
581 output, unused_err = process.communicate()
582 raise TimeoutExpired(process.args, timeout, output=output)
583 except:
584 process.kill()
585 process.wait()
586 raise
587 retcode = process.poll()
588 if retcode:
589 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000590 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000591
592
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000593def list2cmdline(seq):
594 """
595 Translate a sequence of arguments into a command line
596 string, using the same rules as the MS C runtime:
597
598 1) Arguments are delimited by white space, which is either a
599 space or a tab.
600
601 2) A string surrounded by double quotation marks is
602 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000603 contained within. A quoted string can be embedded in an
604 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000605
606 3) A double quotation mark preceded by a backslash is
607 interpreted as a literal double quotation mark.
608
609 4) Backslashes are interpreted literally, unless they
610 immediately precede a double quotation mark.
611
612 5) If backslashes immediately precede a double quotation mark,
613 every pair of backslashes is interpreted as a literal
614 backslash. If the number of backslashes is odd, the last
615 backslash escapes the next double quotation mark as
616 described in rule 3.
617 """
618
619 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000620 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
621 # or search http://msdn.microsoft.com for
622 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000623 result = []
624 needquote = False
625 for arg in seq:
626 bs_buf = []
627
628 # Add a space to separate this argument from the others
629 if result:
630 result.append(' ')
631
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000632 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000633 if needquote:
634 result.append('"')
635
636 for c in arg:
637 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000638 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000639 bs_buf.append(c)
640 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000641 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000642 result.append('\\' * len(bs_buf)*2)
643 bs_buf = []
644 result.append('\\"')
645 else:
646 # Normal char
647 if bs_buf:
648 result.extend(bs_buf)
649 bs_buf = []
650 result.append(c)
651
Christian Heimesfdab48e2008-01-20 09:06:41 +0000652 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000653 if bs_buf:
654 result.extend(bs_buf)
655
656 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000657 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000658 result.append('"')
659
660 return ''.join(result)
661
662
Brett Cannona23810f2008-05-26 19:04:21 +0000663# Various tools for executing commands and looking at their output and status.
664#
Brett Cannona23810f2008-05-26 19:04:21 +0000665
666def getstatusoutput(cmd):
667 """Return (status, output) of executing cmd in a shell.
668
669 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
670 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
671 returned output will contain output or error messages. A trailing newline
672 is stripped from the output. The exit status for the command can be
673 interpreted according to the rules for the C function wait(). Example:
674
675 >>> import subprocess
676 >>> subprocess.getstatusoutput('ls /bin/ls')
677 (0, '/bin/ls')
678 >>> subprocess.getstatusoutput('cat /bin/junk')
679 (256, 'cat: /bin/junk: No such file or directory')
680 >>> subprocess.getstatusoutput('/bin/junk')
681 (256, 'sh: /bin/junk: not found')
682 """
Tim Goldene0041752013-11-03 12:53:17 +0000683 try:
684 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
685 status = 0
686 except CalledProcessError as ex:
687 data = ex.output
688 status = ex.returncode
689 if data[-1:] == '\n':
690 data = data[:-1]
691 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000692
693def getoutput(cmd):
694 """Return output (stdout or stderr) of executing cmd in a shell.
695
696 Like getstatusoutput(), except the exit status is ignored and the return
697 value is a string containing the command's output. Example:
698
699 >>> import subprocess
700 >>> subprocess.getoutput('ls /bin/ls')
701 '/bin/ls'
702 """
703 return getstatusoutput(cmd)[1]
704
705
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000706_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000707
708
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000709class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200710
711 _child_created = False # Set here since __del__ checks it
712
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700713 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000714 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000715 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
716 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000717 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000718 restore_signals=True, start_new_session=False,
719 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000720 """Create new Popen instance."""
721 _cleanup()
722
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400723 self._input = None
724 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000725 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700726 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000727 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000728 raise TypeError("bufsize must be an integer")
729
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000730 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000731 if preexec_fn is not None:
732 raise ValueError("preexec_fn is not supported on Windows "
733 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000734 any_stdio_set = (stdin is not None or stdout is not None or
735 stderr is not None)
736 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
737 if any_stdio_set:
738 close_fds = False
739 else:
740 close_fds = True
741 elif close_fds and any_stdio_set:
742 raise ValueError(
743 "close_fds is not supported on Windows platforms"
744 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000745 else:
746 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000747 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
748 close_fds = True
749 if pass_fds and not close_fds:
750 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
751 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000752 if startupinfo is not None:
753 raise ValueError("startupinfo is only supported on Windows "
754 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000755 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000756 raise ValueError("creationflags is only supported on Windows "
757 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000758
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400759 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000760 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000761 self.stdout = None
762 self.stderr = None
763 self.pid = None
764 self.returncode = None
765 self.universal_newlines = universal_newlines
766
767 # Input and output objects. The general principle is like
768 # this:
769 #
770 # Parent Child
771 # ------ -----
772 # p2cwrite ---stdin---> p2cread
773 # c2pread <--stdout--- c2pwrite
774 # errread <--stderr--- errwrite
775 #
776 # On POSIX, the child objects are file descriptors. On
777 # Windows, these are Windows file handles. The parent objects
778 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000779 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000781
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000782 (p2cread, p2cwrite,
783 c2pread, c2pwrite,
784 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
785
Antoine Pitrouc9982322011-01-04 19:07:07 +0000786 # We wrap OS handles *before* launching the child, otherwise a
787 # quickly terminating child could make our fds unwrappable
788 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000789
Thomas Wouterscf297e42007-02-23 15:07:44 +0000790 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000791 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000792 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000793 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000794 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000795 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000796 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000797
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000798 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000799 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300800 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200801 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000802 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000803 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000805 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000806 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000807 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000808 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000809 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000810
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700811 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000812 try:
813 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300814 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000815 startupinfo, creationflags, shell,
816 p2cread, p2cwrite,
817 c2pread, c2pwrite,
818 errread, errwrite,
819 restore_signals, start_new_session)
820 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800821 # Cleanup if the child failed starting.
822 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000823 try:
824 f.close()
825 except EnvironmentError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800826 pass # Ignore EBADF or other errors.
827
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700828 if not self._closed_child_pipe_fds:
829 to_close = []
830 if stdin == PIPE:
831 to_close.append(p2cread)
832 if stdout == PIPE:
833 to_close.append(c2pwrite)
834 if stderr == PIPE:
835 to_close.append(errwrite)
836 if hasattr(self, '_devnull'):
837 to_close.append(self._devnull)
838 for fd in to_close:
839 try:
840 os.close(fd)
841 except EnvironmentError:
842 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
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200864 def __del__(self, _maxsize=sys.maxsize):
865 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000866 # We didn't get to successfully create a child process.
867 return
868 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000869 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000870 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000871 # Child is still running, keep us alive until we can wait on it.
872 _active.append(self)
873
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200874 def _get_devnull(self):
875 if not hasattr(self, '_devnull'):
876 self._devnull = os.open(os.devnull, os.O_RDWR)
877 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000878
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400879 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000880 """Interact with process: Send data to stdin. Read data from
881 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700882 process to terminate. The optional input argument should be
883 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000884 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000885
Peter Astrand23109f02005-03-03 20:28:59 +0000886 communicate() returns a tuple (stdout, stderr)."""
887
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400888 if self._communication_started and input:
889 raise ValueError("Cannot send input after starting communication")
890
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400891 # Optimization: If we are not worried about timeouts, we haven't
892 # started communicating, and we have one or zero pipes, using select()
893 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200894 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400895 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000896 stdout = None
897 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000898 if self.stdin:
899 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200900 try:
901 self.stdin.write(input)
902 except IOError as e:
903 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
904 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000905 self.stdin.close()
906 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200907 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000908 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000909 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200910 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000911 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000912 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200913 else:
914 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200915 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200916 else:
917 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000918
Victor Stinner7a8d0812011-04-05 13:13:08 +0200919 try:
920 stdout, stderr = self._communicate(input, endtime, timeout)
921 finally:
922 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400923
Victor Stinner7a8d0812011-04-05 13:13:08 +0200924 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400925
926 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000927
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000928
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000929 def poll(self):
930 return self._internal_poll()
931
932
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400933 def _remaining_time(self, endtime):
934 """Convenience for _communicate when computing timeouts."""
935 if endtime is None:
936 return None
937 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200938 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400939
940
Reid Kleckner2b228f02011-03-16 16:57:54 -0400941 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400942 """Convenience for checking if a timeout has expired."""
943 if endtime is None:
944 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200945 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400946 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400947
948
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000949 if mswindows:
950 #
951 # Windows methods
952 #
953 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000954 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000955 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
956 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000957 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000958 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000959
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000960 p2cread, p2cwrite = -1, -1
961 c2pread, c2pwrite = -1, -1
962 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000963
Peter Astrandd38ddf42005-02-10 08:32:50 +0000964 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200965 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000966 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200967 p2cread, _ = _winapi.CreatePipe(None, 0)
968 p2cread = Handle(p2cread)
969 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000970 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200971 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
972 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200973 elif stdin == DEVNULL:
974 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000975 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000976 p2cread = msvcrt.get_osfhandle(stdin)
977 else:
978 # Assuming file-like object
979 p2cread = msvcrt.get_osfhandle(stdin.fileno())
980 p2cread = self._make_inheritable(p2cread)
981
Peter Astrandd38ddf42005-02-10 08:32:50 +0000982 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200983 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000984 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200985 _, c2pwrite = _winapi.CreatePipe(None, 0)
986 c2pwrite = Handle(c2pwrite)
987 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000988 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200989 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
990 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200991 elif stdout == DEVNULL:
992 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000993 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000994 c2pwrite = msvcrt.get_osfhandle(stdout)
995 else:
996 # Assuming file-like object
997 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
998 c2pwrite = self._make_inheritable(c2pwrite)
999
Peter Astrandd38ddf42005-02-10 08:32:50 +00001000 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001001 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001002 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001003 _, errwrite = _winapi.CreatePipe(None, 0)
1004 errwrite = Handle(errwrite)
1005 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001006 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001007 errread, errwrite = _winapi.CreatePipe(None, 0)
1008 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001009 elif stderr == STDOUT:
1010 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001011 elif stderr == DEVNULL:
1012 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001013 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001014 errwrite = msvcrt.get_osfhandle(stderr)
1015 else:
1016 # Assuming file-like object
1017 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1018 errwrite = self._make_inheritable(errwrite)
1019
1020 return (p2cread, p2cwrite,
1021 c2pread, c2pwrite,
1022 errread, errwrite)
1023
1024
1025 def _make_inheritable(self, handle):
1026 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001027 h = _winapi.DuplicateHandle(
1028 _winapi.GetCurrentProcess(), handle,
1029 _winapi.GetCurrentProcess(), 0, 1,
1030 _winapi.DUPLICATE_SAME_ACCESS)
1031 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001032
1033
1034 def _find_w9xpopen(self):
1035 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001036 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001037 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001038 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001039 if not os.path.exists(w9xpopen):
1040 # Eeek - file-not-found - possibly an embedding
1041 # situation - see if we can locate it in sys.exec_prefix
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001042 w9xpopen = os.path.join(os.path.dirname(sys.base_exec_prefix),
Tim Peterse8374a52004-10-13 03:15:00 +00001043 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001044 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +00001045 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1046 "needed for Popen to work with your "
1047 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001048 return w9xpopen
1049
Tim Peterse718f612004-10-12 21:51:32 +00001050
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001051 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001052 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001053 startupinfo, creationflags, shell,
1054 p2cread, p2cwrite,
1055 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001056 errread, errwrite,
1057 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001058 """Execute program (MS Windows version)"""
1059
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001060 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001061
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001062 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001063 args = list2cmdline(args)
1064
Peter Astrandc1d65362004-11-07 14:30:34 +00001065 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001066 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001067 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001068 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001069 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001070 startupinfo.hStdInput = p2cread
1071 startupinfo.hStdOutput = c2pwrite
1072 startupinfo.hStdError = errwrite
1073
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001074 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001075 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1076 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001077 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001078 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001079 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001080 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001081 # Win9x, or using command.com on NT. We need to
1082 # use the w9xpopen intermediate program. For more
1083 # information, see KB Q150956
1084 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1085 w9xpopen = self._find_w9xpopen()
1086 args = '"%s" %s' % (w9xpopen, args)
1087 # Not passing CREATE_NEW_CONSOLE has been known to
1088 # cause random failures on win9x. Specifically a
1089 # dialog: "Your program accessed mem currently in
1090 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001091 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001093 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001094
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001095 # Start the process
1096 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001097 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001098 # no special security
1099 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001100 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001101 creationflags,
1102 env,
1103 cwd,
1104 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001105 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001106 # Translate pywintypes.error to WindowsError, which is
1107 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001108 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109 # how can this be done from Python?
1110 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001111 finally:
1112 # Child is launched. Close the parent's copy of those pipe
1113 # handles that only the child should have open. You need
1114 # to make sure that no handles to the write end of the
1115 # output pipe are maintained in this process or else the
1116 # pipe will not close when the child process exits and the
1117 # ReadFile will hang.
1118 if p2cread != -1:
1119 p2cread.Close()
1120 if c2pwrite != -1:
1121 c2pwrite.Close()
1122 if errwrite != -1:
1123 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001124 if hasattr(self, '_devnull'):
1125 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001126
1127 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001128 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001129 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001130 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001131 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001132
Brett Cannon84df1e62010-05-14 00:33:40 +00001133 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001134 _WaitForSingleObject=_winapi.WaitForSingleObject,
1135 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1136 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001137 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001138 attribute.
1139
1140 This method is called by __del__, so it can only refer to objects
1141 in its local scope.
1142
1143 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001144 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001145 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1146 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001147 return self.returncode
1148
1149
Reid Kleckner2b228f02011-03-16 16:57:54 -04001150 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001151 """Wait for child process to terminate. Returns returncode
1152 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001153 if endtime is not None:
1154 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001155 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001156 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001157 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001158 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001159 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001160 result = _winapi.WaitForSingleObject(self._handle,
1161 timeout_millis)
1162 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001163 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001164 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001165 return self.returncode
1166
1167
1168 def _readerthread(self, fh, buffer):
1169 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001170 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001171
1172
Reid Kleckner2b228f02011-03-16 16:57:54 -04001173 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001174 # Start reader threads feeding into a list hanging off of this
1175 # object, unless they've already been started.
1176 if self.stdout and not hasattr(self, "_stdout_buff"):
1177 self._stdout_buff = []
1178 self.stdout_thread = \
1179 threading.Thread(target=self._readerthread,
1180 args=(self.stdout, self._stdout_buff))
1181 self.stdout_thread.daemon = True
1182 self.stdout_thread.start()
1183 if self.stderr and not hasattr(self, "_stderr_buff"):
1184 self._stderr_buff = []
1185 self.stderr_thread = \
1186 threading.Thread(target=self._readerthread,
1187 args=(self.stderr, self._stderr_buff))
1188 self.stderr_thread.daemon = True
1189 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001190
1191 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001192 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001193 try:
1194 self.stdin.write(input)
1195 except IOError as e:
1196 if e.errno != errno.EPIPE:
1197 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001198 self.stdin.close()
1199
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001200 # Wait for the reader threads, or time out. If we time out, the
1201 # threads remain reading and the fds left open in case the user
1202 # calls communicate again.
1203 if self.stdout is not None:
1204 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001205 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001206 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001207 if self.stderr is not None:
1208 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001209 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001210 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001211
1212 # Collect the output from and close both pipes, now that we know
1213 # both have been read successfully.
1214 stdout = None
1215 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001216 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001217 stdout = self._stdout_buff
1218 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001219 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001220 stderr = self._stderr_buff
1221 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001222
1223 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001224 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001225 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001226 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001227 stderr = stderr[0]
1228
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001229 return (stdout, stderr)
1230
Christian Heimesa342c012008-04-20 21:01:16 +00001231 def send_signal(self, sig):
1232 """Send a signal to the process
1233 """
1234 if sig == signal.SIGTERM:
1235 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001236 elif sig == signal.CTRL_C_EVENT:
1237 os.kill(self.pid, signal.CTRL_C_EVENT)
1238 elif sig == signal.CTRL_BREAK_EVENT:
1239 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001240 else:
Brian Curtin19651362010-09-07 13:24:38 +00001241 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001242
1243 def terminate(self):
1244 """Terminates the process
1245 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001246 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001247 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001248 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001249 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1250 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001251 rc = _winapi.GetExitCodeProcess(self._handle)
1252 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001253 raise
1254 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001255
1256 kill = terminate
1257
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001258 else:
1259 #
1260 # POSIX methods
1261 #
1262 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001263 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001264 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1265 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001266 p2cread, p2cwrite = -1, -1
1267 c2pread, c2pwrite = -1, -1
1268 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001269
Peter Astrandd38ddf42005-02-10 08:32:50 +00001270 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001271 pass
1272 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001273 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001274 elif stdin == DEVNULL:
1275 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001276 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001277 p2cread = stdin
1278 else:
1279 # Assuming file-like object
1280 p2cread = stdin.fileno()
1281
Peter Astrandd38ddf42005-02-10 08:32:50 +00001282 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001283 pass
1284 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001285 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001286 elif stdout == DEVNULL:
1287 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001288 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001289 c2pwrite = stdout
1290 else:
1291 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001292 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001293
Peter Astrandd38ddf42005-02-10 08:32:50 +00001294 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001295 pass
1296 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001297 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001298 elif stderr == STDOUT:
1299 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001300 elif stderr == DEVNULL:
1301 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001302 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303 errwrite = stderr
1304 else:
1305 # Assuming file-like object
1306 errwrite = stderr.fileno()
1307
1308 return (p2cread, p2cwrite,
1309 c2pread, c2pwrite,
1310 errread, errwrite)
1311
1312
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001313 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001314 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001315 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001316 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001317 os.closerange(start_fd, fd)
1318 start_fd = fd + 1
1319 if start_fd <= MAXFD:
1320 os.closerange(start_fd, MAXFD)
1321
1322
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001323 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001324 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001325 startupinfo, creationflags, shell,
1326 p2cread, p2cwrite,
1327 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001328 errread, errwrite,
1329 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001330 """Execute program (POSIX version)"""
1331
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001332 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001334 else:
1335 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001336
1337 if shell:
1338 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001339 if executable:
1340 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001341
Peter Astrandd38ddf42005-02-10 08:32:50 +00001342 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001344 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001345
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001346 # For transferring possible exec failure from child to parent.
1347 # Data format: "exception name:hex errno:description"
1348 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001349 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001350 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001351 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001352 # We must avoid complex work that could involve
1353 # malloc or free in the child process to avoid
1354 # potential deadlocks, thus we do all this here.
1355 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001356
Victor Stinner372b8382011-06-21 17:24:21 +02001357 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001358 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1359 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001360 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001361 env_list = None # Use execv instead of execve.
1362 executable = os.fsencode(executable)
1363 if os.path.dirname(executable):
1364 executable_list = (executable,)
1365 else:
1366 # This matches the behavior of os._execvpe().
1367 executable_list = tuple(
1368 os.path.join(os.fsencode(dir), executable)
1369 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001370 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001371 fds_to_keep.add(errpipe_write)
1372 self.pid = _posixsubprocess.fork_exec(
1373 args, executable_list,
1374 close_fds, sorted(fds_to_keep), cwd, env_list,
1375 p2cread, p2cwrite, c2pread, c2pwrite,
1376 errread, errwrite,
1377 errpipe_read, errpipe_write,
1378 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001379 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001380 finally:
1381 # be sure the FD is closed no matter what
1382 os.close(errpipe_write)
1383
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001384 # self._devnull is not always defined.
1385 devnull_fd = getattr(self, '_devnull', None)
1386 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001387 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001388 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001389 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001390 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001391 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001392 if devnull_fd is not None:
1393 os.close(devnull_fd)
1394 # Prevent a double close of these fds from __init__ on error.
1395 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001396
1397 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001398 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001399 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001400 while True:
1401 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001402 errpipe_data += part
1403 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001404 break
Facundo Batista10706e22009-06-19 20:34:30 +00001405 finally:
1406 # be sure the FD is closed no matter what
1407 os.close(errpipe_read)
1408
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001409 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001410 try:
1411 _eintr_retry_call(os.waitpid, self.pid, 0)
1412 except OSError as e:
1413 if e.errno != errno.ECHILD:
1414 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001415 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001416 exception_name, hex_errno, err_msg = (
1417 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001418 except ValueError:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001419 exception_name = b'RuntimeError'
1420 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001421 err_msg = (b'Bad exception data from child: ' +
1422 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001423 child_exception_type = getattr(
1424 builtins, exception_name.decode('ascii'),
1425 RuntimeError)
Victor Stinner4d078042010-04-23 19:28:32 +00001426 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001427 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001428 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001429 child_exec_never_called = (err_msg == "noexec")
1430 if child_exec_never_called:
1431 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001432 if errno_num != 0:
1433 err_msg = os.strerror(errno_num)
1434 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001435 if child_exec_never_called:
1436 # The error must be from chdir(cwd).
1437 err_msg += ': ' + repr(cwd)
1438 else:
1439 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001440 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001441 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001442
1443
Brett Cannon84df1e62010-05-14 00:33:40 +00001444 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1445 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1446 _WEXITSTATUS=os.WEXITSTATUS):
1447 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001448 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001449 if _WIFSIGNALED(sts):
1450 self.returncode = -_WTERMSIG(sts)
1451 elif _WIFEXITED(sts):
1452 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001453 else:
1454 # Should never happen
1455 raise RuntimeError("Unknown child exit status!")
1456
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457
Brett Cannon84df1e62010-05-14 00:33:40 +00001458 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov08bab072012-12-24 20:06:35 +02001459 _WNOHANG=os.WNOHANG, _os_error=os.error, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001460 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001461 attribute.
1462
1463 This method is called by __del__, so it cannot reference anything
1464 outside of the local scope (nor can any methods it calls).
1465
1466 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001467 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001468 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001469 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001470 if pid == self.pid:
1471 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001472 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001473 if _deadstate is not None:
1474 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001475 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001476 # This happens if SIGCLD is set to be ignored or
1477 # waiting for child processes has otherwise been
1478 # disabled for our process. This child is dead, we
1479 # can't get the status.
1480 # http://bugs.python.org/issue15756
1481 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001482 return self.returncode
1483
1484
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001485 def _try_wait(self, wait_flags):
1486 try:
1487 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1488 except OSError as e:
1489 if e.errno != errno.ECHILD:
1490 raise
1491 # This happens if SIGCLD is set to be ignored or waiting
1492 # for child processes has otherwise been disabled for our
1493 # process. This child is dead, we can't get the status.
1494 pid = self.pid
1495 sts = 0
1496 return (pid, sts)
1497
1498
1499 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001500 """Wait for child process to terminate. Returns returncode
1501 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001502 if self.returncode is not None:
1503 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001504
1505 # endtime is preferred to timeout. timeout is only used for
1506 # printing.
1507 if endtime is not None or timeout is not None:
1508 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001509 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001510 elif timeout is None:
1511 timeout = self._remaining_time(endtime)
1512
1513 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001514 # Enter a busy loop if we have a timeout. This busy loop was
1515 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1516 delay = 0.0005 # 500 us -> initial delay of 1 ms
1517 while True:
1518 (pid, sts) = self._try_wait(os.WNOHANG)
1519 assert pid == self.pid or pid == 0
1520 if pid == self.pid:
1521 self._handle_exitstatus(sts)
1522 break
1523 remaining = self._remaining_time(endtime)
1524 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001525 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001526 delay = min(delay * 2, remaining, .05)
1527 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001528 else:
1529 while self.returncode is None:
1530 (pid, sts) = self._try_wait(0)
1531 # Check the pid and loop as waitpid has been known to return
1532 # 0 even without WNOHANG in odd situations. issue14396.
1533 if pid == self.pid:
1534 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001535 return self.returncode
1536
1537
Reid Kleckner2b228f02011-03-16 16:57:54 -04001538 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001539 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001540 # Flush stdio buffer. This might block, if the user has
1541 # been writing to .stdin in an uncontrolled fashion.
1542 self.stdin.flush()
1543 if not input:
1544 self.stdin.close()
1545
1546 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001547 stdout, stderr = self._communicate_with_poll(input, endtime,
1548 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001549 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001550 stdout, stderr = self._communicate_with_select(input, endtime,
1551 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001552
1553 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001554
1555 # All data exchanged. Translate lists into strings.
1556 if stdout is not None:
1557 stdout = b''.join(stdout)
1558 if stderr is not None:
1559 stderr = b''.join(stderr)
1560
1561 # Translate newlines, if requested.
1562 # This also turns bytes into strings.
1563 if self.universal_newlines:
1564 if stdout is not None:
1565 stdout = self._translate_newlines(stdout,
1566 self.stdout.encoding)
1567 if stderr is not None:
1568 stderr = self._translate_newlines(stderr,
1569 self.stderr.encoding)
1570
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001571 return (stdout, stderr)
1572
1573
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001574 def _save_input(self, input):
1575 # This method is called from the _communicate_with_*() methods
1576 # so that if we time out while communicating, we can continue
1577 # sending input if we retry.
1578 if self.stdin and self._input is None:
1579 self._input_offset = 0
1580 self._input = input
1581 if self.universal_newlines and input is not None:
1582 self._input = self._input.encode(self.stdin.encoding)
1583
1584
Reid Kleckner2b228f02011-03-16 16:57:54 -04001585 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001586 stdout = None # Return
1587 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001588
1589 if not self._communication_started:
1590 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001591
1592 poller = select.poll()
1593 def register_and_append(file_obj, eventmask):
1594 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001595 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001596
1597 def close_unregister_and_remove(fd):
1598 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001599 self._fd2file[fd].close()
1600 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001601
1602 if self.stdin and input:
1603 register_and_append(self.stdin, select.POLLOUT)
1604
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001605 # Only create this mapping if we haven't already.
1606 if not self._communication_started:
1607 self._fd2output = {}
1608 if self.stdout:
1609 self._fd2output[self.stdout.fileno()] = []
1610 if self.stderr:
1611 self._fd2output[self.stderr.fileno()] = []
1612
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001613 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1614 if self.stdout:
1615 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001616 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001617 if self.stderr:
1618 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001619 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001620
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001621 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001622
Gregory P. Smith774f9092013-12-07 19:12:46 -08001623 if self._input:
1624 input_view = memoryview(self._input)
1625
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001626 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001627 timeout = self._remaining_time(endtime)
1628 if timeout is not None and timeout < 0:
1629 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001630 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001631 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001632 except select.error as e:
1633 if e.args[0] == errno.EINTR:
1634 continue
1635 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001636 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001637
1638 # XXX Rewrite these to use non-blocking I/O on the
1639 # file objects; they are no longer using C stdio!
1640
1641 for fd, mode in ready:
1642 if mode & select.POLLOUT:
Gregory P. Smith774f9092013-12-07 19:12:46 -08001643 chunk = input_view[self._input_offset :
1644 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001645 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001646 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001647 except OSError as e:
1648 if e.errno == errno.EPIPE:
1649 close_unregister_and_remove(fd)
1650 else:
1651 raise
1652 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001653 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001654 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001655 elif mode & select_POLLIN_POLLPRI:
Gregory P. Smith589ecda2013-12-08 10:56:07 -08001656 data = os.read(fd, 32768)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001657 if not data:
1658 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001659 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001660 else:
1661 # Ignore hang up or errors.
1662 close_unregister_and_remove(fd)
1663
1664 return (stdout, stderr)
1665
1666
Reid Kleckner2b228f02011-03-16 16:57:54 -04001667 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001668 if not self._communication_started:
1669 self._read_set = []
1670 self._write_set = []
1671 if self.stdin and input:
1672 self._write_set.append(self.stdin)
1673 if self.stdout:
1674 self._read_set.append(self.stdout)
1675 if self.stderr:
1676 self._read_set.append(self.stderr)
1677
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001678 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001679
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001680 stdout = None # Return
1681 stderr = None # Return
1682
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001683 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001684 if not self._communication_started:
1685 self._stdout_buff = []
1686 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001687 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001688 if not self._communication_started:
1689 self._stderr_buff = []
1690 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001691
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001692 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001693 timeout = self._remaining_time(endtime)
1694 if timeout is not None and timeout < 0:
1695 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001696 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001697 (rlist, wlist, xlist) = \
1698 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001699 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001700 except select.error as e:
1701 if e.args[0] == errno.EINTR:
1702 continue
1703 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001704
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001705 # According to the docs, returning three empty lists indicates
1706 # that the timeout expired.
1707 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001708 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001709 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001710 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001711
Guido van Rossum98297ee2007-11-06 21:34:58 +00001712 # XXX Rewrite these to use non-blocking I/O on the
1713 # file objects; they are no longer using C stdio!
1714
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001715 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001716 chunk = self._input[self._input_offset :
1717 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001718 try:
1719 bytes_written = os.write(self.stdin.fileno(), chunk)
1720 except OSError as e:
1721 if e.errno == errno.EPIPE:
1722 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001723 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001724 else:
1725 raise
1726 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001727 self._input_offset += bytes_written
1728 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001729 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001730 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001731
1732 if self.stdout in rlist:
1733 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001734 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001735 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001736 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001737 stdout.append(data)
1738
1739 if self.stderr in rlist:
1740 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001741 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001743 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001744 stderr.append(data)
1745
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001746 return (stdout, stderr)
1747
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001748
Christian Heimesa342c012008-04-20 21:01:16 +00001749 def send_signal(self, sig):
1750 """Send a signal to the process
1751 """
1752 os.kill(self.pid, sig)
1753
1754 def terminate(self):
1755 """Terminate the process with SIGTERM
1756 """
1757 self.send_signal(signal.SIGTERM)
1758
1759 def kill(self):
1760 """Kill the process with SIGKILL
1761 """
1762 self.send_signal(signal.SIGKILL)