blob: 4c6635352fde074a7d44d32a10356162c137b47c [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
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000746 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000747 self.stdin = io.open(p2cwrite, 'wb', bufsize)
748 if self.universal_newlines:
749 self.stdin = io.TextIOWrapper(self.stdin)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000750 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000751 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000752 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000753 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000754 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000755 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000756 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000757 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000758
Antoine Pitrouc9982322011-01-04 19:07:07 +0000759 try:
760 self._execute_child(args, executable, preexec_fn, close_fds,
761 pass_fds, cwd, env, universal_newlines,
762 startupinfo, creationflags, shell,
763 p2cread, p2cwrite,
764 c2pread, c2pwrite,
765 errread, errwrite,
766 restore_signals, start_new_session)
767 except:
768 # Cleanup if the child failed starting
769 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
770 try:
771 f.close()
772 except EnvironmentError:
773 # Ignore EBADF or other errors
774 pass
775 raise
776
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000777
Guido van Rossum98297ee2007-11-06 21:34:58 +0000778 def _translate_newlines(self, data, encoding):
779 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
780 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000781
Brian Curtin79cdb662010-12-03 02:46:02 +0000782 def __enter__(self):
783 return self
784
785 def __exit__(self, type, value, traceback):
786 if self.stdout:
787 self.stdout.close()
788 if self.stderr:
789 self.stderr.close()
790 if self.stdin:
791 self.stdin.close()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000792
Brett Cannon84df1e62010-05-14 00:33:40 +0000793 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000794 if not self._child_created:
795 # We didn't get to successfully create a child process.
796 return
797 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000798 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000799 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000800 # Child is still running, keep us alive until we can wait on it.
801 _active.append(self)
802
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200803 def _get_devnull(self):
804 if not hasattr(self, '_devnull'):
805 self._devnull = os.open(os.devnull, os.O_RDWR)
806 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000807
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400808 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000809 """Interact with process: Send data to stdin. Read data from
810 stdout and stderr, until end-of-file is reached. Wait for
811 process to terminate. The optional input argument should be a
812 string to be sent to the child process, or None, if no data
813 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000814
Peter Astrand23109f02005-03-03 20:28:59 +0000815 communicate() returns a tuple (stdout, stderr)."""
816
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400817 if self._communication_started and input:
818 raise ValueError("Cannot send input after starting communication")
819
820 if timeout is not None:
821 endtime = time.time() + timeout
822 else:
823 endtime = None
824
825 # Optimization: If we are not worried about timeouts, we haven't
826 # started communicating, and we have one or zero pipes, using select()
827 # or threads is unnecessary.
828 if (endtime is None and not self._communication_started and
829 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000830 stdout = None
831 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000832 if self.stdin:
833 if input:
834 self.stdin.write(input)
835 self.stdin.close()
836 elif self.stdout:
837 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000838 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000839 elif self.stderr:
840 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000841 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000842 self.wait()
843 return (stdout, stderr)
Tim Peterseba28be2005-03-28 01:08:02 +0000844
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400845 try:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400846 stdout, stderr = self._communicate(input, endtime, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400847 finally:
848 self._communication_started = True
849
850 sts = self.wait(timeout=self._remaining_time(endtime))
851
852 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000853
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000854
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000855 def poll(self):
856 return self._internal_poll()
857
858
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400859 def _remaining_time(self, endtime):
860 """Convenience for _communicate when computing timeouts."""
861 if endtime is None:
862 return None
863 else:
864 return endtime - time.time()
865
866
Reid Kleckner2b228f02011-03-16 16:57:54 -0400867 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400868 """Convenience for checking if a timeout has expired."""
869 if endtime is None:
870 return
871 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400872 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400873
874
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000875 if mswindows:
876 #
877 # Windows methods
878 #
879 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000880 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000881 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
882 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000883 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000884 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000885
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000886 p2cread, p2cwrite = -1, -1
887 c2pread, c2pwrite = -1, -1
888 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000889
Peter Astrandd38ddf42005-02-10 08:32:50 +0000890 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000891 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000892 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000893 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000894 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000895 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200896 elif stdin == DEVNULL:
897 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000898 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000899 p2cread = msvcrt.get_osfhandle(stdin)
900 else:
901 # Assuming file-like object
902 p2cread = msvcrt.get_osfhandle(stdin.fileno())
903 p2cread = self._make_inheritable(p2cread)
904
Peter Astrandd38ddf42005-02-10 08:32:50 +0000905 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000906 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000907 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000908 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000909 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000910 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200911 elif stdout == DEVNULL:
912 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000913 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000914 c2pwrite = msvcrt.get_osfhandle(stdout)
915 else:
916 # Assuming file-like object
917 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
918 c2pwrite = self._make_inheritable(c2pwrite)
919
Peter Astrandd38ddf42005-02-10 08:32:50 +0000920 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000921 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000922 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000923 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000924 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000925 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000926 elif stderr == STDOUT:
927 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200928 elif stderr == DEVNULL:
929 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000930 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000931 errwrite = msvcrt.get_osfhandle(stderr)
932 else:
933 # Assuming file-like object
934 errwrite = msvcrt.get_osfhandle(stderr.fileno())
935 errwrite = self._make_inheritable(errwrite)
936
937 return (p2cread, p2cwrite,
938 c2pread, c2pwrite,
939 errread, errwrite)
940
941
942 def _make_inheritable(self, handle):
943 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000944 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
945 handle, _subprocess.GetCurrentProcess(), 0, 1,
946 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000947
948
949 def _find_w9xpopen(self):
950 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000951 w9xpopen = os.path.join(
952 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000953 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000954 if not os.path.exists(w9xpopen):
955 # Eeek - file-not-found - possibly an embedding
956 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000957 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
958 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000959 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000960 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
961 "needed for Popen to work with your "
962 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000963 return w9xpopen
964
Tim Peterse718f612004-10-12 21:51:32 +0000965
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000966 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000967 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000968 startupinfo, creationflags, shell,
969 p2cread, p2cwrite,
970 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000971 errread, errwrite,
972 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000973 """Execute program (MS Windows version)"""
974
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000975 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000976
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000977 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000978 args = list2cmdline(args)
979
Peter Astrandc1d65362004-11-07 14:30:34 +0000980 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000981 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000982 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000983 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000984 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000985 startupinfo.hStdInput = p2cread
986 startupinfo.hStdOutput = c2pwrite
987 startupinfo.hStdError = errwrite
988
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000989 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000990 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
991 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000992 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000993 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000994 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000995 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000996 # Win9x, or using command.com on NT. We need to
997 # use the w9xpopen intermediate program. For more
998 # information, see KB Q150956
999 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1000 w9xpopen = self._find_w9xpopen()
1001 args = '"%s" %s' % (w9xpopen, args)
1002 # Not passing CREATE_NEW_CONSOLE has been known to
1003 # cause random failures on win9x. Specifically a
1004 # dialog: "Your program accessed mem currently in
1005 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001006 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001007 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +00001008 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001009
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001010 # Start the process
1011 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +00001012 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001013 # no special security
1014 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001015 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001016 creationflags,
1017 env,
1018 cwd,
1019 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001020 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001021 # Translate pywintypes.error to WindowsError, which is
1022 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001023 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001024 # how can this be done from Python?
1025 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001026 finally:
1027 # Child is launched. Close the parent's copy of those pipe
1028 # handles that only the child should have open. You need
1029 # to make sure that no handles to the write end of the
1030 # output pipe are maintained in this process or else the
1031 # pipe will not close when the child process exits and the
1032 # ReadFile will hang.
1033 if p2cread != -1:
1034 p2cread.Close()
1035 if c2pwrite != -1:
1036 c2pwrite.Close()
1037 if errwrite != -1:
1038 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001039 if hasattr(self, '_devnull'):
1040 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001041
1042 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001043 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001044 self._handle = hp
1045 self.pid = pid
1046 ht.Close()
1047
Brett Cannon84df1e62010-05-14 00:33:40 +00001048 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001049 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1050 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1051 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001052 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001053 attribute.
1054
1055 This method is called by __del__, so it can only refer to objects
1056 in its local scope.
1057
1058 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001059 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001060 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1061 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001062 return self.returncode
1063
1064
Reid Kleckner2b228f02011-03-16 16:57:54 -04001065 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066 """Wait for child process to terminate. Returns returncode
1067 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001068 if endtime is not None:
1069 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001070 if timeout is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001071 timeout_millis = _subprocess.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001072 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001073 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001074 if self.returncode is None:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001075 result = _subprocess.WaitForSingleObject(self._handle,
1076 timeout_millis)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001077 if result == _subprocess.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001078 raise TimeoutExpired(self.args, timeout)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001079 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001080 return self.returncode
1081
1082
1083 def _readerthread(self, fh, buffer):
1084 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001085 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001086
1087
Reid Kleckner2b228f02011-03-16 16:57:54 -04001088 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001089 # Start reader threads feeding into a list hanging off of this
1090 # object, unless they've already been started.
1091 if self.stdout and not hasattr(self, "_stdout_buff"):
1092 self._stdout_buff = []
1093 self.stdout_thread = \
1094 threading.Thread(target=self._readerthread,
1095 args=(self.stdout, self._stdout_buff))
1096 self.stdout_thread.daemon = True
1097 self.stdout_thread.start()
1098 if self.stderr and not hasattr(self, "_stderr_buff"):
1099 self._stderr_buff = []
1100 self.stderr_thread = \
1101 threading.Thread(target=self._readerthread,
1102 args=(self.stderr, self._stderr_buff))
1103 self.stderr_thread.daemon = True
1104 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001105
1106 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001107 if input is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001108 self.stdin.write(input)
1109 self.stdin.close()
1110
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001111 # Wait for the reader threads, or time out. If we time out, the
1112 # threads remain reading and the fds left open in case the user
1113 # calls communicate again.
1114 if self.stdout is not None:
1115 self.stdout_thread.join(self._remaining_time(endtime))
1116 if self.stdout_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001117 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001118 if self.stderr is not None:
1119 self.stderr_thread.join(self._remaining_time(endtime))
1120 if self.stderr_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001121 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001122
1123 # Collect the output from and close both pipes, now that we know
1124 # both have been read successfully.
1125 stdout = None
1126 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001127 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001128 stdout = self._stdout_buff
1129 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001130 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001131 stderr = self._stderr_buff
1132 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133
1134 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001135 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001136 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001137 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001138 stderr = stderr[0]
1139
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001140 return (stdout, stderr)
1141
Christian Heimesa342c012008-04-20 21:01:16 +00001142 def send_signal(self, sig):
1143 """Send a signal to the process
1144 """
1145 if sig == signal.SIGTERM:
1146 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001147 elif sig == signal.CTRL_C_EVENT:
1148 os.kill(self.pid, signal.CTRL_C_EVENT)
1149 elif sig == signal.CTRL_BREAK_EVENT:
1150 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001151 else:
Brian Curtin19651362010-09-07 13:24:38 +00001152 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001153
1154 def terminate(self):
1155 """Terminates the process
1156 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001157 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001158
1159 kill = terminate
1160
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001161 else:
1162 #
1163 # POSIX methods
1164 #
1165 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001166 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001167 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1168 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001169 p2cread, p2cwrite = -1, -1
1170 c2pread, c2pwrite = -1, -1
1171 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172
Peter Astrandd38ddf42005-02-10 08:32:50 +00001173 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001174 pass
1175 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001176 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001177 elif stdin == DEVNULL:
1178 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001179 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180 p2cread = stdin
1181 else:
1182 # Assuming file-like object
1183 p2cread = stdin.fileno()
1184
Peter Astrandd38ddf42005-02-10 08:32:50 +00001185 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001186 pass
1187 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001188 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001189 elif stdout == DEVNULL:
1190 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001191 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001192 c2pwrite = stdout
1193 else:
1194 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001195 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001196
Peter Astrandd38ddf42005-02-10 08:32:50 +00001197 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001198 pass
1199 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001200 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001201 elif stderr == STDOUT:
1202 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001203 elif stderr == DEVNULL:
1204 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001205 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001206 errwrite = stderr
1207 else:
1208 # Assuming file-like object
1209 errwrite = stderr.fileno()
1210
1211 return (p2cread, p2cwrite,
1212 c2pread, c2pwrite,
1213 errread, errwrite)
1214
1215
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001216 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001217 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001218 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001219 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001220 os.closerange(start_fd, fd)
1221 start_fd = fd + 1
1222 if start_fd <= MAXFD:
1223 os.closerange(start_fd, MAXFD)
1224
1225
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001226 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001227 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001228 startupinfo, creationflags, shell,
1229 p2cread, p2cwrite,
1230 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001231 errread, errwrite,
1232 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001233 """Execute program (POSIX version)"""
1234
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001235 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001236 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001237 else:
1238 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001239
1240 if shell:
1241 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001242 if executable:
1243 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001244
Peter Astrandd38ddf42005-02-10 08:32:50 +00001245 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001246 executable = args[0]
1247
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001248 # For transferring possible exec failure from child to parent.
1249 # Data format: "exception name:hex errno:description"
1250 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001251 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001252 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001253 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001254
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001255 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001256 # We must avoid complex work that could involve
1257 # malloc or free in the child process to avoid
1258 # potential deadlocks, thus we do all this here.
1259 # and pass it to fork_exec()
1260
1261 if env:
Victor Stinner449c4662010-05-08 11:10:09 +00001262 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001263 for k, v in env.items()]
1264 else:
1265 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001266 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001267 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001268 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001269 else:
1270 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001271 executable_list = tuple(
1272 os.path.join(os.fsencode(dir), executable)
1273 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001274 fds_to_keep = set(pass_fds)
1275 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001276 self.pid = _posixsubprocess.fork_exec(
1277 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001278 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001279 p2cread, p2cwrite, c2pread, c2pwrite,
1280 errread, errwrite,
1281 errpipe_read, errpipe_write,
1282 restore_signals, start_new_session, preexec_fn)
1283 else:
1284 # Pure Python implementation: It is not thread safe.
1285 # This implementation may deadlock in the child if your
1286 # parent process has any other threads running.
1287
1288 gc_was_enabled = gc.isenabled()
1289 # Disable gc to avoid bug where gc -> file_dealloc ->
1290 # write to stderr -> hang. See issue1336
1291 gc.disable()
1292 try:
1293 self.pid = os.fork()
1294 except:
1295 if gc_was_enabled:
1296 gc.enable()
1297 raise
1298 self._child_created = True
1299 if self.pid == 0:
1300 # Child
1301 try:
1302 # Close parent's pipe ends
1303 if p2cwrite != -1:
1304 os.close(p2cwrite)
1305 if c2pread != -1:
1306 os.close(c2pread)
1307 if errread != -1:
1308 os.close(errread)
1309 os.close(errpipe_read)
1310
1311 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001312 def _dup2(a, b):
1313 # dup2() removes the CLOEXEC flag but
1314 # we must do it ourselves if dup2()
1315 # would be a no-op (issue #10806).
1316 if a == b:
1317 _set_cloexec(a, False)
1318 elif a != -1:
1319 os.dup2(a, b)
1320 _dup2(p2cread, 0)
1321 _dup2(c2pwrite, 1)
1322 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001323
1324 # Close pipe fds. Make sure we don't close the
1325 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001326 closed = set()
1327 for fd in [p2cread, c2pwrite, errwrite]:
1328 if fd > 2 and fd not in closed:
1329 os.close(fd)
1330 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001331
1332 # Close all other fds, if asked for
1333 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001334 fds_to_keep = set(pass_fds)
1335 fds_to_keep.add(errpipe_write)
1336 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001337
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001338
1339 if cwd is not None:
1340 os.chdir(cwd)
1341
1342 # This is a copy of Python/pythonrun.c
1343 # _Py_RestoreSignals(). If that were exposed
1344 # as a sys._py_restoresignals func it would be
1345 # better.. but this pure python implementation
1346 # isn't likely to be used much anymore.
1347 if restore_signals:
1348 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1349 for sig in signals:
1350 if hasattr(signal, sig):
1351 signal.signal(getattr(signal, sig),
1352 signal.SIG_DFL)
1353
1354 if start_new_session and hasattr(os, 'setsid'):
1355 os.setsid()
1356
1357 if preexec_fn:
1358 preexec_fn()
1359
1360 if env is None:
1361 os.execvp(executable, args)
1362 else:
1363 os.execvpe(executable, args, env)
1364
1365 except:
1366 try:
1367 exc_type, exc_value = sys.exc_info()[:2]
1368 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001369 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001371 errno_num = 0
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001372 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001373 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001374 message = message.encode(errors="surrogatepass")
1375 os.write(errpipe_write, message)
1376 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001377 # We MUST not allow anything odd happening
1378 # above to prevent us from exiting below.
1379 pass
1380
1381 # This exitcode won't be reported to applications
1382 # so it really doesn't matter what we return.
1383 os._exit(255)
1384
1385 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001386 if gc_was_enabled:
1387 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001388 finally:
1389 # be sure the FD is closed no matter what
1390 os.close(errpipe_write)
1391
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001392 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001393 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001394 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001395 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001396 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001397 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001398 if hasattr(self, '_devnull'):
1399 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001400
1401 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001402 # exception (limited in size)
1403 data = bytearray()
1404 while True:
1405 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1406 data += part
1407 if not part or len(data) > 50000:
1408 break
Facundo Batista10706e22009-06-19 20:34:30 +00001409 finally:
1410 # be sure the FD is closed no matter what
1411 os.close(errpipe_read)
1412
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001413 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001414 try:
1415 _eintr_retry_call(os.waitpid, self.pid, 0)
1416 except OSError as e:
1417 if e.errno != errno.ECHILD:
1418 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001419 try:
1420 exception_name, hex_errno, err_msg = data.split(b':', 2)
1421 except ValueError:
1422 print('Bad exception data:', repr(data))
1423 exception_name = b'RuntimeError'
1424 hex_errno = b'0'
1425 err_msg = b'Unknown'
1426 child_exception_type = getattr(
1427 builtins, exception_name.decode('ascii'),
1428 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001429 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001430 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001431 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001432 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001433 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001434 errno_num = int(hex_errno, 16)
1435 if errno_num != 0:
1436 err_msg = os.strerror(errno_num)
1437 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001438 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001439 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001440 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001441
1442
Brett Cannon84df1e62010-05-14 00:33:40 +00001443 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1444 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1445 _WEXITSTATUS=os.WEXITSTATUS):
1446 # This method is called (indirectly) by __del__, so it cannot
1447 # refer to anything outside of its local scope."""
1448 if _WIFSIGNALED(sts):
1449 self.returncode = -_WTERMSIG(sts)
1450 elif _WIFEXITED(sts):
1451 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001452 else:
1453 # Should never happen
1454 raise RuntimeError("Unknown child exit status!")
1455
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001456
Brett Cannon84df1e62010-05-14 00:33:40 +00001457 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1458 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001459 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001460 attribute.
1461
1462 This method is called by __del__, so it cannot reference anything
1463 outside of the local scope (nor can any methods it calls).
1464
1465 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001466 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001467 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001468 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001469 if pid == self.pid:
1470 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001471 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001472 if _deadstate is not None:
1473 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001474 return self.returncode
1475
1476
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001477 def _try_wait(self, wait_flags):
1478 try:
1479 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1480 except OSError as e:
1481 if e.errno != errno.ECHILD:
1482 raise
1483 # This happens if SIGCLD is set to be ignored or waiting
1484 # for child processes has otherwise been disabled for our
1485 # process. This child is dead, we can't get the status.
1486 pid = self.pid
1487 sts = 0
1488 return (pid, sts)
1489
1490
1491 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001492 """Wait for child process to terminate. Returns returncode
1493 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001494 if self.returncode is not None:
1495 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001496
1497 # endtime is preferred to timeout. timeout is only used for
1498 # printing.
1499 if endtime is not None or timeout is not None:
1500 if endtime is None:
1501 endtime = time.time() + timeout
1502 elif timeout is None:
1503 timeout = self._remaining_time(endtime)
1504
1505 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001506 # Enter a busy loop if we have a timeout. This busy loop was
1507 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1508 delay = 0.0005 # 500 us -> initial delay of 1 ms
1509 while True:
1510 (pid, sts) = self._try_wait(os.WNOHANG)
1511 assert pid == self.pid or pid == 0
1512 if pid == self.pid:
1513 self._handle_exitstatus(sts)
1514 break
1515 remaining = self._remaining_time(endtime)
1516 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001517 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001518 delay = min(delay * 2, remaining, .05)
1519 time.sleep(delay)
1520 elif self.returncode is None:
1521 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001522 self._handle_exitstatus(sts)
1523 return self.returncode
1524
1525
Reid Kleckner2b228f02011-03-16 16:57:54 -04001526 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001527 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001528 # Flush stdio buffer. This might block, if the user has
1529 # been writing to .stdin in an uncontrolled fashion.
1530 self.stdin.flush()
1531 if not input:
1532 self.stdin.close()
1533
1534 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001535 stdout, stderr = self._communicate_with_poll(input, endtime,
1536 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001537 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001538 stdout, stderr = self._communicate_with_select(input, endtime,
1539 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001540
1541 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001542
1543 # All data exchanged. Translate lists into strings.
1544 if stdout is not None:
1545 stdout = b''.join(stdout)
1546 if stderr is not None:
1547 stderr = b''.join(stderr)
1548
1549 # Translate newlines, if requested.
1550 # This also turns bytes into strings.
1551 if self.universal_newlines:
1552 if stdout is not None:
1553 stdout = self._translate_newlines(stdout,
1554 self.stdout.encoding)
1555 if stderr is not None:
1556 stderr = self._translate_newlines(stderr,
1557 self.stderr.encoding)
1558
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001559 return (stdout, stderr)
1560
1561
Reid Kleckner2b228f02011-03-16 16:57:54 -04001562 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001563 stdout = None # Return
1564 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001565
1566 if not self._communication_started:
1567 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001568
1569 poller = select.poll()
1570 def register_and_append(file_obj, eventmask):
1571 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001572 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001573
1574 def close_unregister_and_remove(fd):
1575 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001576 self._fd2file[fd].close()
1577 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001578
1579 if self.stdin and input:
1580 register_and_append(self.stdin, select.POLLOUT)
1581
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001582 # Only create this mapping if we haven't already.
1583 if not self._communication_started:
1584 self._fd2output = {}
1585 if self.stdout:
1586 self._fd2output[self.stdout.fileno()] = []
1587 if self.stderr:
1588 self._fd2output[self.stderr.fileno()] = []
1589
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001590 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1591 if self.stdout:
1592 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001593 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001594 if self.stderr:
1595 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001597
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001598 # Save the input here so that if we time out while communicating,
1599 # we can continue sending input if we retry.
1600 if self.stdin and self._input is None:
1601 self._input_offset = 0
1602 self._input = input
1603 if self.universal_newlines:
1604 self._input = self._input.encode(self.stdin.encoding)
1605
1606 while self._fd2file:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001607 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001608 ready = poller.poll(self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001609 except select.error as e:
1610 if e.args[0] == errno.EINTR:
1611 continue
1612 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001613 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001614
1615 # XXX Rewrite these to use non-blocking I/O on the
1616 # file objects; they are no longer using C stdio!
1617
1618 for fd, mode in ready:
1619 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001620 chunk = self._input[self._input_offset :
1621 self._input_offset + _PIPE_BUF]
1622 self._input_offset += os.write(fd, chunk)
1623 if self._input_offset >= len(self._input):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001624 close_unregister_and_remove(fd)
1625 elif mode & select_POLLIN_POLLPRI:
1626 data = os.read(fd, 4096)
1627 if not data:
1628 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001629 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001630 else:
1631 # Ignore hang up or errors.
1632 close_unregister_and_remove(fd)
1633
1634 return (stdout, stderr)
1635
1636
Reid Kleckner2b228f02011-03-16 16:57:54 -04001637 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001638 if not self._communication_started:
1639 self._read_set = []
1640 self._write_set = []
1641 if self.stdin and input:
1642 self._write_set.append(self.stdin)
1643 if self.stdout:
1644 self._read_set.append(self.stdout)
1645 if self.stderr:
1646 self._read_set.append(self.stderr)
1647
1648 if self.stdin and self._input is None:
1649 self._input_offset = 0
1650 self._input = input
1651 if self.universal_newlines:
1652 self._input = self._input.encode(self.stdin.encoding)
1653
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001654 stdout = None # Return
1655 stderr = None # Return
1656
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001657 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001658 if not self._communication_started:
1659 self._stdout_buff = []
1660 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001661 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001662 if not self._communication_started:
1663 self._stderr_buff = []
1664 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001665
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001666 while self._read_set or self._write_set:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001667 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001668 (rlist, wlist, xlist) = \
1669 select.select(self._read_set, self._write_set, [],
1670 self._remaining_time(endtime))
Georg Brandl86b2fb92008-07-16 03:43:04 +00001671 except select.error as e:
1672 if e.args[0] == errno.EINTR:
1673 continue
1674 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001675
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001676 # According to the docs, returning three empty lists indicates
1677 # that the timeout expired.
1678 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001679 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001680 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001681 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001682
Guido van Rossum98297ee2007-11-06 21:34:58 +00001683 # XXX Rewrite these to use non-blocking I/O on the
1684 # file objects; they are no longer using C stdio!
1685
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001686 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001687 chunk = self._input[self._input_offset :
1688 self._input_offset + _PIPE_BUF]
Guido van Rossumbae07c92007-10-08 02:46:15 +00001689 bytes_written = os.write(self.stdin.fileno(), chunk)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001690 self._input_offset += bytes_written
1691 if self._input_offset >= len(self._input):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001692 self.stdin.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001693 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001694
1695 if self.stdout in rlist:
1696 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001697 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001698 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001699 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001700 stdout.append(data)
1701
1702 if self.stderr in rlist:
1703 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001704 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001705 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001706 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001707 stderr.append(data)
1708
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001709 return (stdout, stderr)
1710
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001711
Christian Heimesa342c012008-04-20 21:01:16 +00001712 def send_signal(self, sig):
1713 """Send a signal to the process
1714 """
1715 os.kill(self.pid, sig)
1716
1717 def terminate(self):
1718 """Terminate the process with SIGTERM
1719 """
1720 self.send_signal(signal.SIGTERM)
1721
1722 def kill(self):
1723 """Kill the process with SIGKILL
1724 """
1725 self.send_signal(signal.SIGKILL)
1726
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001727
1728def _demo_posix():
1729 #
1730 # Example 1: Simple redirection: Get process list
1731 #
1732 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001733 print("Process list:")
1734 print(plist)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001735
1736 #
1737 # Example 2: Change uid before executing child
1738 #
1739 if os.getuid() == 0:
1740 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
1741 p.wait()
1742
1743 #
1744 # Example 3: Connecting several subprocesses
1745 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001746 print("Looking for 'hda'...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001747 p1 = Popen(["dmesg"], stdout=PIPE)
1748 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001749 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001750
1751 #
1752 # Example 4: Catch execution error
1753 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001754 print()
1755 print("Trying a weird file...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001756 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001757 print(Popen(["/this/path/does/not/exist"]).communicate())
Guido van Rossumb940e112007-01-10 16:19:56 +00001758 except OSError as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001759 if e.errno == errno.ENOENT:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001760 print("The file didn't exist. I thought so...")
1761 print("Child traceback:")
1762 print(e.child_traceback)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001763 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001764 print("Error", e.errno)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001765 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001766 print("Gosh. No error.", file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001767
1768
1769def _demo_windows():
1770 #
1771 # Example 1: Connecting several subprocesses
1772 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001773 print("Looking for 'PROMPT' in set output...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001774 p1 = Popen("set", stdout=PIPE, shell=True)
1775 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001776 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001777
1778 #
1779 # Example 2: Simple execution of program
1780 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001781 print("Executing calc...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001782 p = Popen("calc")
1783 p.wait()
1784
1785
1786if __name__ == "__main__":
1787 if mswindows:
1788 _demo_windows()
1789 else:
1790 _demo_posix()