blob: 4a8adcfa7d2533cf8486b7f525ae53e36cb29678 [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 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400374 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400375 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400376 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400377 self.output = output
378
379 def __str__(self):
380 return ("Command '%s' timed out after %s seconds" %
381 (self.cmd, self.timeout))
382
383
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000384if mswindows:
385 import threading
386 import msvcrt
Brian Curtin1ce6b582010-04-24 16:19:22 +0000387 import _subprocess
388 class STARTUPINFO:
389 dwFlags = 0
390 hStdInput = None
391 hStdOutput = None
392 hStdError = None
393 wShowWindow = 0
394 class pywintypes:
395 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000396else:
397 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000398 _has_poll = hasattr(select, 'poll')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000399 import errno
400 import fcntl
401 import pickle
402
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000403 try:
404 import _posixsubprocess
405 except ImportError:
406 _posixsubprocess = None
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000407 warnings.warn("The _posixsubprocess module is not being used. "
408 "Child process reliability may suffer if your "
409 "program uses threads.", RuntimeWarning)
410
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000411 # When select or poll has indicated that the file is writable,
412 # we can write up to _PIPE_BUF bytes without risk of blocking.
413 # POSIX defines PIPE_BUF as >= 512.
414 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
415
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000416 _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1)
417
418 def _set_cloexec(fd, cloexec):
419 old = fcntl.fcntl(fd, fcntl.F_GETFD)
420 if cloexec:
421 fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC)
422 else:
423 fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC)
424
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000425 if _posixsubprocess:
426 _create_pipe = _posixsubprocess.cloexec_pipe
427 else:
428 def _create_pipe():
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000429 fds = os.pipe()
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000430 _set_cloexec(fds[0], True)
431 _set_cloexec(fds[1], True)
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000432 return fds
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000433
Brett Cannona23810f2008-05-26 19:04:21 +0000434__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200435 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000436
Brian Curtin1ce6b582010-04-24 16:19:22 +0000437if mswindows:
Brett Cannon84df1e62010-05-14 00:33:40 +0000438 from _subprocess import CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP
Brian Curtin1ce6b582010-04-24 16:19:22 +0000439 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000440try:
441 MAXFD = os.sysconf("SC_OPEN_MAX")
442except:
443 MAXFD = 256
444
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000445_active = []
446
447def _cleanup():
448 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000449 res = inst._internal_poll(_deadstate=sys.maxsize)
Guido van Rossumb5d47ef2006-08-24 02:27:45 +0000450 if res is not None and res >= 0:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000451 try:
452 _active.remove(inst)
453 except ValueError:
454 # This can happen if two threads create a new Popen instance.
455 # It's harmless that it was already removed, so ignore.
456 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000457
458PIPE = -1
459STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200460DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000461
462
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000463def _eintr_retry_call(func, *args):
464 while True:
465 try:
466 return func(*args)
467 except OSError as e:
468 if e.errno == errno.EINTR:
469 continue
470 raise
471
472
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400473def call(*popenargs, timeout=None, **kwargs):
474 """Run command with arguments. Wait for command to complete or
475 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000476
477 The arguments are the same as for the Popen constructor. Example:
478
479 retcode = call(["ls", "-l"])
480 """
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400481 p = Popen(*popenargs, **kwargs)
482 try:
483 return p.wait(timeout=timeout)
484 except TimeoutExpired:
485 p.kill()
486 p.wait()
487 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000488
489
Peter Astrand454f7672005-01-01 09:36:35 +0000490def check_call(*popenargs, **kwargs):
491 """Run command with arguments. Wait for command to complete. If
492 the exit code was zero then return, otherwise raise
493 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000494 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000495
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400496 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000497
498 check_call(["ls", "-l"])
499 """
500 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000501 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000502 cmd = kwargs.get("args")
503 if cmd is None:
504 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000505 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000506 return 0
507
508
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400509def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000510 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000511
512 If the exit code was non-zero it raises a CalledProcessError. The
513 CalledProcessError object will have the return code in the returncode
514 attribute and output in the output attribute.
515
516 The arguments are the same as for the Popen constructor. Example:
517
518 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000519 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000520
521 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000522 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000523
524 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000525 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000526 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000527 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000528 """
529 if 'stdout' in kwargs:
530 raise ValueError('stdout argument not allowed, it will be overridden.')
531 process = Popen(*popenargs, stdout=PIPE, **kwargs)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400532 try:
533 output, unused_err = process.communicate(timeout=timeout)
534 except TimeoutExpired:
535 process.kill()
536 output, unused_err = process.communicate()
Reid Kleckner2b228f02011-03-16 16:57:54 -0400537 raise TimeoutExpired(process.args, timeout, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000538 retcode = process.poll()
539 if retcode:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400540 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000541 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000542
543
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000544def list2cmdline(seq):
545 """
546 Translate a sequence of arguments into a command line
547 string, using the same rules as the MS C runtime:
548
549 1) Arguments are delimited by white space, which is either a
550 space or a tab.
551
552 2) A string surrounded by double quotation marks is
553 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000554 contained within. A quoted string can be embedded in an
555 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000556
557 3) A double quotation mark preceded by a backslash is
558 interpreted as a literal double quotation mark.
559
560 4) Backslashes are interpreted literally, unless they
561 immediately precede a double quotation mark.
562
563 5) If backslashes immediately precede a double quotation mark,
564 every pair of backslashes is interpreted as a literal
565 backslash. If the number of backslashes is odd, the last
566 backslash escapes the next double quotation mark as
567 described in rule 3.
568 """
569
570 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000571 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
572 # or search http://msdn.microsoft.com for
573 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000574 result = []
575 needquote = False
576 for arg in seq:
577 bs_buf = []
578
579 # Add a space to separate this argument from the others
580 if result:
581 result.append(' ')
582
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000583 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000584 if needquote:
585 result.append('"')
586
587 for c in arg:
588 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000589 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000590 bs_buf.append(c)
591 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000592 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000593 result.append('\\' * len(bs_buf)*2)
594 bs_buf = []
595 result.append('\\"')
596 else:
597 # Normal char
598 if bs_buf:
599 result.extend(bs_buf)
600 bs_buf = []
601 result.append(c)
602
Christian Heimesfdab48e2008-01-20 09:06:41 +0000603 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000604 if bs_buf:
605 result.extend(bs_buf)
606
607 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000608 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000609 result.append('"')
610
611 return ''.join(result)
612
613
Brett Cannona23810f2008-05-26 19:04:21 +0000614# Various tools for executing commands and looking at their output and status.
615#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000616# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000617
618def getstatusoutput(cmd):
619 """Return (status, output) of executing cmd in a shell.
620
621 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
622 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
623 returned output will contain output or error messages. A trailing newline
624 is stripped from the output. The exit status for the command can be
625 interpreted according to the rules for the C function wait(). Example:
626
627 >>> import subprocess
628 >>> subprocess.getstatusoutput('ls /bin/ls')
629 (0, '/bin/ls')
630 >>> subprocess.getstatusoutput('cat /bin/junk')
631 (256, 'cat: /bin/junk: No such file or directory')
632 >>> subprocess.getstatusoutput('/bin/junk')
633 (256, 'sh: /bin/junk: not found')
634 """
635 pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
636 text = pipe.read()
637 sts = pipe.close()
638 if sts is None: sts = 0
639 if text[-1:] == '\n': text = text[:-1]
640 return sts, text
641
642
643def getoutput(cmd):
644 """Return output (stdout or stderr) of executing cmd in a shell.
645
646 Like getstatusoutput(), except the exit status is ignored and the return
647 value is a string containing the command's output. Example:
648
649 >>> import subprocess
650 >>> subprocess.getoutput('ls /bin/ls')
651 '/bin/ls'
652 """
653 return getstatusoutput(cmd)[1]
654
655
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000656_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000657
658
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000659class Popen(object):
660 def __init__(self, args, bufsize=0, executable=None,
661 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000662 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
663 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000664 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000665 restore_signals=True, start_new_session=False,
666 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000667 """Create new Popen instance."""
668 _cleanup()
669
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000670 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400671 self._input = None
672 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000673 if bufsize is None:
674 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000675 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000676 raise TypeError("bufsize must be an integer")
677
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000678 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000679 if preexec_fn is not None:
680 raise ValueError("preexec_fn is not supported on Windows "
681 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000682 any_stdio_set = (stdin is not None or stdout is not None or
683 stderr is not None)
684 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
685 if any_stdio_set:
686 close_fds = False
687 else:
688 close_fds = True
689 elif close_fds and any_stdio_set:
690 raise ValueError(
691 "close_fds is not supported on Windows platforms"
692 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000693 else:
694 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000695 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
696 close_fds = True
697 if pass_fds and not close_fds:
698 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
699 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000700 if startupinfo is not None:
701 raise ValueError("startupinfo is only supported on Windows "
702 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000703 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000704 raise ValueError("creationflags is only supported on Windows "
705 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000706
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400707 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000708 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000709 self.stdout = None
710 self.stderr = None
711 self.pid = None
712 self.returncode = None
713 self.universal_newlines = universal_newlines
714
715 # Input and output objects. The general principle is like
716 # this:
717 #
718 # Parent Child
719 # ------ -----
720 # p2cwrite ---stdin---> p2cread
721 # c2pread <--stdout--- c2pwrite
722 # errread <--stderr--- errwrite
723 #
724 # On POSIX, the child objects are file descriptors. On
725 # Windows, these are Windows file handles. The parent objects
726 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000727 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000728 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000729
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000730 (p2cread, p2cwrite,
731 c2pread, c2pwrite,
732 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
733
Antoine Pitrouc9982322011-01-04 19:07:07 +0000734 # We wrap OS handles *before* launching the child, otherwise a
735 # quickly terminating child could make our fds unwrappable
736 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000737
Thomas Wouterscf297e42007-02-23 15:07:44 +0000738 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000739 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000740 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000741 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000742 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000743 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000744 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000745
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000746 if bufsize == 0:
747 bufsize = 1 # Nearly unbuffered (XXX for now)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000748 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000749 self.stdin = io.open(p2cwrite, 'wb', bufsize)
750 if self.universal_newlines:
751 self.stdin = io.TextIOWrapper(self.stdin)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000752 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000753 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000754 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000755 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000756 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000757 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000758 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000759 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000760
Antoine Pitrouc9982322011-01-04 19:07:07 +0000761 try:
762 self._execute_child(args, executable, preexec_fn, close_fds,
763 pass_fds, cwd, env, universal_newlines,
764 startupinfo, creationflags, shell,
765 p2cread, p2cwrite,
766 c2pread, c2pwrite,
767 errread, errwrite,
768 restore_signals, start_new_session)
769 except:
770 # Cleanup if the child failed starting
771 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
772 try:
773 f.close()
774 except EnvironmentError:
775 # Ignore EBADF or other errors
776 pass
777 raise
778
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000779
Guido van Rossum98297ee2007-11-06 21:34:58 +0000780 def _translate_newlines(self, data, encoding):
781 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
782 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000783
Brian Curtin79cdb662010-12-03 02:46:02 +0000784 def __enter__(self):
785 return self
786
787 def __exit__(self, type, value, traceback):
788 if self.stdout:
789 self.stdout.close()
790 if self.stderr:
791 self.stderr.close()
792 if self.stdin:
793 self.stdin.close()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000794
Brett Cannon84df1e62010-05-14 00:33:40 +0000795 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000796 if not self._child_created:
797 # We didn't get to successfully create a child process.
798 return
799 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000800 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000801 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000802 # Child is still running, keep us alive until we can wait on it.
803 _active.append(self)
804
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200805 def _get_devnull(self):
806 if not hasattr(self, '_devnull'):
807 self._devnull = os.open(os.devnull, os.O_RDWR)
808 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000809
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400810 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000811 """Interact with process: Send data to stdin. Read data from
812 stdout and stderr, until end-of-file is reached. Wait for
813 process to terminate. The optional input argument should be a
814 string to be sent to the child process, or None, if no data
815 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000816
Peter Astrand23109f02005-03-03 20:28:59 +0000817 communicate() returns a tuple (stdout, stderr)."""
818
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400819 if self._communication_started and input:
820 raise ValueError("Cannot send input after starting communication")
821
822 if timeout is not None:
823 endtime = time.time() + timeout
824 else:
825 endtime = None
826
827 # Optimization: If we are not worried about timeouts, we haven't
828 # started communicating, and we have one or zero pipes, using select()
829 # or threads is unnecessary.
830 if (endtime is None and not self._communication_started and
831 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000832 stdout = None
833 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000834 if self.stdin:
835 if input:
836 self.stdin.write(input)
837 self.stdin.close()
838 elif self.stdout:
839 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000840 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000841 elif self.stderr:
842 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000843 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000844 self.wait()
845 return (stdout, stderr)
Tim Peterseba28be2005-03-28 01:08:02 +0000846
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400847 try:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400848 stdout, stderr = self._communicate(input, endtime, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400849 finally:
850 self._communication_started = True
851
852 sts = self.wait(timeout=self._remaining_time(endtime))
853
854 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000855
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000856
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000857 def poll(self):
858 return self._internal_poll()
859
860
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400861 def _remaining_time(self, endtime):
862 """Convenience for _communicate when computing timeouts."""
863 if endtime is None:
864 return None
865 else:
866 return endtime - time.time()
867
868
Reid Kleckner2b228f02011-03-16 16:57:54 -0400869 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400870 """Convenience for checking if a timeout has expired."""
871 if endtime is None:
872 return
873 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400874 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400875
876
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000877 if mswindows:
878 #
879 # Windows methods
880 #
881 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000882 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000883 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
884 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000885 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000886 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000887
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000888 p2cread, p2cwrite = -1, -1
889 c2pread, c2pwrite = -1, -1
890 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000891
Peter Astrandd38ddf42005-02-10 08:32:50 +0000892 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000893 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000894 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000895 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000896 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000897 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200898 elif stdin == DEVNULL:
899 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000900 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000901 p2cread = msvcrt.get_osfhandle(stdin)
902 else:
903 # Assuming file-like object
904 p2cread = msvcrt.get_osfhandle(stdin.fileno())
905 p2cread = self._make_inheritable(p2cread)
906
Peter Astrandd38ddf42005-02-10 08:32:50 +0000907 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000908 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000909 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000910 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000911 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000912 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200913 elif stdout == DEVNULL:
914 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000915 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000916 c2pwrite = msvcrt.get_osfhandle(stdout)
917 else:
918 # Assuming file-like object
919 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
920 c2pwrite = self._make_inheritable(c2pwrite)
921
Peter Astrandd38ddf42005-02-10 08:32:50 +0000922 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000923 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000924 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000925 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000926 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000927 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000928 elif stderr == STDOUT:
929 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200930 elif stderr == DEVNULL:
931 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000932 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000933 errwrite = msvcrt.get_osfhandle(stderr)
934 else:
935 # Assuming file-like object
936 errwrite = msvcrt.get_osfhandle(stderr.fileno())
937 errwrite = self._make_inheritable(errwrite)
938
939 return (p2cread, p2cwrite,
940 c2pread, c2pwrite,
941 errread, errwrite)
942
943
944 def _make_inheritable(self, handle):
945 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000946 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
947 handle, _subprocess.GetCurrentProcess(), 0, 1,
948 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000949
950
951 def _find_w9xpopen(self):
952 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000953 w9xpopen = os.path.join(
954 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000955 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000956 if not os.path.exists(w9xpopen):
957 # Eeek - file-not-found - possibly an embedding
958 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000959 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
960 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000961 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000962 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
963 "needed for Popen to work with your "
964 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000965 return w9xpopen
966
Tim Peterse718f612004-10-12 21:51:32 +0000967
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000968 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000969 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000970 startupinfo, creationflags, shell,
971 p2cread, p2cwrite,
972 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000973 errread, errwrite,
974 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000975 """Execute program (MS Windows version)"""
976
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000977 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000978
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000979 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000980 args = list2cmdline(args)
981
Peter Astrandc1d65362004-11-07 14:30:34 +0000982 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000983 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000984 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000985 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000986 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000987 startupinfo.hStdInput = p2cread
988 startupinfo.hStdOutput = c2pwrite
989 startupinfo.hStdError = errwrite
990
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000991 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000992 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
993 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000994 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000995 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000996 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000997 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000998 # Win9x, or using command.com on NT. We need to
999 # use the w9xpopen intermediate program. For more
1000 # information, see KB Q150956
1001 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1002 w9xpopen = self._find_w9xpopen()
1003 args = '"%s" %s' % (w9xpopen, args)
1004 # Not passing CREATE_NEW_CONSOLE has been known to
1005 # cause random failures on win9x. Specifically a
1006 # dialog: "Your program accessed mem currently in
1007 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001008 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001009 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001010 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001011
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001012 # Start the process
1013 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001014 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001015 # no special security
1016 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001017 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001018 creationflags,
1019 env,
1020 cwd,
1021 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001022 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001023 # Translate pywintypes.error to WindowsError, which is
1024 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001025 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001026 # how can this be done from Python?
1027 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001028 finally:
1029 # Child is launched. Close the parent's copy of those pipe
1030 # handles that only the child should have open. You need
1031 # to make sure that no handles to the write end of the
1032 # output pipe are maintained in this process or else the
1033 # pipe will not close when the child process exits and the
1034 # ReadFile will hang.
1035 if p2cread != -1:
1036 p2cread.Close()
1037 if c2pwrite != -1:
1038 c2pwrite.Close()
1039 if errwrite != -1:
1040 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001041 if hasattr(self, '_devnull'):
1042 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001043
1044 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001045 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001046 self._handle = hp
1047 self.pid = pid
1048 ht.Close()
1049
Brett Cannon84df1e62010-05-14 00:33:40 +00001050 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001051 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1052 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1053 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001054 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001055 attribute.
1056
1057 This method is called by __del__, so it can only refer to objects
1058 in its local scope.
1059
1060 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001061 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001062 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1063 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001064 return self.returncode
1065
1066
Reid Kleckner2b228f02011-03-16 16:57:54 -04001067 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001068 """Wait for child process to terminate. Returns returncode
1069 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001070 if endtime is not None:
1071 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001072 if timeout is None:
1073 timeout = _subprocess.INFINITE
1074 else:
1075 timeout = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001076 if self.returncode is None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001077 result = _subprocess.WaitForSingleObject(self._handle, timeout)
1078 if result == _subprocess.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001079 raise TimeoutExpired(self.args, timeout)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001080 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001081 return self.returncode
1082
1083
1084 def _readerthread(self, fh, buffer):
1085 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001086 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001087
1088
Reid Kleckner2b228f02011-03-16 16:57:54 -04001089 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001090 # Start reader threads feeding into a list hanging off of this
1091 # object, unless they've already been started.
1092 if self.stdout and not hasattr(self, "_stdout_buff"):
1093 self._stdout_buff = []
1094 self.stdout_thread = \
1095 threading.Thread(target=self._readerthread,
1096 args=(self.stdout, self._stdout_buff))
1097 self.stdout_thread.daemon = True
1098 self.stdout_thread.start()
1099 if self.stderr and not hasattr(self, "_stderr_buff"):
1100 self._stderr_buff = []
1101 self.stderr_thread = \
1102 threading.Thread(target=self._readerthread,
1103 args=(self.stderr, self._stderr_buff))
1104 self.stderr_thread.daemon = True
1105 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001106
1107 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001108 if input is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109 self.stdin.write(input)
1110 self.stdin.close()
1111
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001112 # Wait for the reader threads, or time out. If we time out, the
1113 # threads remain reading and the fds left open in case the user
1114 # calls communicate again.
1115 if self.stdout is not None:
1116 self.stdout_thread.join(self._remaining_time(endtime))
1117 if self.stdout_thread.isAlive():
1118 raise TimeoutExpired(self.args)
1119 if self.stderr is not None:
1120 self.stderr_thread.join(self._remaining_time(endtime))
1121 if self.stderr_thread.isAlive():
1122 raise TimeoutExpired(self.args)
1123
1124 # Collect the output from and close both pipes, now that we know
1125 # both have been read successfully.
1126 stdout = None
1127 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001128 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001129 stdout = self._stdout_buff
1130 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001131 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001132 stderr = self._stderr_buff
1133 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001134
1135 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001136 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001137 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001138 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001139 stderr = stderr[0]
1140
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001141 return (stdout, stderr)
1142
Christian Heimesa342c012008-04-20 21:01:16 +00001143 def send_signal(self, sig):
1144 """Send a signal to the process
1145 """
1146 if sig == signal.SIGTERM:
1147 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001148 elif sig == signal.CTRL_C_EVENT:
1149 os.kill(self.pid, signal.CTRL_C_EVENT)
1150 elif sig == signal.CTRL_BREAK_EVENT:
1151 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001152 else:
Brian Curtin19651362010-09-07 13:24:38 +00001153 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001154
1155 def terminate(self):
1156 """Terminates the process
1157 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001158 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001159
1160 kill = terminate
1161
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001162 else:
1163 #
1164 # POSIX methods
1165 #
1166 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001167 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001168 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1169 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001170 p2cread, p2cwrite = -1, -1
1171 c2pread, c2pwrite = -1, -1
1172 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001173
Peter Astrandd38ddf42005-02-10 08:32:50 +00001174 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001175 pass
1176 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001177 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001178 elif stdin == DEVNULL:
1179 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001180 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001181 p2cread = stdin
1182 else:
1183 # Assuming file-like object
1184 p2cread = stdin.fileno()
1185
Peter Astrandd38ddf42005-02-10 08:32:50 +00001186 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001187 pass
1188 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001189 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001190 elif stdout == DEVNULL:
1191 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001192 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001193 c2pwrite = stdout
1194 else:
1195 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001196 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001197
Peter Astrandd38ddf42005-02-10 08:32:50 +00001198 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001199 pass
1200 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001201 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001202 elif stderr == STDOUT:
1203 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001204 elif stderr == DEVNULL:
1205 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001206 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001207 errwrite = stderr
1208 else:
1209 # Assuming file-like object
1210 errwrite = stderr.fileno()
1211
1212 return (p2cread, p2cwrite,
1213 c2pread, c2pwrite,
1214 errread, errwrite)
1215
1216
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001217 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001218 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001219 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001220 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001221 os.closerange(start_fd, fd)
1222 start_fd = fd + 1
1223 if start_fd <= MAXFD:
1224 os.closerange(start_fd, MAXFD)
1225
1226
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001227 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001228 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001229 startupinfo, creationflags, shell,
1230 p2cread, p2cwrite,
1231 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001232 errread, errwrite,
1233 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001234 """Execute program (POSIX version)"""
1235
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001236 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001238 else:
1239 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001240
1241 if shell:
1242 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001243 if executable:
1244 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001245
Peter Astrandd38ddf42005-02-10 08:32:50 +00001246 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001247 executable = args[0]
1248
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001249 # For transferring possible exec failure from child to parent.
1250 # Data format: "exception name:hex errno:description"
1251 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001252 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001253 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001254 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001255
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001256 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001257 # We must avoid complex work that could involve
1258 # malloc or free in the child process to avoid
1259 # potential deadlocks, thus we do all this here.
1260 # and pass it to fork_exec()
1261
1262 if env:
Victor Stinner449c4662010-05-08 11:10:09 +00001263 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001264 for k, v in env.items()]
1265 else:
1266 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001267 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001268 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001269 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001270 else:
1271 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001272 executable_list = tuple(
1273 os.path.join(os.fsencode(dir), executable)
1274 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001275 fds_to_keep = set(pass_fds)
1276 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001277 self.pid = _posixsubprocess.fork_exec(
1278 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001279 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001280 p2cread, p2cwrite, c2pread, c2pwrite,
1281 errread, errwrite,
1282 errpipe_read, errpipe_write,
1283 restore_signals, start_new_session, preexec_fn)
1284 else:
1285 # Pure Python implementation: It is not thread safe.
1286 # This implementation may deadlock in the child if your
1287 # parent process has any other threads running.
1288
1289 gc_was_enabled = gc.isenabled()
1290 # Disable gc to avoid bug where gc -> file_dealloc ->
1291 # write to stderr -> hang. See issue1336
1292 gc.disable()
1293 try:
1294 self.pid = os.fork()
1295 except:
1296 if gc_was_enabled:
1297 gc.enable()
1298 raise
1299 self._child_created = True
1300 if self.pid == 0:
1301 # Child
1302 try:
1303 # Close parent's pipe ends
1304 if p2cwrite != -1:
1305 os.close(p2cwrite)
1306 if c2pread != -1:
1307 os.close(c2pread)
1308 if errread != -1:
1309 os.close(errread)
1310 os.close(errpipe_read)
1311
1312 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001313 def _dup2(a, b):
1314 # dup2() removes the CLOEXEC flag but
1315 # we must do it ourselves if dup2()
1316 # would be a no-op (issue #10806).
1317 if a == b:
1318 _set_cloexec(a, False)
1319 elif a != -1:
1320 os.dup2(a, b)
1321 _dup2(p2cread, 0)
1322 _dup2(c2pwrite, 1)
1323 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001324
1325 # Close pipe fds. Make sure we don't close the
1326 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001327 closed = set()
1328 for fd in [p2cread, c2pwrite, errwrite]:
1329 if fd > 2 and fd not in closed:
1330 os.close(fd)
1331 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001332
1333 # Close all other fds, if asked for
1334 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001335 fds_to_keep = set(pass_fds)
1336 fds_to_keep.add(errpipe_write)
1337 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001338
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001339
1340 if cwd is not None:
1341 os.chdir(cwd)
1342
1343 # This is a copy of Python/pythonrun.c
1344 # _Py_RestoreSignals(). If that were exposed
1345 # as a sys._py_restoresignals func it would be
1346 # better.. but this pure python implementation
1347 # isn't likely to be used much anymore.
1348 if restore_signals:
1349 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1350 for sig in signals:
1351 if hasattr(signal, sig):
1352 signal.signal(getattr(signal, sig),
1353 signal.SIG_DFL)
1354
1355 if start_new_session and hasattr(os, 'setsid'):
1356 os.setsid()
1357
1358 if preexec_fn:
1359 preexec_fn()
1360
1361 if env is None:
1362 os.execvp(executable, args)
1363 else:
1364 os.execvpe(executable, args, env)
1365
1366 except:
1367 try:
1368 exc_type, exc_value = sys.exc_info()[:2]
1369 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001370 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001371 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001372 errno_num = 0
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001373 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001374 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001375 message = message.encode(errors="surrogatepass")
1376 os.write(errpipe_write, message)
1377 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001378 # We MUST not allow anything odd happening
1379 # above to prevent us from exiting below.
1380 pass
1381
1382 # This exitcode won't be reported to applications
1383 # so it really doesn't matter what we return.
1384 os._exit(255)
1385
1386 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001387 if gc_was_enabled:
1388 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001389 finally:
1390 # be sure the FD is closed no matter what
1391 os.close(errpipe_write)
1392
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001393 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001394 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001395 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001396 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001397 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001398 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001399 if hasattr(self, '_devnull'):
1400 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001401
1402 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001403 # exception (limited in size)
1404 data = bytearray()
1405 while True:
1406 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1407 data += part
1408 if not part or len(data) > 50000:
1409 break
Facundo Batista10706e22009-06-19 20:34:30 +00001410 finally:
1411 # be sure the FD is closed no matter what
1412 os.close(errpipe_read)
1413
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001414 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001415 try:
1416 _eintr_retry_call(os.waitpid, self.pid, 0)
1417 except OSError as e:
1418 if e.errno != errno.ECHILD:
1419 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001420 try:
1421 exception_name, hex_errno, err_msg = data.split(b':', 2)
1422 except ValueError:
1423 print('Bad exception data:', repr(data))
1424 exception_name = b'RuntimeError'
1425 hex_errno = b'0'
1426 err_msg = b'Unknown'
1427 child_exception_type = getattr(
1428 builtins, exception_name.decode('ascii'),
1429 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001430 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001431 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001432 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001433 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001434 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001435 errno_num = int(hex_errno, 16)
1436 if errno_num != 0:
1437 err_msg = os.strerror(errno_num)
1438 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001439 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001440 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001441 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001442
1443
Brett Cannon84df1e62010-05-14 00:33:40 +00001444 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1445 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1446 _WEXITSTATUS=os.WEXITSTATUS):
1447 # This method is called (indirectly) by __del__, so it cannot
1448 # refer to anything outside of its local scope."""
1449 if _WIFSIGNALED(sts):
1450 self.returncode = -_WTERMSIG(sts)
1451 elif _WIFEXITED(sts):
1452 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001453 else:
1454 # Should never happen
1455 raise RuntimeError("Unknown child exit status!")
1456
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001457
Brett Cannon84df1e62010-05-14 00:33:40 +00001458 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1459 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001460 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001461 attribute.
1462
1463 This method is called by __del__, so it cannot reference anything
1464 outside of the local scope (nor can any methods it calls).
1465
1466 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001467 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001468 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001469 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001470 if pid == self.pid:
1471 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001472 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001473 if _deadstate is not None:
1474 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001475 return self.returncode
1476
1477
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001478 def _try_wait(self, wait_flags):
1479 try:
1480 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1481 except OSError as e:
1482 if e.errno != errno.ECHILD:
1483 raise
1484 # This happens if SIGCLD is set to be ignored or waiting
1485 # for child processes has otherwise been disabled for our
1486 # process. This child is dead, we can't get the status.
1487 pid = self.pid
1488 sts = 0
1489 return (pid, sts)
1490
1491
1492 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001493 """Wait for child process to terminate. Returns returncode
1494 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001495 if self.returncode is not None:
1496 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001497
1498 # endtime is preferred to timeout. timeout is only used for
1499 # printing.
1500 if endtime is not None or timeout is not None:
1501 if endtime is None:
1502 endtime = time.time() + timeout
1503 elif timeout is None:
1504 timeout = self._remaining_time(endtime)
1505
1506 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001507 # Enter a busy loop if we have a timeout. This busy loop was
1508 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1509 delay = 0.0005 # 500 us -> initial delay of 1 ms
1510 while True:
1511 (pid, sts) = self._try_wait(os.WNOHANG)
1512 assert pid == self.pid or pid == 0
1513 if pid == self.pid:
1514 self._handle_exitstatus(sts)
1515 break
1516 remaining = self._remaining_time(endtime)
1517 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001518 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001519 delay = min(delay * 2, remaining, .05)
1520 time.sleep(delay)
1521 elif self.returncode is None:
1522 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001523 self._handle_exitstatus(sts)
1524 return self.returncode
1525
1526
Reid Kleckner2b228f02011-03-16 16:57:54 -04001527 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001528 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001529 # Flush stdio buffer. This might block, if the user has
1530 # been writing to .stdin in an uncontrolled fashion.
1531 self.stdin.flush()
1532 if not input:
1533 self.stdin.close()
1534
1535 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001536 stdout, stderr = self._communicate_with_poll(input, endtime,
1537 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001538 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001539 stdout, stderr = self._communicate_with_select(input, endtime,
1540 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001541
1542 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001543
1544 # All data exchanged. Translate lists into strings.
1545 if stdout is not None:
1546 stdout = b''.join(stdout)
1547 if stderr is not None:
1548 stderr = b''.join(stderr)
1549
1550 # Translate newlines, if requested.
1551 # This also turns bytes into strings.
1552 if self.universal_newlines:
1553 if stdout is not None:
1554 stdout = self._translate_newlines(stdout,
1555 self.stdout.encoding)
1556 if stderr is not None:
1557 stderr = self._translate_newlines(stderr,
1558 self.stderr.encoding)
1559
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001560 return (stdout, stderr)
1561
1562
Reid Kleckner2b228f02011-03-16 16:57:54 -04001563 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001564 stdout = None # Return
1565 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001566
1567 if not self._communication_started:
1568 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001569
1570 poller = select.poll()
1571 def register_and_append(file_obj, eventmask):
1572 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001573 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001574
1575 def close_unregister_and_remove(fd):
1576 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001577 self._fd2file[fd].close()
1578 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001579
1580 if self.stdin and input:
1581 register_and_append(self.stdin, select.POLLOUT)
1582
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001583 # Only create this mapping if we haven't already.
1584 if not self._communication_started:
1585 self._fd2output = {}
1586 if self.stdout:
1587 self._fd2output[self.stdout.fileno()] = []
1588 if self.stderr:
1589 self._fd2output[self.stderr.fileno()] = []
1590
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001591 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1592 if self.stdout:
1593 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001594 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001595 if self.stderr:
1596 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001597 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001598
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001599 # Save the input here so that if we time out while communicating,
1600 # we can continue sending input if we retry.
1601 if self.stdin and self._input is None:
1602 self._input_offset = 0
1603 self._input = input
1604 if self.universal_newlines:
1605 self._input = self._input.encode(self.stdin.encoding)
1606
1607 while self._fd2file:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001608 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001609 ready = poller.poll(self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001610 except select.error as e:
1611 if e.args[0] == errno.EINTR:
1612 continue
1613 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001614 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001615
1616 # XXX Rewrite these to use non-blocking I/O on the
1617 # file objects; they are no longer using C stdio!
1618
1619 for fd, mode in ready:
1620 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001621 chunk = self._input[self._input_offset :
1622 self._input_offset + _PIPE_BUF]
1623 self._input_offset += os.write(fd, chunk)
1624 if self._input_offset >= len(self._input):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001625 close_unregister_and_remove(fd)
1626 elif mode & select_POLLIN_POLLPRI:
1627 data = os.read(fd, 4096)
1628 if not data:
1629 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001630 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001631 else:
1632 # Ignore hang up or errors.
1633 close_unregister_and_remove(fd)
1634
1635 return (stdout, stderr)
1636
1637
Reid Kleckner2b228f02011-03-16 16:57:54 -04001638 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001639 if not self._communication_started:
1640 self._read_set = []
1641 self._write_set = []
1642 if self.stdin and input:
1643 self._write_set.append(self.stdin)
1644 if self.stdout:
1645 self._read_set.append(self.stdout)
1646 if self.stderr:
1647 self._read_set.append(self.stderr)
1648
1649 if self.stdin and self._input is None:
1650 self._input_offset = 0
1651 self._input = input
1652 if self.universal_newlines:
1653 self._input = self._input.encode(self.stdin.encoding)
1654
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001655 stdout = None # Return
1656 stderr = None # Return
1657
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001658 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001659 if not self._communication_started:
1660 self._stdout_buff = []
1661 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001662 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001663 if not self._communication_started:
1664 self._stderr_buff = []
1665 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001666
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001667 while self._read_set or self._write_set:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001668 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001669 (rlist, wlist, xlist) = \
1670 select.select(self._read_set, self._write_set, [],
1671 self._remaining_time(endtime))
Georg Brandl86b2fb92008-07-16 03:43:04 +00001672 except select.error as e:
1673 if e.args[0] == errno.EINTR:
1674 continue
1675 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001676
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001677 # According to the docs, returning three empty lists indicates
1678 # that the timeout expired.
1679 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001680 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001681 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001682 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001683
Guido van Rossum98297ee2007-11-06 21:34:58 +00001684 # XXX Rewrite these to use non-blocking I/O on the
1685 # file objects; they are no longer using C stdio!
1686
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001687 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001688 chunk = self._input[self._input_offset :
1689 self._input_offset + _PIPE_BUF]
Guido van Rossumbae07c92007-10-08 02:46:15 +00001690 bytes_written = os.write(self.stdin.fileno(), chunk)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001691 self._input_offset += bytes_written
1692 if self._input_offset >= len(self._input):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001693 self.stdin.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001694 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001695
1696 if self.stdout in rlist:
1697 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001698 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001699 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001700 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001701 stdout.append(data)
1702
1703 if self.stderr in rlist:
1704 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001705 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001706 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001707 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001708 stderr.append(data)
1709
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001710 return (stdout, stderr)
1711
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001712
Christian Heimesa342c012008-04-20 21:01:16 +00001713 def send_signal(self, sig):
1714 """Send a signal to the process
1715 """
1716 os.kill(self.pid, sig)
1717
1718 def terminate(self):
1719 """Terminate the process with SIGTERM
1720 """
1721 self.send_signal(signal.SIGTERM)
1722
1723 def kill(self):
1724 """Kill the process with SIGKILL
1725 """
1726 self.send_signal(signal.SIGKILL)
1727
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001728
1729def _demo_posix():
1730 #
1731 # Example 1: Simple redirection: Get process list
1732 #
1733 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001734 print("Process list:")
1735 print(plist)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001736
1737 #
1738 # Example 2: Change uid before executing child
1739 #
1740 if os.getuid() == 0:
1741 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
1742 p.wait()
1743
1744 #
1745 # Example 3: Connecting several subprocesses
1746 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001747 print("Looking for 'hda'...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001748 p1 = Popen(["dmesg"], stdout=PIPE)
1749 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001750 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001751
1752 #
1753 # Example 4: Catch execution error
1754 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001755 print()
1756 print("Trying a weird file...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001757 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001758 print(Popen(["/this/path/does/not/exist"]).communicate())
Guido van Rossumb940e112007-01-10 16:19:56 +00001759 except OSError as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001760 if e.errno == errno.ENOENT:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001761 print("The file didn't exist. I thought so...")
1762 print("Child traceback:")
1763 print(e.child_traceback)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001764 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001765 print("Error", e.errno)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001766 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001767 print("Gosh. No error.", file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001768
1769
1770def _demo_windows():
1771 #
1772 # Example 1: Connecting several subprocesses
1773 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001774 print("Looking for 'PROMPT' in set output...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001775 p1 = Popen("set", stdout=PIPE, shell=True)
1776 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001777 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001778
1779 #
1780 # Example 2: Simple execution of program
1781 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001782 print("Executing calc...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001783 p = Popen("calc")
1784 p.wait()
1785
1786
1787if __name__ == "__main__":
1788 if mswindows:
1789 _demo_windows()
1790 else:
1791 _demo_posix()