blob: a0aadb91a23b8fd780aa8a8ae933a1d713da6bf5 [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)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200453 except InterruptedError:
454 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000455
456
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400457def call(*popenargs, timeout=None, **kwargs):
458 """Run command with arguments. Wait for command to complete or
459 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000460
461 The arguments are the same as for the Popen constructor. Example:
462
463 retcode = call(["ls", "-l"])
464 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200465 with Popen(*popenargs, **kwargs) as p:
466 try:
467 return p.wait(timeout=timeout)
468 except:
469 p.kill()
470 p.wait()
471 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000472
473
Peter Astrand454f7672005-01-01 09:36:35 +0000474def check_call(*popenargs, **kwargs):
475 """Run command with arguments. Wait for command to complete. If
476 the exit code was zero then return, otherwise raise
477 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000478 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000479
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400480 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000481
482 check_call(["ls", "-l"])
483 """
484 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000485 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000486 cmd = kwargs.get("args")
487 if cmd is None:
488 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000489 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000490 return 0
491
492
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400493def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000494 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000495
496 If the exit code was non-zero it raises a CalledProcessError. The
497 CalledProcessError object will have the return code in the returncode
498 attribute and output in the output attribute.
499
500 The arguments are the same as for the Popen constructor. Example:
501
502 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000503 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000504
505 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000506 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000507
508 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000509 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000510 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000511 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000512 """
513 if 'stdout' in kwargs:
514 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200515 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
516 try:
517 output, unused_err = process.communicate(timeout=timeout)
518 except TimeoutExpired:
519 process.kill()
520 output, unused_err = process.communicate()
521 raise TimeoutExpired(process.args, timeout, output=output)
522 except:
523 process.kill()
524 process.wait()
525 raise
526 retcode = process.poll()
527 if retcode:
528 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000529 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000530
531
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000532def list2cmdline(seq):
533 """
534 Translate a sequence of arguments into a command line
535 string, using the same rules as the MS C runtime:
536
537 1) Arguments are delimited by white space, which is either a
538 space or a tab.
539
540 2) A string surrounded by double quotation marks is
541 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000542 contained within. A quoted string can be embedded in an
543 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000544
545 3) A double quotation mark preceded by a backslash is
546 interpreted as a literal double quotation mark.
547
548 4) Backslashes are interpreted literally, unless they
549 immediately precede a double quotation mark.
550
551 5) If backslashes immediately precede a double quotation mark,
552 every pair of backslashes is interpreted as a literal
553 backslash. If the number of backslashes is odd, the last
554 backslash escapes the next double quotation mark as
555 described in rule 3.
556 """
557
558 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000559 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
560 # or search http://msdn.microsoft.com for
561 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000562 result = []
563 needquote = False
564 for arg in seq:
565 bs_buf = []
566
567 # Add a space to separate this argument from the others
568 if result:
569 result.append(' ')
570
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000571 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000572 if needquote:
573 result.append('"')
574
575 for c in arg:
576 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000577 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000578 bs_buf.append(c)
579 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000580 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000581 result.append('\\' * len(bs_buf)*2)
582 bs_buf = []
583 result.append('\\"')
584 else:
585 # Normal char
586 if bs_buf:
587 result.extend(bs_buf)
588 bs_buf = []
589 result.append(c)
590
Christian Heimesfdab48e2008-01-20 09:06:41 +0000591 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000592 if bs_buf:
593 result.extend(bs_buf)
594
595 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000596 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000597 result.append('"')
598
599 return ''.join(result)
600
601
Brett Cannona23810f2008-05-26 19:04:21 +0000602# Various tools for executing commands and looking at their output and status.
603#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000604# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000605
606def getstatusoutput(cmd):
607 """Return (status, output) of executing cmd in a shell.
608
609 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
610 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
611 returned output will contain output or error messages. A trailing newline
612 is stripped from the output. The exit status for the command can be
613 interpreted according to the rules for the C function wait(). Example:
614
615 >>> import subprocess
616 >>> subprocess.getstatusoutput('ls /bin/ls')
617 (0, '/bin/ls')
618 >>> subprocess.getstatusoutput('cat /bin/junk')
619 (256, 'cat: /bin/junk: No such file or directory')
620 >>> subprocess.getstatusoutput('/bin/junk')
621 (256, 'sh: /bin/junk: not found')
622 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200623 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
624 try:
625 text = pipe.read()
626 sts = pipe.close()
627 except:
628 process = pipe._proc
629 process.kill()
630 process.wait()
631 raise
632 if sts is None:
633 sts = 0
634 if text[-1:] == '\n':
635 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000636 return sts, text
637
638
639def getoutput(cmd):
640 """Return output (stdout or stderr) of executing cmd in a shell.
641
642 Like getstatusoutput(), except the exit status is ignored and the return
643 value is a string containing the command's output. Example:
644
645 >>> import subprocess
646 >>> subprocess.getoutput('ls /bin/ls')
647 '/bin/ls'
648 """
649 return getstatusoutput(cmd)[1]
650
651
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000652_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000653
654
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000655class Popen(object):
656 def __init__(self, args, bufsize=0, executable=None,
657 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000658 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
659 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000660 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000661 restore_signals=True, start_new_session=False,
662 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000663 """Create new Popen instance."""
664 _cleanup()
665
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000666 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400667 self._input = None
668 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000669 if bufsize is None:
670 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000671 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000672 raise TypeError("bufsize must be an integer")
673
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000674 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000675 if preexec_fn is not None:
676 raise ValueError("preexec_fn is not supported on Windows "
677 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000678 any_stdio_set = (stdin is not None or stdout is not None or
679 stderr is not None)
680 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
681 if any_stdio_set:
682 close_fds = False
683 else:
684 close_fds = True
685 elif close_fds and any_stdio_set:
686 raise ValueError(
687 "close_fds is not supported on Windows platforms"
688 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000689 else:
690 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000691 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
692 close_fds = True
693 if pass_fds and not close_fds:
694 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
695 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000696 if startupinfo is not None:
697 raise ValueError("startupinfo is only supported on Windows "
698 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000699 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000700 raise ValueError("creationflags is only supported on Windows "
701 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000702
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400703 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000704 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000705 self.stdout = None
706 self.stderr = None
707 self.pid = None
708 self.returncode = None
709 self.universal_newlines = universal_newlines
710
711 # Input and output objects. The general principle is like
712 # this:
713 #
714 # Parent Child
715 # ------ -----
716 # p2cwrite ---stdin---> p2cread
717 # c2pread <--stdout--- c2pwrite
718 # errread <--stderr--- errwrite
719 #
720 # On POSIX, the child objects are file descriptors. On
721 # Windows, these are Windows file handles. The parent objects
722 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000723 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000724 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000725
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000726 (p2cread, p2cwrite,
727 c2pread, c2pwrite,
728 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
729
Antoine Pitrouc9982322011-01-04 19:07:07 +0000730 # We wrap OS handles *before* launching the child, otherwise a
731 # quickly terminating child could make our fds unwrappable
732 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000733
Thomas Wouterscf297e42007-02-23 15:07:44 +0000734 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000735 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000736 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000737 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000738 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000739 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000740 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000741
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000742 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000743 self.stdin = io.open(p2cwrite, 'wb', bufsize)
744 if self.universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200745 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000746 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000747 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000748 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000749 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000750 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000751 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000752 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000753 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000754
Antoine Pitrouc9982322011-01-04 19:07:07 +0000755 try:
756 self._execute_child(args, executable, preexec_fn, close_fds,
757 pass_fds, cwd, env, universal_newlines,
758 startupinfo, creationflags, shell,
759 p2cread, p2cwrite,
760 c2pread, c2pwrite,
761 errread, errwrite,
762 restore_signals, start_new_session)
763 except:
764 # Cleanup if the child failed starting
765 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
766 try:
767 f.close()
768 except EnvironmentError:
769 # Ignore EBADF or other errors
770 pass
771 raise
772
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000773
Guido van Rossum98297ee2007-11-06 21:34:58 +0000774 def _translate_newlines(self, data, encoding):
775 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
776 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000777
Brian Curtin79cdb662010-12-03 02:46:02 +0000778 def __enter__(self):
779 return self
780
781 def __exit__(self, type, value, traceback):
782 if self.stdout:
783 self.stdout.close()
784 if self.stderr:
785 self.stderr.close()
786 if self.stdin:
787 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700788 # Wait for the process to terminate, to avoid zombies.
789 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000790
Brett Cannon84df1e62010-05-14 00:33:40 +0000791 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200792 # If __init__ hasn't had a chance to execute (e.g. if it
793 # was passed an undeclared keyword argument), we don't
794 # have a _child_created attribute at all.
795 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000796 # We didn't get to successfully create a child process.
797 return
798 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000799 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000800 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000801 # Child is still running, keep us alive until we can wait on it.
802 _active.append(self)
803
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200804 def _get_devnull(self):
805 if not hasattr(self, '_devnull'):
806 self._devnull = os.open(os.devnull, os.O_RDWR)
807 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000808
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400809 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000810 """Interact with process: Send data to stdin. Read data from
811 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700812 process to terminate. The optional input argument should be
813 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000814 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000815
Peter Astrand23109f02005-03-03 20:28:59 +0000816 communicate() returns a tuple (stdout, stderr)."""
817
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400818 if self._communication_started and input:
819 raise ValueError("Cannot send input after starting communication")
820
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400821 # Optimization: If we are not worried about timeouts, we haven't
822 # started communicating, and we have one or zero pipes, using select()
823 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200824 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400825 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000826 stdout = None
827 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000828 if self.stdin:
829 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200830 try:
831 self.stdin.write(input)
832 except IOError as e:
833 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
834 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000835 self.stdin.close()
836 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200837 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000838 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000839 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200840 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000841 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000842 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200843 else:
844 if timeout is not None:
845 endtime = time.time() + timeout
846 else:
847 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000848
Victor Stinner7a8d0812011-04-05 13:13:08 +0200849 try:
850 stdout, stderr = self._communicate(input, endtime, timeout)
851 finally:
852 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400853
Victor Stinner7a8d0812011-04-05 13:13:08 +0200854 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400855
856 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000857
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000858
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000859 def poll(self):
860 return self._internal_poll()
861
862
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400863 def _remaining_time(self, endtime):
864 """Convenience for _communicate when computing timeouts."""
865 if endtime is None:
866 return None
867 else:
868 return endtime - time.time()
869
870
Reid Kleckner2b228f02011-03-16 16:57:54 -0400871 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400872 """Convenience for checking if a timeout has expired."""
873 if endtime is None:
874 return
875 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400876 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400877
878
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000879 if mswindows:
880 #
881 # Windows methods
882 #
883 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000884 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000885 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
886 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000887 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000888 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000889
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000890 p2cread, p2cwrite = -1, -1
891 c2pread, c2pwrite = -1, -1
892 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000893
Peter Astrandd38ddf42005-02-10 08:32:50 +0000894 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000895 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000896 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000897 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000898 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000899 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200900 elif stdin == DEVNULL:
901 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000902 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000903 p2cread = msvcrt.get_osfhandle(stdin)
904 else:
905 # Assuming file-like object
906 p2cread = msvcrt.get_osfhandle(stdin.fileno())
907 p2cread = self._make_inheritable(p2cread)
908
Peter Astrandd38ddf42005-02-10 08:32:50 +0000909 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000910 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000911 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000912 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000913 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000914 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200915 elif stdout == DEVNULL:
916 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000917 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000918 c2pwrite = msvcrt.get_osfhandle(stdout)
919 else:
920 # Assuming file-like object
921 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
922 c2pwrite = self._make_inheritable(c2pwrite)
923
Peter Astrandd38ddf42005-02-10 08:32:50 +0000924 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000925 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000926 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000927 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000928 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000929 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000930 elif stderr == STDOUT:
931 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200932 elif stderr == DEVNULL:
933 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000934 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000935 errwrite = msvcrt.get_osfhandle(stderr)
936 else:
937 # Assuming file-like object
938 errwrite = msvcrt.get_osfhandle(stderr.fileno())
939 errwrite = self._make_inheritable(errwrite)
940
941 return (p2cread, p2cwrite,
942 c2pread, c2pwrite,
943 errread, errwrite)
944
945
946 def _make_inheritable(self, handle):
947 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000948 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
949 handle, _subprocess.GetCurrentProcess(), 0, 1,
950 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000951
952
953 def _find_w9xpopen(self):
954 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000955 w9xpopen = os.path.join(
956 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000957 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000958 if not os.path.exists(w9xpopen):
959 # Eeek - file-not-found - possibly an embedding
960 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000961 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
962 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000963 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000964 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
965 "needed for Popen to work with your "
966 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000967 return w9xpopen
968
Tim Peterse718f612004-10-12 21:51:32 +0000969
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000970 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000971 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000972 startupinfo, creationflags, shell,
973 p2cread, p2cwrite,
974 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000975 errread, errwrite,
976 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000977 """Execute program (MS Windows version)"""
978
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000979 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000980
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000981 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000982 args = list2cmdline(args)
983
Peter Astrandc1d65362004-11-07 14:30:34 +0000984 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000985 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000986 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000987 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000988 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000989 startupinfo.hStdInput = p2cread
990 startupinfo.hStdOutput = c2pwrite
991 startupinfo.hStdError = errwrite
992
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000993 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000994 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
995 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000996 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000997 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000998 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000999 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001000 # Win9x, or using command.com on NT. We need to
1001 # use the w9xpopen intermediate program. For more
1002 # information, see KB Q150956
1003 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1004 w9xpopen = self._find_w9xpopen()
1005 args = '"%s" %s' % (w9xpopen, args)
1006 # Not passing CREATE_NEW_CONSOLE has been known to
1007 # cause random failures on win9x. Specifically a
1008 # dialog: "Your program accessed mem currently in
1009 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001010 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001011 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001012 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001013
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001014 # Start the process
1015 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001016 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001017 # no special security
1018 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001019 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001020 creationflags,
1021 env,
1022 cwd,
1023 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001024 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001025 # Translate pywintypes.error to WindowsError, which is
1026 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001027 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001028 # how can this be done from Python?
1029 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001030 finally:
1031 # Child is launched. Close the parent's copy of those pipe
1032 # handles that only the child should have open. You need
1033 # to make sure that no handles to the write end of the
1034 # output pipe are maintained in this process or else the
1035 # pipe will not close when the child process exits and the
1036 # ReadFile will hang.
1037 if p2cread != -1:
1038 p2cread.Close()
1039 if c2pwrite != -1:
1040 c2pwrite.Close()
1041 if errwrite != -1:
1042 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001043 if hasattr(self, '_devnull'):
1044 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001045
1046 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001047 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001048 self._handle = hp
1049 self.pid = pid
1050 ht.Close()
1051
Brett Cannon84df1e62010-05-14 00:33:40 +00001052 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001053 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1054 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1055 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001057 attribute.
1058
1059 This method is called by __del__, so it can only refer to objects
1060 in its local scope.
1061
1062 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001063 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001064 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1065 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066 return self.returncode
1067
1068
Reid Kleckner2b228f02011-03-16 16:57:54 -04001069 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001070 """Wait for child process to terminate. Returns returncode
1071 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001072 if endtime is not None:
1073 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001074 if timeout is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001075 timeout_millis = _subprocess.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001076 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001077 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001078 if self.returncode is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001079 result = _subprocess.WaitForSingleObject(self._handle,
1080 timeout_millis)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001081 if result == _subprocess.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001082 raise TimeoutExpired(self.args, timeout)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001083 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001084 return self.returncode
1085
1086
1087 def _readerthread(self, fh, buffer):
1088 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001089 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001090
1091
Reid Kleckner2b228f02011-03-16 16:57:54 -04001092 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001093 # Start reader threads feeding into a list hanging off of this
1094 # object, unless they've already been started.
1095 if self.stdout and not hasattr(self, "_stdout_buff"):
1096 self._stdout_buff = []
1097 self.stdout_thread = \
1098 threading.Thread(target=self._readerthread,
1099 args=(self.stdout, self._stdout_buff))
1100 self.stdout_thread.daemon = True
1101 self.stdout_thread.start()
1102 if self.stderr and not hasattr(self, "_stderr_buff"):
1103 self._stderr_buff = []
1104 self.stderr_thread = \
1105 threading.Thread(target=self._readerthread,
1106 args=(self.stderr, self._stderr_buff))
1107 self.stderr_thread.daemon = True
1108 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109
1110 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001111 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001112 try:
1113 self.stdin.write(input)
1114 except IOError as e:
1115 if e.errno != errno.EPIPE:
1116 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001117 self.stdin.close()
1118
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001119 # Wait for the reader threads, or time out. If we time out, the
1120 # threads remain reading and the fds left open in case the user
1121 # calls communicate again.
1122 if self.stdout is not None:
1123 self.stdout_thread.join(self._remaining_time(endtime))
1124 if self.stdout_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001125 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001126 if self.stderr is not None:
1127 self.stderr_thread.join(self._remaining_time(endtime))
1128 if self.stderr_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001129 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001130
1131 # Collect the output from and close both pipes, now that we know
1132 # both have been read successfully.
1133 stdout = None
1134 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001135 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001136 stdout = self._stdout_buff
1137 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001139 stderr = self._stderr_buff
1140 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001141
1142 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001143 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001144 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001145 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001146 stderr = stderr[0]
1147
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001148 return (stdout, stderr)
1149
Christian Heimesa342c012008-04-20 21:01:16 +00001150 def send_signal(self, sig):
1151 """Send a signal to the process
1152 """
1153 if sig == signal.SIGTERM:
1154 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001155 elif sig == signal.CTRL_C_EVENT:
1156 os.kill(self.pid, signal.CTRL_C_EVENT)
1157 elif sig == signal.CTRL_BREAK_EVENT:
1158 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001159 else:
Brian Curtin19651362010-09-07 13:24:38 +00001160 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001161
1162 def terminate(self):
1163 """Terminates the process
1164 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001165 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001166
1167 kill = terminate
1168
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001169 else:
1170 #
1171 # POSIX methods
1172 #
1173 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001174 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001175 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1176 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001177 p2cread, p2cwrite = -1, -1
1178 c2pread, c2pwrite = -1, -1
1179 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180
Peter Astrandd38ddf42005-02-10 08:32:50 +00001181 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001182 pass
1183 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001184 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001185 elif stdin == DEVNULL:
1186 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001187 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001188 p2cread = stdin
1189 else:
1190 # Assuming file-like object
1191 p2cread = stdin.fileno()
1192
Peter Astrandd38ddf42005-02-10 08:32:50 +00001193 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001194 pass
1195 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001196 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001197 elif stdout == DEVNULL:
1198 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001199 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001200 c2pwrite = stdout
1201 else:
1202 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001203 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001204
Peter Astrandd38ddf42005-02-10 08:32:50 +00001205 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001206 pass
1207 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001208 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001209 elif stderr == STDOUT:
1210 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001211 elif stderr == DEVNULL:
1212 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001213 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001214 errwrite = stderr
1215 else:
1216 # Assuming file-like object
1217 errwrite = stderr.fileno()
1218
1219 return (p2cread, p2cwrite,
1220 c2pread, c2pwrite,
1221 errread, errwrite)
1222
1223
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001224 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001225 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001226 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001227 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001228 os.closerange(start_fd, fd)
1229 start_fd = fd + 1
1230 if start_fd <= MAXFD:
1231 os.closerange(start_fd, MAXFD)
1232
1233
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001234 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001235 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001236 startupinfo, creationflags, shell,
1237 p2cread, p2cwrite,
1238 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001239 errread, errwrite,
1240 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001241 """Execute program (POSIX version)"""
1242
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001243 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001245 else:
1246 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001247
1248 if shell:
1249 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001250 if executable:
1251 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001252
Peter Astrandd38ddf42005-02-10 08:32:50 +00001253 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001254 executable = args[0]
1255
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001256 # For transferring possible exec failure from child to parent.
1257 # Data format: "exception name:hex errno:description"
1258 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001259 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001260 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001261 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001262 # We must avoid complex work that could involve
1263 # malloc or free in the child process to avoid
1264 # potential deadlocks, thus we do all this here.
1265 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001266
Victor Stinner372b8382011-06-21 17:24:21 +02001267 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001268 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1269 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001270 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001271 env_list = None # Use execv instead of execve.
1272 executable = os.fsencode(executable)
1273 if os.path.dirname(executable):
1274 executable_list = (executable,)
1275 else:
1276 # This matches the behavior of os._execvpe().
1277 executable_list = tuple(
1278 os.path.join(os.fsencode(dir), executable)
1279 for dir in os.get_exec_path(env))
1280 fds_to_keep = set(pass_fds)
1281 fds_to_keep.add(errpipe_write)
1282 self.pid = _posixsubprocess.fork_exec(
1283 args, executable_list,
1284 close_fds, sorted(fds_to_keep), cwd, env_list,
1285 p2cread, p2cwrite, c2pread, c2pwrite,
1286 errread, errwrite,
1287 errpipe_read, errpipe_write,
1288 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001289 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001290 finally:
1291 # be sure the FD is closed no matter what
1292 os.close(errpipe_write)
1293
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001294 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001295 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001296 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001297 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001298 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001299 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001300 if hasattr(self, '_devnull'):
1301 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001302
1303 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001304 # exception (limited in size)
1305 data = bytearray()
1306 while True:
1307 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1308 data += part
1309 if not part or len(data) > 50000:
1310 break
Facundo Batista10706e22009-06-19 20:34:30 +00001311 finally:
1312 # be sure the FD is closed no matter what
1313 os.close(errpipe_read)
1314
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001315 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001316 try:
1317 _eintr_retry_call(os.waitpid, self.pid, 0)
1318 except OSError as e:
1319 if e.errno != errno.ECHILD:
1320 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001321 try:
1322 exception_name, hex_errno, err_msg = data.split(b':', 2)
1323 except ValueError:
1324 print('Bad exception data:', repr(data))
1325 exception_name = b'RuntimeError'
1326 hex_errno = b'0'
1327 err_msg = b'Unknown'
1328 child_exception_type = getattr(
1329 builtins, exception_name.decode('ascii'),
1330 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001331 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001332 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001333 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001334 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001335 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001336 errno_num = int(hex_errno, 16)
1337 if errno_num != 0:
1338 err_msg = os.strerror(errno_num)
1339 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001340 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001341 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001342 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343
1344
Brett Cannon84df1e62010-05-14 00:33:40 +00001345 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1346 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1347 _WEXITSTATUS=os.WEXITSTATUS):
1348 # This method is called (indirectly) by __del__, so it cannot
1349 # refer to anything outside of its local scope."""
1350 if _WIFSIGNALED(sts):
1351 self.returncode = -_WTERMSIG(sts)
1352 elif _WIFEXITED(sts):
1353 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001354 else:
1355 # Should never happen
1356 raise RuntimeError("Unknown child exit status!")
1357
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001358
Brett Cannon84df1e62010-05-14 00:33:40 +00001359 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1360 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001361 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001362 attribute.
1363
1364 This method is called by __del__, so it cannot reference anything
1365 outside of the local scope (nor can any methods it calls).
1366
1367 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001368 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001369 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001370 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001371 if pid == self.pid:
1372 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001373 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001374 if _deadstate is not None:
1375 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001376 return self.returncode
1377
1378
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001379 def _try_wait(self, wait_flags):
1380 try:
1381 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1382 except OSError as e:
1383 if e.errno != errno.ECHILD:
1384 raise
1385 # This happens if SIGCLD is set to be ignored or waiting
1386 # for child processes has otherwise been disabled for our
1387 # process. This child is dead, we can't get the status.
1388 pid = self.pid
1389 sts = 0
1390 return (pid, sts)
1391
1392
1393 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001394 """Wait for child process to terminate. Returns returncode
1395 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001396 if self.returncode is not None:
1397 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001398
1399 # endtime is preferred to timeout. timeout is only used for
1400 # printing.
1401 if endtime is not None or timeout is not None:
1402 if endtime is None:
1403 endtime = time.time() + timeout
1404 elif timeout is None:
1405 timeout = self._remaining_time(endtime)
1406
1407 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001408 # Enter a busy loop if we have a timeout. This busy loop was
1409 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1410 delay = 0.0005 # 500 us -> initial delay of 1 ms
1411 while True:
1412 (pid, sts) = self._try_wait(os.WNOHANG)
1413 assert pid == self.pid or pid == 0
1414 if pid == self.pid:
1415 self._handle_exitstatus(sts)
1416 break
1417 remaining = self._remaining_time(endtime)
1418 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001419 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001420 delay = min(delay * 2, remaining, .05)
1421 time.sleep(delay)
1422 elif self.returncode is None:
1423 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001424 self._handle_exitstatus(sts)
1425 return self.returncode
1426
1427
Reid Kleckner2b228f02011-03-16 16:57:54 -04001428 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001429 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001430 # Flush stdio buffer. This might block, if the user has
1431 # been writing to .stdin in an uncontrolled fashion.
1432 self.stdin.flush()
1433 if not input:
1434 self.stdin.close()
1435
1436 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001437 stdout, stderr = self._communicate_with_poll(input, endtime,
1438 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001439 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001440 stdout, stderr = self._communicate_with_select(input, endtime,
1441 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001442
1443 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001444
1445 # All data exchanged. Translate lists into strings.
1446 if stdout is not None:
1447 stdout = b''.join(stdout)
1448 if stderr is not None:
1449 stderr = b''.join(stderr)
1450
1451 # Translate newlines, if requested.
1452 # This also turns bytes into strings.
1453 if self.universal_newlines:
1454 if stdout is not None:
1455 stdout = self._translate_newlines(stdout,
1456 self.stdout.encoding)
1457 if stderr is not None:
1458 stderr = self._translate_newlines(stderr,
1459 self.stderr.encoding)
1460
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001461 return (stdout, stderr)
1462
1463
Reid Kleckner2b228f02011-03-16 16:57:54 -04001464 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001465 stdout = None # Return
1466 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001467
1468 if not self._communication_started:
1469 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001470
1471 poller = select.poll()
1472 def register_and_append(file_obj, eventmask):
1473 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001474 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001475
1476 def close_unregister_and_remove(fd):
1477 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001478 self._fd2file[fd].close()
1479 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001480
1481 if self.stdin and input:
1482 register_and_append(self.stdin, select.POLLOUT)
1483
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001484 # Only create this mapping if we haven't already.
1485 if not self._communication_started:
1486 self._fd2output = {}
1487 if self.stdout:
1488 self._fd2output[self.stdout.fileno()] = []
1489 if self.stderr:
1490 self._fd2output[self.stderr.fileno()] = []
1491
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001492 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1493 if self.stdout:
1494 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001495 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001496 if self.stderr:
1497 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001498 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001499
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001500 # Save the input here so that if we time out while communicating,
1501 # we can continue sending input if we retry.
1502 if self.stdin and self._input is None:
1503 self._input_offset = 0
1504 self._input = input
1505 if self.universal_newlines:
1506 self._input = self._input.encode(self.stdin.encoding)
1507
1508 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001509 timeout = self._remaining_time(endtime)
1510 if timeout is not None and timeout < 0:
1511 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001512 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001513 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001514 except select.error as e:
1515 if e.args[0] == errno.EINTR:
1516 continue
1517 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001518 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001519
1520 # XXX Rewrite these to use non-blocking I/O on the
1521 # file objects; they are no longer using C stdio!
1522
1523 for fd, mode in ready:
1524 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001525 chunk = self._input[self._input_offset :
1526 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001527 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001528 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001529 except OSError as e:
1530 if e.errno == errno.EPIPE:
1531 close_unregister_and_remove(fd)
1532 else:
1533 raise
1534 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001535 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001536 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001537 elif mode & select_POLLIN_POLLPRI:
1538 data = os.read(fd, 4096)
1539 if not data:
1540 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001541 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001542 else:
1543 # Ignore hang up or errors.
1544 close_unregister_and_remove(fd)
1545
1546 return (stdout, stderr)
1547
1548
Reid Kleckner2b228f02011-03-16 16:57:54 -04001549 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001550 if not self._communication_started:
1551 self._read_set = []
1552 self._write_set = []
1553 if self.stdin and input:
1554 self._write_set.append(self.stdin)
1555 if self.stdout:
1556 self._read_set.append(self.stdout)
1557 if self.stderr:
1558 self._read_set.append(self.stderr)
1559
1560 if self.stdin and self._input is None:
1561 self._input_offset = 0
1562 self._input = input
1563 if self.universal_newlines:
1564 self._input = self._input.encode(self.stdin.encoding)
1565
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001566 stdout = None # Return
1567 stderr = None # Return
1568
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001569 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001570 if not self._communication_started:
1571 self._stdout_buff = []
1572 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001573 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001574 if not self._communication_started:
1575 self._stderr_buff = []
1576 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001577
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001578 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001579 timeout = self._remaining_time(endtime)
1580 if timeout is not None and timeout < 0:
1581 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001582 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001583 (rlist, wlist, xlist) = \
1584 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001585 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001586 except select.error as e:
1587 if e.args[0] == errno.EINTR:
1588 continue
1589 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001590
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001591 # According to the docs, returning three empty lists indicates
1592 # that the timeout expired.
1593 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001594 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001595 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001596 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001597
Guido van Rossum98297ee2007-11-06 21:34:58 +00001598 # XXX Rewrite these to use non-blocking I/O on the
1599 # file objects; they are no longer using C stdio!
1600
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001601 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001602 chunk = self._input[self._input_offset :
1603 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001604 try:
1605 bytes_written = os.write(self.stdin.fileno(), chunk)
1606 except OSError as e:
1607 if e.errno == errno.EPIPE:
1608 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001609 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001610 else:
1611 raise
1612 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001613 self._input_offset += bytes_written
1614 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001615 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001616 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001617
1618 if self.stdout in rlist:
1619 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001620 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001621 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001622 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001623 stdout.append(data)
1624
1625 if self.stderr in rlist:
1626 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001627 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001628 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001629 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001630 stderr.append(data)
1631
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001632 return (stdout, stderr)
1633
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001634
Christian Heimesa342c012008-04-20 21:01:16 +00001635 def send_signal(self, sig):
1636 """Send a signal to the process
1637 """
1638 os.kill(self.pid, sig)
1639
1640 def terminate(self):
1641 """Terminate the process with SIGTERM
1642 """
1643 self.send_signal(signal.SIGTERM)
1644
1645 def kill(self):
1646 """Kill the process with SIGKILL
1647 """
1648 self.send_signal(signal.SIGKILL)