blob: 7cd5a571f3799b95c4d8cf7b2aebd7c7580b8319 [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
Georg Brandlf9734072008-12-07 15:30:06 +0000194check_call() and check_output() will raise CalledProcessError, if the
195called process returns a non-zero return code.
Peter Astrand454f7672005-01-01 09:36:35 +0000196
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000197
198Security
199--------
200Unlike some other popen functions, this implementation will never call
201/bin/sh implicitly. This means that all characters, including shell
202metacharacters, can safely be passed to child processes.
203
204
205Popen objects
206=============
207Instances of the Popen class have the following methods:
208
209poll()
210 Check if child process has terminated. Returns returncode
211 attribute.
212
213wait()
214 Wait for child process to terminate. Returns returncode attribute.
215
216communicate(input=None)
217 Interact with process: Send data to stdin. Read data from stdout
218 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000219 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000220 sent to the child process, or None, if no data should be sent to
221 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000222
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000223 communicate() returns a tuple (stdout, stderr).
224
225 Note: The data read is buffered in memory, so do not use this
226 method if the data size is large or unlimited.
227
228The following attributes are also available:
229
230stdin
231 If the stdin argument is PIPE, this attribute is a file object
232 that provides input to the child process. Otherwise, it is None.
233
234stdout
235 If the stdout argument is PIPE, this attribute is a file object
236 that provides output from the child process. Otherwise, it is
237 None.
238
239stderr
240 If the stderr argument is PIPE, this attribute is file object that
241 provides error output from the child process. Otherwise, it is
242 None.
243
244pid
245 The process ID of the child process.
246
247returncode
248 The child return code. A None value indicates that the process
249 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000250 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000251
252
253Replacing older functions with the subprocess module
254====================================================
255In this section, "a ==> b" means that b can be used as a replacement
256for a.
257
258Note: All functions in this section fail (more or less) silently if
259the executed program cannot be found; this module raises an OSError
260exception.
261
262In the following examples, we assume that the subprocess module is
263imported with "from subprocess import *".
264
265
266Replacing /bin/sh shell backquote
267---------------------------------
268output=`mycmd myarg`
269==>
270output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
271
272
273Replacing shell pipe line
274-------------------------
275output=`dmesg | grep hda`
276==>
277p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000278p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000279output = p2.communicate()[0]
280
281
282Replacing os.system()
283---------------------
284sts = os.system("mycmd" + " myarg")
285==>
286p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000287pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000288
289Note:
290
291* Calling the program through the shell is usually not required.
292
293* It's easier to look at the returncode attribute than the
294 exitstatus.
295
296A more real-world example would look like this:
297
298try:
299 retcode = call("mycmd" + " myarg", shell=True)
300 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000301 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000302 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000303 print("Child returned", retcode, file=sys.stderr)
304except OSError as e:
305 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000306
307
308Replacing os.spawn*
309-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000310P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000311
312pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
313==>
314pid = Popen(["/bin/mycmd", "myarg"]).pid
315
316
317P_WAIT example:
318
319retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
320==>
321retcode = call(["/bin/mycmd", "myarg"])
322
323
Tim Peterse718f612004-10-12 21:51:32 +0000324Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000325
326os.spawnvp(os.P_NOWAIT, path, args)
327==>
328Popen([path] + args[1:])
329
330
Tim Peterse718f612004-10-12 21:51:32 +0000331Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000332
333os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
334==>
335Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000336"""
337
338import sys
339mswindows = (sys.platform == "win32")
340
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000341import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000342import os
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000343import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000344import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000345import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000346import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000347import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200348import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000349
Peter Astrand454f7672005-01-01 09:36:35 +0000350# Exception classes used by this module.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000351class CalledProcessError(Exception):
Georg Brandlf9734072008-12-07 15:30:06 +0000352 """This exception is raised when a process run by check_call() or
353 check_output() returns a non-zero exit status.
354 The exit status will be stored in the returncode attribute;
355 check_output() will also store the output in the output attribute.
356 """
357 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000358 self.returncode = returncode
359 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000360 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000361 def __str__(self):
362 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
363
Peter Astrand454f7672005-01-01 09:36:35 +0000364
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000365if mswindows:
366 import threading
367 import msvcrt
Brian Curtin1ce6b582010-04-24 16:19:22 +0000368 import _subprocess
369 class STARTUPINFO:
370 dwFlags = 0
371 hStdInput = None
372 hStdOutput = None
373 hStdError = None
374 wShowWindow = 0
375 class pywintypes:
376 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000377else:
378 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000379 _has_poll = hasattr(select, 'poll')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000380 import fcntl
381 import pickle
382
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000383 try:
384 import _posixsubprocess
385 except ImportError:
386 _posixsubprocess = None
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000387 warnings.warn("The _posixsubprocess module is not being used. "
388 "Child process reliability may suffer if your "
389 "program uses threads.", RuntimeWarning)
390
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000391 # When select or poll has indicated that the file is writable,
392 # we can write up to _PIPE_BUF bytes without risk of blocking.
393 # POSIX defines PIPE_BUF as >= 512.
394 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
395
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000396 _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1)
397
398 def _set_cloexec(fd, cloexec):
399 old = fcntl.fcntl(fd, fcntl.F_GETFD)
400 if cloexec:
401 fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC)
402 else:
403 fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC)
404
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000405 if _posixsubprocess:
406 _create_pipe = _posixsubprocess.cloexec_pipe
407 else:
408 def _create_pipe():
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000409 fds = os.pipe()
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000410 _set_cloexec(fds[0], True)
411 _set_cloexec(fds[1], True)
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000412 return fds
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000413
Brett Cannona23810f2008-05-26 19:04:21 +0000414__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Georg Brandlf9734072008-12-07 15:30:06 +0000415 "getoutput", "check_output", "CalledProcessError"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000416
Brian Curtin1ce6b582010-04-24 16:19:22 +0000417if mswindows:
Brian Curtin08fd8d92011-04-29 16:11:30 -0500418 from _subprocess import (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)
Gregory P. Smith0ef3e392011-05-11 22:20:11 -0700422
Brian Curtin08fd8d92011-04-29 16:11:30 -0500423 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500424 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
425 "STD_ERROR_HANDLE", "SW_HIDE",
426 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000427try:
428 MAXFD = os.sysconf("SC_OPEN_MAX")
429except:
430 MAXFD = 256
431
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200432# This lists holds Popen instances for which the underlying process had not
433# exited at the time its __del__ method got called: those processes are wait()ed
434# for synchronously from _cleanup() when a new Popen object is created, to avoid
435# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000436_active = []
437
438def _cleanup():
439 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000440 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200441 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000442 try:
443 _active.remove(inst)
444 except ValueError:
445 # This can happen if two threads create a new Popen instance.
446 # It's harmless that it was already removed, so ignore.
447 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000448
449PIPE = -1
450STDOUT = -2
451
452
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000453def _eintr_retry_call(func, *args):
454 while True:
455 try:
456 return func(*args)
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200457 except (OSError, IOError) as e:
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000458 if e.errno == errno.EINTR:
459 continue
460 raise
461
462
Peter Astrand5f5e1412004-12-05 20:15:36 +0000463def call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000464 """Run command with arguments. Wait for command to complete, then
465 return the returncode attribute.
466
467 The arguments are the same as for the Popen constructor. Example:
468
469 retcode = call(["ls", "-l"])
470 """
Peter Astrand5f5e1412004-12-05 20:15:36 +0000471 return Popen(*popenargs, **kwargs).wait()
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
480 The arguments are the same as for the Popen constructor. Example:
481
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
493def check_output(*popenargs, **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.')
515 process = Popen(*popenargs, stdout=PIPE, **kwargs)
516 output, unused_err = process.communicate()
517 retcode = process.poll()
518 if retcode:
519 cmd = kwargs.get("args")
520 if cmd is None:
521 cmd = popenargs[0]
522 raise CalledProcessError(retcode, cmd, output=output)
523 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000524
525
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000526def list2cmdline(seq):
527 """
528 Translate a sequence of arguments into a command line
529 string, using the same rules as the MS C runtime:
530
531 1) Arguments are delimited by white space, which is either a
532 space or a tab.
533
534 2) A string surrounded by double quotation marks is
535 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000536 contained within. A quoted string can be embedded in an
537 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000538
539 3) A double quotation mark preceded by a backslash is
540 interpreted as a literal double quotation mark.
541
542 4) Backslashes are interpreted literally, unless they
543 immediately precede a double quotation mark.
544
545 5) If backslashes immediately precede a double quotation mark,
546 every pair of backslashes is interpreted as a literal
547 backslash. If the number of backslashes is odd, the last
548 backslash escapes the next double quotation mark as
549 described in rule 3.
550 """
551
552 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000553 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
554 # or search http://msdn.microsoft.com for
555 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000556 result = []
557 needquote = False
558 for arg in seq:
559 bs_buf = []
560
561 # Add a space to separate this argument from the others
562 if result:
563 result.append(' ')
564
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000565 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000566 if needquote:
567 result.append('"')
568
569 for c in arg:
570 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000571 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000572 bs_buf.append(c)
573 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000574 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000575 result.append('\\' * len(bs_buf)*2)
576 bs_buf = []
577 result.append('\\"')
578 else:
579 # Normal char
580 if bs_buf:
581 result.extend(bs_buf)
582 bs_buf = []
583 result.append(c)
584
Christian Heimesfdab48e2008-01-20 09:06:41 +0000585 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000586 if bs_buf:
587 result.extend(bs_buf)
588
589 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000590 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000591 result.append('"')
592
593 return ''.join(result)
594
595
Brett Cannona23810f2008-05-26 19:04:21 +0000596# Various tools for executing commands and looking at their output and status.
597#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000598# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000599
600def getstatusoutput(cmd):
601 """Return (status, output) of executing cmd in a shell.
602
603 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
604 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
605 returned output will contain output or error messages. A trailing newline
606 is stripped from the output. The exit status for the command can be
607 interpreted according to the rules for the C function wait(). Example:
608
609 >>> import subprocess
610 >>> subprocess.getstatusoutput('ls /bin/ls')
611 (0, '/bin/ls')
612 >>> subprocess.getstatusoutput('cat /bin/junk')
613 (256, 'cat: /bin/junk: No such file or directory')
614 >>> subprocess.getstatusoutput('/bin/junk')
615 (256, 'sh: /bin/junk: not found')
616 """
617 pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
618 text = pipe.read()
619 sts = pipe.close()
620 if sts is None: sts = 0
621 if text[-1:] == '\n': text = text[:-1]
622 return sts, text
623
624
625def getoutput(cmd):
626 """Return output (stdout or stderr) of executing cmd in a shell.
627
628 Like getstatusoutput(), except the exit status is ignored and the return
629 value is a string containing the command's output. Example:
630
631 >>> import subprocess
632 >>> subprocess.getoutput('ls /bin/ls')
633 '/bin/ls'
634 """
635 return getstatusoutput(cmd)[1]
636
637
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000638_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000639
640
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000641class Popen(object):
642 def __init__(self, args, bufsize=0, executable=None,
643 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000644 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
645 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000646 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000647 restore_signals=True, start_new_session=False,
648 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000649 """Create new Popen instance."""
650 _cleanup()
651
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000652 self._child_created = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000653 if bufsize is None:
654 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000655 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000656 raise TypeError("bufsize must be an integer")
657
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000658 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000659 if preexec_fn is not None:
660 raise ValueError("preexec_fn is not supported on Windows "
661 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000662 any_stdio_set = (stdin is not None or stdout is not None or
663 stderr is not None)
664 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
665 if any_stdio_set:
666 close_fds = False
667 else:
668 close_fds = True
669 elif close_fds and any_stdio_set:
670 raise ValueError(
671 "close_fds is not supported on Windows platforms"
672 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000673 else:
674 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000675 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
676 close_fds = True
677 if pass_fds and not close_fds:
678 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
679 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000680 if startupinfo is not None:
681 raise ValueError("startupinfo is only supported on Windows "
682 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000683 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000684 raise ValueError("creationflags is only supported on Windows "
685 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000686
Tim Peterse718f612004-10-12 21:51:32 +0000687 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000688 self.stdout = None
689 self.stderr = None
690 self.pid = None
691 self.returncode = None
692 self.universal_newlines = universal_newlines
693
694 # Input and output objects. The general principle is like
695 # this:
696 #
697 # Parent Child
698 # ------ -----
699 # p2cwrite ---stdin---> p2cread
700 # c2pread <--stdout--- c2pwrite
701 # errread <--stderr--- errwrite
702 #
703 # On POSIX, the child objects are file descriptors. On
704 # Windows, these are Windows file handles. The parent objects
705 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000706 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000707 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000708
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000709 (p2cread, p2cwrite,
710 c2pread, c2pwrite,
711 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
712
Antoine Pitrouc9982322011-01-04 19:07:07 +0000713 # We wrap OS handles *before* launching the child, otherwise a
714 # quickly terminating child could make our fds unwrappable
715 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000716
Thomas Wouterscf297e42007-02-23 15:07:44 +0000717 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000718 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000719 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000720 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000721 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000722 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000723 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000724
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000725 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000726 self.stdin = io.open(p2cwrite, 'wb', bufsize)
727 if self.universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200728 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000729 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000730 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000731 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000732 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000733 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000734 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000735 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000736 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000737
Antoine Pitrouc9982322011-01-04 19:07:07 +0000738 try:
739 self._execute_child(args, executable, preexec_fn, close_fds,
740 pass_fds, cwd, env, universal_newlines,
741 startupinfo, creationflags, shell,
742 p2cread, p2cwrite,
743 c2pread, c2pwrite,
744 errread, errwrite,
745 restore_signals, start_new_session)
746 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800747 # Cleanup if the child failed starting.
748 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000749 try:
750 f.close()
751 except EnvironmentError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800752 pass # Ignore EBADF or other errors.
753
754 # Make sure the child pipes are closed as well.
755 to_close = []
756 if stdin == PIPE:
757 to_close.append(p2cread)
758 if stdout == PIPE:
759 to_close.append(c2pwrite)
760 if stderr == PIPE:
761 to_close.append(errwrite)
762 for fd in to_close:
763 try:
764 os.close(fd)
765 except EnvironmentError:
Antoine Pitrouc9982322011-01-04 19:07:07 +0000766 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800767
Antoine Pitrouc9982322011-01-04 19:07:07 +0000768 raise
769
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000770
Guido van Rossum98297ee2007-11-06 21:34:58 +0000771 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300772 data = data.decode(encoding)
773 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000774
Brian Curtin79cdb662010-12-03 02:46:02 +0000775 def __enter__(self):
776 return self
777
778 def __exit__(self, type, value, traceback):
779 if self.stdout:
780 self.stdout.close()
781 if self.stderr:
782 self.stderr.close()
783 if self.stdin:
784 self.stdin.close()
Gregory P. Smithc9557af2011-05-11 22:18:23 -0700785 # Wait for the process to terminate, to avoid zombies.
786 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000787
Brett Cannon84df1e62010-05-14 00:33:40 +0000788 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200789 # If __init__ hasn't had a chance to execute (e.g. if it
790 # was passed an undeclared keyword argument), we don't
791 # have a _child_created attribute at all.
792 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000793 # We didn't get to successfully create a child process.
794 return
795 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000796 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000797 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000798 # Child is still running, keep us alive until we can wait on it.
799 _active.append(self)
800
801
Peter Astrand23109f02005-03-03 20:28:59 +0000802 def communicate(self, input=None):
803 """Interact with process: Send data to stdin. Read data from
804 stdout and stderr, until end-of-file is reached. Wait for
805 process to terminate. The optional input argument should be a
806 string to be sent to the child process, or None, if no data
807 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000808
Peter Astrand23109f02005-03-03 20:28:59 +0000809 communicate() returns a tuple (stdout, stderr)."""
810
811 # Optimization: If we are only using one pipe, or no pipe at
812 # all, using select() or threads is unnecessary.
813 if [self.stdin, self.stdout, self.stderr].count(None) >= 2:
Tim Peterseba28be2005-03-28 01:08:02 +0000814 stdout = None
815 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000816 if self.stdin:
817 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200818 try:
819 self.stdin.write(input)
820 except IOError as e:
821 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
822 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000823 self.stdin.close()
824 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200825 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000826 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000827 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200828 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000829 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000830 self.wait()
831 return (stdout, stderr)
Tim Peterseba28be2005-03-28 01:08:02 +0000832
Peter Astrand23109f02005-03-03 20:28:59 +0000833 return self._communicate(input)
834
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000835
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000836 def poll(self):
837 return self._internal_poll()
838
839
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000840 if mswindows:
841 #
842 # Windows methods
843 #
844 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000845 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000846 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
847 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000848 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000849 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000850
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000851 p2cread, p2cwrite = -1, -1
852 c2pread, c2pwrite = -1, -1
853 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000854
Peter Astrandd38ddf42005-02-10 08:32:50 +0000855 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000856 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000857 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000858 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000859 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000860 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Peter Astrandd38ddf42005-02-10 08:32:50 +0000861 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000862 p2cread = msvcrt.get_osfhandle(stdin)
863 else:
864 # Assuming file-like object
865 p2cread = msvcrt.get_osfhandle(stdin.fileno())
866 p2cread = self._make_inheritable(p2cread)
867
Peter Astrandd38ddf42005-02-10 08:32:50 +0000868 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000869 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000870 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000871 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000872 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000873 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Peter Astrandd38ddf42005-02-10 08:32:50 +0000874 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000875 c2pwrite = msvcrt.get_osfhandle(stdout)
876 else:
877 # Assuming file-like object
878 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
879 c2pwrite = self._make_inheritable(c2pwrite)
880
Peter Astrandd38ddf42005-02-10 08:32:50 +0000881 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000882 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000883 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000884 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000885 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000886 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000887 elif stderr == STDOUT:
888 errwrite = c2pwrite
Peter Astrandd38ddf42005-02-10 08:32:50 +0000889 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000890 errwrite = msvcrt.get_osfhandle(stderr)
891 else:
892 # Assuming file-like object
893 errwrite = msvcrt.get_osfhandle(stderr.fileno())
894 errwrite = self._make_inheritable(errwrite)
895
896 return (p2cread, p2cwrite,
897 c2pread, c2pwrite,
898 errread, errwrite)
899
900
901 def _make_inheritable(self, handle):
902 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000903 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
904 handle, _subprocess.GetCurrentProcess(), 0, 1,
905 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000906
907
908 def _find_w9xpopen(self):
909 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000910 w9xpopen = os.path.join(
911 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000912 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000913 if not os.path.exists(w9xpopen):
914 # Eeek - file-not-found - possibly an embedding
915 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000916 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
917 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000918 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000919 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
920 "needed for Popen to work with your "
921 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000922 return w9xpopen
923
Tim Peterse718f612004-10-12 21:51:32 +0000924
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000925 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000926 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000927 startupinfo, creationflags, shell,
928 p2cread, p2cwrite,
929 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000930 errread, errwrite,
931 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000932 """Execute program (MS Windows version)"""
933
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000934 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000935
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000936 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000937 args = list2cmdline(args)
938
Peter Astrandc1d65362004-11-07 14:30:34 +0000939 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000940 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000941 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000942 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000943 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000944 startupinfo.hStdInput = p2cread
945 startupinfo.hStdOutput = c2pwrite
946 startupinfo.hStdError = errwrite
947
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000948 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000949 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
950 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000951 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000952 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000953 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000954 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000955 # Win9x, or using command.com on NT. We need to
956 # use the w9xpopen intermediate program. For more
957 # information, see KB Q150956
958 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
959 w9xpopen = self._find_w9xpopen()
960 args = '"%s" %s' % (w9xpopen, args)
961 # Not passing CREATE_NEW_CONSOLE has been known to
962 # cause random failures on win9x. Specifically a
963 # dialog: "Your program accessed mem currently in
964 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +0000965 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000966 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +0000967 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000968
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000969 # Start the process
970 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000971 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +0000972 # no special security
973 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +0000974 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +0000975 creationflags,
976 env,
977 cwd,
978 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +0000979 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000980 # Translate pywintypes.error to WindowsError, which is
981 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +0200982 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000983 # how can this be done from Python?
984 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +0000985 finally:
986 # Child is launched. Close the parent's copy of those pipe
987 # handles that only the child should have open. You need
988 # to make sure that no handles to the write end of the
989 # output pipe are maintained in this process or else the
990 # pipe will not close when the child process exits and the
991 # ReadFile will hang.
992 if p2cread != -1:
993 p2cread.Close()
994 if c2pwrite != -1:
995 c2pwrite.Close()
996 if errwrite != -1:
997 errwrite.Close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000998
999 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001000 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001001 self._handle = hp
1002 self.pid = pid
1003 ht.Close()
1004
Brett Cannon84df1e62010-05-14 00:33:40 +00001005 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001006 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1007 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1008 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001009 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001010 attribute.
1011
1012 This method is called by __del__, so it can only refer to objects
1013 in its local scope.
1014
1015 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001016 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001017 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1018 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001019 return self.returncode
1020
1021
1022 def wait(self):
1023 """Wait for child process to terminate. Returns returncode
1024 attribute."""
Peter Astrandd38ddf42005-02-10 08:32:50 +00001025 if self.returncode is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001026 _subprocess.WaitForSingleObject(self._handle,
1027 _subprocess.INFINITE)
1028 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001029 return self.returncode
1030
1031
1032 def _readerthread(self, fh, buffer):
1033 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001034 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001035
1036
Peter Astrand23109f02005-03-03 20:28:59 +00001037 def _communicate(self, input):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001038 stdout = None # Return
1039 stderr = None # Return
1040
1041 if self.stdout:
1042 stdout = []
Tim Peterse8374a52004-10-13 03:15:00 +00001043 stdout_thread = threading.Thread(target=self._readerthread,
1044 args=(self.stdout, stdout))
Benjamin Peterson632e0362008-08-18 19:08:51 +00001045 stdout_thread.daemon = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001046 stdout_thread.start()
1047 if self.stderr:
1048 stderr = []
Tim Peterse8374a52004-10-13 03:15:00 +00001049 stderr_thread = threading.Thread(target=self._readerthread,
1050 args=(self.stderr, stderr))
Benjamin Peterson632e0362008-08-18 19:08:51 +00001051 stderr_thread.daemon = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001052 stderr_thread.start()
1053
1054 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001055 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001056 try:
1057 self.stdin.write(input)
1058 except IOError as e:
1059 if e.errno != errno.EPIPE:
1060 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001061 self.stdin.close()
1062
1063 if self.stdout:
1064 stdout_thread.join()
1065 if self.stderr:
1066 stderr_thread.join()
1067
1068 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001069 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001070 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001071 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001072 stderr = stderr[0]
1073
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001074 self.wait()
1075 return (stdout, stderr)
1076
Christian Heimesa342c012008-04-20 21:01:16 +00001077 def send_signal(self, sig):
1078 """Send a signal to the process
1079 """
1080 if sig == signal.SIGTERM:
1081 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001082 elif sig == signal.CTRL_C_EVENT:
1083 os.kill(self.pid, signal.CTRL_C_EVENT)
1084 elif sig == signal.CTRL_BREAK_EVENT:
1085 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001086 else:
Brian Curtin19651362010-09-07 13:24:38 +00001087 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001088
1089 def terminate(self):
1090 """Terminates the process
1091 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001092 try:
1093 _subprocess.TerminateProcess(self._handle, 1)
1094 except OSError as e:
1095 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1096 # process already died.
1097 if e.winerror != 5:
1098 raise
1099 rc = _subprocess.GetExitCodeProcess(self._handle)
1100 if rc == _subprocess.STILL_ACTIVE:
1101 raise
1102 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001103
1104 kill = terminate
1105
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001106 else:
1107 #
1108 # POSIX methods
1109 #
1110 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001111 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001112 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1113 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001114 p2cread, p2cwrite = -1, -1
1115 c2pread, c2pwrite = -1, -1
1116 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001117
Peter Astrandd38ddf42005-02-10 08:32:50 +00001118 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001119 pass
1120 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001121 p2cread, p2cwrite = _create_pipe()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001122 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001123 p2cread = stdin
1124 else:
1125 # Assuming file-like object
1126 p2cread = stdin.fileno()
1127
Peter Astrandd38ddf42005-02-10 08:32:50 +00001128 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001129 pass
1130 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001131 c2pread, c2pwrite = _create_pipe()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001132 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133 c2pwrite = stdout
1134 else:
1135 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001136 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001137
Peter Astrandd38ddf42005-02-10 08:32:50 +00001138 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001139 pass
1140 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001141 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001142 elif stderr == STDOUT:
1143 errwrite = c2pwrite
Peter Astrandd38ddf42005-02-10 08:32:50 +00001144 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001145 errwrite = stderr
1146 else:
1147 # Assuming file-like object
1148 errwrite = stderr.fileno()
1149
1150 return (p2cread, p2cwrite,
1151 c2pread, c2pwrite,
1152 errread, errwrite)
1153
1154
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001155 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001156 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001157 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001158 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001159 os.closerange(start_fd, fd)
1160 start_fd = fd + 1
1161 if start_fd <= MAXFD:
1162 os.closerange(start_fd, MAXFD)
1163
1164
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001165 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001166 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001167 startupinfo, creationflags, shell,
1168 p2cread, p2cwrite,
1169 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001170 errread, errwrite,
1171 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172 """Execute program (POSIX version)"""
1173
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001174 if isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001175 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001176 else:
1177 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001178
1179 if shell:
1180 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001181 if executable:
1182 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001183
Peter Astrandd38ddf42005-02-10 08:32:50 +00001184 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001185 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001186 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001187
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001188 # For transferring possible exec failure from child to parent.
1189 # Data format: "exception name:hex errno:description"
1190 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001191 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001192 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001193 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001194
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001195 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001196 # We must avoid complex work that could involve
1197 # malloc or free in the child process to avoid
1198 # potential deadlocks, thus we do all this here.
1199 # and pass it to fork_exec()
1200
Victor Stinnerf1512a22011-06-21 17:18:38 +02001201 if env is not None:
Victor Stinner449c4662010-05-08 11:10:09 +00001202 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001203 for k, v in env.items()]
1204 else:
1205 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001206 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001207 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001208 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001209 else:
1210 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001211 executable_list = tuple(
1212 os.path.join(os.fsencode(dir), executable)
1213 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001214 fds_to_keep = set(pass_fds)
1215 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001216 self.pid = _posixsubprocess.fork_exec(
1217 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001218 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001219 p2cread, p2cwrite, c2pread, c2pwrite,
1220 errread, errwrite,
1221 errpipe_read, errpipe_write,
1222 restore_signals, start_new_session, preexec_fn)
Charles-François Natali134a8ba2011-08-18 18:49:39 +02001223 self._child_created = True
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001224 else:
1225 # Pure Python implementation: It is not thread safe.
1226 # This implementation may deadlock in the child if your
1227 # parent process has any other threads running.
1228
1229 gc_was_enabled = gc.isenabled()
1230 # Disable gc to avoid bug where gc -> file_dealloc ->
1231 # write to stderr -> hang. See issue1336
1232 gc.disable()
1233 try:
1234 self.pid = os.fork()
1235 except:
1236 if gc_was_enabled:
1237 gc.enable()
1238 raise
1239 self._child_created = True
1240 if self.pid == 0:
1241 # Child
Gregory P. Smith5591b022012-10-10 03:34:47 -07001242 reached_preexec = False
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001243 try:
1244 # Close parent's pipe ends
1245 if p2cwrite != -1:
1246 os.close(p2cwrite)
1247 if c2pread != -1:
1248 os.close(c2pread)
1249 if errread != -1:
1250 os.close(errread)
1251 os.close(errpipe_read)
1252
Ross Lagerwalld98646e2011-07-27 07:16:31 +02001253 # When duping fds, if there arises a situation
1254 # where one of the fds is either 0, 1 or 2, it
1255 # is possible that it is overwritten (#12607).
1256 if c2pwrite == 0:
1257 c2pwrite = os.dup(c2pwrite)
1258 if errwrite == 0 or errwrite == 1:
1259 errwrite = os.dup(errwrite)
1260
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001261 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001262 def _dup2(a, b):
1263 # dup2() removes the CLOEXEC flag but
1264 # we must do it ourselves if dup2()
1265 # would be a no-op (issue #10806).
1266 if a == b:
1267 _set_cloexec(a, False)
1268 elif a != -1:
1269 os.dup2(a, b)
1270 _dup2(p2cread, 0)
1271 _dup2(c2pwrite, 1)
1272 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001273
1274 # Close pipe fds. Make sure we don't close the
1275 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001276 closed = set()
1277 for fd in [p2cread, c2pwrite, errwrite]:
1278 if fd > 2 and fd not in closed:
1279 os.close(fd)
1280 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001281
1282 # Close all other fds, if asked for
1283 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001284 fds_to_keep = set(pass_fds)
1285 fds_to_keep.add(errpipe_write)
1286 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001287
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001288
1289 if cwd is not None:
1290 os.chdir(cwd)
1291
1292 # This is a copy of Python/pythonrun.c
1293 # _Py_RestoreSignals(). If that were exposed
1294 # as a sys._py_restoresignals func it would be
1295 # better.. but this pure python implementation
1296 # isn't likely to be used much anymore.
1297 if restore_signals:
1298 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1299 for sig in signals:
1300 if hasattr(signal, sig):
1301 signal.signal(getattr(signal, sig),
1302 signal.SIG_DFL)
1303
1304 if start_new_session and hasattr(os, 'setsid'):
1305 os.setsid()
1306
Gregory P. Smith5591b022012-10-10 03:34:47 -07001307 reached_preexec = True
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001308 if preexec_fn:
1309 preexec_fn()
1310
1311 if env is None:
1312 os.execvp(executable, args)
1313 else:
1314 os.execvpe(executable, args, env)
1315
1316 except:
1317 try:
1318 exc_type, exc_value = sys.exc_info()[:2]
1319 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001320 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001321 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001322 errno_num = 0
Gregory P. Smith5591b022012-10-10 03:34:47 -07001323 if not reached_preexec:
1324 exc_value = "noexec"
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001325 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001326 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001327 message = message.encode(errors="surrogatepass")
1328 os.write(errpipe_write, message)
1329 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001330 # We MUST not allow anything odd happening
1331 # above to prevent us from exiting below.
1332 pass
1333
1334 # This exitcode won't be reported to applications
1335 # so it really doesn't matter what we return.
1336 os._exit(255)
1337
1338 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001339 if gc_was_enabled:
1340 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001341 finally:
1342 # be sure the FD is closed no matter what
1343 os.close(errpipe_write)
1344
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001345 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001346 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001347 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001348 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001349 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001350 os.close(errwrite)
1351
1352 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001353 # exception (limited in size)
1354 data = bytearray()
1355 while True:
1356 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1357 data += part
1358 if not part or len(data) > 50000:
1359 break
Facundo Batista10706e22009-06-19 20:34:30 +00001360 finally:
1361 # be sure the FD is closed no matter what
1362 os.close(errpipe_read)
1363
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001364 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001365 try:
1366 _eintr_retry_call(os.waitpid, self.pid, 0)
1367 except OSError as e:
1368 if e.errno != errno.ECHILD:
1369 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 try:
1371 exception_name, hex_errno, err_msg = data.split(b':', 2)
1372 except ValueError:
1373 print('Bad exception data:', repr(data))
1374 exception_name = b'RuntimeError'
1375 hex_errno = b'0'
1376 err_msg = b'Unknown'
1377 child_exception_type = getattr(
1378 builtins, exception_name.decode('ascii'),
1379 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001380 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001381 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001382 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001383 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001384 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001385 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001386 child_exec_never_called = (err_msg == "noexec")
1387 if child_exec_never_called:
1388 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001389 if errno_num != 0:
1390 err_msg = os.strerror(errno_num)
1391 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001392 if child_exec_never_called:
1393 # The error must be from chdir(cwd).
1394 err_msg += ': ' + repr(cwd)
1395 else:
1396 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001397 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001398 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001399
1400
Brett Cannon84df1e62010-05-14 00:33:40 +00001401 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1402 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1403 _WEXITSTATUS=os.WEXITSTATUS):
1404 # This method is called (indirectly) by __del__, so it cannot
1405 # refer to anything outside of its local scope."""
1406 if _WIFSIGNALED(sts):
1407 self.returncode = -_WTERMSIG(sts)
1408 elif _WIFEXITED(sts):
1409 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001410 else:
1411 # Should never happen
1412 raise RuntimeError("Unknown child exit status!")
1413
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001414
Brett Cannon84df1e62010-05-14 00:33:40 +00001415 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1416 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001417 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001418 attribute.
1419
1420 This method is called by __del__, so it cannot reference anything
1421 outside of the local scope (nor can any methods it calls).
1422
1423 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001424 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001425 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001426 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001427 if pid == self.pid:
1428 self._handle_exitstatus(sts)
Gregory P. Smith39051712012-09-29 11:40:38 -07001429 except _os_error as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001430 if _deadstate is not None:
1431 self.returncode = _deadstate
Gregory P. Smith39051712012-09-29 11:40:38 -07001432 elif e.errno == errno.ECHILD:
1433 # This happens if SIGCLD is set to be ignored or
1434 # waiting for child processes has otherwise been
1435 # disabled for our process. This child is dead, we
1436 # can't get the status.
1437 # http://bugs.python.org/issue15756
1438 self.returncode = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001439 return self.returncode
1440
1441
1442 def wait(self):
1443 """Wait for child process to terminate. Returns returncode
1444 attribute."""
Gregory P. Smith2ec82332012-11-10 20:52:29 -08001445 while self.returncode is None:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001446 try:
1447 pid, sts = _eintr_retry_call(os.waitpid, self.pid, 0)
1448 except OSError as e:
1449 if e.errno != errno.ECHILD:
1450 raise
1451 # This happens if SIGCLD is set to be ignored or waiting
1452 # for child processes has otherwise been disabled for our
1453 # process. This child is dead, we can't get the status.
Gregory P. Smith2ec82332012-11-10 20:52:29 -08001454 pid = self.pid
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001455 sts = 0
Gregory P. Smith2ec82332012-11-10 20:52:29 -08001456 # Check the pid and loop as waitpid has been known to return
1457 # 0 even without WNOHANG in odd situations. issue14396.
1458 if pid == self.pid:
1459 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001460 return self.returncode
1461
1462
Peter Astrand23109f02005-03-03 20:28:59 +00001463 def _communicate(self, input):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001464 if self.stdin:
1465 # Flush stdio buffer. This might block, if the user has
1466 # been writing to .stdin in an uncontrolled fashion.
1467 self.stdin.flush()
1468 if not input:
1469 self.stdin.close()
1470
1471 if _has_poll:
1472 stdout, stderr = self._communicate_with_poll(input)
1473 else:
1474 stdout, stderr = self._communicate_with_select(input)
1475
1476 # All data exchanged. Translate lists into strings.
1477 if stdout is not None:
1478 stdout = b''.join(stdout)
1479 if stderr is not None:
1480 stderr = b''.join(stderr)
1481
1482 # Translate newlines, if requested.
1483 # This also turns bytes into strings.
1484 if self.universal_newlines:
1485 if stdout is not None:
1486 stdout = self._translate_newlines(stdout,
1487 self.stdout.encoding)
1488 if stderr is not None:
1489 stderr = self._translate_newlines(stderr,
1490 self.stderr.encoding)
1491
1492 self.wait()
1493 return (stdout, stderr)
1494
1495
1496 def _communicate_with_poll(self, input):
1497 stdout = None # Return
1498 stderr = None # Return
1499 fd2file = {}
1500 fd2output = {}
1501
1502 poller = select.poll()
1503 def register_and_append(file_obj, eventmask):
1504 poller.register(file_obj.fileno(), eventmask)
1505 fd2file[file_obj.fileno()] = file_obj
1506
1507 def close_unregister_and_remove(fd):
1508 poller.unregister(fd)
1509 fd2file[fd].close()
1510 fd2file.pop(fd)
1511
1512 if self.stdin and input:
1513 register_and_append(self.stdin, select.POLLOUT)
1514
1515 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1516 if self.stdout:
1517 register_and_append(self.stdout, select_POLLIN_POLLPRI)
1518 fd2output[self.stdout.fileno()] = stdout = []
1519 if self.stderr:
1520 register_and_append(self.stderr, select_POLLIN_POLLPRI)
1521 fd2output[self.stderr.fileno()] = stderr = []
1522
1523 input_offset = 0
1524 while fd2file:
1525 try:
1526 ready = poller.poll()
1527 except select.error as e:
1528 if e.args[0] == errno.EINTR:
1529 continue
1530 raise
1531
1532 # XXX Rewrite these to use non-blocking I/O on the
1533 # file objects; they are no longer using C stdio!
1534
1535 for fd, mode in ready:
1536 if mode & select.POLLOUT:
1537 chunk = input[input_offset : input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001538 try:
1539 input_offset += os.write(fd, chunk)
1540 except OSError as e:
1541 if e.errno == errno.EPIPE:
1542 close_unregister_and_remove(fd)
1543 else:
1544 raise
1545 else:
1546 if input_offset >= len(input):
1547 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001548 elif mode & select_POLLIN_POLLPRI:
1549 data = os.read(fd, 4096)
1550 if not data:
1551 close_unregister_and_remove(fd)
1552 fd2output[fd].append(data)
1553 else:
1554 # Ignore hang up or errors.
1555 close_unregister_and_remove(fd)
1556
1557 return (stdout, stderr)
1558
1559
1560 def _communicate_with_select(self, input):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001561 read_set = []
1562 write_set = []
1563 stdout = None # Return
1564 stderr = None # Return
1565
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001566 if self.stdin and input:
1567 write_set.append(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001568 if self.stdout:
1569 read_set.append(self.stdout)
Tim Peterse718f612004-10-12 21:51:32 +00001570 stdout = []
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001571 if self.stderr:
1572 read_set.append(self.stderr)
1573 stderr = []
1574
Thomas Wouters902d6eb2007-01-09 23:18:33 +00001575 input_offset = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001576 while read_set or write_set:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001577 try:
1578 rlist, wlist, xlist = select.select(read_set, write_set, [])
1579 except select.error as e:
1580 if e.args[0] == errno.EINTR:
1581 continue
1582 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001583
Guido van Rossum98297ee2007-11-06 21:34:58 +00001584 # XXX Rewrite these to use non-blocking I/O on the
1585 # file objects; they are no longer using C stdio!
1586
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001587 if self.stdin in wlist:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001588 chunk = input[input_offset : input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001589 try:
1590 bytes_written = os.write(self.stdin.fileno(), chunk)
1591 except OSError as e:
1592 if e.errno == errno.EPIPE:
1593 self.stdin.close()
1594 write_set.remove(self.stdin)
1595 else:
1596 raise
1597 else:
1598 input_offset += bytes_written
1599 if input_offset >= len(input):
1600 self.stdin.close()
1601 write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001602
1603 if self.stdout in rlist:
1604 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001605 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001606 self.stdout.close()
1607 read_set.remove(self.stdout)
1608 stdout.append(data)
1609
1610 if self.stderr in rlist:
1611 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001612 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001613 self.stderr.close()
1614 read_set.remove(self.stderr)
1615 stderr.append(data)
1616
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001617 return (stdout, stderr)
1618
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001619
Christian Heimesa342c012008-04-20 21:01:16 +00001620 def send_signal(self, sig):
1621 """Send a signal to the process
1622 """
1623 os.kill(self.pid, sig)
1624
1625 def terminate(self):
1626 """Terminate the process with SIGTERM
1627 """
1628 self.send_signal(signal.SIGTERM)
1629
1630 def kill(self):
1631 """Kill the process with SIGKILL
1632 """
1633 self.send_signal(signal.SIGKILL)
1634
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001635
1636def _demo_posix():
1637 #
1638 # Example 1: Simple redirection: Get process list
1639 #
1640 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001641 print("Process list:")
1642 print(plist)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001643
1644 #
1645 # Example 2: Change uid before executing child
1646 #
1647 if os.getuid() == 0:
1648 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
1649 p.wait()
1650
1651 #
1652 # Example 3: Connecting several subprocesses
1653 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001654 print("Looking for 'hda'...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001655 p1 = Popen(["dmesg"], stdout=PIPE)
1656 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001657 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001658
1659 #
1660 # Example 4: Catch execution error
1661 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001662 print()
1663 print("Trying a weird file...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001664 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001665 print(Popen(["/this/path/does/not/exist"]).communicate())
Guido van Rossumb940e112007-01-10 16:19:56 +00001666 except OSError as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001667 if e.errno == errno.ENOENT:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001668 print("The file didn't exist. I thought so...")
1669 print("Child traceback:")
1670 print(e.child_traceback)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001671 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001672 print("Error", e.errno)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001673 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001674 print("Gosh. No error.", file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001675
1676
1677def _demo_windows():
1678 #
1679 # Example 1: Connecting several subprocesses
1680 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001681 print("Looking for 'PROMPT' in set output...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001682 p1 = Popen("set", stdout=PIPE, shell=True)
1683 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001684 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001685
1686 #
1687 # Example 2: Simple execution of program
1688 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001689 print("Executing calc...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001690 p = Popen("calc")
1691 p.wait()
1692
1693
1694if __name__ == "__main__":
1695 if mswindows:
1696 _demo_windows()
1697 else:
1698 _demo_posix()