blob: 15398914041fbc3fd8dd298749a4fd4f8cb68303 [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001# subprocess - Subprocesses with accessible I/O streams
2#
Tim Peterse718f612004-10-12 21:51:32 +00003# For more information about this module, see PEP 324.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00004#
Peter Astrand3a708df2005-09-23 17:37:29 +00005# Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00006#
Peter Astrand69bf13f2005-02-14 08:56:32 +00007# Licensed to PSF under a Contributor Agreement.
Peter Astrand3a708df2005-09-23 17:37:29 +00008# See http://www.python.org/2.4/license for licensing details.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009
Raymond Hettinger837dd932004-10-17 16:36:53 +000010r"""subprocess - Subprocesses with accessible I/O streams
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000011
Fredrik Lundh15aaacc2004-10-17 14:47:05 +000012This module allows you to spawn processes, connect to their
13input/output/error pipes, and obtain their return codes. This module
14intends to replace several other, older modules and functions, like:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000015
16os.system
17os.spawn*
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000018
19Information about how the subprocess module can be used to replace these
20modules and functions can be found below.
21
22
23
24Using the subprocess module
25===========================
26This module defines one class called Popen:
27
28class Popen(args, bufsize=0, executable=None,
29 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000030 preexec_fn=None, close_fds=True, shell=False,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000031 cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000032 startupinfo=None, creationflags=0,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000033 restore_signals=True, start_new_session=False, pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000034
35
36Arguments are:
37
38args should be a string, or a sequence of program arguments. The
39program to execute is normally the first item in the args sequence or
40string, but can be explicitly set by using the executable argument.
41
Gregory P. Smithf5604852010-12-13 06:45:02 +000042On POSIX, with shell=False (default): In this case, the Popen class
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000043uses os.execvp() to execute the child program. args should normally
44be a sequence. A string will be treated as a sequence with the string
45as the only item (the program to execute).
46
Gregory P. Smithf5604852010-12-13 06:45:02 +000047On POSIX, with shell=True: If args is a string, it specifies the
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000048command string to execute through the shell. If args is a sequence,
49the first item specifies the command string, and any additional items
50will be treated as additional shell arguments.
51
52On Windows: the Popen class uses CreateProcess() to execute the child
53program, which operates on strings. If args is a sequence, it will be
54converted to a string using the list2cmdline method. Please note that
55not all MS Windows applications interpret the command line the same
56way: The list2cmdline is designed for applications using the same
57rules as the MS C runtime.
58
59bufsize, if given, has the same meaning as the corresponding argument
60to the built-in open() function: 0 means unbuffered, 1 means line
61buffered, any other positive value means use a buffer of
62(approximately) that size. A negative bufsize means to use the system
63default, which usually means fully buffered. The default value for
64bufsize is 0 (unbuffered).
65
66stdin, stdout and stderr specify the executed programs' standard
67input, standard output and standard error file handles, respectively.
68Valid values are PIPE, an existing file descriptor (a positive
69integer), an existing file object, and None. PIPE indicates that a
70new pipe to the child should be created. With None, no redirection
71will occur; the child's file handles will be inherited from the
72parent. Additionally, stderr can be STDOUT, which indicates that the
73stderr data from the applications should be captured into the same
74file handle as for stdout.
75
Gregory P. Smithf5604852010-12-13 06:45:02 +000076On POSIX, if preexec_fn is set to a callable object, this object will be
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000077called in the child process just before the child is executed. The use
78of preexec_fn is not thread safe, using it in the presence of threads
79could lead to a deadlock in the child process before the new executable
80is executed.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000081
82If close_fds is true, all file descriptors except 0, 1 and 2 will be
Gregory P. Smithf5604852010-12-13 06:45:02 +000083closed before the child process is executed. The default for close_fds
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000084varies by platform: Always true on POSIX. True when stdin/stdout/stderr
85are None on Windows, false otherwise.
86
87pass_fds is an optional sequence of file descriptors to keep open between the
88parent and child. Providing any pass_fds implicitly sets close_fds to true.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000089
90if shell is true, the specified command will be executed through the
91shell.
92
93If cwd is not None, the current directory will be changed to cwd
94before the child is executed.
95
Gregory P. Smithf5604852010-12-13 06:45:02 +000096On POSIX, if restore_signals is True all signals that Python sets to
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000097SIG_IGN are restored to SIG_DFL in the child process before the exec.
98Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. This
99parameter does nothing on Windows.
100
Gregory P. Smithf5604852010-12-13 06:45:02 +0000101On POSIX, if start_new_session is True, the setsid() system call will be made
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000102in the child process prior to executing the command.
103
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000104If env is not None, it defines the environment variables for the new
105process.
106
107If universal_newlines is true, the file objects stdout and stderr are
108opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000109the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110'\r\n', the Windows convention. All of these external representations
111are seen as '\n' by the Python program. Note: This feature is only
112available if Python is built with universal newline support (the
113default). Also, the newlines attribute of the file objects stdout,
114stdin and stderr are not updated by the communicate() method.
115
116The startupinfo and creationflags, if given, will be passed to the
117underlying CreateProcess() function. They can specify things such as
118appearance of the main window and priority for the new process.
119(Windows only)
120
121
Georg Brandlf9734072008-12-07 15:30:06 +0000122This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000123
Peter Astrand5f5e1412004-12-05 20:15:36 +0000124call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125 Run command with arguments. Wait for command to complete, then
126 return the returncode attribute.
127
128 The arguments are the same as for the Popen constructor. Example:
129
Florent Xicluna4886d242010-03-08 13:27:26 +0000130 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131
Peter Astrand454f7672005-01-01 09:36:35 +0000132check_call(*popenargs, **kwargs):
133 Run command with arguments. Wait for command to complete. If the
134 exit code was zero then return, otherwise raise
135 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000136 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000137
138 The arguments are the same as for the Popen constructor. Example:
139
Florent Xicluna4886d242010-03-08 13:27:26 +0000140 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000141 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000142
Brett Cannona23810f2008-05-26 19:04:21 +0000143getstatusoutput(cmd):
144 Return (status, output) of executing cmd in a shell.
145
146 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
147 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
148 returned output will contain output or error messages. A trailing newline
149 is stripped from the output. The exit status for the command can be
150 interpreted according to the rules for the C function wait(). Example:
151
Brett Cannona23810f2008-05-26 19:04:21 +0000152 >>> subprocess.getstatusoutput('ls /bin/ls')
153 (0, '/bin/ls')
154 >>> subprocess.getstatusoutput('cat /bin/junk')
155 (256, 'cat: /bin/junk: No such file or directory')
156 >>> subprocess.getstatusoutput('/bin/junk')
157 (256, 'sh: /bin/junk: not found')
158
159getoutput(cmd):
160 Return output (stdout or stderr) of executing cmd in a shell.
161
162 Like getstatusoutput(), except the exit status is ignored and the return
163 value is a string containing the command's output. Example:
164
Brett Cannona23810f2008-05-26 19:04:21 +0000165 >>> subprocess.getoutput('ls /bin/ls')
166 '/bin/ls'
167
Georg Brandlf9734072008-12-07 15:30:06 +0000168check_output(*popenargs, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000169 Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000170
Georg Brandl2708f3a2009-12-20 14:38:23 +0000171 If the exit code was non-zero it raises a CalledProcessError. The
172 CalledProcessError object will have the return code in the returncode
173 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000174
Georg Brandl2708f3a2009-12-20 14:38:23 +0000175 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Brett Cannona23810f2008-05-26 19:04:21 +0000179
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000180Exceptions
181----------
182Exceptions raised in the child process, before the new program has
183started to execute, will be re-raised in the parent. Additionally,
184the exception object will have one extra attribute called
185'child_traceback', which is a string containing traceback information
186from the childs point of view.
187
188The most common exception raised is OSError. This occurs, for
189example, when trying to execute a non-existent file. Applications
190should prepare for OSErrors.
191
192A ValueError will be raised if Popen is called with invalid arguments.
193
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400194Exceptions defined within this module inherit from SubprocessError.
195check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400196called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400197be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000198
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000199
200Security
201--------
202Unlike some other popen functions, this implementation will never call
203/bin/sh implicitly. This means that all characters, including shell
204metacharacters, can safely be passed to child processes.
205
206
207Popen objects
208=============
209Instances of the Popen class have the following methods:
210
211poll()
212 Check if child process has terminated. Returns returncode
213 attribute.
214
215wait()
216 Wait for child process to terminate. Returns returncode attribute.
217
218communicate(input=None)
219 Interact with process: Send data to stdin. Read data from stdout
220 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000221 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000222 sent to the child process, or None, if no data should be sent to
223 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000224
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225 communicate() returns a tuple (stdout, stderr).
226
227 Note: The data read is buffered in memory, so do not use this
228 method if the data size is large or unlimited.
229
230The following attributes are also available:
231
232stdin
233 If the stdin argument is PIPE, this attribute is a file object
234 that provides input to the child process. Otherwise, it is None.
235
236stdout
237 If the stdout argument is PIPE, this attribute is a file object
238 that provides output from the child process. Otherwise, it is
239 None.
240
241stderr
242 If the stderr argument is PIPE, this attribute is file object that
243 provides error output from the child process. Otherwise, it is
244 None.
245
246pid
247 The process ID of the child process.
248
249returncode
250 The child return code. A None value indicates that the process
251 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000252 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000253
254
255Replacing older functions with the subprocess module
256====================================================
257In this section, "a ==> b" means that b can be used as a replacement
258for a.
259
260Note: All functions in this section fail (more or less) silently if
261the executed program cannot be found; this module raises an OSError
262exception.
263
264In the following examples, we assume that the subprocess module is
265imported with "from subprocess import *".
266
267
268Replacing /bin/sh shell backquote
269---------------------------------
270output=`mycmd myarg`
271==>
272output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
273
274
275Replacing shell pipe line
276-------------------------
277output=`dmesg | grep hda`
278==>
279p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000280p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000281output = p2.communicate()[0]
282
283
284Replacing os.system()
285---------------------
286sts = os.system("mycmd" + " myarg")
287==>
288p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000289pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000290
291Note:
292
293* Calling the program through the shell is usually not required.
294
295* It's easier to look at the returncode attribute than the
296 exitstatus.
297
298A more real-world example would look like this:
299
300try:
301 retcode = call("mycmd" + " myarg", shell=True)
302 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000303 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000304 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000305 print("Child returned", retcode, file=sys.stderr)
306except OSError as e:
307 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000308
309
310Replacing os.spawn*
311-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000312P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000313
314pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
315==>
316pid = Popen(["/bin/mycmd", "myarg"]).pid
317
318
319P_WAIT example:
320
321retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
322==>
323retcode = call(["/bin/mycmd", "myarg"])
324
325
Tim Peterse718f612004-10-12 21:51:32 +0000326Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000327
328os.spawnvp(os.P_NOWAIT, path, args)
329==>
330Popen([path] + args[1:])
331
332
Tim Peterse718f612004-10-12 21:51:32 +0000333Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000334
335os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
336==>
337Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000338"""
339
340import sys
341mswindows = (sys.platform == "win32")
342
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000343import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000344import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400345import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000346import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000347import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000348import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000349import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000350import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200351import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000352
Peter Astrand454f7672005-01-01 09:36:35 +0000353# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400354class SubprocessError(Exception): pass
355
356
357class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000358 """This exception is raised when a process run by check_call() or
359 check_output() returns a non-zero exit status.
360 The exit status will be stored in the returncode attribute;
361 check_output() will also store the output in the output attribute.
362 """
363 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000364 self.returncode = returncode
365 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000366 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000367 def __str__(self):
368 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
369
Peter Astrand454f7672005-01-01 09:36:35 +0000370
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400371class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400372 """This exception is raised when the timeout expires while waiting for a
373 child process.
374 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400375 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400376 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400377 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400378 self.output = output
379
380 def __str__(self):
381 return ("Command '%s' timed out after %s seconds" %
382 (self.cmd, self.timeout))
383
384
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000385if mswindows:
386 import threading
387 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200388 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000389 class STARTUPINFO:
390 dwFlags = 0
391 hStdInput = None
392 hStdOutput = None
393 hStdError = None
394 wShowWindow = 0
395 class pywintypes:
396 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000397else:
398 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000399 _has_poll = hasattr(select, 'poll')
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700400 import _posixsubprocess
401 _create_pipe = _posixsubprocess.cloexec_pipe
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000402
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000403 # When select or poll has indicated that the file is writable,
404 # we can write up to _PIPE_BUF bytes without risk of blocking.
405 # POSIX defines PIPE_BUF as >= 512.
406 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
407
408
Brett Cannona23810f2008-05-26 19:04:21 +0000409__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200410 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000411
Brian Curtin1ce6b582010-04-24 16:19:22 +0000412if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200413 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
414 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
415 STD_ERROR_HANDLE, SW_HIDE,
416 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500417
Brian Curtin08fd8d92011-04-29 16:11:30 -0500418 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500419 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
420 "STD_ERROR_HANDLE", "SW_HIDE",
421 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200422
423 class Handle(int):
424 closed = False
425
426 def Close(self, CloseHandle=_winapi.CloseHandle):
427 if not self.closed:
428 self.closed = True
429 CloseHandle(self)
430
431 def Detach(self):
432 if not self.closed:
433 self.closed = True
434 return int(self)
435 raise ValueError("already closed")
436
437 def __repr__(self):
438 return "Handle(%d)" % int(self)
439
440 __del__ = Close
441 __str__ = __repr__
442
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000443try:
444 MAXFD = os.sysconf("SC_OPEN_MAX")
445except:
446 MAXFD = 256
447
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200448# This lists holds Popen instances for which the underlying process had not
449# exited at the time its __del__ method got called: those processes are wait()ed
450# for synchronously from _cleanup() when a new Popen object is created, to avoid
451# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000452_active = []
453
454def _cleanup():
455 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000456 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200457 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000458 try:
459 _active.remove(inst)
460 except ValueError:
461 # This can happen if two threads create a new Popen instance.
462 # It's harmless that it was already removed, so ignore.
463 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000464
465PIPE = -1
466STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200467DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000468
469
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000470def _eintr_retry_call(func, *args):
471 while True:
472 try:
473 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200474 except InterruptedError:
475 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000476
477
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200478# XXX This function is only used by multiprocessing and the test suite,
479# but it's here so that it can be imported when Python is compiled without
480# threads.
481
482def _args_from_interpreter_flags():
483 """Return a list of command-line arguments reproducing the current
484 settings in sys.flags and sys.warnoptions."""
485 flag_opt_map = {
486 'debug': 'd',
487 # 'inspect': 'i',
488 # 'interactive': 'i',
489 'optimize': 'O',
490 'dont_write_bytecode': 'B',
491 'no_user_site': 's',
492 'no_site': 'S',
493 'ignore_environment': 'E',
494 'verbose': 'v',
495 'bytes_warning': 'b',
496 'quiet': 'q',
497 'hash_randomization': 'R',
498 }
499 args = []
500 for flag, opt in flag_opt_map.items():
501 v = getattr(sys.flags, flag)
502 if v > 0:
503 args.append('-' + opt * v)
504 for opt in sys.warnoptions:
505 args.append('-W' + opt)
506 return args
507
508
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400509def call(*popenargs, timeout=None, **kwargs):
510 """Run command with arguments. Wait for command to complete or
511 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000512
513 The arguments are the same as for the Popen constructor. Example:
514
515 retcode = call(["ls", "-l"])
516 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200517 with Popen(*popenargs, **kwargs) as p:
518 try:
519 return p.wait(timeout=timeout)
520 except:
521 p.kill()
522 p.wait()
523 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000524
525
Peter Astrand454f7672005-01-01 09:36:35 +0000526def check_call(*popenargs, **kwargs):
527 """Run command with arguments. Wait for command to complete. If
528 the exit code was zero then return, otherwise raise
529 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000530 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000531
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400532 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000533
534 check_call(["ls", "-l"])
535 """
536 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000537 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000538 cmd = kwargs.get("args")
539 if cmd is None:
540 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000541 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000542 return 0
543
544
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400545def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000546 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000547
548 If the exit code was non-zero it raises a CalledProcessError. The
549 CalledProcessError object will have the return code in the returncode
550 attribute and output in the output attribute.
551
552 The arguments are the same as for the Popen constructor. Example:
553
554 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000555 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000556
557 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000558 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000559
560 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000561 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000562 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000563 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000564 """
565 if 'stdout' in kwargs:
566 raise ValueError('stdout argument not allowed, it will be overridden.')
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200567 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
568 try:
569 output, unused_err = process.communicate(timeout=timeout)
570 except TimeoutExpired:
571 process.kill()
572 output, unused_err = process.communicate()
573 raise TimeoutExpired(process.args, timeout, output=output)
574 except:
575 process.kill()
576 process.wait()
577 raise
578 retcode = process.poll()
579 if retcode:
580 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000581 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000582
583
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000584def list2cmdline(seq):
585 """
586 Translate a sequence of arguments into a command line
587 string, using the same rules as the MS C runtime:
588
589 1) Arguments are delimited by white space, which is either a
590 space or a tab.
591
592 2) A string surrounded by double quotation marks is
593 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000594 contained within. A quoted string can be embedded in an
595 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000596
597 3) A double quotation mark preceded by a backslash is
598 interpreted as a literal double quotation mark.
599
600 4) Backslashes are interpreted literally, unless they
601 immediately precede a double quotation mark.
602
603 5) If backslashes immediately precede a double quotation mark,
604 every pair of backslashes is interpreted as a literal
605 backslash. If the number of backslashes is odd, the last
606 backslash escapes the next double quotation mark as
607 described in rule 3.
608 """
609
610 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000611 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
612 # or search http://msdn.microsoft.com for
613 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000614 result = []
615 needquote = False
616 for arg in seq:
617 bs_buf = []
618
619 # Add a space to separate this argument from the others
620 if result:
621 result.append(' ')
622
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000623 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000624 if needquote:
625 result.append('"')
626
627 for c in arg:
628 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000629 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000630 bs_buf.append(c)
631 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000632 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000633 result.append('\\' * len(bs_buf)*2)
634 bs_buf = []
635 result.append('\\"')
636 else:
637 # Normal char
638 if bs_buf:
639 result.extend(bs_buf)
640 bs_buf = []
641 result.append(c)
642
Christian Heimesfdab48e2008-01-20 09:06:41 +0000643 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000644 if bs_buf:
645 result.extend(bs_buf)
646
647 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000648 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000649 result.append('"')
650
651 return ''.join(result)
652
653
Brett Cannona23810f2008-05-26 19:04:21 +0000654# Various tools for executing commands and looking at their output and status.
655#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000656# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000657
658def getstatusoutput(cmd):
659 """Return (status, output) of executing cmd in a shell.
660
661 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
662 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
663 returned output will contain output or error messages. A trailing newline
664 is stripped from the output. The exit status for the command can be
665 interpreted according to the rules for the C function wait(). Example:
666
667 >>> import subprocess
668 >>> subprocess.getstatusoutput('ls /bin/ls')
669 (0, '/bin/ls')
670 >>> subprocess.getstatusoutput('cat /bin/junk')
671 (256, 'cat: /bin/junk: No such file or directory')
672 >>> subprocess.getstatusoutput('/bin/junk')
673 (256, 'sh: /bin/junk: not found')
674 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200675 with os.popen('{ ' + cmd + '; } 2>&1', 'r') as pipe:
676 try:
677 text = pipe.read()
678 sts = pipe.close()
679 except:
680 process = pipe._proc
681 process.kill()
682 process.wait()
683 raise
684 if sts is None:
685 sts = 0
686 if text[-1:] == '\n':
687 text = text[:-1]
Brett Cannona23810f2008-05-26 19:04:21 +0000688 return sts, text
689
690
691def getoutput(cmd):
692 """Return output (stdout or stderr) of executing cmd in a shell.
693
694 Like getstatusoutput(), except the exit status is ignored and the return
695 value is a string containing the command's output. Example:
696
697 >>> import subprocess
698 >>> subprocess.getoutput('ls /bin/ls')
699 '/bin/ls'
700 """
701 return getstatusoutput(cmd)[1]
702
703
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000704_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000705
706
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000707class Popen(object):
708 def __init__(self, args, bufsize=0, executable=None,
709 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000710 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
711 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000712 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000713 restore_signals=True, start_new_session=False,
714 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000715 """Create new Popen instance."""
716 _cleanup()
717
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000718 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400719 self._input = None
720 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000721 if bufsize is None:
722 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000723 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000724 raise TypeError("bufsize must be an integer")
725
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000726 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000727 if preexec_fn is not None:
728 raise ValueError("preexec_fn is not supported on Windows "
729 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000730 any_stdio_set = (stdin is not None or stdout is not None or
731 stderr is not None)
732 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
733 if any_stdio_set:
734 close_fds = False
735 else:
736 close_fds = True
737 elif close_fds and any_stdio_set:
738 raise ValueError(
739 "close_fds is not supported on Windows platforms"
740 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000741 else:
742 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000743 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
744 close_fds = True
745 if pass_fds and not close_fds:
746 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
747 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000748 if startupinfo is not None:
749 raise ValueError("startupinfo is only supported on Windows "
750 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000751 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000752 raise ValueError("creationflags is only supported on Windows "
753 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000754
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400755 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000756 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000757 self.stdout = None
758 self.stderr = None
759 self.pid = None
760 self.returncode = None
761 self.universal_newlines = universal_newlines
762
763 # Input and output objects. The general principle is like
764 # this:
765 #
766 # Parent Child
767 # ------ -----
768 # p2cwrite ---stdin---> p2cread
769 # c2pread <--stdout--- c2pwrite
770 # errread <--stderr--- errwrite
771 #
772 # On POSIX, the child objects are file descriptors. On
773 # Windows, these are Windows file handles. The parent objects
774 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000775 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000776 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000777
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000778 (p2cread, p2cwrite,
779 c2pread, c2pwrite,
780 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
781
Antoine Pitrouc9982322011-01-04 19:07:07 +0000782 # We wrap OS handles *before* launching the child, otherwise a
783 # quickly terminating child could make our fds unwrappable
784 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000785
Thomas Wouterscf297e42007-02-23 15:07:44 +0000786 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000787 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000788 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000789 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000790 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000791 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000792 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000793
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000794 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000795 self.stdin = io.open(p2cwrite, 'wb', bufsize)
796 if self.universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200797 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000798 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000799 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000800 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000801 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000802 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000803 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000805 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000806
Antoine Pitrouc9982322011-01-04 19:07:07 +0000807 try:
808 self._execute_child(args, executable, preexec_fn, close_fds,
809 pass_fds, cwd, env, universal_newlines,
810 startupinfo, creationflags, shell,
811 p2cread, p2cwrite,
812 c2pread, c2pwrite,
813 errread, errwrite,
814 restore_signals, start_new_session)
815 except:
816 # Cleanup if the child failed starting
817 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
818 try:
819 f.close()
820 except EnvironmentError:
821 # Ignore EBADF or other errors
822 pass
823 raise
824
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000825
Guido van Rossum98297ee2007-11-06 21:34:58 +0000826 def _translate_newlines(self, data, encoding):
827 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
828 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000829
Brian Curtin79cdb662010-12-03 02:46:02 +0000830 def __enter__(self):
831 return self
832
833 def __exit__(self, type, value, traceback):
834 if self.stdout:
835 self.stdout.close()
836 if self.stderr:
837 self.stderr.close()
838 if self.stdin:
839 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700840 # Wait for the process to terminate, to avoid zombies.
841 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000842
Brett Cannon84df1e62010-05-14 00:33:40 +0000843 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Victor Stinner87b9bc32011-06-01 00:57:47 +0200844 # If __init__ hasn't had a chance to execute (e.g. if it
845 # was passed an undeclared keyword argument), we don't
846 # have a _child_created attribute at all.
847 if not getattr(self, '_child_created', False):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000848 # We didn't get to successfully create a child process.
849 return
850 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000851 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000852 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000853 # Child is still running, keep us alive until we can wait on it.
854 _active.append(self)
855
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200856 def _get_devnull(self):
857 if not hasattr(self, '_devnull'):
858 self._devnull = os.open(os.devnull, os.O_RDWR)
859 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000860
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400861 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000862 """Interact with process: Send data to stdin. Read data from
863 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700864 process to terminate. The optional input argument should be
865 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000866 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000867
Peter Astrand23109f02005-03-03 20:28:59 +0000868 communicate() returns a tuple (stdout, stderr)."""
869
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400870 if self._communication_started and input:
871 raise ValueError("Cannot send input after starting communication")
872
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400873 # Optimization: If we are not worried about timeouts, we haven't
874 # started communicating, and we have one or zero pipes, using select()
875 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200876 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400877 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000878 stdout = None
879 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000880 if self.stdin:
881 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200882 try:
883 self.stdin.write(input)
884 except IOError as e:
885 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
886 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000887 self.stdin.close()
888 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200889 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000890 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000891 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200892 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000893 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000894 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200895 else:
896 if timeout is not None:
897 endtime = time.time() + timeout
898 else:
899 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000900
Victor Stinner7a8d0812011-04-05 13:13:08 +0200901 try:
902 stdout, stderr = self._communicate(input, endtime, timeout)
903 finally:
904 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400905
Victor Stinner7a8d0812011-04-05 13:13:08 +0200906 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400907
908 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000909
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000910
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000911 def poll(self):
912 return self._internal_poll()
913
914
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400915 def _remaining_time(self, endtime):
916 """Convenience for _communicate when computing timeouts."""
917 if endtime is None:
918 return None
919 else:
920 return endtime - time.time()
921
922
Reid Kleckner2b228f02011-03-16 16:57:54 -0400923 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400924 """Convenience for checking if a timeout has expired."""
925 if endtime is None:
926 return
927 if time.time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400928 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400929
930
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000931 if mswindows:
932 #
933 # Windows methods
934 #
935 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000936 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000937 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
938 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000939 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000940 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000941
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000942 p2cread, p2cwrite = -1, -1
943 c2pread, c2pwrite = -1, -1
944 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000945
Peter Astrandd38ddf42005-02-10 08:32:50 +0000946 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200947 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000948 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200949 p2cread, _ = _winapi.CreatePipe(None, 0)
950 p2cread = Handle(p2cread)
951 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000952 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200953 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
954 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200955 elif stdin == DEVNULL:
956 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000957 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000958 p2cread = msvcrt.get_osfhandle(stdin)
959 else:
960 # Assuming file-like object
961 p2cread = msvcrt.get_osfhandle(stdin.fileno())
962 p2cread = self._make_inheritable(p2cread)
963
Peter Astrandd38ddf42005-02-10 08:32:50 +0000964 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200965 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000966 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200967 _, c2pwrite = _winapi.CreatePipe(None, 0)
968 c2pwrite = Handle(c2pwrite)
969 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000970 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200971 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
972 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200973 elif stdout == DEVNULL:
974 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000975 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000976 c2pwrite = msvcrt.get_osfhandle(stdout)
977 else:
978 # Assuming file-like object
979 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
980 c2pwrite = self._make_inheritable(c2pwrite)
981
Peter Astrandd38ddf42005-02-10 08:32:50 +0000982 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200983 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000984 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200985 _, errwrite = _winapi.CreatePipe(None, 0)
986 errwrite = Handle(errwrite)
987 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000988 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200989 errread, errwrite = _winapi.CreatePipe(None, 0)
990 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000991 elif stderr == STDOUT:
992 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200993 elif stderr == DEVNULL:
994 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +0000995 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000996 errwrite = msvcrt.get_osfhandle(stderr)
997 else:
998 # Assuming file-like object
999 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1000 errwrite = self._make_inheritable(errwrite)
1001
1002 return (p2cread, p2cwrite,
1003 c2pread, c2pwrite,
1004 errread, errwrite)
1005
1006
1007 def _make_inheritable(self, handle):
1008 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001009 h = _winapi.DuplicateHandle(
1010 _winapi.GetCurrentProcess(), handle,
1011 _winapi.GetCurrentProcess(), 0, 1,
1012 _winapi.DUPLICATE_SAME_ACCESS)
1013 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001014
1015
1016 def _find_w9xpopen(self):
1017 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +00001018 w9xpopen = os.path.join(
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001019 os.path.dirname(_winapi.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +00001020 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001021 if not os.path.exists(w9xpopen):
1022 # Eeek - file-not-found - possibly an embedding
1023 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +00001024 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
1025 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001026 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +00001027 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1028 "needed for Popen to work with your "
1029 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001030 return w9xpopen
1031
Tim Peterse718f612004-10-12 21:51:32 +00001032
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001033 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001034 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001035 startupinfo, creationflags, shell,
1036 p2cread, p2cwrite,
1037 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001038 errread, errwrite,
1039 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001040 """Execute program (MS Windows version)"""
1041
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001042 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001043
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001044 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001045 args = list2cmdline(args)
1046
Peter Astrandc1d65362004-11-07 14:30:34 +00001047 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001048 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001049 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001050 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001051 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001052 startupinfo.hStdInput = p2cread
1053 startupinfo.hStdOutput = c2pwrite
1054 startupinfo.hStdError = errwrite
1055
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001056 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001057 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1058 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001059 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001060 args = '{} /c "{}"'.format (comspec, args)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001061 if (_winapi.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +00001062 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001063 # Win9x, or using command.com on NT. We need to
1064 # use the w9xpopen intermediate program. For more
1065 # information, see KB Q150956
1066 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
1067 w9xpopen = self._find_w9xpopen()
1068 args = '"%s" %s' % (w9xpopen, args)
1069 # Not passing CREATE_NEW_CONSOLE has been known to
1070 # cause random failures on win9x. Specifically a
1071 # dialog: "Your program accessed mem currently in
1072 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +00001073 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001074 # kill children.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001075 creationflags |= _winapi.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001076
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001077 # Start the process
1078 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001079 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001080 # no special security
1081 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001082 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001083 creationflags,
1084 env,
1085 cwd,
1086 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001087 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001088 # Translate pywintypes.error to WindowsError, which is
1089 # a subclass of OSError. FIXME: We should really
Ezio Melotti13925002011-03-16 11:05:33 +02001090 # translate errno using _sys_errlist (or similar), but
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001091 # how can this be done from Python?
1092 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001093 finally:
1094 # Child is launched. Close the parent's copy of those pipe
1095 # handles that only the child should have open. You need
1096 # to make sure that no handles to the write end of the
1097 # output pipe are maintained in this process or else the
1098 # pipe will not close when the child process exits and the
1099 # ReadFile will hang.
1100 if p2cread != -1:
1101 p2cread.Close()
1102 if c2pwrite != -1:
1103 c2pwrite.Close()
1104 if errwrite != -1:
1105 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001106 if hasattr(self, '_devnull'):
1107 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001108
1109 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001110 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001111 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001112 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001113 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114
Brett Cannon84df1e62010-05-14 00:33:40 +00001115 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001116 _WaitForSingleObject=_winapi.WaitForSingleObject,
1117 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1118 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001119 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001120 attribute.
1121
1122 This method is called by __del__, so it can only refer to objects
1123 in its local scope.
1124
1125 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001126 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001127 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1128 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001129 return self.returncode
1130
1131
Reid Kleckner2b228f02011-03-16 16:57:54 -04001132 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001133 """Wait for child process to terminate. Returns returncode
1134 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001135 if endtime is not None:
1136 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001137 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001138 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001139 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001140 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001141 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001142 result = _winapi.WaitForSingleObject(self._handle,
1143 timeout_millis)
1144 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001145 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001146 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001147 return self.returncode
1148
1149
1150 def _readerthread(self, fh, buffer):
1151 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001152 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001153
1154
Reid Kleckner2b228f02011-03-16 16:57:54 -04001155 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001156 # Start reader threads feeding into a list hanging off of this
1157 # object, unless they've already been started.
1158 if self.stdout and not hasattr(self, "_stdout_buff"):
1159 self._stdout_buff = []
1160 self.stdout_thread = \
1161 threading.Thread(target=self._readerthread,
1162 args=(self.stdout, self._stdout_buff))
1163 self.stdout_thread.daemon = True
1164 self.stdout_thread.start()
1165 if self.stderr and not hasattr(self, "_stderr_buff"):
1166 self._stderr_buff = []
1167 self.stderr_thread = \
1168 threading.Thread(target=self._readerthread,
1169 args=(self.stderr, self._stderr_buff))
1170 self.stderr_thread.daemon = True
1171 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172
1173 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001174 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001175 try:
1176 self.stdin.write(input)
1177 except IOError as e:
1178 if e.errno != errno.EPIPE:
1179 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180 self.stdin.close()
1181
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001182 # Wait for the reader threads, or time out. If we time out, the
1183 # threads remain reading and the fds left open in case the user
1184 # calls communicate again.
1185 if self.stdout is not None:
1186 self.stdout_thread.join(self._remaining_time(endtime))
1187 if self.stdout_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001188 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001189 if self.stderr is not None:
1190 self.stderr_thread.join(self._remaining_time(endtime))
1191 if self.stderr_thread.isAlive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001192 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001193
1194 # Collect the output from and close both pipes, now that we know
1195 # both have been read successfully.
1196 stdout = None
1197 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001198 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001199 stdout = self._stdout_buff
1200 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001201 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001202 stderr = self._stderr_buff
1203 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001204
1205 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001206 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001207 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001208 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001209 stderr = stderr[0]
1210
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211 return (stdout, stderr)
1212
Christian Heimesa342c012008-04-20 21:01:16 +00001213 def send_signal(self, sig):
1214 """Send a signal to the process
1215 """
1216 if sig == signal.SIGTERM:
1217 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001218 elif sig == signal.CTRL_C_EVENT:
1219 os.kill(self.pid, signal.CTRL_C_EVENT)
1220 elif sig == signal.CTRL_BREAK_EVENT:
1221 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001222 else:
Brian Curtin19651362010-09-07 13:24:38 +00001223 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001224
1225 def terminate(self):
1226 """Terminates the process
1227 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001228 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001229 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001230 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001231 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1232 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001233 rc = _winapi.GetExitCodeProcess(self._handle)
1234 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001235 raise
1236 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001237
1238 kill = terminate
1239
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001240 else:
1241 #
1242 # POSIX methods
1243 #
1244 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001245 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001246 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1247 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001248 p2cread, p2cwrite = -1, -1
1249 c2pread, c2pwrite = -1, -1
1250 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001251
Peter Astrandd38ddf42005-02-10 08:32:50 +00001252 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001253 pass
1254 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001255 p2cread, p2cwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001256 elif stdin == DEVNULL:
1257 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001258 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001259 p2cread = stdin
1260 else:
1261 # Assuming file-like object
1262 p2cread = stdin.fileno()
1263
Peter Astrandd38ddf42005-02-10 08:32:50 +00001264 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001265 pass
1266 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001267 c2pread, c2pwrite = _create_pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001268 elif stdout == DEVNULL:
1269 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001270 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001271 c2pwrite = stdout
1272 else:
1273 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001274 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001275
Peter Astrandd38ddf42005-02-10 08:32:50 +00001276 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001277 pass
1278 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001279 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001280 elif stderr == STDOUT:
1281 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001282 elif stderr == DEVNULL:
1283 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001284 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285 errwrite = stderr
1286 else:
1287 # Assuming file-like object
1288 errwrite = stderr.fileno()
1289
1290 return (p2cread, p2cwrite,
1291 c2pread, c2pwrite,
1292 errread, errwrite)
1293
1294
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001295 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001296 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001297 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001298 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001299 os.closerange(start_fd, fd)
1300 start_fd = fd + 1
1301 if start_fd <= MAXFD:
1302 os.closerange(start_fd, MAXFD)
1303
1304
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001305 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001306 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001307 startupinfo, creationflags, shell,
1308 p2cread, p2cwrite,
1309 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001310 errread, errwrite,
1311 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001312 """Execute program (POSIX version)"""
1313
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001314 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001315 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001316 else:
1317 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001318
1319 if shell:
1320 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001321 if executable:
1322 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001323
Peter Astrandd38ddf42005-02-10 08:32:50 +00001324 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001325 executable = args[0]
1326
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001327 # For transferring possible exec failure from child to parent.
1328 # Data format: "exception name:hex errno:description"
1329 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001330 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001331 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001332 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001333 # We must avoid complex work that could involve
1334 # malloc or free in the child process to avoid
1335 # potential deadlocks, thus we do all this here.
1336 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001337
Victor Stinner372b8382011-06-21 17:24:21 +02001338 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001339 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1340 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001341 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001342 env_list = None # Use execv instead of execve.
1343 executable = os.fsencode(executable)
1344 if os.path.dirname(executable):
1345 executable_list = (executable,)
1346 else:
1347 # This matches the behavior of os._execvpe().
1348 executable_list = tuple(
1349 os.path.join(os.fsencode(dir), executable)
1350 for dir in os.get_exec_path(env))
1351 fds_to_keep = set(pass_fds)
1352 fds_to_keep.add(errpipe_write)
1353 self.pid = _posixsubprocess.fork_exec(
1354 args, executable_list,
1355 close_fds, sorted(fds_to_keep), cwd, env_list,
1356 p2cread, p2cwrite, c2pread, c2pwrite,
1357 errread, errwrite,
1358 errpipe_read, errpipe_write,
1359 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001360 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001361 finally:
1362 # be sure the FD is closed no matter what
1363 os.close(errpipe_write)
1364
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001365 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001366 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001367 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001368 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001369 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001370 os.close(errwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001371 if hasattr(self, '_devnull'):
1372 os.close(self._devnull)
Facundo Batista10706e22009-06-19 20:34:30 +00001373
1374 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001375 # exception (limited in size)
1376 data = bytearray()
1377 while True:
1378 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1379 data += part
1380 if not part or len(data) > 50000:
1381 break
Facundo Batista10706e22009-06-19 20:34:30 +00001382 finally:
1383 # be sure the FD is closed no matter what
1384 os.close(errpipe_read)
1385
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001386 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001387 try:
1388 _eintr_retry_call(os.waitpid, self.pid, 0)
1389 except OSError as e:
1390 if e.errno != errno.ECHILD:
1391 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001392 try:
1393 exception_name, hex_errno, err_msg = data.split(b':', 2)
1394 except ValueError:
1395 print('Bad exception data:', repr(data))
1396 exception_name = b'RuntimeError'
1397 hex_errno = b'0'
1398 err_msg = b'Unknown'
1399 child_exception_type = getattr(
1400 builtins, exception_name.decode('ascii'),
1401 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001402 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001403 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001404 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001405 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001406 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001407 errno_num = int(hex_errno, 16)
1408 if errno_num != 0:
1409 err_msg = os.strerror(errno_num)
1410 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001411 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001412 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001413 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001414
1415
Brett Cannon84df1e62010-05-14 00:33:40 +00001416 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1417 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1418 _WEXITSTATUS=os.WEXITSTATUS):
1419 # This method is called (indirectly) by __del__, so it cannot
1420 # refer to anything outside of its local scope."""
1421 if _WIFSIGNALED(sts):
1422 self.returncode = -_WTERMSIG(sts)
1423 elif _WIFEXITED(sts):
1424 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001425 else:
1426 # Should never happen
1427 raise RuntimeError("Unknown child exit status!")
1428
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001429
Brett Cannon84df1e62010-05-14 00:33:40 +00001430 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1431 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001432 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001433 attribute.
1434
1435 This method is called by __del__, so it cannot reference anything
1436 outside of the local scope (nor can any methods it calls).
1437
1438 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001439 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001440 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001441 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001442 if pid == self.pid:
1443 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001444 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001445 if _deadstate is not None:
1446 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001447 return self.returncode
1448
1449
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001450 def _try_wait(self, wait_flags):
1451 try:
1452 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1453 except OSError as e:
1454 if e.errno != errno.ECHILD:
1455 raise
1456 # This happens if SIGCLD is set to be ignored or waiting
1457 # for child processes has otherwise been disabled for our
1458 # process. This child is dead, we can't get the status.
1459 pid = self.pid
1460 sts = 0
1461 return (pid, sts)
1462
1463
1464 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001465 """Wait for child process to terminate. Returns returncode
1466 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001467 if self.returncode is not None:
1468 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001469
1470 # endtime is preferred to timeout. timeout is only used for
1471 # printing.
1472 if endtime is not None or timeout is not None:
1473 if endtime is None:
1474 endtime = time.time() + timeout
1475 elif timeout is None:
1476 timeout = self._remaining_time(endtime)
1477
1478 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001479 # Enter a busy loop if we have a timeout. This busy loop was
1480 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1481 delay = 0.0005 # 500 us -> initial delay of 1 ms
1482 while True:
1483 (pid, sts) = self._try_wait(os.WNOHANG)
1484 assert pid == self.pid or pid == 0
1485 if pid == self.pid:
1486 self._handle_exitstatus(sts)
1487 break
1488 remaining = self._remaining_time(endtime)
1489 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001490 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001491 delay = min(delay * 2, remaining, .05)
1492 time.sleep(delay)
1493 elif self.returncode is None:
1494 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001495 self._handle_exitstatus(sts)
1496 return self.returncode
1497
1498
Reid Kleckner2b228f02011-03-16 16:57:54 -04001499 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001500 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001501 # Flush stdio buffer. This might block, if the user has
1502 # been writing to .stdin in an uncontrolled fashion.
1503 self.stdin.flush()
1504 if not input:
1505 self.stdin.close()
1506
1507 if _has_poll:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001508 stdout, stderr = self._communicate_with_poll(input, endtime,
1509 orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001510 else:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001511 stdout, stderr = self._communicate_with_select(input, endtime,
1512 orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001513
1514 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001515
1516 # All data exchanged. Translate lists into strings.
1517 if stdout is not None:
1518 stdout = b''.join(stdout)
1519 if stderr is not None:
1520 stderr = b''.join(stderr)
1521
1522 # Translate newlines, if requested.
1523 # This also turns bytes into strings.
1524 if self.universal_newlines:
1525 if stdout is not None:
1526 stdout = self._translate_newlines(stdout,
1527 self.stdout.encoding)
1528 if stderr is not None:
1529 stderr = self._translate_newlines(stderr,
1530 self.stderr.encoding)
1531
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001532 return (stdout, stderr)
1533
1534
Reid Kleckner2b228f02011-03-16 16:57:54 -04001535 def _communicate_with_poll(self, input, endtime, orig_timeout):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001536 stdout = None # Return
1537 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001538
1539 if not self._communication_started:
1540 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001541
1542 poller = select.poll()
1543 def register_and_append(file_obj, eventmask):
1544 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001545 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001546
1547 def close_unregister_and_remove(fd):
1548 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001549 self._fd2file[fd].close()
1550 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001551
1552 if self.stdin and input:
1553 register_and_append(self.stdin, select.POLLOUT)
1554
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001555 # Only create this mapping if we haven't already.
1556 if not self._communication_started:
1557 self._fd2output = {}
1558 if self.stdout:
1559 self._fd2output[self.stdout.fileno()] = []
1560 if self.stderr:
1561 self._fd2output[self.stderr.fileno()] = []
1562
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001563 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1564 if self.stdout:
1565 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001566 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001567 if self.stderr:
1568 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001569 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001570
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001571 # Save the input here so that if we time out while communicating,
1572 # we can continue sending input if we retry.
1573 if self.stdin and self._input is None:
1574 self._input_offset = 0
1575 self._input = input
1576 if self.universal_newlines:
1577 self._input = self._input.encode(self.stdin.encoding)
1578
1579 while self._fd2file:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001580 timeout = self._remaining_time(endtime)
1581 if timeout is not None and timeout < 0:
1582 raise TimeoutExpired(self.args, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001583 try:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001584 ready = poller.poll(timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001585 except select.error as e:
1586 if e.args[0] == errno.EINTR:
1587 continue
1588 raise
Reid Kleckner2b228f02011-03-16 16:57:54 -04001589 self._check_timeout(endtime, orig_timeout)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001590
1591 # XXX Rewrite these to use non-blocking I/O on the
1592 # file objects; they are no longer using C stdio!
1593
1594 for fd, mode in ready:
1595 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001596 chunk = self._input[self._input_offset :
1597 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001598 try:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001599 self._input_offset += os.write(fd, chunk)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001600 except OSError as e:
1601 if e.errno == errno.EPIPE:
1602 close_unregister_and_remove(fd)
1603 else:
1604 raise
1605 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001606 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001607 close_unregister_and_remove(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001608 elif mode & select_POLLIN_POLLPRI:
1609 data = os.read(fd, 4096)
1610 if not data:
1611 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001612 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001613 else:
1614 # Ignore hang up or errors.
1615 close_unregister_and_remove(fd)
1616
1617 return (stdout, stderr)
1618
1619
Reid Kleckner2b228f02011-03-16 16:57:54 -04001620 def _communicate_with_select(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001621 if not self._communication_started:
1622 self._read_set = []
1623 self._write_set = []
1624 if self.stdin and input:
1625 self._write_set.append(self.stdin)
1626 if self.stdout:
1627 self._read_set.append(self.stdout)
1628 if self.stderr:
1629 self._read_set.append(self.stderr)
1630
1631 if self.stdin and self._input is None:
1632 self._input_offset = 0
1633 self._input = input
1634 if self.universal_newlines:
1635 self._input = self._input.encode(self.stdin.encoding)
1636
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001637 stdout = None # Return
1638 stderr = None # Return
1639
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001640 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001641 if not self._communication_started:
1642 self._stdout_buff = []
1643 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001644 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001645 if not self._communication_started:
1646 self._stderr_buff = []
1647 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001648
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001649 while self._read_set or self._write_set:
Victor Stinner7a8d0812011-04-05 13:13:08 +02001650 timeout = self._remaining_time(endtime)
1651 if timeout is not None and timeout < 0:
1652 raise TimeoutExpired(self.args, orig_timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001653 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001654 (rlist, wlist, xlist) = \
1655 select.select(self._read_set, self._write_set, [],
Victor Stinner7a8d0812011-04-05 13:13:08 +02001656 timeout)
Georg Brandl86b2fb92008-07-16 03:43:04 +00001657 except select.error as e:
1658 if e.args[0] == errno.EINTR:
1659 continue
1660 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001661
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001662 # According to the docs, returning three empty lists indicates
1663 # that the timeout expired.
1664 if not (rlist or wlist or xlist):
Reid Kleckner2b228f02011-03-16 16:57:54 -04001665 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001666 # We also check what time it is ourselves for good measure.
Reid Kleckner2b228f02011-03-16 16:57:54 -04001667 self._check_timeout(endtime, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001668
Guido van Rossum98297ee2007-11-06 21:34:58 +00001669 # XXX Rewrite these to use non-blocking I/O on the
1670 # file objects; they are no longer using C stdio!
1671
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001672 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001673 chunk = self._input[self._input_offset :
1674 self._input_offset + _PIPE_BUF]
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001675 try:
1676 bytes_written = os.write(self.stdin.fileno(), chunk)
1677 except OSError as e:
1678 if e.errno == errno.EPIPE:
1679 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001680 self._write_set.remove(self.stdin)
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001681 else:
1682 raise
1683 else:
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001684 self._input_offset += bytes_written
1685 if self._input_offset >= len(self._input):
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001686 self.stdin.close()
Ross Lagerwall0b9ea932011-04-05 16:07:49 +02001687 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001688
1689 if self.stdout in rlist:
1690 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001691 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001692 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001693 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001694 stdout.append(data)
1695
1696 if self.stderr in rlist:
1697 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001698 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001699 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001700 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001701 stderr.append(data)
1702
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001703 return (stdout, stderr)
1704
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001705
Christian Heimesa342c012008-04-20 21:01:16 +00001706 def send_signal(self, sig):
1707 """Send a signal to the process
1708 """
1709 os.kill(self.pid, sig)
1710
1711 def terminate(self):
1712 """Terminate the process with SIGTERM
1713 """
1714 self.send_signal(signal.SIGTERM)
1715
1716 def kill(self):
1717 """Kill the process with SIGKILL
1718 """
1719 self.send_signal(signal.SIGKILL)