blob: 0e15f10c662f1668ffcbdd5c15c6b9ce72522d30 [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
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000351
Peter Astrand454f7672005-01-01 09:36:35 +0000352# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400353class SubprocessError(Exception): pass
354
355
356class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000357 """This exception is raised when a process run by check_call() or
358 check_output() returns a non-zero exit status.
359 The exit status will be stored in the returncode attribute;
360 check_output() will also store the output in the output attribute.
361 """
362 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000363 self.returncode = returncode
364 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000365 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000366 def __str__(self):
367 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
368
Peter Astrand454f7672005-01-01 09:36:35 +0000369
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400370class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400371 """This exception is raised when the timeout expires while waiting for a
372 child process.
373 """
374 def __init__(self, cmd, output=None):
375 self.cmd = cmd
376 self.output = output
377
378 def __str__(self):
379 return ("Command '%s' timed out after %s seconds" %
380 (self.cmd, self.timeout))
381
382
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000383if mswindows:
384 import threading
385 import msvcrt
Brian Curtin1ce6b582010-04-24 16:19:22 +0000386 import _subprocess
387 class STARTUPINFO:
388 dwFlags = 0
389 hStdInput = None
390 hStdOutput = None
391 hStdError = None
392 wShowWindow = 0
393 class pywintypes:
394 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000395else:
396 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000397 _has_poll = hasattr(select, 'poll')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000398 import errno
399 import fcntl
400 import pickle
401
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000402 try:
403 import _posixsubprocess
404 except ImportError:
405 _posixsubprocess = None
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000406 warnings.warn("The _posixsubprocess module is not being used. "
407 "Child process reliability may suffer if your "
408 "program uses threads.", RuntimeWarning)
409
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000410 # When select or poll has indicated that the file is writable,
411 # we can write up to _PIPE_BUF bytes without risk of blocking.
412 # POSIX defines PIPE_BUF as >= 512.
413 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
414
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000415 _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1)
416
417 def _set_cloexec(fd, cloexec):
418 old = fcntl.fcntl(fd, fcntl.F_GETFD)
419 if cloexec:
420 fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC)
421 else:
422 fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC)
423
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000424 if _posixsubprocess:
425 _create_pipe = _posixsubprocess.cloexec_pipe
426 else:
427 def _create_pipe():
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000428 fds = os.pipe()
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000429 _set_cloexec(fds[0], True)
430 _set_cloexec(fds[1], True)
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000431 return fds
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000432
Brett Cannona23810f2008-05-26 19:04:21 +0000433__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200434 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000435
Brian Curtin1ce6b582010-04-24 16:19:22 +0000436if mswindows:
Brett Cannon84df1e62010-05-14 00:33:40 +0000437 from _subprocess import CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP
Brian Curtin1ce6b582010-04-24 16:19:22 +0000438 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000439try:
440 MAXFD = os.sysconf("SC_OPEN_MAX")
441except:
442 MAXFD = 256
443
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000444_active = []
445
446def _cleanup():
447 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000448 res = inst._internal_poll(_deadstate=sys.maxsize)
Guido van Rossumb5d47ef2006-08-24 02:27:45 +0000449 if res is not None and res >= 0:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000450 try:
451 _active.remove(inst)
452 except ValueError:
453 # This can happen if two threads create a new Popen instance.
454 # It's harmless that it was already removed, so ignore.
455 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000456
457PIPE = -1
458STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200459DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000460
461
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000462def _eintr_retry_call(func, *args):
463 while True:
464 try:
465 return func(*args)
466 except OSError as e:
467 if e.errno == errno.EINTR:
468 continue
469 raise
470
471
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400472def call(*popenargs, timeout=None, **kwargs):
473 """Run command with arguments. Wait for command to complete or
474 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000475
476 The arguments are the same as for the Popen constructor. Example:
477
478 retcode = call(["ls", "-l"])
479 """
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400480 p = Popen(*popenargs, **kwargs)
481 try:
482 return p.wait(timeout=timeout)
483 except TimeoutExpired:
484 p.kill()
485 p.wait()
486 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000487
488
Peter Astrand454f7672005-01-01 09:36:35 +0000489def check_call(*popenargs, **kwargs):
490 """Run command with arguments. Wait for command to complete. If
491 the exit code was zero then return, otherwise raise
492 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000493 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000494
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400495 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000496
497 check_call(["ls", "-l"])
498 """
499 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000500 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000501 cmd = kwargs.get("args")
502 if cmd is None:
503 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000504 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000505 return 0
506
507
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400508def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000509 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000510
511 If the exit code was non-zero it raises a CalledProcessError. The
512 CalledProcessError object will have the return code in the returncode
513 attribute and output in the output attribute.
514
515 The arguments are the same as for the Popen constructor. Example:
516
517 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000518 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000519
520 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000521 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000522
523 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000524 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000525 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000526 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000527 """
528 if 'stdout' in kwargs:
529 raise ValueError('stdout argument not allowed, it will be overridden.')
530 process = Popen(*popenargs, stdout=PIPE, **kwargs)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400531 try:
532 output, unused_err = process.communicate(timeout=timeout)
533 except TimeoutExpired:
534 process.kill()
535 output, unused_err = process.communicate()
536 raise TimeoutExpired(process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000537 retcode = process.poll()
538 if retcode:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400539 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000540 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000541
542
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000543def list2cmdline(seq):
544 """
545 Translate a sequence of arguments into a command line
546 string, using the same rules as the MS C runtime:
547
548 1) Arguments are delimited by white space, which is either a
549 space or a tab.
550
551 2) A string surrounded by double quotation marks is
552 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000553 contained within. A quoted string can be embedded in an
554 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000555
556 3) A double quotation mark preceded by a backslash is
557 interpreted as a literal double quotation mark.
558
559 4) Backslashes are interpreted literally, unless they
560 immediately precede a double quotation mark.
561
562 5) If backslashes immediately precede a double quotation mark,
563 every pair of backslashes is interpreted as a literal
564 backslash. If the number of backslashes is odd, the last
565 backslash escapes the next double quotation mark as
566 described in rule 3.
567 """
568
569 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000570 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
571 # or search http://msdn.microsoft.com for
572 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000573 result = []
574 needquote = False
575 for arg in seq:
576 bs_buf = []
577
578 # Add a space to separate this argument from the others
579 if result:
580 result.append(' ')
581
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000582 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000583 if needquote:
584 result.append('"')
585
586 for c in arg:
587 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000588 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000589 bs_buf.append(c)
590 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000591 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000592 result.append('\\' * len(bs_buf)*2)
593 bs_buf = []
594 result.append('\\"')
595 else:
596 # Normal char
597 if bs_buf:
598 result.extend(bs_buf)
599 bs_buf = []
600 result.append(c)
601
Christian Heimesfdab48e2008-01-20 09:06:41 +0000602 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000603 if bs_buf:
604 result.extend(bs_buf)
605
606 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000607 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000608 result.append('"')
609
610 return ''.join(result)
611
612
Brett Cannona23810f2008-05-26 19:04:21 +0000613# Various tools for executing commands and looking at their output and status.
614#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000615# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000616
617def getstatusoutput(cmd):
618 """Return (status, output) of executing cmd in a shell.
619
620 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
621 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
622 returned output will contain output or error messages. A trailing newline
623 is stripped from the output. The exit status for the command can be
624 interpreted according to the rules for the C function wait(). Example:
625
626 >>> import subprocess
627 >>> subprocess.getstatusoutput('ls /bin/ls')
628 (0, '/bin/ls')
629 >>> subprocess.getstatusoutput('cat /bin/junk')
630 (256, 'cat: /bin/junk: No such file or directory')
631 >>> subprocess.getstatusoutput('/bin/junk')
632 (256, 'sh: /bin/junk: not found')
633 """
634 pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
635 text = pipe.read()
636 sts = pipe.close()
637 if sts is None: sts = 0
638 if text[-1:] == '\n': text = text[:-1]
639 return sts, text
640
641
642def getoutput(cmd):
643 """Return output (stdout or stderr) of executing cmd in a shell.
644
645 Like getstatusoutput(), except the exit status is ignored and the return
646 value is a string containing the command's output. Example:
647
648 >>> import subprocess
649 >>> subprocess.getoutput('ls /bin/ls')
650 '/bin/ls'
651 """
652 return getstatusoutput(cmd)[1]
653
654
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000655_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000656
657
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000658class Popen(object):
659 def __init__(self, args, bufsize=0, executable=None,
660 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000661 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
662 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000663 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000664 restore_signals=True, start_new_session=False,
665 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000666 """Create new Popen instance."""
667 _cleanup()
668
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000669 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400670 self._input = None
671 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000672 if bufsize is None:
673 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000674 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000675 raise TypeError("bufsize must be an integer")
676
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000677 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000678 if preexec_fn is not None:
679 raise ValueError("preexec_fn is not supported on Windows "
680 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000681 any_stdio_set = (stdin is not None or stdout is not None or
682 stderr is not None)
683 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
684 if any_stdio_set:
685 close_fds = False
686 else:
687 close_fds = True
688 elif close_fds and any_stdio_set:
689 raise ValueError(
690 "close_fds is not supported on Windows platforms"
691 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000692 else:
693 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000694 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
695 close_fds = True
696 if pass_fds and not close_fds:
697 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
698 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000699 if startupinfo is not None:
700 raise ValueError("startupinfo is only supported on Windows "
701 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000702 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000703 raise ValueError("creationflags is only supported on Windows "
704 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000705
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400706 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000707 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000708 self.stdout = None
709 self.stderr = None
710 self.pid = None
711 self.returncode = None
712 self.universal_newlines = universal_newlines
713
714 # Input and output objects. The general principle is like
715 # this:
716 #
717 # Parent Child
718 # ------ -----
719 # p2cwrite ---stdin---> p2cread
720 # c2pread <--stdout--- c2pwrite
721 # errread <--stderr--- errwrite
722 #
723 # On POSIX, the child objects are file descriptors. On
724 # Windows, these are Windows file handles. The parent objects
725 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000726 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000727 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000728
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000729 (p2cread, p2cwrite,
730 c2pread, c2pwrite,
731 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
732
Antoine Pitrouc9982322011-01-04 19:07:07 +0000733 # We wrap OS handles *before* launching the child, otherwise a
734 # quickly terminating child could make our fds unwrappable
735 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000736
Thomas Wouterscf297e42007-02-23 15:07:44 +0000737 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000738 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000739 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000740 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000741 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000742 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000743 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000744
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000745 if bufsize == 0:
746 bufsize = 1 # Nearly unbuffered (XXX for now)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000747 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000748 self.stdin = io.open(p2cwrite, 'wb', bufsize)
749 if self.universal_newlines:
750 self.stdin = io.TextIOWrapper(self.stdin)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000751 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000752 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000754 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000755 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000756 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000757 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000758 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000759
Antoine Pitrouc9982322011-01-04 19:07:07 +0000760 try:
761 self._execute_child(args, executable, preexec_fn, close_fds,
762 pass_fds, cwd, env, universal_newlines,
763 startupinfo, creationflags, shell,
764 p2cread, p2cwrite,
765 c2pread, c2pwrite,
766 errread, errwrite,
767 restore_signals, start_new_session)
768 except:
769 # Cleanup if the child failed starting
770 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
771 try:
772 f.close()
773 except EnvironmentError:
774 # Ignore EBADF or other errors
775 pass
776 raise
777
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000778
Guido van Rossum98297ee2007-11-06 21:34:58 +0000779 def _translate_newlines(self, data, encoding):
780 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
781 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000782
Brian Curtin79cdb662010-12-03 02:46:02 +0000783 def __enter__(self):
784 return self
785
786 def __exit__(self, type, value, traceback):
787 if self.stdout:
788 self.stdout.close()
789 if self.stderr:
790 self.stderr.close()
791 if self.stdin:
792 self.stdin.close()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000793
Brett Cannon84df1e62010-05-14 00:33:40 +0000794 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000795 if not self._child_created:
796 # 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
812 process to terminate. The optional input argument should be a
813 string to be sent to the child process, or None, if no data
814 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
821 if timeout is not None:
822 endtime = time.time() + timeout
823 else:
824 endtime = None
825
826 # Optimization: If we are not worried about timeouts, we haven't
827 # started communicating, and we have one or zero pipes, using select()
828 # or threads is unnecessary.
829 if (endtime is None and not self._communication_started and
830 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000831 stdout = None
832 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000833 if self.stdin:
834 if input:
835 self.stdin.write(input)
836 self.stdin.close()
837 elif self.stdout:
838 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000839 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000840 elif self.stderr:
841 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000842 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000843 self.wait()
844 return (stdout, stderr)
Tim Peterseba28be2005-03-28 01:08:02 +0000845
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400846 try:
847 stdout, stderr = self._communicate(input, endtime)
848 finally:
849 self._communication_started = True
850
851 sts = self.wait(timeout=self._remaining_time(endtime))
852
853 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000854
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000855
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000856 def poll(self):
857 return self._internal_poll()
858
859
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400860 def _remaining_time(self, endtime):
861 """Convenience for _communicate when computing timeouts."""
862 if endtime is None:
863 return None
864 else:
865 return endtime - time.time()
866
867
868 def _check_timeout(self, endtime):
869 """Convenience for checking if a timeout has expired."""
870 if endtime is None:
871 return
872 if time.time() > endtime:
873 raise TimeoutExpired(self.args)
874
875
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000876 if mswindows:
877 #
878 # Windows methods
879 #
880 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000881 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000882 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
883 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000884 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000885 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000886
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000887 p2cread, p2cwrite = -1, -1
888 c2pread, c2pwrite = -1, -1
889 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000890
Peter Astrandd38ddf42005-02-10 08:32:50 +0000891 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000892 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000893 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000894 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000895 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000896 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200897 elif stdin == DEVNULL:
898 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000899 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000900 p2cread = msvcrt.get_osfhandle(stdin)
901 else:
902 # Assuming file-like object
903 p2cread = msvcrt.get_osfhandle(stdin.fileno())
904 p2cread = self._make_inheritable(p2cread)
905
Peter Astrandd38ddf42005-02-10 08:32:50 +0000906 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000907 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000908 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000909 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000910 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000911 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200912 elif stdout == DEVNULL:
913 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000914 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000915 c2pwrite = msvcrt.get_osfhandle(stdout)
916 else:
917 # Assuming file-like object
918 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
919 c2pwrite = self._make_inheritable(c2pwrite)
920
Peter Astrandd38ddf42005-02-10 08:32:50 +0000921 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000922 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000923 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000924 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000925 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000926 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000927 elif stderr == STDOUT:
928 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200929 elif stderr == DEVNULL:
930 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000931 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000932 errwrite = msvcrt.get_osfhandle(stderr)
933 else:
934 # Assuming file-like object
935 errwrite = msvcrt.get_osfhandle(stderr.fileno())
936 errwrite = self._make_inheritable(errwrite)
937
938 return (p2cread, p2cwrite,
939 c2pread, c2pwrite,
940 errread, errwrite)
941
942
943 def _make_inheritable(self, handle):
944 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000945 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
946 handle, _subprocess.GetCurrentProcess(), 0, 1,
947 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000948
949
950 def _find_w9xpopen(self):
951 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000952 w9xpopen = os.path.join(
953 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000954 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000955 if not os.path.exists(w9xpopen):
956 # Eeek - file-not-found - possibly an embedding
957 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000958 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
959 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000960 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000961 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
962 "needed for Popen to work with your "
963 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000964 return w9xpopen
965
Tim Peterse718f612004-10-12 21:51:32 +0000966
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000967 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000968 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000969 startupinfo, creationflags, shell,
970 p2cread, p2cwrite,
971 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000972 errread, errwrite,
973 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000974 """Execute program (MS Windows version)"""
975
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000976 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000977
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000978 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000979 args = list2cmdline(args)
980
Peter Astrandc1d65362004-11-07 14:30:34 +0000981 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000982 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000983 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000984 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000985 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000986 startupinfo.hStdInput = p2cread
987 startupinfo.hStdOutput = c2pwrite
988 startupinfo.hStdError = errwrite
989
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000990 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000991 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
992 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000993 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000994 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000995 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000996 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000997 # Win9x, or using command.com on NT. We need to
998 # use the w9xpopen intermediate program. For more
999 # information, see KB Q150956
1000 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1001 w9xpopen = self._find_w9xpopen()
1002 args = '"%s" %s' % (w9xpopen, args)
1003 # Not passing CREATE_NEW_CONSOLE has been known to
1004 # cause random failures on win9x. Specifically a
1005 # dialog: "Your program accessed mem currently in
1006 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001007 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001008 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001009 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001010
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001011 # Start the process
1012 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001013 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001014 # no special security
1015 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001016 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001017 creationflags,
1018 env,
1019 cwd,
1020 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001021 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001022 # Translate pywintypes.error to WindowsError, which is
1023 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001024 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001025 # how can this be done from Python?
1026 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001027 finally:
1028 # Child is launched. Close the parent's copy of those pipe
1029 # handles that only the child should have open. You need
1030 # to make sure that no handles to the write end of the
1031 # output pipe are maintained in this process or else the
1032 # pipe will not close when the child process exits and the
1033 # ReadFile will hang.
1034 if p2cread != -1:
1035 p2cread.Close()
1036 if c2pwrite != -1:
1037 c2pwrite.Close()
1038 if errwrite != -1:
1039 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001040 if hasattr(self, '_devnull'):
1041 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001042
1043 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001044 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001045 self._handle = hp
1046 self.pid = pid
1047 ht.Close()
1048
Brett Cannon84df1e62010-05-14 00:33:40 +00001049 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001050 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1051 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1052 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001053 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001054 attribute.
1055
1056 This method is called by __del__, so it can only refer to objects
1057 in its local scope.
1058
1059 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001060 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001061 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1062 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001063 return self.returncode
1064
1065
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001066 def wait(self, timeout=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001067 """Wait for child process to terminate. Returns returncode
1068 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001069 if timeout is None:
1070 timeout = _subprocess.INFINITE
1071 else:
1072 timeout = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001073 if self.returncode is None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001074 result = _subprocess.WaitForSingleObject(self._handle, timeout)
1075 if result == _subprocess.WAIT_TIMEOUT:
1076 raise TimeoutExpired(self.args)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001077 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001078 return self.returncode
1079
1080
1081 def _readerthread(self, fh, buffer):
1082 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001083 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001084
1085
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001086 def _communicate(self, input, endtime):
1087 # Start reader threads feeding into a list hanging off of this
1088 # object, unless they've already been started.
1089 if self.stdout and not hasattr(self, "_stdout_buff"):
1090 self._stdout_buff = []
1091 self.stdout_thread = \
1092 threading.Thread(target=self._readerthread,
1093 args=(self.stdout, self._stdout_buff))
1094 self.stdout_thread.daemon = True
1095 self.stdout_thread.start()
1096 if self.stderr and not hasattr(self, "_stderr_buff"):
1097 self._stderr_buff = []
1098 self.stderr_thread = \
1099 threading.Thread(target=self._readerthread,
1100 args=(self.stderr, self._stderr_buff))
1101 self.stderr_thread.daemon = True
1102 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001103
1104 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001105 if input is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001106 self.stdin.write(input)
1107 self.stdin.close()
1108
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001109 # Wait for the reader threads, or time out. If we time out, the
1110 # threads remain reading and the fds left open in case the user
1111 # calls communicate again.
1112 if self.stdout is not None:
1113 self.stdout_thread.join(self._remaining_time(endtime))
1114 if self.stdout_thread.isAlive():
1115 raise TimeoutExpired(self.args)
1116 if self.stderr is not None:
1117 self.stderr_thread.join(self._remaining_time(endtime))
1118 if self.stderr_thread.isAlive():
1119 raise TimeoutExpired(self.args)
1120
1121 # Collect the output from and close both pipes, now that we know
1122 # both have been read successfully.
1123 stdout = None
1124 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001125 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001126 stdout = self._stdout_buff
1127 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001128 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001129 stderr = self._stderr_buff
1130 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001131
1132 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001133 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001134 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001135 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001136 stderr = stderr[0]
1137
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 return (stdout, stderr)
1139
Christian Heimesa342c012008-04-20 21:01:16 +00001140 def send_signal(self, sig):
1141 """Send a signal to the process
1142 """
1143 if sig == signal.SIGTERM:
1144 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001145 elif sig == signal.CTRL_C_EVENT:
1146 os.kill(self.pid, signal.CTRL_C_EVENT)
1147 elif sig == signal.CTRL_BREAK_EVENT:
1148 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001149 else:
Brian Curtin19651362010-09-07 13:24:38 +00001150 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001151
1152 def terminate(self):
1153 """Terminates the process
1154 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001155 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001156
1157 kill = terminate
1158
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001159 else:
1160 #
1161 # POSIX methods
1162 #
1163 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001164 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001165 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1166 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001167 p2cread, p2cwrite = -1, -1
1168 c2pread, c2pwrite = -1, -1
1169 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001170
Peter Astrandd38ddf42005-02-10 08:32:50 +00001171 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172 pass
1173 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001174 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001175 elif stdin == DEVNULL:
1176 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001177 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001178 p2cread = stdin
1179 else:
1180 # Assuming file-like object
1181 p2cread = stdin.fileno()
1182
Peter Astrandd38ddf42005-02-10 08:32:50 +00001183 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001184 pass
1185 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001186 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001187 elif stdout == DEVNULL:
1188 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001189 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001190 c2pwrite = stdout
1191 else:
1192 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001193 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001194
Peter Astrandd38ddf42005-02-10 08:32:50 +00001195 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001196 pass
1197 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001198 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001199 elif stderr == STDOUT:
1200 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001201 elif stderr == DEVNULL:
1202 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001203 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001204 errwrite = stderr
1205 else:
1206 # Assuming file-like object
1207 errwrite = stderr.fileno()
1208
1209 return (p2cread, p2cwrite,
1210 c2pread, c2pwrite,
1211 errread, errwrite)
1212
1213
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001214 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001215 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001216 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001217 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001218 os.closerange(start_fd, fd)
1219 start_fd = fd + 1
1220 if start_fd <= MAXFD:
1221 os.closerange(start_fd, MAXFD)
1222
1223
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001224 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001225 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001226 startupinfo, creationflags, shell,
1227 p2cread, p2cwrite,
1228 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001229 errread, errwrite,
1230 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001231 """Execute program (POSIX version)"""
1232
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001233 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001234 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001235 else:
1236 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237
1238 if shell:
1239 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001240 if executable:
1241 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001242
Peter Astrandd38ddf42005-02-10 08:32:50 +00001243 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244 executable = args[0]
1245
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001246 # For transferring possible exec failure from child to parent.
1247 # Data format: "exception name:hex errno:description"
1248 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001249 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001250 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001252
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001253 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001254 # We must avoid complex work that could involve
1255 # malloc or free in the child process to avoid
1256 # potential deadlocks, thus we do all this here.
1257 # and pass it to fork_exec()
1258
1259 if env:
Victor Stinner449c4662010-05-08 11:10:09 +00001260 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001261 for k, v in env.items()]
1262 else:
1263 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001264 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001265 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001266 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001267 else:
1268 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001269 executable_list = tuple(
1270 os.path.join(os.fsencode(dir), executable)
1271 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001272 fds_to_keep = set(pass_fds)
1273 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001274 self.pid = _posixsubprocess.fork_exec(
1275 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001276 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001277 p2cread, p2cwrite, c2pread, c2pwrite,
1278 errread, errwrite,
1279 errpipe_read, errpipe_write,
1280 restore_signals, start_new_session, preexec_fn)
1281 else:
1282 # Pure Python implementation: It is not thread safe.
1283 # This implementation may deadlock in the child if your
1284 # parent process has any other threads running.
1285
1286 gc_was_enabled = gc.isenabled()
1287 # Disable gc to avoid bug where gc -> file_dealloc ->
1288 # write to stderr -> hang. See issue1336
1289 gc.disable()
1290 try:
1291 self.pid = os.fork()
1292 except:
1293 if gc_was_enabled:
1294 gc.enable()
1295 raise
1296 self._child_created = True
1297 if self.pid == 0:
1298 # Child
1299 try:
1300 # Close parent's pipe ends
1301 if p2cwrite != -1:
1302 os.close(p2cwrite)
1303 if c2pread != -1:
1304 os.close(c2pread)
1305 if errread != -1:
1306 os.close(errread)
1307 os.close(errpipe_read)
1308
1309 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001310 def _dup2(a, b):
1311 # dup2() removes the CLOEXEC flag but
1312 # we must do it ourselves if dup2()
1313 # would be a no-op (issue #10806).
1314 if a == b:
1315 _set_cloexec(a, False)
1316 elif a != -1:
1317 os.dup2(a, b)
1318 _dup2(p2cread, 0)
1319 _dup2(c2pwrite, 1)
1320 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001321
1322 # Close pipe fds. Make sure we don't close the
1323 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001324 closed = set()
1325 for fd in [p2cread, c2pwrite, errwrite]:
1326 if fd > 2 and fd not in closed:
1327 os.close(fd)
1328 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001329
1330 # Close all other fds, if asked for
1331 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001332 fds_to_keep = set(pass_fds)
1333 fds_to_keep.add(errpipe_write)
1334 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001335
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001336
1337 if cwd is not None:
1338 os.chdir(cwd)
1339
1340 # This is a copy of Python/pythonrun.c
1341 # _Py_RestoreSignals(). If that were exposed
1342 # as a sys._py_restoresignals func it would be
1343 # better.. but this pure python implementation
1344 # isn't likely to be used much anymore.
1345 if restore_signals:
1346 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1347 for sig in signals:
1348 if hasattr(signal, sig):
1349 signal.signal(getattr(signal, sig),
1350 signal.SIG_DFL)
1351
1352 if start_new_session and hasattr(os, 'setsid'):
1353 os.setsid()
1354
1355 if preexec_fn:
1356 preexec_fn()
1357
1358 if env is None:
1359 os.execvp(executable, args)
1360 else:
1361 os.execvpe(executable, args, env)
1362
1363 except:
1364 try:
1365 exc_type, exc_value = sys.exc_info()[:2]
1366 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001367 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001368 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001369 errno_num = 0
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001371 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001372 message = message.encode(errors="surrogatepass")
1373 os.write(errpipe_write, message)
1374 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001375 # We MUST not allow anything odd happening
1376 # above to prevent us from exiting below.
1377 pass
1378
1379 # This exitcode won't be reported to applications
1380 # so it really doesn't matter what we return.
1381 os._exit(255)
1382
1383 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001384 if gc_was_enabled:
1385 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001386 finally:
1387 # be sure the FD is closed no matter what
1388 os.close(errpipe_write)
1389
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001390 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001391 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001392 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001393 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001394 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001395 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001396 if hasattr(self, '_devnull'):
1397 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001398
1399 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001400 # exception (limited in size)
1401 data = bytearray()
1402 while True:
1403 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1404 data += part
1405 if not part or len(data) > 50000:
1406 break
Facundo Batista10706e22009-06-19 20:34:30 +00001407 finally:
1408 # be sure the FD is closed no matter what
1409 os.close(errpipe_read)
1410
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001411 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001412 try:
1413 _eintr_retry_call(os.waitpid, self.pid, 0)
1414 except OSError as e:
1415 if e.errno != errno.ECHILD:
1416 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001417 try:
1418 exception_name, hex_errno, err_msg = data.split(b':', 2)
1419 except ValueError:
1420 print('Bad exception data:', repr(data))
1421 exception_name = b'RuntimeError'
1422 hex_errno = b'0'
1423 err_msg = b'Unknown'
1424 child_exception_type = getattr(
1425 builtins, exception_name.decode('ascii'),
1426 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001427 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001428 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001429 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001430 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001431 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001432 errno_num = int(hex_errno, 16)
1433 if errno_num != 0:
1434 err_msg = os.strerror(errno_num)
1435 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001436 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001437 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001438 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001439
1440
Brett Cannon84df1e62010-05-14 00:33:40 +00001441 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1442 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1443 _WEXITSTATUS=os.WEXITSTATUS):
1444 # This method is called (indirectly) by __del__, so it cannot
1445 # refer to anything outside of its local scope."""
1446 if _WIFSIGNALED(sts):
1447 self.returncode = -_WTERMSIG(sts)
1448 elif _WIFEXITED(sts):
1449 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001450 else:
1451 # Should never happen
1452 raise RuntimeError("Unknown child exit status!")
1453
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001454
Brett Cannon84df1e62010-05-14 00:33:40 +00001455 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1456 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001458 attribute.
1459
1460 This method is called by __del__, so it cannot reference anything
1461 outside of the local scope (nor can any methods it calls).
1462
1463 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001464 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001465 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001466 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001467 if pid == self.pid:
1468 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001469 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001470 if _deadstate is not None:
1471 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001472 return self.returncode
1473
1474
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001475 def _try_wait(self, wait_flags):
1476 try:
1477 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1478 except OSError as e:
1479 if e.errno != errno.ECHILD:
1480 raise
1481 # This happens if SIGCLD is set to be ignored or waiting
1482 # for child processes has otherwise been disabled for our
1483 # process. This child is dead, we can't get the status.
1484 pid = self.pid
1485 sts = 0
1486 return (pid, sts)
1487
1488
1489 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001490 """Wait for child process to terminate. Returns returncode
1491 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001492 # If timeout was passed but not endtime, compute endtime in terms of
1493 # timeout.
1494 if endtime is None and timeout is not None:
1495 endtime = time.time() + timeout
1496 if self.returncode is not None:
1497 return self.returncode
1498 elif endtime is not None:
1499 # Enter a busy loop if we have a timeout. This busy loop was
1500 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1501 delay = 0.0005 # 500 us -> initial delay of 1 ms
1502 while True:
1503 (pid, sts) = self._try_wait(os.WNOHANG)
1504 assert pid == self.pid or pid == 0
1505 if pid == self.pid:
1506 self._handle_exitstatus(sts)
1507 break
1508 remaining = self._remaining_time(endtime)
1509 if remaining <= 0:
1510 raise TimeoutExpired(self.args)
1511 delay = min(delay * 2, remaining, .05)
1512 time.sleep(delay)
1513 elif self.returncode is None:
1514 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001515 self._handle_exitstatus(sts)
1516 return self.returncode
1517
1518
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001519 def _communicate(self, input, endtime):
1520 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001521 # Flush stdio buffer. This might block, if the user has
1522 # been writing to .stdin in an uncontrolled fashion.
1523 self.stdin.flush()
1524 if not input:
1525 self.stdin.close()
1526
1527 if _has_poll:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001528 stdout, stderr = self._communicate_with_poll(input, endtime)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001529 else:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001530 stdout, stderr = self._communicate_with_select(input, endtime)
1531
1532 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001533
1534 # All data exchanged. Translate lists into strings.
1535 if stdout is not None:
1536 stdout = b''.join(stdout)
1537 if stderr is not None:
1538 stderr = b''.join(stderr)
1539
1540 # Translate newlines, if requested.
1541 # This also turns bytes into strings.
1542 if self.universal_newlines:
1543 if stdout is not None:
1544 stdout = self._translate_newlines(stdout,
1545 self.stdout.encoding)
1546 if stderr is not None:
1547 stderr = self._translate_newlines(stderr,
1548 self.stderr.encoding)
1549
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001550 return (stdout, stderr)
1551
1552
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001553 def _communicate_with_poll(self, input, endtime):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001554 stdout = None # Return
1555 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001556
1557 if not self._communication_started:
1558 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001559
1560 poller = select.poll()
1561 def register_and_append(file_obj, eventmask):
1562 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001563 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001564
1565 def close_unregister_and_remove(fd):
1566 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001567 self._fd2file[fd].close()
1568 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001569
1570 if self.stdin and input:
1571 register_and_append(self.stdin, select.POLLOUT)
1572
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001573 # Only create this mapping if we haven't already.
1574 if not self._communication_started:
1575 self._fd2output = {}
1576 if self.stdout:
1577 self._fd2output[self.stdout.fileno()] = []
1578 if self.stderr:
1579 self._fd2output[self.stderr.fileno()] = []
1580
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001581 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1582 if self.stdout:
1583 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001584 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001585 if self.stderr:
1586 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001587 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001588
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001589 # Save the input here so that if we time out while communicating,
1590 # we can continue sending input if we retry.
1591 if self.stdin and self._input is None:
1592 self._input_offset = 0
1593 self._input = input
1594 if self.universal_newlines:
1595 self._input = self._input.encode(self.stdin.encoding)
1596
1597 while self._fd2file:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001598 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001599 ready = poller.poll(self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001600 except select.error as e:
1601 if e.args[0] == errno.EINTR:
1602 continue
1603 raise
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001604 self._check_timeout(endtime)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001605
1606 # XXX Rewrite these to use non-blocking I/O on the
1607 # file objects; they are no longer using C stdio!
1608
1609 for fd, mode in ready:
1610 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001611 chunk = self._input[self._input_offset :
1612 self._input_offset + _PIPE_BUF]
1613 self._input_offset += os.write(fd, chunk)
1614 if self._input_offset >= len(self._input):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001615 close_unregister_and_remove(fd)
1616 elif mode & select_POLLIN_POLLPRI:
1617 data = os.read(fd, 4096)
1618 if not data:
1619 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001620 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001621 else:
1622 # Ignore hang up or errors.
1623 close_unregister_and_remove(fd)
1624
1625 return (stdout, stderr)
1626
1627
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001628 def _communicate_with_select(self, input, endtime):
1629 if not self._communication_started:
1630 self._read_set = []
1631 self._write_set = []
1632 if self.stdin and input:
1633 self._write_set.append(self.stdin)
1634 if self.stdout:
1635 self._read_set.append(self.stdout)
1636 if self.stderr:
1637 self._read_set.append(self.stderr)
1638
1639 if self.stdin and self._input is None:
1640 self._input_offset = 0
1641 self._input = input
1642 if self.universal_newlines:
1643 self._input = self._input.encode(self.stdin.encoding)
1644
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001645 stdout = None # Return
1646 stderr = None # Return
1647
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001648 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001649 if not self._communication_started:
1650 self._stdout_buff = []
1651 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001652 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001653 if not self._communication_started:
1654 self._stderr_buff = []
1655 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001656
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001657 while self._read_set or self._write_set:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001658 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001659 (rlist, wlist, xlist) = \
1660 select.select(self._read_set, self._write_set, [],
1661 self._remaining_time(endtime))
Georg Brandl86b2fb92008-07-16 03:43:04 +00001662 except select.error as e:
1663 if e.args[0] == errno.EINTR:
1664 continue
1665 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001666
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001667 # According to the docs, returning three empty lists indicates
1668 # that the timeout expired.
1669 if not (rlist or wlist or xlist):
1670 raise TimeoutExpired(self.args)
1671 # We also check what time it is ourselves for good measure.
1672 self._check_timeout(endtime)
1673
Guido van Rossum98297ee2007-11-06 21:34:58 +00001674 # XXX Rewrite these to use non-blocking I/O on the
1675 # file objects; they are no longer using C stdio!
1676
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001677 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001678 chunk = self._input[self._input_offset :
1679 self._input_offset + _PIPE_BUF]
Guido van Rossumbae07c92007-10-08 02:46:15 +00001680 bytes_written = os.write(self.stdin.fileno(), chunk)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001681 self._input_offset += bytes_written
1682 if self._input_offset >= len(self._input):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001683 self.stdin.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001684 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001685
1686 if self.stdout in rlist:
1687 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001688 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001689 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001690 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001691 stdout.append(data)
1692
1693 if self.stderr in rlist:
1694 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001695 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001696 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001697 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001698 stderr.append(data)
1699
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001700 return (stdout, stderr)
1701
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001702
Christian Heimesa342c012008-04-20 21:01:16 +00001703 def send_signal(self, sig):
1704 """Send a signal to the process
1705 """
1706 os.kill(self.pid, sig)
1707
1708 def terminate(self):
1709 """Terminate the process with SIGTERM
1710 """
1711 self.send_signal(signal.SIGTERM)
1712
1713 def kill(self):
1714 """Kill the process with SIGKILL
1715 """
1716 self.send_signal(signal.SIGKILL)
1717
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001718
1719def _demo_posix():
1720 #
1721 # Example 1: Simple redirection: Get process list
1722 #
1723 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001724 print("Process list:")
1725 print(plist)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001726
1727 #
1728 # Example 2: Change uid before executing child
1729 #
1730 if os.getuid() == 0:
1731 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
1732 p.wait()
1733
1734 #
1735 # Example 3: Connecting several subprocesses
1736 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001737 print("Looking for 'hda'...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001738 p1 = Popen(["dmesg"], stdout=PIPE)
1739 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001740 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001741
1742 #
1743 # Example 4: Catch execution error
1744 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001745 print()
1746 print("Trying a weird file...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001747 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001748 print(Popen(["/this/path/does/not/exist"]).communicate())
Guido van Rossumb940e112007-01-10 16:19:56 +00001749 except OSError as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001750 if e.errno == errno.ENOENT:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001751 print("The file didn't exist. I thought so...")
1752 print("Child traceback:")
1753 print(e.child_traceback)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001754 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001755 print("Error", e.errno)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001756 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001757 print("Gosh. No error.", file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001758
1759
1760def _demo_windows():
1761 #
1762 # Example 1: Connecting several subprocesses
1763 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001764 print("Looking for 'PROMPT' in set output...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001765 p1 = Popen("set", stdout=PIPE, shell=True)
1766 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001767 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001768
1769 #
1770 # Example 2: Simple execution of program
1771 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001772 print("Executing calc...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001773 p = Popen("calc")
1774 p.wait()
1775
1776
1777if __name__ == "__main__":
1778 if mswindows:
1779 _demo_windows()
1780 else:
1781 _demo_posix()