blob: c3a278836c19121319363f1c896e528b48968202 [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):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700710 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000711 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000712 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
713 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000714 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000715 restore_signals=True, start_new_session=False,
716 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000717 """Create new Popen instance."""
718 _cleanup()
719
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000720 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400721 self._input = None
722 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000723 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700724 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000725 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000726 raise TypeError("bufsize must be an integer")
727
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000728 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000729 if preexec_fn is not None:
730 raise ValueError("preexec_fn is not supported on Windows "
731 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000732 any_stdio_set = (stdin is not None or stdout is not None or
733 stderr is not None)
734 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
735 if any_stdio_set:
736 close_fds = False
737 else:
738 close_fds = True
739 elif close_fds and any_stdio_set:
740 raise ValueError(
741 "close_fds is not supported on Windows platforms"
742 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000743 else:
744 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000745 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
746 close_fds = True
747 if pass_fds and not close_fds:
748 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
749 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000750 if startupinfo is not None:
751 raise ValueError("startupinfo is only supported on Windows "
752 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000754 raise ValueError("creationflags is only supported on Windows "
755 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000756
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400757 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000758 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000759 self.stdout = None
760 self.stderr = None
761 self.pid = None
762 self.returncode = None
763 self.universal_newlines = universal_newlines
764
765 # Input and output objects. The general principle is like
766 # this:
767 #
768 # Parent Child
769 # ------ -----
770 # p2cwrite ---stdin---> p2cread
771 # c2pread <--stdout--- c2pwrite
772 # errread <--stderr--- errwrite
773 #
774 # On POSIX, the child objects are file descriptors. On
775 # Windows, these are Windows file handles. The parent objects
776 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000777 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000778 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000779
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 (p2cread, p2cwrite,
781 c2pread, c2pwrite,
782 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
783
Antoine Pitrouc9982322011-01-04 19:07:07 +0000784 # We wrap OS handles *before* launching the child, otherwise a
785 # quickly terminating child could make our fds unwrappable
786 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000787
Thomas Wouterscf297e42007-02-23 15:07:44 +0000788 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000789 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000790 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000791 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000792 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000793 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000794 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000795
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000796 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000797 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300798 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200799 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000800 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000801 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000802 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000803 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000804 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000805 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000806 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000807 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000808
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700809 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000810 try:
811 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300812 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000813 startupinfo, creationflags, shell,
814 p2cread, p2cwrite,
815 c2pread, c2pwrite,
816 errread, errwrite,
817 restore_signals, start_new_session)
818 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800819 # Cleanup if the child failed starting.
820 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000821 try:
822 f.close()
823 except EnvironmentError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800824 pass # Ignore EBADF or other errors.
825
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700826 if not self._closed_child_pipe_fds:
827 to_close = []
828 if stdin == PIPE:
829 to_close.append(p2cread)
830 if stdout == PIPE:
831 to_close.append(c2pwrite)
832 if stderr == PIPE:
833 to_close.append(errwrite)
834 if hasattr(self, '_devnull'):
835 to_close.append(self._devnull)
836 for fd in to_close:
837 try:
838 os.close(fd)
839 except EnvironmentError:
840 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800841
Antoine Pitrouc9982322011-01-04 19:07:07 +0000842 raise
843
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000844
Guido van Rossum98297ee2007-11-06 21:34:58 +0000845 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300846 data = data.decode(encoding)
847 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000848
Brian Curtin79cdb662010-12-03 02:46:02 +0000849 def __enter__(self):
850 return self
851
852 def __exit__(self, type, value, traceback):
853 if self.stdout:
854 self.stdout.close()
855 if self.stderr:
856 self.stderr.close()
857 if self.stdin:
858 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700859 # Wait for the process to terminate, to avoid zombies.
860 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000861
Brett Cannon84df1e62010-05-14 00:33:40 +0000862 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200863 # If __init__ hasn't had a chance to execute (e.g. if it
864 # was passed an undeclared keyword argument), we don't
865 # have a _child_created attribute at all.
866 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000867 # We didn't get to successfully create a child process.
868 return
869 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000870 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000871 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000872 # Child is still running, keep us alive until we can wait on it.
873 _active.append(self)
874
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200875 def _get_devnull(self):
876 if not hasattr(self, '_devnull'):
877 self._devnull = os.open(os.devnull, os.O_RDWR)
878 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000879
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400880 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000881 """Interact with process: Send data to stdin. Read data from
882 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700883 process to terminate. The optional input argument should be
884 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000885 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000886
Peter Astrand23109f02005-03-03 20:28:59 +0000887 communicate() returns a tuple (stdout, stderr)."""
888
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400889 if self._communication_started and input:
890 raise ValueError("Cannot send input after starting communication")
891
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400892 # Optimization: If we are not worried about timeouts, we haven't
893 # started communicating, and we have one or zero pipes, using select()
894 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200895 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400896 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000897 stdout = None
898 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000899 if self.stdin:
900 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200901 try:
902 self.stdin.write(input)
903 except IOError as e:
904 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
905 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000906 self.stdin.close()
907 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200908 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000909 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000910 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200911 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000912 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000913 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200914 else:
915 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200916 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200917 else:
918 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000919
Victor Stinner7a8d0812011-04-05 13:13:08 +0200920 try:
921 stdout, stderr = self._communicate(input, endtime, timeout)
922 finally:
923 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400924
Victor Stinner7a8d0812011-04-05 13:13:08 +0200925 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400926
927 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000928
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000929
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000930 def poll(self):
931 return self._internal_poll()
932
933
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400934 def _remaining_time(self, endtime):
935 """Convenience for _communicate when computing timeouts."""
936 if endtime is None:
937 return None
938 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200939 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400940
941
Reid Kleckner2b228f02011-03-16 16:57:54 -0400942 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400943 """Convenience for checking if a timeout has expired."""
944 if endtime is None:
945 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200946 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400947 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400948
949
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000950 if mswindows:
951 #
952 # Windows methods
953 #
954 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000955 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000956 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
957 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000958 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000959 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000960
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000961 p2cread, p2cwrite = -1, -1
962 c2pread, c2pwrite = -1, -1
963 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000964
Peter Astrandd38ddf42005-02-10 08:32:50 +0000965 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200966 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000967 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200968 p2cread, _ = _winapi.CreatePipe(None, 0)
969 p2cread = Handle(p2cread)
970 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000971 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200972 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
973 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200974 elif stdin == DEVNULL:
975 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000976 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000977 p2cread = msvcrt.get_osfhandle(stdin)
978 else:
979 # Assuming file-like object
980 p2cread = msvcrt.get_osfhandle(stdin.fileno())
981 p2cread = self._make_inheritable(p2cread)
982
Peter Astrandd38ddf42005-02-10 08:32:50 +0000983 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200984 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000985 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200986 _, c2pwrite = _winapi.CreatePipe(None, 0)
987 c2pwrite = Handle(c2pwrite)
988 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000989 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200990 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
991 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200992 elif stdout == DEVNULL:
993 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000994 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000995 c2pwrite = msvcrt.get_osfhandle(stdout)
996 else:
997 # Assuming file-like object
998 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
999 c2pwrite = self._make_inheritable(c2pwrite)
1000
Peter Astrandd38ddf42005-02-10 08:32:50 +00001001 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001002 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001003 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001004 _, errwrite = _winapi.CreatePipe(None, 0)
1005 errwrite = Handle(errwrite)
1006 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001007 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001008 errread, errwrite = _winapi.CreatePipe(None, 0)
1009 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001010 elif stderr == STDOUT:
1011 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001012 elif stderr == DEVNULL:
1013 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001014 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001015 errwrite = msvcrt.get_osfhandle(stderr)
1016 else:
1017 # Assuming file-like object
1018 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1019 errwrite = self._make_inheritable(errwrite)
1020
1021 return (p2cread, p2cwrite,
1022 c2pread, c2pwrite,
1023 errread, errwrite)
1024
1025
1026 def _make_inheritable(self, handle):
1027 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001028 h = _winapi.DuplicateHandle(
1029 _winapi.GetCurrentProcess(), handle,
1030 _winapi.GetCurrentProcess(), 0, 1,
1031 _winapi.DUPLICATE_SAME_ACCESS)
1032 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001033
1034
1035 def _find_w9xpopen(self):
1036 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001037 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001038 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001039 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001040 if not os.path.exists(w9xpopen):
1041 # Eeek - file-not-found - possibly an embedding
1042 # situation - see if we can locate it in sys.exec_prefix
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001043 w9xpopen = os.path.join(os.path.dirname(sys.base_exec_prefix),
Tim Peterse8374a52004-10-13 03:15:00 +00001044 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001045 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +00001046 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1047 "needed for Popen to work with your "
1048 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001049 return w9xpopen
1050
Tim Peterse718f612004-10-12 21:51:32 +00001051
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001052 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001053 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001054 startupinfo, creationflags, shell,
1055 p2cread, p2cwrite,
1056 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001057 errread, errwrite,
1058 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001059 """Execute program (MS Windows version)"""
1060
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001061 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001062
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001063 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001064 args = list2cmdline(args)
1065
Peter Astrandc1d65362004-11-07 14:30:34 +00001066 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001067 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001068 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001069 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001070 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001071 startupinfo.hStdInput = p2cread
1072 startupinfo.hStdOutput = c2pwrite
1073 startupinfo.hStdError = errwrite
1074
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001075 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001076 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1077 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001078 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001079 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001080 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001081 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001082 # Win9x, or using command.com on NT. We need to
1083 # use the w9xpopen intermediate program. For more
1084 # information, see KB Q150956
1085 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1086 w9xpopen = self._find_w9xpopen()
1087 args = '"%s" %s' % (w9xpopen, args)
1088 # Not passing CREATE_NEW_CONSOLE has been known to
1089 # cause random failures on win9x. Specifically a
1090 # dialog: "Your program accessed mem currently in
1091 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001092 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001093 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001094 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001095
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001096 # Start the process
1097 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001098 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001099 # no special security
1100 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001101 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001102 creationflags,
1103 env,
1104 cwd,
1105 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001106 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001107 # Translate pywintypes.error to WindowsError, which is
1108 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001109 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001110 # how can this be done from Python?
1111 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001112 finally:
1113 # Child is launched. Close the parent's copy of those pipe
1114 # handles that only the child should have open. You need
1115 # to make sure that no handles to the write end of the
1116 # output pipe are maintained in this process or else the
1117 # pipe will not close when the child process exits and the
1118 # ReadFile will hang.
1119 if p2cread != -1:
1120 p2cread.Close()
1121 if c2pwrite != -1:
1122 c2pwrite.Close()
1123 if errwrite != -1:
1124 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001125 if hasattr(self, '_devnull'):
1126 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001127
1128 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001129 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001130 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001131 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001132 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133
Brett Cannon84df1e62010-05-14 00:33:40 +00001134 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001135 _WaitForSingleObject=_winapi.WaitForSingleObject,
1136 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1137 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001139 attribute.
1140
1141 This method is called by __del__, so it can only refer to objects
1142 in its local scope.
1143
1144 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001145 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001146 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1147 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001148 return self.returncode
1149
1150
Reid Kleckner2b228f02011-03-16 16:57:54 -04001151 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152 """Wait for child process to terminate. Returns returncode
1153 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001154 if endtime is not None:
1155 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001156 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001157 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001158 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001159 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001160 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001161 result = _winapi.WaitForSingleObject(self._handle,
1162 timeout_millis)
1163 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001164 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001165 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001166 return self.returncode
1167
1168
1169 def _readerthread(self, fh, buffer):
1170 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001171 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172
1173
Reid Kleckner2b228f02011-03-16 16:57:54 -04001174 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001175 # Start reader threads feeding into a list hanging off of this
1176 # object, unless they've already been started.
1177 if self.stdout and not hasattr(self, "_stdout_buff"):
1178 self._stdout_buff = []
1179 self.stdout_thread = \
1180 threading.Thread(target=self._readerthread,
1181 args=(self.stdout, self._stdout_buff))
1182 self.stdout_thread.daemon = True
1183 self.stdout_thread.start()
1184 if self.stderr and not hasattr(self, "_stderr_buff"):
1185 self._stderr_buff = []
1186 self.stderr_thread = \
1187 threading.Thread(target=self._readerthread,
1188 args=(self.stderr, self._stderr_buff))
1189 self.stderr_thread.daemon = True
1190 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001191
1192 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001193 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001194 try:
1195 self.stdin.write(input)
1196 except IOError as e:
1197 if e.errno != errno.EPIPE:
1198 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001199 self.stdin.close()
1200
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001201 # Wait for the reader threads, or time out. If we time out, the
1202 # threads remain reading and the fds left open in case the user
1203 # calls communicate again.
1204 if self.stdout is not None:
1205 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001206 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001207 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001208 if self.stderr is not None:
1209 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001210 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001211 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001212
1213 # Collect the output from and close both pipes, now that we know
1214 # both have been read successfully.
1215 stdout = None
1216 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001217 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001218 stdout = self._stdout_buff
1219 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001220 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001221 stderr = self._stderr_buff
1222 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001223
1224 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001225 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001226 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001227 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001228 stderr = stderr[0]
1229
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001230 return (stdout, stderr)
1231
Christian Heimesa342c012008-04-20 21:01:16 +00001232 def send_signal(self, sig):
1233 """Send a signal to the process
1234 """
1235 if sig == signal.SIGTERM:
1236 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001237 elif sig == signal.CTRL_C_EVENT:
1238 os.kill(self.pid, signal.CTRL_C_EVENT)
1239 elif sig == signal.CTRL_BREAK_EVENT:
1240 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001241 else:
Brian Curtin19651362010-09-07 13:24:38 +00001242 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001243
1244 def terminate(self):
1245 """Terminates the process
1246 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001247 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001248 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001249 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001250 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1251 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001252 rc = _winapi.GetExitCodeProcess(self._handle)
1253 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001254 raise
1255 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001256
1257 kill = terminate
1258
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001259 else:
1260 #
1261 # POSIX methods
1262 #
1263 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001264 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001265 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1266 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001267 p2cread, p2cwrite = -1, -1
1268 c2pread, c2pwrite = -1, -1
1269 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001270
Peter Astrandd38ddf42005-02-10 08:32:50 +00001271 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001272 pass
1273 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001274 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001275 elif stdin == DEVNULL:
1276 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001277 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001278 p2cread = stdin
1279 else:
1280 # Assuming file-like object
1281 p2cread = stdin.fileno()
1282
Peter Astrandd38ddf42005-02-10 08:32:50 +00001283 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001284 pass
1285 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001286 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001287 elif stdout == DEVNULL:
1288 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001289 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001290 c2pwrite = stdout
1291 else:
1292 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001293 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001294
Peter Astrandd38ddf42005-02-10 08:32:50 +00001295 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001296 pass
1297 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001298 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001299 elif stderr == STDOUT:
1300 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001301 elif stderr == DEVNULL:
1302 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001303 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001304 errwrite = stderr
1305 else:
1306 # Assuming file-like object
1307 errwrite = stderr.fileno()
1308
1309 return (p2cread, p2cwrite,
1310 c2pread, c2pwrite,
1311 errread, errwrite)
1312
1313
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001314 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001315 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001316 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001317 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001318 os.closerange(start_fd, fd)
1319 start_fd = fd + 1
1320 if start_fd <= MAXFD:
1321 os.closerange(start_fd, MAXFD)
1322
1323
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001324 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001325 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001326 startupinfo, creationflags, shell,
1327 p2cread, p2cwrite,
1328 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001329 errread, errwrite,
1330 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331 """Execute program (POSIX version)"""
1332
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001333 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001334 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001335 else:
1336 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001337
1338 if shell:
1339 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001340 if executable:
1341 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001342
Peter Astrandd38ddf42005-02-10 08:32:50 +00001343 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001345 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001346
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001347 # For transferring possible exec failure from child to parent.
1348 # Data format: "exception name:hex errno:description"
1349 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001350 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001351 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001352 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001353 # We must avoid complex work that could involve
1354 # malloc or free in the child process to avoid
1355 # potential deadlocks, thus we do all this here.
1356 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001357
Victor Stinner372b8382011-06-21 17:24:21 +02001358 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001359 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1360 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001361 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001362 env_list = None # Use execv instead of execve.
1363 executable = os.fsencode(executable)
1364 if os.path.dirname(executable):
1365 executable_list = (executable,)
1366 else:
1367 # This matches the behavior of os._execvpe().
1368 executable_list = tuple(
1369 os.path.join(os.fsencode(dir), executable)
1370 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001371 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001372 fds_to_keep.add(errpipe_write)
1373 self.pid = _posixsubprocess.fork_exec(
1374 args, executable_list,
1375 close_fds, sorted(fds_to_keep), cwd, env_list,
1376 p2cread, p2cwrite, c2pread, c2pwrite,
1377 errread, errwrite,
1378 errpipe_read, errpipe_write,
1379 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001380 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001381 finally:
1382 # be sure the FD is closed no matter what
1383 os.close(errpipe_write)
1384
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001385 # self._devnull is not always defined.
1386 devnull_fd = getattr(self, '_devnull', None)
1387 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001388 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001389 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001390 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001391 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001392 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001393 if devnull_fd is not None:
1394 os.close(devnull_fd)
1395 # Prevent a double close of these fds from __init__ on error.
1396 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001397
1398 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001399 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001400 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001401 while True:
1402 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001403 errpipe_data += part
1404 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001405 break
Facundo Batista10706e22009-06-19 20:34:30 +00001406 finally:
1407 # be sure the FD is closed no matter what
1408 os.close(errpipe_read)
1409
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001410 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001411 try:
1412 _eintr_retry_call(os.waitpid, self.pid, 0)
1413 except OSError as e:
1414 if e.errno != errno.ECHILD:
1415 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001416 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001417 exception_name, hex_errno, err_msg = (
1418 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001419 except ValueError:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001420 exception_name = b'RuntimeError'
1421 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001422 err_msg = (b'Bad exception data from child: ' +
1423 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001424 child_exception_type = getattr(
1425 builtins, exception_name.decode('ascii'),
1426 RuntimeError)
Victor Stinner4d078042010-04-23 19:28:32 +00001427 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001428 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001429 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001430 child_exec_never_called = (err_msg == "noexec")
1431 if child_exec_never_called:
1432 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001433 if errno_num != 0:
1434 err_msg = os.strerror(errno_num)
1435 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001436 if child_exec_never_called:
1437 # The error must be from chdir(cwd).
1438 err_msg += ': ' + repr(cwd)
1439 else:
1440 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001441 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001442 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001443
1444
Brett Cannon84df1e62010-05-14 00:33:40 +00001445 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1446 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1447 _WEXITSTATUS=os.WEXITSTATUS):
1448 # This method is called (indirectly) by __del__, so it cannot
1449 # refer to anything outside of its local scope."""
1450 if _WIFSIGNALED(sts):
1451 self.returncode = -_WTERMSIG(sts)
1452 elif _WIFEXITED(sts):
1453 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001454 else:
1455 # Should never happen
1456 raise RuntimeError("Unknown child exit status!")
1457
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001458
Brett Cannon84df1e62010-05-14 00:33:40 +00001459 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov08bab072012-12-24 20:06:35 +02001460 _WNOHANG=os.WNOHANG, _os_error=os.error, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001461 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001462 attribute.
1463
1464 This method is called by __del__, so it cannot reference anything
1465 outside of the local scope (nor can any methods it calls).
1466
1467 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001468 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001469 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001470 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001471 if pid == self.pid:
1472 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001473 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001474 if _deadstate is not None:
1475 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001476 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001477 # This happens if SIGCLD is set to be ignored or
1478 # waiting for child processes has otherwise been
1479 # disabled for our process. This child is dead, we
1480 # can't get the status.
1481 # http://bugs.python.org/issue15756
1482 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001483 return self.returncode
1484
1485
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001486 def _try_wait(self, wait_flags):
1487 try:
1488 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1489 except OSError as e:
1490 if e.errno != errno.ECHILD:
1491 raise
1492 # This happens if SIGCLD is set to be ignored or waiting
1493 # for child processes has otherwise been disabled for our
1494 # process. This child is dead, we can't get the status.
1495 pid = self.pid
1496 sts = 0
1497 return (pid, sts)
1498
1499
1500 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001501 """Wait for child process to terminate. Returns returncode
1502 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001503 if self.returncode is not None:
1504 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001505
1506 # endtime is preferred to timeout. timeout is only used for
1507 # printing.
1508 if endtime is not None or timeout is not None:
1509 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001510 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001511 elif timeout is None:
1512 timeout = self._remaining_time(endtime)
1513
1514 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001515 # Enter a busy loop if we have a timeout. This busy loop was
1516 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1517 delay = 0.0005 # 500 us -> initial delay of 1 ms
1518 while True:
1519 (pid, sts) = self._try_wait(os.WNOHANG)
1520 assert pid == self.pid or pid == 0
1521 if pid == self.pid:
1522 self._handle_exitstatus(sts)
1523 break
1524 remaining = self._remaining_time(endtime)
1525 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001526 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001527 delay = min(delay * 2, remaining, .05)
1528 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001529 else:
1530 while self.returncode is None:
1531 (pid, sts) = self._try_wait(0)
1532 # Check the pid and loop as waitpid has been known to return
1533 # 0 even without WNOHANG in odd situations. issue14396.
1534 if pid == self.pid:
1535 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001536 return self.returncode
1537
1538
Reid Kleckner2b228f02011-03-16 16:57:54 -04001539 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001540 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001541 # Flush stdio buffer. This might block, if the user has
1542 # been writing to .stdin in an uncontrolled fashion.
1543 self.stdin.flush()
1544 if not input:
1545 self.stdin.close()
1546
1547 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001548 stdout, stderr = self._communicate_with_poll(input, endtime,
1549 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001550 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001551 stdout, stderr = self._communicate_with_select(input, endtime,
1552 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001553
1554 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001555
1556 # All data exchanged. Translate lists into strings.
1557 if stdout is not None:
1558 stdout = b''.join(stdout)
1559 if stderr is not None:
1560 stderr = b''.join(stderr)
1561
1562 # Translate newlines, if requested.
1563 # This also turns bytes into strings.
1564 if self.universal_newlines:
1565 if stdout is not None:
1566 stdout = self._translate_newlines(stdout,
1567 self.stdout.encoding)
1568 if stderr is not None:
1569 stderr = self._translate_newlines(stderr,
1570 self.stderr.encoding)
1571
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001572 return (stdout, stderr)
1573
1574
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001575 def _save_input(self, input):
1576 # This method is called from the _communicate_with_*() methods
1577 # so that if we time out while communicating, we can continue
1578 # sending input if we retry.
1579 if self.stdin and self._input is None:
1580 self._input_offset = 0
1581 self._input = input
1582 if self.universal_newlines and input is not None:
1583 self._input = self._input.encode(self.stdin.encoding)
1584
1585
Reid Kleckner2b228f02011-03-16 16:57:54 -04001586 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001587 stdout = None # Return
1588 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001589
1590 if not self._communication_started:
1591 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001592
1593 poller = select.poll()
1594 def register_and_append(file_obj, eventmask):
1595 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001597
1598 def close_unregister_and_remove(fd):
1599 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001600 self._fd2file[fd].close()
1601 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001602
1603 if self.stdin and input:
1604 register_and_append(self.stdin, select.POLLOUT)
1605
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001606 # Only create this mapping if we haven't already.
1607 if not self._communication_started:
1608 self._fd2output = {}
1609 if self.stdout:
1610 self._fd2output[self.stdout.fileno()] = []
1611 if self.stderr:
1612 self._fd2output[self.stderr.fileno()] = []
1613
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001614 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1615 if self.stdout:
1616 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001617 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001618 if self.stderr:
1619 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001620 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001621
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001622 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001623
1624 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001625 timeout = self._remaining_time(endtime)
1626 if timeout is not None and timeout < 0:
1627 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001628 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001629 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001630 except select.error as e:
1631 if e.args[0] == errno.EINTR:
1632 continue
1633 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001634 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001635
1636 # XXX Rewrite these to use non-blocking I/O on the
1637 # file objects; they are no longer using C stdio!
1638
1639 for fd, mode in ready:
1640 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001641 chunk = self._input[self._input_offset :
1642 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001643 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001644 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001645 except OSError as e:
1646 if e.errno == errno.EPIPE:
1647 close_unregister_and_remove(fd)
1648 else:
1649 raise
1650 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001651 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001652 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001653 elif mode & select_POLLIN_POLLPRI:
1654 data = os.read(fd, 4096)
1655 if not data:
1656 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001657 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001658 else:
1659 # Ignore hang up or errors.
1660 close_unregister_and_remove(fd)
1661
1662 return (stdout, stderr)
1663
1664
Reid Kleckner2b228f02011-03-16 16:57:54 -04001665 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001666 if not self._communication_started:
1667 self._read_set = []
1668 self._write_set = []
1669 if self.stdin and input:
1670 self._write_set.append(self.stdin)
1671 if self.stdout:
1672 self._read_set.append(self.stdout)
1673 if self.stderr:
1674 self._read_set.append(self.stderr)
1675
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001676 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001677
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001678 stdout = None # Return
1679 stderr = None # Return
1680
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001681 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001682 if not self._communication_started:
1683 self._stdout_buff = []
1684 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001685 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001686 if not self._communication_started:
1687 self._stderr_buff = []
1688 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001689
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001690 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001691 timeout = self._remaining_time(endtime)
1692 if timeout is not None and timeout < 0:
1693 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001694 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001695 (rlist, wlist, xlist) = \
1696 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001697 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001698 except select.error as e:
1699 if e.args[0] == errno.EINTR:
1700 continue
1701 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001702
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001703 # According to the docs, returning three empty lists indicates
1704 # that the timeout expired.
1705 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001706 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001707 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001708 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001709
Guido van Rossum98297ee2007-11-06 21:34:58 +00001710 # XXX Rewrite these to use non-blocking I/O on the
1711 # file objects; they are no longer using C stdio!
1712
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001713 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001714 chunk = self._input[self._input_offset :
1715 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001716 try:
1717 bytes_written = os.write(self.stdin.fileno(), chunk)
1718 except OSError as e:
1719 if e.errno == errno.EPIPE:
1720 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001721 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001722 else:
1723 raise
1724 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001725 self._input_offset += bytes_written
1726 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001727 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001728 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001729
1730 if self.stdout in rlist:
1731 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001732 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001733 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001734 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001735 stdout.append(data)
1736
1737 if self.stderr in rlist:
1738 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001739 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001740 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001741 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 stderr.append(data)
1743
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001744 return (stdout, stderr)
1745
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001746
Christian Heimesa342c012008-04-20 21:01:16 +00001747 def send_signal(self, sig):
1748 """Send a signal to the process
1749 """
1750 os.kill(self.pid, sig)
1751
1752 def terminate(self):
1753 """Terminate the process with SIGTERM
1754 """
1755 self.send_signal(signal.SIGTERM)
1756
1757 def kill(self):
1758 """Kill the process with SIGKILL
1759 """
1760 self.send_signal(signal.SIGKILL)