blob: 376b50546bd95a21b63a3e9231bb8cdaa60b932e [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#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000665# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000666
667def getstatusoutput(cmd):
668 """Return (status, output) of executing cmd in a shell.
669
670 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
671 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
672 returned output will contain output or error messages. A trailing newline
673 is stripped from the output. The exit status for the command can be
674 interpreted according to the rules for the C function wait(). Example:
675
676 >>> import subprocess
677 >>> subprocess.getstatusoutput('ls /bin/ls')
678 (0, '/bin/ls')
679 >>> subprocess.getstatusoutput('cat /bin/junk')
680 (256, 'cat: /bin/junk: No such file or directory')
681 >>> subprocess.getstatusoutput('/bin/junk')
682 (256, 'sh: /bin/junk: not found')
683 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200684 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
685 try:
686 text = pipe.read()
687 sts = pipe.close()
688 except:
689 process = pipe._proc
690 process.kill()
691 process.wait()
692 raise
693 if sts is None:
694 sts = 0
695 if text[-1:] == '\n':
696 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000697 return sts, text
698
699
700def getoutput(cmd):
701 """Return output (stdout or stderr) of executing cmd in a shell.
702
703 Like getstatusoutput(), except the exit status is ignored and the return
704 value is a string containing the command's output. Example:
705
706 >>> import subprocess
707 >>> subprocess.getoutput('ls /bin/ls')
708 '/bin/ls'
709 """
710 return getstatusoutput(cmd)[1]
711
712
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000713_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000714
715
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000716class Popen(object):
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700717 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000718 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000719 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
720 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000721 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000722 restore_signals=True, start_new_session=False,
723 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000724 """Create new Popen instance."""
725 _cleanup()
726
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000727 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400728 self._input = None
729 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000730 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700731 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000732 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000733 raise TypeError("bufsize must be an integer")
734
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000735 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000736 if preexec_fn is not None:
737 raise ValueError("preexec_fn is not supported on Windows "
738 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000739 any_stdio_set = (stdin is not None or stdout is not None or
740 stderr is not None)
741 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
742 if any_stdio_set:
743 close_fds = False
744 else:
745 close_fds = True
746 elif close_fds and any_stdio_set:
747 raise ValueError(
748 "close_fds is not supported on Windows platforms"
749 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000750 else:
751 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000752 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
753 close_fds = True
754 if pass_fds and not close_fds:
755 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
756 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000757 if startupinfo is not None:
758 raise ValueError("startupinfo is only supported on Windows "
759 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000760 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000761 raise ValueError("creationflags is only supported on Windows "
762 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000763
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400764 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000765 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000766 self.stdout = None
767 self.stderr = None
768 self.pid = None
769 self.returncode = None
770 self.universal_newlines = universal_newlines
771
772 # Input and output objects. The general principle is like
773 # this:
774 #
775 # Parent Child
776 # ------ -----
777 # p2cwrite ---stdin---> p2cread
778 # c2pread <--stdout--- c2pwrite
779 # errread <--stderr--- errwrite
780 #
781 # On POSIX, the child objects are file descriptors. On
782 # Windows, these are Windows file handles. The parent objects
783 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000784 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000785 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000786
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000787 (p2cread, p2cwrite,
788 c2pread, c2pwrite,
789 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
790
Antoine Pitrouc9982322011-01-04 19:07:07 +0000791 # We wrap OS handles *before* launching the child, otherwise a
792 # quickly terminating child could make our fds unwrappable
793 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000794
Thomas Wouterscf297e42007-02-23 15:07:44 +0000795 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000796 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000797 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000798 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000799 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000800 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000801 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000802
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000803 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000804 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300805 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200806 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000807 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000808 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000809 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000810 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000811 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000812 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000813 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000814 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000815
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700816 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000817 try:
818 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300819 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000820 startupinfo, creationflags, shell,
821 p2cread, p2cwrite,
822 c2pread, c2pwrite,
823 errread, errwrite,
824 restore_signals, start_new_session)
825 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800826 # Cleanup if the child failed starting.
827 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000828 try:
829 f.close()
830 except EnvironmentError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800831 pass # Ignore EBADF or other errors.
832
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700833 if not self._closed_child_pipe_fds:
834 to_close = []
835 if stdin == PIPE:
836 to_close.append(p2cread)
837 if stdout == PIPE:
838 to_close.append(c2pwrite)
839 if stderr == PIPE:
840 to_close.append(errwrite)
841 if hasattr(self, '_devnull'):
842 to_close.append(self._devnull)
843 for fd in to_close:
844 try:
845 os.close(fd)
846 except EnvironmentError:
847 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800848
Antoine Pitrouc9982322011-01-04 19:07:07 +0000849 raise
850
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000851
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300853 data = data.decode(encoding)
854 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000855
Brian Curtin79cdb662010-12-03 02:46:02 +0000856 def __enter__(self):
857 return self
858
859 def __exit__(self, type, value, traceback):
860 if self.stdout:
861 self.stdout.close()
862 if self.stderr:
863 self.stderr.close()
864 if self.stdin:
865 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700866 # Wait for the process to terminate, to avoid zombies.
867 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000868
Brett Cannon84df1e62010-05-14 00:33:40 +0000869 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200870 # If __init__ hasn't had a chance to execute (e.g. if it
871 # was passed an undeclared keyword argument), we don't
872 # have a _child_created attribute at all.
873 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000874 # We didn't get to successfully create a child process.
875 return
876 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000877 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000878 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000879 # Child is still running, keep us alive until we can wait on it.
880 _active.append(self)
881
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200882 def _get_devnull(self):
883 if not hasattr(self, '_devnull'):
884 self._devnull = os.open(os.devnull, os.O_RDWR)
885 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000886
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400887 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000888 """Interact with process: Send data to stdin. Read data from
889 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700890 process to terminate. The optional input argument should be
891 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000892 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000893
Peter Astrand23109f02005-03-03 20:28:59 +0000894 communicate() returns a tuple (stdout, stderr)."""
895
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400896 if self._communication_started and input:
897 raise ValueError("Cannot send input after starting communication")
898
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400899 # Optimization: If we are not worried about timeouts, we haven't
900 # started communicating, and we have one or zero pipes, using select()
901 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200902 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400903 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000904 stdout = None
905 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000906 if self.stdin:
907 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200908 try:
909 self.stdin.write(input)
910 except IOError as e:
911 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
912 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000913 self.stdin.close()
914 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200915 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000916 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000917 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200918 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000919 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000920 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200921 else:
922 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200923 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200924 else:
925 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000926
Victor Stinner7a8d0812011-04-05 13:13:08 +0200927 try:
928 stdout, stderr = self._communicate(input, endtime, timeout)
929 finally:
930 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400931
Victor Stinner7a8d0812011-04-05 13:13:08 +0200932 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400933
934 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000935
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000936
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000937 def poll(self):
938 return self._internal_poll()
939
940
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400941 def _remaining_time(self, endtime):
942 """Convenience for _communicate when computing timeouts."""
943 if endtime is None:
944 return None
945 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200946 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400947
948
Reid Kleckner2b228f02011-03-16 16:57:54 -0400949 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400950 """Convenience for checking if a timeout has expired."""
951 if endtime is None:
952 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200953 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400954 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400955
956
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000957 if mswindows:
958 #
959 # Windows methods
960 #
961 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000962 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000963 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
964 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000965 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000966 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000967
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000968 p2cread, p2cwrite = -1, -1
969 c2pread, c2pwrite = -1, -1
970 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000971
Peter Astrandd38ddf42005-02-10 08:32:50 +0000972 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200973 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000974 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200975 p2cread, _ = _winapi.CreatePipe(None, 0)
976 p2cread = Handle(p2cread)
977 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000978 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200979 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
980 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200981 elif stdin == DEVNULL:
982 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000983 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000984 p2cread = msvcrt.get_osfhandle(stdin)
985 else:
986 # Assuming file-like object
987 p2cread = msvcrt.get_osfhandle(stdin.fileno())
988 p2cread = self._make_inheritable(p2cread)
989
Peter Astrandd38ddf42005-02-10 08:32:50 +0000990 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200991 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000992 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200993 _, c2pwrite = _winapi.CreatePipe(None, 0)
994 c2pwrite = Handle(c2pwrite)
995 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000996 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200997 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
998 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200999 elif stdout == DEVNULL:
1000 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001001 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001002 c2pwrite = msvcrt.get_osfhandle(stdout)
1003 else:
1004 # Assuming file-like object
1005 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1006 c2pwrite = self._make_inheritable(c2pwrite)
1007
Peter Astrandd38ddf42005-02-10 08:32:50 +00001008 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001009 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001010 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001011 _, errwrite = _winapi.CreatePipe(None, 0)
1012 errwrite = Handle(errwrite)
1013 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001014 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001015 errread, errwrite = _winapi.CreatePipe(None, 0)
1016 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001017 elif stderr == STDOUT:
1018 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001019 elif stderr == DEVNULL:
1020 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001021 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001022 errwrite = msvcrt.get_osfhandle(stderr)
1023 else:
1024 # Assuming file-like object
1025 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1026 errwrite = self._make_inheritable(errwrite)
1027
1028 return (p2cread, p2cwrite,
1029 c2pread, c2pwrite,
1030 errread, errwrite)
1031
1032
1033 def _make_inheritable(self, handle):
1034 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001035 h = _winapi.DuplicateHandle(
1036 _winapi.GetCurrentProcess(), handle,
1037 _winapi.GetCurrentProcess(), 0, 1,
1038 _winapi.DUPLICATE_SAME_ACCESS)
1039 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001040
1041
1042 def _find_w9xpopen(self):
1043 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001044 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001045 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001046 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001047 if not os.path.exists(w9xpopen):
1048 # Eeek - file-not-found - possibly an embedding
1049 # situation - see if we can locate it in sys.exec_prefix
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001050 w9xpopen = os.path.join(os.path.dirname(sys.base_exec_prefix),
Tim Peterse8374a52004-10-13 03:15:00 +00001051 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001052 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +00001053 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1054 "needed for Popen to work with your "
1055 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 return w9xpopen
1057
Tim Peterse718f612004-10-12 21:51:32 +00001058
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001059 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001060 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 startupinfo, creationflags, shell,
1062 p2cread, p2cwrite,
1063 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001064 errread, errwrite,
1065 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066 """Execute program (MS Windows version)"""
1067
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001068 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001069
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001070 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001071 args = list2cmdline(args)
1072
Peter Astrandc1d65362004-11-07 14:30:34 +00001073 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001074 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001075 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001076 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001077 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001078 startupinfo.hStdInput = p2cread
1079 startupinfo.hStdOutput = c2pwrite
1080 startupinfo.hStdError = errwrite
1081
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001082 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001083 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1084 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001085 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001086 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001087 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001088 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001089 # Win9x, or using command.com on NT. We need to
1090 # use the w9xpopen intermediate program. For more
1091 # information, see KB Q150956
1092 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1093 w9xpopen = self._find_w9xpopen()
1094 args = '"%s" %s' % (w9xpopen, args)
1095 # Not passing CREATE_NEW_CONSOLE has been known to
1096 # cause random failures on win9x. Specifically a
1097 # dialog: "Your program accessed mem currently in
1098 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001099 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001100 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001101 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001102
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001103 # Start the process
1104 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001105 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001106 # no special security
1107 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001108 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001109 creationflags,
1110 env,
1111 cwd,
1112 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001113 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114 # Translate pywintypes.error to WindowsError, which is
1115 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001116 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001117 # how can this be done from Python?
1118 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001119 finally:
1120 # Child is launched. Close the parent's copy of those pipe
1121 # handles that only the child should have open. You need
1122 # to make sure that no handles to the write end of the
1123 # output pipe are maintained in this process or else the
1124 # pipe will not close when the child process exits and the
1125 # ReadFile will hang.
1126 if p2cread != -1:
1127 p2cread.Close()
1128 if c2pwrite != -1:
1129 c2pwrite.Close()
1130 if errwrite != -1:
1131 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001132 if hasattr(self, '_devnull'):
1133 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001134
1135 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001136 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001137 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001139 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001140
Brett Cannon84df1e62010-05-14 00:33:40 +00001141 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001142 _WaitForSingleObject=_winapi.WaitForSingleObject,
1143 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1144 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001145 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001146 attribute.
1147
1148 This method is called by __del__, so it can only refer to objects
1149 in its local scope.
1150
1151 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001152 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001153 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1154 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001155 return self.returncode
1156
1157
Reid Kleckner2b228f02011-03-16 16:57:54 -04001158 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001159 """Wait for child process to terminate. Returns returncode
1160 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001161 if endtime is not None:
1162 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001163 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001164 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001165 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001166 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001167 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001168 result = _winapi.WaitForSingleObject(self._handle,
1169 timeout_millis)
1170 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001171 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001172 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001173 return self.returncode
1174
1175
1176 def _readerthread(self, fh, buffer):
1177 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001178 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001179
1180
Reid Kleckner2b228f02011-03-16 16:57:54 -04001181 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001182 # Start reader threads feeding into a list hanging off of this
1183 # object, unless they've already been started.
1184 if self.stdout and not hasattr(self, "_stdout_buff"):
1185 self._stdout_buff = []
1186 self.stdout_thread = \
1187 threading.Thread(target=self._readerthread,
1188 args=(self.stdout, self._stdout_buff))
1189 self.stdout_thread.daemon = True
1190 self.stdout_thread.start()
1191 if self.stderr and not hasattr(self, "_stderr_buff"):
1192 self._stderr_buff = []
1193 self.stderr_thread = \
1194 threading.Thread(target=self._readerthread,
1195 args=(self.stderr, self._stderr_buff))
1196 self.stderr_thread.daemon = True
1197 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001198
1199 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001200 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001201 try:
1202 self.stdin.write(input)
1203 except IOError as e:
1204 if e.errno != errno.EPIPE:
1205 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001206 self.stdin.close()
1207
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001208 # Wait for the reader threads, or time out. If we time out, the
1209 # threads remain reading and the fds left open in case the user
1210 # calls communicate again.
1211 if self.stdout is not None:
1212 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001213 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001214 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001215 if self.stderr is not None:
1216 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001217 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001218 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001219
1220 # Collect the output from and close both pipes, now that we know
1221 # both have been read successfully.
1222 stdout = None
1223 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001224 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001225 stdout = self._stdout_buff
1226 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001227 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001228 stderr = self._stderr_buff
1229 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001230
1231 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001232 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001233 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001234 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001235 stderr = stderr[0]
1236
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237 return (stdout, stderr)
1238
Christian Heimesa342c012008-04-20 21:01:16 +00001239 def send_signal(self, sig):
1240 """Send a signal to the process
1241 """
1242 if sig == signal.SIGTERM:
1243 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001244 elif sig == signal.CTRL_C_EVENT:
1245 os.kill(self.pid, signal.CTRL_C_EVENT)
1246 elif sig == signal.CTRL_BREAK_EVENT:
1247 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001248 else:
Brian Curtin19651362010-09-07 13:24:38 +00001249 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001250
1251 def terminate(self):
1252 """Terminates the process
1253 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001254 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001255 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001256 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001257 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1258 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001259 rc = _winapi.GetExitCodeProcess(self._handle)
1260 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001261 raise
1262 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001263
1264 kill = terminate
1265
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001266 else:
1267 #
1268 # POSIX methods
1269 #
1270 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001271 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001272 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1273 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001274 p2cread, p2cwrite = -1, -1
1275 c2pread, c2pwrite = -1, -1
1276 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001277
Peter Astrandd38ddf42005-02-10 08:32:50 +00001278 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001279 pass
1280 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001281 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001282 elif stdin == DEVNULL:
1283 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001284 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285 p2cread = stdin
1286 else:
1287 # Assuming file-like object
1288 p2cread = stdin.fileno()
1289
Peter Astrandd38ddf42005-02-10 08:32:50 +00001290 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001291 pass
1292 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001293 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001294 elif stdout == DEVNULL:
1295 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001296 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001297 c2pwrite = stdout
1298 else:
1299 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001300 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001301
Peter Astrandd38ddf42005-02-10 08:32:50 +00001302 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303 pass
1304 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001305 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001306 elif stderr == STDOUT:
1307 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001308 elif stderr == DEVNULL:
1309 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001310 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001311 errwrite = stderr
1312 else:
1313 # Assuming file-like object
1314 errwrite = stderr.fileno()
1315
1316 return (p2cread, p2cwrite,
1317 c2pread, c2pwrite,
1318 errread, errwrite)
1319
1320
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001321 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001322 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001323 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001324 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001325 os.closerange(start_fd, fd)
1326 start_fd = fd + 1
1327 if start_fd <= MAXFD:
1328 os.closerange(start_fd, MAXFD)
1329
1330
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001332 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333 startupinfo, creationflags, shell,
1334 p2cread, p2cwrite,
1335 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001336 errread, errwrite,
1337 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001338 """Execute program (POSIX version)"""
1339
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001340 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001341 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001342 else:
1343 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344
1345 if shell:
1346 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001347 if executable:
1348 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001349
Peter Astrandd38ddf42005-02-10 08:32:50 +00001350 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001351 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001352 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001353
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001354 # For transferring possible exec failure from child to parent.
1355 # Data format: "exception name:hex errno:description"
1356 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001357 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001358 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001359 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001360 # We must avoid complex work that could involve
1361 # malloc or free in the child process to avoid
1362 # potential deadlocks, thus we do all this here.
1363 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001364
Victor Stinner372b8382011-06-21 17:24:21 +02001365 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001366 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1367 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001368 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001369 env_list = None # Use execv instead of execve.
1370 executable = os.fsencode(executable)
1371 if os.path.dirname(executable):
1372 executable_list = (executable,)
1373 else:
1374 # This matches the behavior of os._execvpe().
1375 executable_list = tuple(
1376 os.path.join(os.fsencode(dir), executable)
1377 for dir in os.get_exec_path(env))
1378 fds_to_keep = set(pass_fds)
1379 fds_to_keep.add(errpipe_write)
1380 self.pid = _posixsubprocess.fork_exec(
1381 args, executable_list,
1382 close_fds, sorted(fds_to_keep), cwd, env_list,
1383 p2cread, p2cwrite, c2pread, c2pwrite,
1384 errread, errwrite,
1385 errpipe_read, errpipe_write,
1386 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001387 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001388 finally:
1389 # be sure the FD is closed no matter what
1390 os.close(errpipe_write)
1391
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001392 # self._devnull is not always defined.
1393 devnull_fd = getattr(self, '_devnull', None)
1394 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001395 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001396 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001397 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001398 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001399 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001400 if devnull_fd is not None:
1401 os.close(devnull_fd)
1402 # Prevent a double close of these fds from __init__ on error.
1403 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001404
1405 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001406 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001407 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001408 while True:
1409 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001410 errpipe_data += part
1411 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001412 break
Facundo Batista10706e22009-06-19 20:34:30 +00001413 finally:
1414 # be sure the FD is closed no matter what
1415 os.close(errpipe_read)
1416
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001417 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001418 try:
1419 _eintr_retry_call(os.waitpid, self.pid, 0)
1420 except OSError as e:
1421 if e.errno != errno.ECHILD:
1422 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001423 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001424 exception_name, hex_errno, err_msg = (
1425 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001426 except ValueError:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001427 exception_name = b'RuntimeError'
1428 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001429 err_msg = (b'Bad exception data from child: ' +
1430 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001431 child_exception_type = getattr(
1432 builtins, exception_name.decode('ascii'),
1433 RuntimeError)
Victor Stinner4d078042010-04-23 19:28:32 +00001434 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001435 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001436 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001437 child_exec_never_called = (err_msg == "noexec")
1438 if child_exec_never_called:
1439 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001440 if errno_num != 0:
1441 err_msg = os.strerror(errno_num)
1442 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001443 if child_exec_never_called:
1444 # The error must be from chdir(cwd).
1445 err_msg += ': ' + repr(cwd)
1446 else:
1447 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001448 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001449 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001450
1451
Brett Cannon84df1e62010-05-14 00:33:40 +00001452 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1453 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1454 _WEXITSTATUS=os.WEXITSTATUS):
1455 # This method is called (indirectly) by __del__, so it cannot
1456 # refer to anything outside of its local scope."""
1457 if _WIFSIGNALED(sts):
1458 self.returncode = -_WTERMSIG(sts)
1459 elif _WIFEXITED(sts):
1460 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001461 else:
1462 # Should never happen
1463 raise RuntimeError("Unknown child exit status!")
1464
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001465
Brett Cannon84df1e62010-05-14 00:33:40 +00001466 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov08bab072012-12-24 20:06:35 +02001467 _WNOHANG=os.WNOHANG, _os_error=os.error, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001468 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001469 attribute.
1470
1471 This method is called by __del__, so it cannot reference anything
1472 outside of the local scope (nor can any methods it calls).
1473
1474 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001475 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001476 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001477 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001478 if pid == self.pid:
1479 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001480 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001481 if _deadstate is not None:
1482 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001483 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001484 # This happens if SIGCLD is set to be ignored or
1485 # waiting for child processes has otherwise been
1486 # disabled for our process. This child is dead, we
1487 # can't get the status.
1488 # http://bugs.python.org/issue15756
1489 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001490 return self.returncode
1491
1492
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001493 def _try_wait(self, wait_flags):
1494 try:
1495 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1496 except OSError as e:
1497 if e.errno != errno.ECHILD:
1498 raise
1499 # This happens if SIGCLD is set to be ignored or waiting
1500 # for child processes has otherwise been disabled for our
1501 # process. This child is dead, we can't get the status.
1502 pid = self.pid
1503 sts = 0
1504 return (pid, sts)
1505
1506
1507 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001508 """Wait for child process to terminate. Returns returncode
1509 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001510 if self.returncode is not None:
1511 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001512
1513 # endtime is preferred to timeout. timeout is only used for
1514 # printing.
1515 if endtime is not None or timeout is not None:
1516 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001517 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001518 elif timeout is None:
1519 timeout = self._remaining_time(endtime)
1520
1521 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001522 # Enter a busy loop if we have a timeout. This busy loop was
1523 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1524 delay = 0.0005 # 500 us -> initial delay of 1 ms
1525 while True:
1526 (pid, sts) = self._try_wait(os.WNOHANG)
1527 assert pid == self.pid or pid == 0
1528 if pid == self.pid:
1529 self._handle_exitstatus(sts)
1530 break
1531 remaining = self._remaining_time(endtime)
1532 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001533 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001534 delay = min(delay * 2, remaining, .05)
1535 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001536 else:
1537 while self.returncode is None:
1538 (pid, sts) = self._try_wait(0)
1539 # Check the pid and loop as waitpid has been known to return
1540 # 0 even without WNOHANG in odd situations. issue14396.
1541 if pid == self.pid:
1542 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001543 return self.returncode
1544
1545
Reid Kleckner2b228f02011-03-16 16:57:54 -04001546 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001547 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001548 # Flush stdio buffer. This might block, if the user has
1549 # been writing to .stdin in an uncontrolled fashion.
1550 self.stdin.flush()
1551 if not input:
1552 self.stdin.close()
1553
1554 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001555 stdout, stderr = self._communicate_with_poll(input, endtime,
1556 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001557 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001558 stdout, stderr = self._communicate_with_select(input, endtime,
1559 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001560
1561 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001562
1563 # All data exchanged. Translate lists into strings.
1564 if stdout is not None:
1565 stdout = b''.join(stdout)
1566 if stderr is not None:
1567 stderr = b''.join(stderr)
1568
1569 # Translate newlines, if requested.
1570 # This also turns bytes into strings.
1571 if self.universal_newlines:
1572 if stdout is not None:
1573 stdout = self._translate_newlines(stdout,
1574 self.stdout.encoding)
1575 if stderr is not None:
1576 stderr = self._translate_newlines(stderr,
1577 self.stderr.encoding)
1578
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001579 return (stdout, stderr)
1580
1581
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001582 def _save_input(self, input):
1583 # This method is called from the _communicate_with_*() methods
1584 # so that if we time out while communicating, we can continue
1585 # sending input if we retry.
1586 if self.stdin and self._input is None:
1587 self._input_offset = 0
1588 self._input = input
1589 if self.universal_newlines and input is not None:
1590 self._input = self._input.encode(self.stdin.encoding)
1591
1592
Reid Kleckner2b228f02011-03-16 16:57:54 -04001593 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001594 stdout = None # Return
1595 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596
1597 if not self._communication_started:
1598 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001599
1600 poller = select.poll()
1601 def register_and_append(file_obj, eventmask):
1602 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001603 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001604
1605 def close_unregister_and_remove(fd):
1606 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001607 self._fd2file[fd].close()
1608 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001609
1610 if self.stdin and input:
1611 register_and_append(self.stdin, select.POLLOUT)
1612
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001613 # Only create this mapping if we haven't already.
1614 if not self._communication_started:
1615 self._fd2output = {}
1616 if self.stdout:
1617 self._fd2output[self.stdout.fileno()] = []
1618 if self.stderr:
1619 self._fd2output[self.stderr.fileno()] = []
1620
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001621 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1622 if self.stdout:
1623 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001624 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001625 if self.stderr:
1626 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001627 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001628
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001629 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001630
1631 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001632 timeout = self._remaining_time(endtime)
1633 if timeout is not None and timeout < 0:
1634 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001635 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001636 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001637 except select.error as e:
1638 if e.args[0] == errno.EINTR:
1639 continue
1640 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001641 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001642
1643 # XXX Rewrite these to use non-blocking I/O on the
1644 # file objects; they are no longer using C stdio!
1645
1646 for fd, mode in ready:
1647 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001648 chunk = self._input[self._input_offset :
1649 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001650 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001651 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001652 except OSError as e:
1653 if e.errno == errno.EPIPE:
1654 close_unregister_and_remove(fd)
1655 else:
1656 raise
1657 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001658 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001659 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001660 elif mode & select_POLLIN_POLLPRI:
1661 data = os.read(fd, 4096)
1662 if not data:
1663 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001664 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001665 else:
1666 # Ignore hang up or errors.
1667 close_unregister_and_remove(fd)
1668
1669 return (stdout, stderr)
1670
1671
Reid Kleckner2b228f02011-03-16 16:57:54 -04001672 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001673 if not self._communication_started:
1674 self._read_set = []
1675 self._write_set = []
1676 if self.stdin and input:
1677 self._write_set.append(self.stdin)
1678 if self.stdout:
1679 self._read_set.append(self.stdout)
1680 if self.stderr:
1681 self._read_set.append(self.stderr)
1682
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001683 self._save_input(input)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001684
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001685 stdout = None # Return
1686 stderr = None # Return
1687
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001688 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001689 if not self._communication_started:
1690 self._stdout_buff = []
1691 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001692 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001693 if not self._communication_started:
1694 self._stderr_buff = []
1695 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001696
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001697 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001698 timeout = self._remaining_time(endtime)
1699 if timeout is not None and timeout < 0:
1700 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001701 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001702 (rlist, wlist, xlist) = \
1703 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001704 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001705 except select.error as e:
1706 if e.args[0] == errno.EINTR:
1707 continue
1708 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001709
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001710 # According to the docs, returning three empty lists indicates
1711 # that the timeout expired.
1712 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001713 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001714 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001715 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001716
Guido van Rossum98297ee2007-11-06 21:34:58 +00001717 # XXX Rewrite these to use non-blocking I/O on the
1718 # file objects; they are no longer using C stdio!
1719
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001720 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001721 chunk = self._input[self._input_offset :
1722 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001723 try:
1724 bytes_written = os.write(self.stdin.fileno(), chunk)
1725 except OSError as e:
1726 if e.errno == errno.EPIPE:
1727 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001728 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001729 else:
1730 raise
1731 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001732 self._input_offset += bytes_written
1733 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001734 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001735 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001736
1737 if self.stdout in rlist:
1738 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001739 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001740 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001741 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742 stdout.append(data)
1743
1744 if self.stderr in rlist:
1745 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001746 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001747 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001748 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001749 stderr.append(data)
1750
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001751 return (stdout, stderr)
1752
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001753
Christian Heimesa342c012008-04-20 21:01:16 +00001754 def send_signal(self, sig):
1755 """Send a signal to the process
1756 """
1757 os.kill(self.pid, sig)
1758
1759 def terminate(self):
1760 """Terminate the process with SIGTERM
1761 """
1762 self.send_signal(signal.SIGTERM)
1763
1764 def kill(self):
1765 """Kill the process with SIGKILL
1766 """
1767 self.send_signal(signal.SIGKILL)