blob: db64588697c13ff6c0e1990bb81b368651389230 [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001# subprocess - Subprocesses with accessible I/O streams
2#
Tim Peterse718f612004-10-12 21:51:32 +00003# For more information about this module, see PEP 324.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00004#
Peter Astrand3a708df2005-09-23 17:37:29 +00005# Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00006#
Peter Astrand69bf13f2005-02-14 08:56:32 +00007# Licensed to PSF under a Contributor Agreement.
Peter Astrand3a708df2005-09-23 17:37:29 +00008# See http://www.python.org/2.4/license for licensing details.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009
Raymond Hettinger837dd932004-10-17 16:36:53 +000010r"""subprocess - Subprocesses with accessible I/O streams
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000011
Fredrik Lundh15aaacc2004-10-17 14:47:05 +000012This module allows you to spawn processes, connect to their
13input/output/error pipes, and obtain their return codes. This module
14intends to replace several other, older modules and functions, like:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000015
16os.system
17os.spawn*
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000018
19Information about how the subprocess module can be used to replace these
20modules and functions can be found below.
21
22
23
24Using the subprocess module
25===========================
26This module defines one class called Popen:
27
28class Popen(args, bufsize=0, executable=None,
29 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000030 preexec_fn=None, close_fds=True, shell=False,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000031 cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000032 startupinfo=None, creationflags=0,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000033 restore_signals=True, start_new_session=False, pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000034
35
36Arguments are:
37
38args should be a string, or a sequence of program arguments. The
39program to execute is normally the first item in the args sequence or
40string, but can be explicitly set by using the executable argument.
41
Gregory P. Smithf5604852010-12-13 06:45:02 +000042On POSIX, with shell=False (default): In this case, the Popen class
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000043uses os.execvp() to execute the child program. args should normally
44be a sequence. A string will be treated as a sequence with the string
45as the only item (the program to execute).
46
Gregory P. Smithf5604852010-12-13 06:45:02 +000047On POSIX, with shell=True: If args is a string, it specifies the
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000048command string to execute through the shell. If args is a sequence,
49the first item specifies the command string, and any additional items
50will be treated as additional shell arguments.
51
52On Windows: the Popen class uses CreateProcess() to execute the child
53program, which operates on strings. If args is a sequence, it will be
54converted to a string using the list2cmdline method. Please note that
55not all MS Windows applications interpret the command line the same
56way: The list2cmdline is designed for applications using the same
57rules as the MS C runtime.
58
59bufsize, if given, has the same meaning as the corresponding argument
60to the built-in open() function: 0 means unbuffered, 1 means line
61buffered, any other positive value means use a buffer of
62(approximately) that size. A negative bufsize means to use the system
63default, which usually means fully buffered. The default value for
64bufsize is 0 (unbuffered).
65
66stdin, stdout and stderr specify the executed programs' standard
67input, standard output and standard error file handles, respectively.
68Valid values are PIPE, an existing file descriptor (a positive
69integer), an existing file object, and None. PIPE indicates that a
70new pipe to the child should be created. With None, no redirection
71will occur; the child's file handles will be inherited from the
72parent. Additionally, stderr can be STDOUT, which indicates that the
73stderr data from the applications should be captured into the same
74file handle as for stdout.
75
Gregory P. Smithf5604852010-12-13 06:45:02 +000076On POSIX, if preexec_fn is set to a callable object, this object will be
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000077called in the child process just before the child is executed. The use
78of preexec_fn is not thread safe, using it in the presence of threads
79could lead to a deadlock in the child process before the new executable
80is executed.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000081
82If close_fds is true, all file descriptors except 0, 1 and 2 will be
Gregory P. Smithf5604852010-12-13 06:45:02 +000083closed before the child process is executed. The default for close_fds
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000084varies by platform: Always true on POSIX. True when stdin/stdout/stderr
85are None on Windows, false otherwise.
86
87pass_fds is an optional sequence of file descriptors to keep open between the
88parent and child. Providing any pass_fds implicitly sets close_fds to true.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000089
90if shell is true, the specified command will be executed through the
91shell.
92
93If cwd is not None, the current directory will be changed to cwd
94before the child is executed.
95
Gregory P. Smithf5604852010-12-13 06:45:02 +000096On POSIX, if restore_signals is True all signals that Python sets to
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000097SIG_IGN are restored to SIG_DFL in the child process before the exec.
98Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. This
99parameter does nothing on Windows.
100
Gregory P. Smithf5604852010-12-13 06:45:02 +0000101On POSIX, if start_new_session is True, the setsid() system call will be made
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000102in the child process prior to executing the command.
103
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000104If env is not None, it defines the environment variables for the new
105process.
106
107If universal_newlines is true, the file objects stdout and stderr are
108opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000109the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110'\r\n', the Windows convention. All of these external representations
111are seen as '\n' by the Python program. Note: This feature is only
112available if Python is built with universal newline support (the
113default). Also, the newlines attribute of the file objects stdout,
114stdin and stderr are not updated by the communicate() method.
115
116The startupinfo and creationflags, if given, will be passed to the
117underlying CreateProcess() function. They can specify things such as
118appearance of the main window and priority for the new process.
119(Windows only)
120
121
Georg Brandlf9734072008-12-07 15:30:06 +0000122This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000123
Peter Astrand5f5e1412004-12-05 20:15:36 +0000124call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125 Run command with arguments. Wait for command to complete, then
126 return the returncode attribute.
127
128 The arguments are the same as for the Popen constructor. Example:
129
Florent Xicluna4886d242010-03-08 13:27:26 +0000130 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131
Peter Astrand454f7672005-01-01 09:36:35 +0000132check_call(*popenargs, **kwargs):
133 Run command with arguments. Wait for command to complete. If the
134 exit code was zero then return, otherwise raise
135 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000136 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000137
138 The arguments are the same as for the Popen constructor. Example:
139
Florent Xicluna4886d242010-03-08 13:27:26 +0000140 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000141 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000142
Brett Cannona23810f2008-05-26 19:04:21 +0000143getstatusoutput(cmd):
144 Return (status, output) of executing cmd in a shell.
145
146 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
147 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
148 returned output will contain output or error messages. A trailing newline
149 is stripped from the output. The exit status for the command can be
150 interpreted according to the rules for the C function wait(). Example:
151
Brett Cannona23810f2008-05-26 19:04:21 +0000152 >>> subprocess.getstatusoutput('ls /bin/ls')
153 (0, '/bin/ls')
154 >>> subprocess.getstatusoutput('cat /bin/junk')
155 (256, 'cat: /bin/junk: No such file or directory')
156 >>> subprocess.getstatusoutput('/bin/junk')
157 (256, 'sh: /bin/junk: not found')
158
159getoutput(cmd):
160 Return output (stdout or stderr) of executing cmd in a shell.
161
162 Like getstatusoutput(), except the exit status is ignored and the return
163 value is a string containing the command's output. Example:
164
Brett Cannona23810f2008-05-26 19:04:21 +0000165 >>> subprocess.getoutput('ls /bin/ls')
166 '/bin/ls'
167
Georg Brandlf9734072008-12-07 15:30:06 +0000168check_output(*popenargs, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000169 Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000170
Georg Brandl2708f3a2009-12-20 14:38:23 +0000171 If the exit code was non-zero it raises a CalledProcessError. The
172 CalledProcessError object will have the return code in the returncode
173 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000174
Georg Brandl2708f3a2009-12-20 14:38:23 +0000175 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Brett Cannona23810f2008-05-26 19:04:21 +0000179
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000180Exceptions
181----------
182Exceptions raised in the child process, before the new program has
183started to execute, will be re-raised in the parent. Additionally,
184the exception object will have one extra attribute called
185'child_traceback', which is a string containing traceback information
186from the childs point of view.
187
188The most common exception raised is OSError. This occurs, for
189example, when trying to execute a non-existent file. Applications
190should prepare for OSErrors.
191
192A ValueError will be raised if Popen is called with invalid arguments.
193
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400194Exceptions defined within this module inherit from SubprocessError.
195check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400196called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400197be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000198
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000199
200Security
201--------
202Unlike some other popen functions, this implementation will never call
203/bin/sh implicitly. This means that all characters, including shell
204metacharacters, can safely be passed to child processes.
205
206
207Popen objects
208=============
209Instances of the Popen class have the following methods:
210
211poll()
212 Check if child process has terminated. Returns returncode
213 attribute.
214
215wait()
216 Wait for child process to terminate. Returns returncode attribute.
217
218communicate(input=None)
219 Interact with process: Send data to stdin. Read data from stdout
220 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000221 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000222 sent to the child process, or None, if no data should be sent to
223 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000224
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225 communicate() returns a tuple (stdout, stderr).
226
227 Note: The data read is buffered in memory, so do not use this
228 method if the data size is large or unlimited.
229
230The following attributes are also available:
231
232stdin
233 If the stdin argument is PIPE, this attribute is a file object
234 that provides input to the child process. Otherwise, it is None.
235
236stdout
237 If the stdout argument is PIPE, this attribute is a file object
238 that provides output from the child process. Otherwise, it is
239 None.
240
241stderr
242 If the stderr argument is PIPE, this attribute is file object that
243 provides error output from the child process. Otherwise, it is
244 None.
245
246pid
247 The process ID of the child process.
248
249returncode
250 The child return code. A None value indicates that the process
251 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000252 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000253
254
255Replacing older functions with the subprocess module
256====================================================
257In this section, "a ==> b" means that b can be used as a replacement
258for a.
259
260Note: All functions in this section fail (more or less) silently if
261the executed program cannot be found; this module raises an OSError
262exception.
263
264In the following examples, we assume that the subprocess module is
265imported with "from subprocess import *".
266
267
268Replacing /bin/sh shell backquote
269---------------------------------
270output=`mycmd myarg`
271==>
272output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
273
274
275Replacing shell pipe line
276-------------------------
277output=`dmesg | grep hda`
278==>
279p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000280p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000281output = p2.communicate()[0]
282
283
284Replacing os.system()
285---------------------
286sts = os.system("mycmd" + " myarg")
287==>
288p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000289pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000290
291Note:
292
293* Calling the program through the shell is usually not required.
294
295* It's easier to look at the returncode attribute than the
296 exitstatus.
297
298A more real-world example would look like this:
299
300try:
301 retcode = call("mycmd" + " myarg", shell=True)
302 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000303 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000304 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000305 print("Child returned", retcode, file=sys.stderr)
306except OSError as e:
307 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000308
309
310Replacing os.spawn*
311-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000312P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000313
314pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
315==>
316pid = Popen(["/bin/mycmd", "myarg"]).pid
317
318
319P_WAIT example:
320
321retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
322==>
323retcode = call(["/bin/mycmd", "myarg"])
324
325
Tim Peterse718f612004-10-12 21:51:32 +0000326Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000327
328os.spawnvp(os.P_NOWAIT, path, args)
329==>
330Popen([path] + args[1:])
331
332
Tim Peterse718f612004-10-12 21:51:32 +0000333Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000334
335os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
336==>
337Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000338"""
339
340import sys
341mswindows = (sys.platform == "win32")
342
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000343import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000344import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400345import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000346import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000347import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000348import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000349import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000350import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200351import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000352
Peter Astrand454f7672005-01-01 09:36:35 +0000353# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400354class SubprocessError(Exception): pass
355
356
357class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000358 """This exception is raised when a process run by check_call() or
359 check_output() returns a non-zero exit status.
360 The exit status will be stored in the returncode attribute;
361 check_output() will also store the output in the output attribute.
362 """
363 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000364 self.returncode = returncode
365 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000366 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000367 def __str__(self):
368 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
369
Peter Astrand454f7672005-01-01 09:36:35 +0000370
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400371class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400372 """This exception is raised when the timeout expires while waiting for a
373 child process.
374 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400375 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400376 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400377 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400378 self.output = output
379
380 def __str__(self):
381 return ("Command '%s' timed out after %s seconds" %
382 (self.cmd, self.timeout))
383
384
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000385if mswindows:
386 import threading
387 import msvcrt
Brian Curtin1ce6b582010-04-24 16:19:22 +0000388 import _subprocess
389 class STARTUPINFO:
390 dwFlags = 0
391 hStdInput = None
392 hStdOutput = None
393 hStdError = None
394 wShowWindow = 0
395 class pywintypes:
396 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000397else:
398 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000399 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700400 import _posixsubprocess
401 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000402
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000403 # When select or poll has indicated that the file is writable,
404 # we can write up to _PIPE_BUF bytes without risk of blocking.
405 # POSIX defines PIPE_BUF as >= 512.
406 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
407
408
Brett Cannona23810f2008-05-26 19:04:21 +0000409__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200410 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000411
Brian Curtin1ce6b582010-04-24 16:19:22 +0000412if mswindows:
Brian Curtin08fd8d92011-04-29 16:11:30 -0500413 from _subprocess import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500414 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
415 STD_ERROR_HANDLE, SW_HIDE,
416 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500417
Brian Curtin08fd8d92011-04-29 16:11:30 -0500418 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500419 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
420 "STD_ERROR_HANDLE", "SW_HIDE",
421 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000422try:
423 MAXFD = os.sysconf("SC_OPEN_MAX")
424except:
425 MAXFD = 256
426
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200427# This lists holds Popen instances for which the underlying process had not
428# exited at the time its __del__ method got called: those processes are wait()ed
429# for synchronously from _cleanup() when a new Popen object is created, to avoid
430# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000431_active = []
432
433def _cleanup():
434 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000435 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200436 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000437 try:
438 _active.remove(inst)
439 except ValueError:
440 # This can happen if two threads create a new Popen instance.
441 # It's harmless that it was already removed, so ignore.
442 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000443
444PIPE = -1
445STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200446DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000447
448
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000449def _eintr_retry_call(func, *args):
450 while True:
451 try:
452 return func(*args)
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200453 except (OSError, IOError) as e:
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000454 if e.errno == errno.EINTR:
455 continue
456 raise
457
458
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400459def call(*popenargs, timeout=None, **kwargs):
460 """Run command with arguments. Wait for command to complete or
461 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000462
463 The arguments are the same as for the Popen constructor. Example:
464
465 retcode = call(["ls", "-l"])
466 """
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400467 p = Popen(*popenargs, **kwargs)
468 try:
469 return p.wait(timeout=timeout)
470 except TimeoutExpired:
471 p.kill()
472 p.wait()
473 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000474
475
Peter Astrand454f7672005-01-01 09:36:35 +0000476def check_call(*popenargs, **kwargs):
477 """Run command with arguments. Wait for command to complete. If
478 the exit code was zero then return, otherwise raise
479 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000480 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000481
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400482 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000483
484 check_call(["ls", "-l"])
485 """
486 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000487 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000488 cmd = kwargs.get("args")
489 if cmd is None:
490 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000491 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000492 return 0
493
494
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400495def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000496 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000497
498 If the exit code was non-zero it raises a CalledProcessError. The
499 CalledProcessError object will have the return code in the returncode
500 attribute and output in the output attribute.
501
502 The arguments are the same as for the Popen constructor. Example:
503
504 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000505 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000506
507 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000508 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000509
510 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000511 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000512 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000513 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000514 """
515 if 'stdout' in kwargs:
516 raise ValueError('stdout argument not allowed, it will be overridden.')
517 process = Popen(*popenargs, stdout=PIPE, **kwargs)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400518 try:
519 output, unused_err = process.communicate(timeout=timeout)
520 except TimeoutExpired:
521 process.kill()
522 output, unused_err = process.communicate()
Reid Kleckner2b228f02011-03-16 16:57:54 -0400523 raise TimeoutExpired(process.args, timeout, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000524 retcode = process.poll()
525 if retcode:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400526 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000527 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000528
529
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000530def list2cmdline(seq):
531 """
532 Translate a sequence of arguments into a command line
533 string, using the same rules as the MS C runtime:
534
535 1) Arguments are delimited by white space, which is either a
536 space or a tab.
537
538 2) A string surrounded by double quotation marks is
539 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000540 contained within. A quoted string can be embedded in an
541 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000542
543 3) A double quotation mark preceded by a backslash is
544 interpreted as a literal double quotation mark.
545
546 4) Backslashes are interpreted literally, unless they
547 immediately precede a double quotation mark.
548
549 5) If backslashes immediately precede a double quotation mark,
550 every pair of backslashes is interpreted as a literal
551 backslash. If the number of backslashes is odd, the last
552 backslash escapes the next double quotation mark as
553 described in rule 3.
554 """
555
556 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000557 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
558 # or search http://msdn.microsoft.com for
559 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000560 result = []
561 needquote = False
562 for arg in seq:
563 bs_buf = []
564
565 # Add a space to separate this argument from the others
566 if result:
567 result.append(' ')
568
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000569 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000570 if needquote:
571 result.append('"')
572
573 for c in arg:
574 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000575 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000576 bs_buf.append(c)
577 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000578 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000579 result.append('\\' * len(bs_buf)*2)
580 bs_buf = []
581 result.append('\\"')
582 else:
583 # Normal char
584 if bs_buf:
585 result.extend(bs_buf)
586 bs_buf = []
587 result.append(c)
588
Christian Heimesfdab48e2008-01-20 09:06:41 +0000589 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000590 if bs_buf:
591 result.extend(bs_buf)
592
593 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000594 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000595 result.append('"')
596
597 return ''.join(result)
598
599
Brett Cannona23810f2008-05-26 19:04:21 +0000600# Various tools for executing commands and looking at their output and status.
601#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000602# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000603
604def getstatusoutput(cmd):
605 """Return (status, output) of executing cmd in a shell.
606
607 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
608 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
609 returned output will contain output or error messages. A trailing newline
610 is stripped from the output. The exit status for the command can be
611 interpreted according to the rules for the C function wait(). Example:
612
613 >>> import subprocess
614 >>> subprocess.getstatusoutput('ls /bin/ls')
615 (0, '/bin/ls')
616 >>> subprocess.getstatusoutput('cat /bin/junk')
617 (256, 'cat: /bin/junk: No such file or directory')
618 >>> subprocess.getstatusoutput('/bin/junk')
619 (256, 'sh: /bin/junk: not found')
620 """
621 pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
622 text = pipe.read()
623 sts = pipe.close()
624 if sts is None: sts = 0
625 if text[-1:] == '\n': text = text[:-1]
626 return sts, text
627
628
629def getoutput(cmd):
630 """Return output (stdout or stderr) of executing cmd in a shell.
631
632 Like getstatusoutput(), except the exit status is ignored and the return
633 value is a string containing the command's output. Example:
634
635 >>> import subprocess
636 >>> subprocess.getoutput('ls /bin/ls')
637 '/bin/ls'
638 """
639 return getstatusoutput(cmd)[1]
640
641
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000642_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000643
644
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000645class Popen(object):
646 def __init__(self, args, bufsize=0, executable=None,
647 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000648 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
649 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000650 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000651 restore_signals=True, start_new_session=False,
652 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000653 """Create new Popen instance."""
654 _cleanup()
655
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000656 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400657 self._input = None
658 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000659 if bufsize is None:
660 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000661 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000662 raise TypeError("bufsize must be an integer")
663
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000664 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000665 if preexec_fn is not None:
666 raise ValueError("preexec_fn is not supported on Windows "
667 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000668 any_stdio_set = (stdin is not None or stdout is not None or
669 stderr is not None)
670 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
671 if any_stdio_set:
672 close_fds = False
673 else:
674 close_fds = True
675 elif close_fds and any_stdio_set:
676 raise ValueError(
677 "close_fds is not supported on Windows platforms"
678 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000679 else:
680 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000681 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
682 close_fds = True
683 if pass_fds and not close_fds:
684 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
685 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000686 if startupinfo is not None:
687 raise ValueError("startupinfo is only supported on Windows "
688 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000689 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000690 raise ValueError("creationflags is only supported on Windows "
691 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000692
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400693 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000694 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000695 self.stdout = None
696 self.stderr = None
697 self.pid = None
698 self.returncode = None
699 self.universal_newlines = universal_newlines
700
701 # Input and output objects. The general principle is like
702 # this:
703 #
704 # Parent Child
705 # ------ -----
706 # p2cwrite ---stdin---> p2cread
707 # c2pread <--stdout--- c2pwrite
708 # errread <--stderr--- errwrite
709 #
710 # On POSIX, the child objects are file descriptors. On
711 # Windows, these are Windows file handles. The parent objects
712 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000713 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000714 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000715
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000716 (p2cread, p2cwrite,
717 c2pread, c2pwrite,
718 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
719
Antoine Pitrouc9982322011-01-04 19:07:07 +0000720 # We wrap OS handles *before* launching the child, otherwise a
721 # quickly terminating child could make our fds unwrappable
722 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000723
Thomas Wouterscf297e42007-02-23 15:07:44 +0000724 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000725 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000726 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000727 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000728 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000729 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000730 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000731
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000732 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000733 self.stdin = io.open(p2cwrite, 'wb', bufsize)
734 if self.universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200735 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000736 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000737 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000738 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000739 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000740 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000741 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000742 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000743 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000744
Antoine Pitrouc9982322011-01-04 19:07:07 +0000745 try:
746 self._execute_child(args, executable, preexec_fn, close_fds,
747 pass_fds, cwd, env, universal_newlines,
748 startupinfo, creationflags, shell,
749 p2cread, p2cwrite,
750 c2pread, c2pwrite,
751 errread, errwrite,
752 restore_signals, start_new_session)
753 except:
754 # Cleanup if the child failed starting
755 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
756 try:
757 f.close()
758 except EnvironmentError:
759 # Ignore EBADF or other errors
760 pass
761 raise
762
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000763
Guido van Rossum98297ee2007-11-06 21:34:58 +0000764 def _translate_newlines(self, data, encoding):
765 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
766 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000767
Brian Curtin79cdb662010-12-03 02:46:02 +0000768 def __enter__(self):
769 return self
770
771 def __exit__(self, type, value, traceback):
772 if self.stdout:
773 self.stdout.close()
774 if self.stderr:
775 self.stderr.close()
776 if self.stdin:
777 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700778 # Wait for the process to terminate, to avoid zombies.
779 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000780
Brett Cannon84df1e62010-05-14 00:33:40 +0000781 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200782 # If __init__ hasn't had a chance to execute (e.g. if it
783 # was passed an undeclared keyword argument), we don't
784 # have a _child_created attribute at all.
785 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000786 # We didn't get to successfully create a child process.
787 return
788 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000789 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000790 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000791 # Child is still running, keep us alive until we can wait on it.
792 _active.append(self)
793
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200794 def _get_devnull(self):
795 if not hasattr(self, '_devnull'):
796 self._devnull = os.open(os.devnull, os.O_RDWR)
797 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000798
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400799 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000800 """Interact with process: Send data to stdin. Read data from
801 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700802 process to terminate. The optional input argument should be
803 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000804 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000805
Peter Astrand23109f02005-03-03 20:28:59 +0000806 communicate() returns a tuple (stdout, stderr)."""
807
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400808 if self._communication_started and input:
809 raise ValueError("Cannot send input after starting communication")
810
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400811 # Optimization: If we are not worried about timeouts, we haven't
812 # started communicating, and we have one or zero pipes, using select()
813 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200814 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400815 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000816 stdout = None
817 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000818 if self.stdin:
819 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200820 try:
821 self.stdin.write(input)
822 except IOError as e:
823 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
824 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000825 self.stdin.close()
826 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200827 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000828 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000829 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200830 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000831 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000832 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200833 else:
834 if timeout is not None:
835 endtime = time.time() + timeout
836 else:
837 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000838
Victor Stinner7a8d0812011-04-05 13:13:08 +0200839 try:
840 stdout, stderr = self._communicate(input, endtime, timeout)
841 finally:
842 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400843
Victor Stinner7a8d0812011-04-05 13:13:08 +0200844 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400845
846 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000847
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000848
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000849 def poll(self):
850 return self._internal_poll()
851
852
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400853 def _remaining_time(self, endtime):
854 """Convenience for _communicate when computing timeouts."""
855 if endtime is None:
856 return None
857 else:
858 return endtime - time.time()
859
860
Reid Kleckner2b228f02011-03-16 16:57:54 -0400861 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400862 """Convenience for checking if a timeout has expired."""
863 if endtime is None:
864 return
865 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400866 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400867
868
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000869 if mswindows:
870 #
871 # Windows methods
872 #
873 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000874 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000875 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
876 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000877 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000878 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000879
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000880 p2cread, p2cwrite = -1, -1
881 c2pread, c2pwrite = -1, -1
882 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000883
Peter Astrandd38ddf42005-02-10 08:32:50 +0000884 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000885 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000886 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000887 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000888 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000889 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200890 elif stdin == DEVNULL:
891 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000892 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000893 p2cread = msvcrt.get_osfhandle(stdin)
894 else:
895 # Assuming file-like object
896 p2cread = msvcrt.get_osfhandle(stdin.fileno())
897 p2cread = self._make_inheritable(p2cread)
898
Peter Astrandd38ddf42005-02-10 08:32:50 +0000899 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000900 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000901 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000902 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000903 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000904 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200905 elif stdout == DEVNULL:
906 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000907 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000908 c2pwrite = msvcrt.get_osfhandle(stdout)
909 else:
910 # Assuming file-like object
911 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
912 c2pwrite = self._make_inheritable(c2pwrite)
913
Peter Astrandd38ddf42005-02-10 08:32:50 +0000914 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000915 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000916 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000917 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000918 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000919 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000920 elif stderr == STDOUT:
921 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200922 elif stderr == DEVNULL:
923 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000924 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000925 errwrite = msvcrt.get_osfhandle(stderr)
926 else:
927 # Assuming file-like object
928 errwrite = msvcrt.get_osfhandle(stderr.fileno())
929 errwrite = self._make_inheritable(errwrite)
930
931 return (p2cread, p2cwrite,
932 c2pread, c2pwrite,
933 errread, errwrite)
934
935
936 def _make_inheritable(self, handle):
937 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000938 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
939 handle, _subprocess.GetCurrentProcess(), 0, 1,
940 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000941
942
943 def _find_w9xpopen(self):
944 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000945 w9xpopen = os.path.join(
946 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000947 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000948 if not os.path.exists(w9xpopen):
949 # Eeek - file-not-found - possibly an embedding
950 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000951 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
952 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000953 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000954 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
955 "needed for Popen to work with your "
956 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000957 return w9xpopen
958
Tim Peterse718f612004-10-12 21:51:32 +0000959
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000960 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000961 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000962 startupinfo, creationflags, shell,
963 p2cread, p2cwrite,
964 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000965 errread, errwrite,
966 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000967 """Execute program (MS Windows version)"""
968
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000969 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000970
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000971 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000972 args = list2cmdline(args)
973
Peter Astrandc1d65362004-11-07 14:30:34 +0000974 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000975 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000976 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000977 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000978 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000979 startupinfo.hStdInput = p2cread
980 startupinfo.hStdOutput = c2pwrite
981 startupinfo.hStdError = errwrite
982
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000983 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000984 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
985 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000986 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000987 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000988 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000989 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000990 # Win9x, or using command.com on NT. We need to
991 # use the w9xpopen intermediate program. For more
992 # information, see KB Q150956
993 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
994 w9xpopen = self._find_w9xpopen()
995 args = '"%s" %s' % (w9xpopen, args)
996 # Not passing CREATE_NEW_CONSOLE has been known to
997 # cause random failures on win9x. Specifically a
998 # dialog: "Your program accessed mem currently in
999 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001000 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001001 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001002 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001003
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001004 # Start the process
1005 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001006 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001007 # no special security
1008 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001009 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001010 creationflags,
1011 env,
1012 cwd,
1013 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001014 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001015 # Translate pywintypes.error to WindowsError, which is
1016 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001017 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001018 # how can this be done from Python?
1019 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001020 finally:
1021 # Child is launched. Close the parent's copy of those pipe
1022 # handles that only the child should have open. You need
1023 # to make sure that no handles to the write end of the
1024 # output pipe are maintained in this process or else the
1025 # pipe will not close when the child process exits and the
1026 # ReadFile will hang.
1027 if p2cread != -1:
1028 p2cread.Close()
1029 if c2pwrite != -1:
1030 c2pwrite.Close()
1031 if errwrite != -1:
1032 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001033 if hasattr(self, '_devnull'):
1034 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001035
1036 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001037 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001038 self._handle = hp
1039 self.pid = pid
1040 ht.Close()
1041
Brett Cannon84df1e62010-05-14 00:33:40 +00001042 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001043 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1044 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1045 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001046 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001047 attribute.
1048
1049 This method is called by __del__, so it can only refer to objects
1050 in its local scope.
1051
1052 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001053 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001054 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1055 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 return self.returncode
1057
1058
Reid Kleckner2b228f02011-03-16 16:57:54 -04001059 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001060 """Wait for child process to terminate. Returns returncode
1061 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001062 if endtime is not None:
1063 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001064 if timeout is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001065 timeout_millis = _subprocess.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001066 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001067 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001068 if self.returncode is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001069 result = _subprocess.WaitForSingleObject(self._handle,
1070 timeout_millis)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001071 if result == _subprocess.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001072 raise TimeoutExpired(self.args, timeout)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001073 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001074 return self.returncode
1075
1076
1077 def _readerthread(self, fh, buffer):
1078 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001079 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001080
1081
Reid Kleckner2b228f02011-03-16 16:57:54 -04001082 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001083 # Start reader threads feeding into a list hanging off of this
1084 # object, unless they've already been started.
1085 if self.stdout and not hasattr(self, "_stdout_buff"):
1086 self._stdout_buff = []
1087 self.stdout_thread = \
1088 threading.Thread(target=self._readerthread,
1089 args=(self.stdout, self._stdout_buff))
1090 self.stdout_thread.daemon = True
1091 self.stdout_thread.start()
1092 if self.stderr and not hasattr(self, "_stderr_buff"):
1093 self._stderr_buff = []
1094 self.stderr_thread = \
1095 threading.Thread(target=self._readerthread,
1096 args=(self.stderr, self._stderr_buff))
1097 self.stderr_thread.daemon = True
1098 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001099
1100 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001101 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001102 try:
1103 self.stdin.write(input)
1104 except IOError as e:
1105 if e.errno != errno.EPIPE:
1106 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001107 self.stdin.close()
1108
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001109 # Wait for the reader threads, or time out. If we time out, the
1110 # threads remain reading and the fds left open in case the user
1111 # calls communicate again.
1112 if self.stdout is not None:
1113 self.stdout_thread.join(self._remaining_time(endtime))
1114 if self.stdout_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001115 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001116 if self.stderr is not None:
1117 self.stderr_thread.join(self._remaining_time(endtime))
1118 if self.stderr_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001119 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001120
1121 # Collect the output from and close both pipes, now that we know
1122 # both have been read successfully.
1123 stdout = None
1124 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001125 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001126 stdout = self._stdout_buff
1127 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001128 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001129 stderr = self._stderr_buff
1130 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001131
1132 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001133 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001134 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001135 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001136 stderr = stderr[0]
1137
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 return (stdout, stderr)
1139
Christian Heimesa342c012008-04-20 21:01:16 +00001140 def send_signal(self, sig):
1141 """Send a signal to the process
1142 """
1143 if sig == signal.SIGTERM:
1144 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001145 elif sig == signal.CTRL_C_EVENT:
1146 os.kill(self.pid, signal.CTRL_C_EVENT)
1147 elif sig == signal.CTRL_BREAK_EVENT:
1148 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001149 else:
Brian Curtin19651362010-09-07 13:24:38 +00001150 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001151
1152 def terminate(self):
1153 """Terminates the process
1154 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001155 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001156
1157 kill = terminate
1158
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001159 else:
1160 #
1161 # POSIX methods
1162 #
1163 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001164 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001165 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1166 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001167 p2cread, p2cwrite = -1, -1
1168 c2pread, c2pwrite = -1, -1
1169 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001170
Peter Astrandd38ddf42005-02-10 08:32:50 +00001171 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172 pass
1173 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001174 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001175 elif stdin == DEVNULL:
1176 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001177 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001178 p2cread = stdin
1179 else:
1180 # Assuming file-like object
1181 p2cread = stdin.fileno()
1182
Peter Astrandd38ddf42005-02-10 08:32:50 +00001183 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001184 pass
1185 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001186 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001187 elif stdout == DEVNULL:
1188 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001189 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001190 c2pwrite = stdout
1191 else:
1192 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001193 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001194
Peter Astrandd38ddf42005-02-10 08:32:50 +00001195 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001196 pass
1197 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001198 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001199 elif stderr == STDOUT:
1200 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001201 elif stderr == DEVNULL:
1202 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001203 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001204 errwrite = stderr
1205 else:
1206 # Assuming file-like object
1207 errwrite = stderr.fileno()
1208
1209 return (p2cread, p2cwrite,
1210 c2pread, c2pwrite,
1211 errread, errwrite)
1212
1213
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001214 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001215 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001216 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001217 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001218 os.closerange(start_fd, fd)
1219 start_fd = fd + 1
1220 if start_fd <= MAXFD:
1221 os.closerange(start_fd, MAXFD)
1222
1223
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001224 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001225 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001226 startupinfo, creationflags, shell,
1227 p2cread, p2cwrite,
1228 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001229 errread, errwrite,
1230 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001231 """Execute program (POSIX version)"""
1232
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001233 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001234 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001235 else:
1236 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237
1238 if shell:
1239 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001240 if executable:
1241 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001242
Peter Astrandd38ddf42005-02-10 08:32:50 +00001243 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244 executable = args[0]
1245
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001246 # For transferring possible exec failure from child to parent.
1247 # Data format: "exception name:hex errno:description"
1248 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001249 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001250 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001252 # We must avoid complex work that could involve
1253 # malloc or free in the child process to avoid
1254 # potential deadlocks, thus we do all this here.
1255 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001256
Victor Stinner372b8382011-06-21 17:24:21 +02001257 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001258 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1259 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001260 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001261 env_list = None # Use execv instead of execve.
1262 executable = os.fsencode(executable)
1263 if os.path.dirname(executable):
1264 executable_list = (executable,)
1265 else:
1266 # This matches the behavior of os._execvpe().
1267 executable_list = tuple(
1268 os.path.join(os.fsencode(dir), executable)
1269 for dir in os.get_exec_path(env))
1270 fds_to_keep = set(pass_fds)
1271 fds_to_keep.add(errpipe_write)
1272 self.pid = _posixsubprocess.fork_exec(
1273 args, executable_list,
1274 close_fds, sorted(fds_to_keep), cwd, env_list,
1275 p2cread, p2cwrite, c2pread, c2pwrite,
1276 errread, errwrite,
1277 errpipe_read, errpipe_write,
1278 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001279 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001280 finally:
1281 # be sure the FD is closed no matter what
1282 os.close(errpipe_write)
1283
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001284 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001285 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001286 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001287 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001288 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001289 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001290 if hasattr(self, '_devnull'):
1291 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001292
1293 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001294 # exception (limited in size)
1295 data = bytearray()
1296 while True:
1297 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1298 data += part
1299 if not part or len(data) > 50000:
1300 break
Facundo Batista10706e22009-06-19 20:34:30 +00001301 finally:
1302 # be sure the FD is closed no matter what
1303 os.close(errpipe_read)
1304
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001305 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001306 try:
1307 _eintr_retry_call(os.waitpid, self.pid, 0)
1308 except OSError as e:
1309 if e.errno != errno.ECHILD:
1310 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001311 try:
1312 exception_name, hex_errno, err_msg = data.split(b':', 2)
1313 except ValueError:
1314 print('Bad exception data:', repr(data))
1315 exception_name = b'RuntimeError'
1316 hex_errno = b'0'
1317 err_msg = b'Unknown'
1318 child_exception_type = getattr(
1319 builtins, exception_name.decode('ascii'),
1320 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001321 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001322 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001323 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001324 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001325 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001326 errno_num = int(hex_errno, 16)
1327 if errno_num != 0:
1328 err_msg = os.strerror(errno_num)
1329 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001330 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001331 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001332 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333
1334
Brett Cannon84df1e62010-05-14 00:33:40 +00001335 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1336 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1337 _WEXITSTATUS=os.WEXITSTATUS):
1338 # This method is called (indirectly) by __del__, so it cannot
1339 # refer to anything outside of its local scope."""
1340 if _WIFSIGNALED(sts):
1341 self.returncode = -_WTERMSIG(sts)
1342 elif _WIFEXITED(sts):
1343 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344 else:
1345 # Should never happen
1346 raise RuntimeError("Unknown child exit status!")
1347
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001348
Brett Cannon84df1e62010-05-14 00:33:40 +00001349 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1350 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001351 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001352 attribute.
1353
1354 This method is called by __del__, so it cannot reference anything
1355 outside of the local scope (nor can any methods it calls).
1356
1357 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001358 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001359 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001360 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001361 if pid == self.pid:
1362 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001363 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001364 if _deadstate is not None:
1365 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001366 return self.returncode
1367
1368
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001369 def _try_wait(self, wait_flags):
1370 try:
1371 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1372 except OSError as e:
1373 if e.errno != errno.ECHILD:
1374 raise
1375 # This happens if SIGCLD is set to be ignored or waiting
1376 # for child processes has otherwise been disabled for our
1377 # process. This child is dead, we can't get the status.
1378 pid = self.pid
1379 sts = 0
1380 return (pid, sts)
1381
1382
1383 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001384 """Wait for child process to terminate. Returns returncode
1385 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001386 if self.returncode is not None:
1387 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001388
1389 # endtime is preferred to timeout. timeout is only used for
1390 # printing.
1391 if endtime is not None or timeout is not None:
1392 if endtime is None:
1393 endtime = time.time() + timeout
1394 elif timeout is None:
1395 timeout = self._remaining_time(endtime)
1396
1397 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001398 # Enter a busy loop if we have a timeout. This busy loop was
1399 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1400 delay = 0.0005 # 500 us -> initial delay of 1 ms
1401 while True:
1402 (pid, sts) = self._try_wait(os.WNOHANG)
1403 assert pid == self.pid or pid == 0
1404 if pid == self.pid:
1405 self._handle_exitstatus(sts)
1406 break
1407 remaining = self._remaining_time(endtime)
1408 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001409 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001410 delay = min(delay * 2, remaining, .05)
1411 time.sleep(delay)
1412 elif self.returncode is None:
1413 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001414 self._handle_exitstatus(sts)
1415 return self.returncode
1416
1417
Reid Kleckner2b228f02011-03-16 16:57:54 -04001418 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001419 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001420 # Flush stdio buffer. This might block, if the user has
1421 # been writing to .stdin in an uncontrolled fashion.
1422 self.stdin.flush()
1423 if not input:
1424 self.stdin.close()
1425
1426 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001427 stdout, stderr = self._communicate_with_poll(input, endtime,
1428 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001429 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001430 stdout, stderr = self._communicate_with_select(input, endtime,
1431 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001432
1433 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001434
1435 # All data exchanged. Translate lists into strings.
1436 if stdout is not None:
1437 stdout = b''.join(stdout)
1438 if stderr is not None:
1439 stderr = b''.join(stderr)
1440
1441 # Translate newlines, if requested.
1442 # This also turns bytes into strings.
1443 if self.universal_newlines:
1444 if stdout is not None:
1445 stdout = self._translate_newlines(stdout,
1446 self.stdout.encoding)
1447 if stderr is not None:
1448 stderr = self._translate_newlines(stderr,
1449 self.stderr.encoding)
1450
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001451 return (stdout, stderr)
1452
1453
Reid Kleckner2b228f02011-03-16 16:57:54 -04001454 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001455 stdout = None # Return
1456 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001457
1458 if not self._communication_started:
1459 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001460
1461 poller = select.poll()
1462 def register_and_append(file_obj, eventmask):
1463 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001464 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001465
1466 def close_unregister_and_remove(fd):
1467 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001468 self._fd2file[fd].close()
1469 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001470
1471 if self.stdin and input:
1472 register_and_append(self.stdin, select.POLLOUT)
1473
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001474 # Only create this mapping if we haven't already.
1475 if not self._communication_started:
1476 self._fd2output = {}
1477 if self.stdout:
1478 self._fd2output[self.stdout.fileno()] = []
1479 if self.stderr:
1480 self._fd2output[self.stderr.fileno()] = []
1481
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001482 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1483 if self.stdout:
1484 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001485 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001486 if self.stderr:
1487 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001488 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001489
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001490 # Save the input here so that if we time out while communicating,
1491 # we can continue sending input if we retry.
1492 if self.stdin and self._input is None:
1493 self._input_offset = 0
1494 self._input = input
1495 if self.universal_newlines:
1496 self._input = self._input.encode(self.stdin.encoding)
1497
1498 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001499 timeout = self._remaining_time(endtime)
1500 if timeout is not None and timeout < 0:
1501 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001502 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001503 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001504 except select.error as e:
1505 if e.args[0] == errno.EINTR:
1506 continue
1507 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001508 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001509
1510 # XXX Rewrite these to use non-blocking I/O on the
1511 # file objects; they are no longer using C stdio!
1512
1513 for fd, mode in ready:
1514 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001515 chunk = self._input[self._input_offset :
1516 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001517 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001518 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001519 except OSError as e:
1520 if e.errno == errno.EPIPE:
1521 close_unregister_and_remove(fd)
1522 else:
1523 raise
1524 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001525 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001526 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001527 elif mode & select_POLLIN_POLLPRI:
1528 data = os.read(fd, 4096)
1529 if not data:
1530 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001531 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001532 else:
1533 # Ignore hang up or errors.
1534 close_unregister_and_remove(fd)
1535
1536 return (stdout, stderr)
1537
1538
Reid Kleckner2b228f02011-03-16 16:57:54 -04001539 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001540 if not self._communication_started:
1541 self._read_set = []
1542 self._write_set = []
1543 if self.stdin and input:
1544 self._write_set.append(self.stdin)
1545 if self.stdout:
1546 self._read_set.append(self.stdout)
1547 if self.stderr:
1548 self._read_set.append(self.stderr)
1549
1550 if self.stdin and self._input is None:
1551 self._input_offset = 0
1552 self._input = input
1553 if self.universal_newlines:
1554 self._input = self._input.encode(self.stdin.encoding)
1555
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001556 stdout = None # Return
1557 stderr = None # Return
1558
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001559 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001560 if not self._communication_started:
1561 self._stdout_buff = []
1562 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001563 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001564 if not self._communication_started:
1565 self._stderr_buff = []
1566 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001567
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001568 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001569 timeout = self._remaining_time(endtime)
1570 if timeout is not None and timeout < 0:
1571 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001572 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001573 (rlist, wlist, xlist) = \
1574 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001575 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001576 except select.error as e:
1577 if e.args[0] == errno.EINTR:
1578 continue
1579 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001580
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001581 # According to the docs, returning three empty lists indicates
1582 # that the timeout expired.
1583 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001584 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001585 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001586 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001587
Guido van Rossum98297ee2007-11-06 21:34:58 +00001588 # XXX Rewrite these to use non-blocking I/O on the
1589 # file objects; they are no longer using C stdio!
1590
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001591 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001592 chunk = self._input[self._input_offset :
1593 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001594 try:
1595 bytes_written = os.write(self.stdin.fileno(), chunk)
1596 except OSError as e:
1597 if e.errno == errno.EPIPE:
1598 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001599 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001600 else:
1601 raise
1602 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001603 self._input_offset += bytes_written
1604 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001605 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001606 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001607
1608 if self.stdout in rlist:
1609 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001610 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001611 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001612 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001613 stdout.append(data)
1614
1615 if self.stderr in rlist:
1616 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001617 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001618 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001619 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001620 stderr.append(data)
1621
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001622 return (stdout, stderr)
1623
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001624
Christian Heimesa342c012008-04-20 21:01:16 +00001625 def send_signal(self, sig):
1626 """Send a signal to the process
1627 """
1628 os.kill(self.pid, sig)
1629
1630 def terminate(self):
1631 """Terminate the process with SIGTERM
1632 """
1633 self.send_signal(signal.SIGTERM)
1634
1635 def kill(self):
1636 """Kill the process with SIGKILL
1637 """
1638 self.send_signal(signal.SIGKILL)