blob: bc0ef0b4bea147cdd1ac2d4dfb771dea77031488 [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
Benjamin Peterson5eea8a72014-03-12 21:41:35 -050014intends to replace several older modules and functions:
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
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070028class Popen(args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000029 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
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070059bufsize will be supplied as the corresponding argument to the io.open()
60function when creating the stdin/stdout/stderr pipe file objects:
610 means unbuffered (read & write are one system call and can return short),
621 means line buffered, any other positive value means use a buffer of
63approximately that size. A negative bufsize, the default, means the system
64default of io.DEFAULT_BUFFER_SIZE will be used.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000065
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
Ronald Oussoren385521c2013-07-07 09:26:45 +0200107If universal_newlines is false, the file objects stdin, stdout and stderr
108are opened as binary files, and no line ending conversion is done.
109
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110If universal_newlines is true, the file objects stdout and stderr are
111opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000112the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000113'\r\n', the Windows convention. All of these external representations
Gregory P. Smith1f8a40b2013-03-20 18:32:03 -0700114are seen as '\n' by the Python program. Also, the newlines attribute
115of the file objects stdout, stdin and stderr are not updated by the
116communicate() method.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000117
118The startupinfo and creationflags, if given, will be passed to the
119underlying CreateProcess() function. They can specify things such as
120appearance of the main window and priority for the new process.
121(Windows only)
122
123
Georg Brandlf9734072008-12-07 15:30:06 +0000124This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125
Peter Astrand5f5e1412004-12-05 20:15:36 +0000126call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000127 Run command with arguments. Wait for command to complete, then
128 return the returncode attribute.
129
130 The arguments are the same as for the Popen constructor. Example:
131
Florent Xicluna4886d242010-03-08 13:27:26 +0000132 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000133
Peter Astrand454f7672005-01-01 09:36:35 +0000134check_call(*popenargs, **kwargs):
135 Run command with arguments. Wait for command to complete. If the
136 exit code was zero then return, otherwise raise
137 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000138 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000139
140 The arguments are the same as for the Popen constructor. Example:
141
Florent Xicluna4886d242010-03-08 13:27:26 +0000142 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000143 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000144
Brett Cannona23810f2008-05-26 19:04:21 +0000145getstatusoutput(cmd):
146 Return (status, output) of executing cmd in a shell.
147
Tim Golden60798142013-11-05 12:57:25 +0000148 Execute the string 'cmd' in a shell with 'check_output' and
149 return a 2-tuple (status, output). Universal newlines mode is used,
150 meaning that the result with be decoded to a string.
151
152 A trailing newline is stripped from the output.
153 The exit status for the command can be interpreted
154 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000155
Brett Cannona23810f2008-05-26 19:04:21 +0000156 >>> subprocess.getstatusoutput('ls /bin/ls')
157 (0, '/bin/ls')
158 >>> subprocess.getstatusoutput('cat /bin/junk')
159 (256, 'cat: /bin/junk: No such file or directory')
160 >>> subprocess.getstatusoutput('/bin/junk')
161 (256, 'sh: /bin/junk: not found')
162
163getoutput(cmd):
164 Return output (stdout or stderr) of executing cmd in a shell.
165
166 Like getstatusoutput(), except the exit status is ignored and the return
167 value is a string containing the command's output. Example:
168
Brett Cannona23810f2008-05-26 19:04:21 +0000169 >>> subprocess.getoutput('ls /bin/ls')
170 '/bin/ls'
171
Georg Brandlf9734072008-12-07 15:30:06 +0000172check_output(*popenargs, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700173 Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000174
Georg Brandl2708f3a2009-12-20 14:38:23 +0000175 If the exit code was non-zero it raises a CalledProcessError. The
176 CalledProcessError object will have the return code in the returncode
177 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Georg Brandl2708f3a2009-12-20 14:38:23 +0000179 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000180
Georg Brandl2708f3a2009-12-20 14:38:23 +0000181 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000182
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300183 There is an additional optional argument, "input", allowing you to
184 pass a string to the subprocess's stdin. If you use this argument
185 you may not also use the Popen constructor's "stdin" argument.
Brett Cannona23810f2008-05-26 19:04:21 +0000186
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000187Exceptions
188----------
189Exceptions raised in the child process, before the new program has
190started to execute, will be re-raised in the parent. Additionally,
191the exception object will have one extra attribute called
192'child_traceback', which is a string containing traceback information
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300193from the child's point of view.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000194
195The most common exception raised is OSError. This occurs, for
196example, when trying to execute a non-existent file. Applications
197should prepare for OSErrors.
198
199A ValueError will be raised if Popen is called with invalid arguments.
200
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400201Exceptions defined within this module inherit from SubprocessError.
202check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400203called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400204be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000205
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000206
207Security
208--------
209Unlike some other popen functions, this implementation will never call
210/bin/sh implicitly. This means that all characters, including shell
211metacharacters, can safely be passed to child processes.
212
213
214Popen objects
215=============
216Instances of the Popen class have the following methods:
217
218poll()
219 Check if child process has terminated. Returns returncode
220 attribute.
221
222wait()
223 Wait for child process to terminate. Returns returncode attribute.
224
225communicate(input=None)
226 Interact with process: Send data to stdin. Read data from stdout
227 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000228 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000229 sent to the child process, or None, if no data should be sent to
230 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000231
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000232 communicate() returns a tuple (stdout, stderr).
233
234 Note: The data read is buffered in memory, so do not use this
235 method if the data size is large or unlimited.
236
237The following attributes are also available:
238
239stdin
240 If the stdin argument is PIPE, this attribute is a file object
241 that provides input to the child process. Otherwise, it is None.
242
243stdout
244 If the stdout argument is PIPE, this attribute is a file object
245 that provides output from the child process. Otherwise, it is
246 None.
247
248stderr
249 If the stderr argument is PIPE, this attribute is file object that
250 provides error output from the child process. Otherwise, it is
251 None.
252
253pid
254 The process ID of the child process.
255
256returncode
257 The child return code. A None value indicates that the process
258 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000259 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000260
261
262Replacing older functions with the subprocess module
263====================================================
264In this section, "a ==> b" means that b can be used as a replacement
265for a.
266
267Note: All functions in this section fail (more or less) silently if
268the executed program cannot be found; this module raises an OSError
269exception.
270
271In the following examples, we assume that the subprocess module is
272imported with "from subprocess import *".
273
274
275Replacing /bin/sh shell backquote
276---------------------------------
277output=`mycmd myarg`
278==>
279output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
280
281
282Replacing shell pipe line
283-------------------------
284output=`dmesg | grep hda`
285==>
286p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000287p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000288output = p2.communicate()[0]
289
290
291Replacing os.system()
292---------------------
293sts = os.system("mycmd" + " myarg")
294==>
295p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000296pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000297
298Note:
299
300* Calling the program through the shell is usually not required.
301
302* It's easier to look at the returncode attribute than the
303 exitstatus.
304
305A more real-world example would look like this:
306
307try:
308 retcode = call("mycmd" + " myarg", shell=True)
309 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000310 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000311 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000312 print("Child returned", retcode, file=sys.stderr)
313except OSError as e:
314 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000315
316
317Replacing os.spawn*
318-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000319P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000320
321pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
322==>
323pid = Popen(["/bin/mycmd", "myarg"]).pid
324
325
326P_WAIT example:
327
328retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
329==>
330retcode = call(["/bin/mycmd", "myarg"])
331
332
Tim Peterse718f612004-10-12 21:51:32 +0000333Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000334
335os.spawnvp(os.P_NOWAIT, path, args)
336==>
337Popen([path] + args[1:])
338
339
Tim Peterse718f612004-10-12 21:51:32 +0000340Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000341
342os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
343==>
344Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000345"""
346
347import sys
348mswindows = (sys.platform == "win32")
349
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000350import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000351import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400352import time
Christian Heimesa342c012008-04-20 21:01:16 +0000353import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000354import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000355import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200356import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200357try:
358 from time import monotonic as _time
Brett Cannoncd171c82013-07-04 17:43:24 -0400359except ImportError:
Victor Stinner949d8c92012-05-30 13:30:32 +0200360 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000361
Peter Astrand454f7672005-01-01 09:36:35 +0000362# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400363class SubprocessError(Exception): pass
364
365
366class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000367 """This exception is raised when a process run by check_call() or
368 check_output() returns a non-zero exit status.
369 The exit status will be stored in the returncode attribute;
370 check_output() will also store the output in the output attribute.
371 """
372 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000373 self.returncode = returncode
374 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000375 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000376 def __str__(self):
377 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
378
Peter Astrand454f7672005-01-01 09:36:35 +0000379
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400380class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400381 """This exception is raised when the timeout expires while waiting for a
382 child process.
383 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400384 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400385 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400386 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400387 self.output = output
388
389 def __str__(self):
390 return ("Command '%s' timed out after %s seconds" %
391 (self.cmd, self.timeout))
392
393
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000394if mswindows:
395 import threading
396 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200397 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000398 class STARTUPINFO:
399 dwFlags = 0
400 hStdInput = None
401 hStdOutput = None
402 hStdError = None
403 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000404else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700405 import _posixsubprocess
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100406 import select
407 import selectors
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700408 try:
409 import threading
410 except ImportError:
411 import dummy_threading as threading
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000412
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000413 # When select or poll has indicated that the file is writable,
414 # we can write up to _PIPE_BUF bytes without risk of blocking.
415 # POSIX defines PIPE_BUF as >= 512.
416 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
417
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100418 # poll/select have the advantage of not requiring any extra file
419 # descriptor, contrarily to epoll/kqueue (also, they require a single
420 # syscall).
421 if hasattr(selectors, 'PollSelector'):
422 _PopenSelector = selectors.PollSelector
423 else:
424 _PopenSelector = selectors.SelectSelector
425
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000426
Brett Cannona23810f2008-05-26 19:04:21 +0000427__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200428 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000429
Brian Curtin1ce6b582010-04-24 16:19:22 +0000430if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200431 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
432 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
433 STD_ERROR_HANDLE, SW_HIDE,
434 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500435
Brian Curtin08fd8d92011-04-29 16:11:30 -0500436 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500437 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
438 "STD_ERROR_HANDLE", "SW_HIDE",
439 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200440
441 class Handle(int):
442 closed = False
443
444 def Close(self, CloseHandle=_winapi.CloseHandle):
445 if not self.closed:
446 self.closed = True
447 CloseHandle(self)
448
449 def Detach(self):
450 if not self.closed:
451 self.closed = True
452 return int(self)
453 raise ValueError("already closed")
454
455 def __repr__(self):
456 return "Handle(%d)" % int(self)
457
458 __del__ = Close
459 __str__ = __repr__
460
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000461try:
462 MAXFD = os.sysconf("SC_OPEN_MAX")
463except:
464 MAXFD = 256
465
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200466# This lists holds Popen instances for which the underlying process had not
467# exited at the time its __del__ method got called: those processes are wait()ed
468# for synchronously from _cleanup() when a new Popen object is created, to avoid
469# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000470_active = []
471
472def _cleanup():
473 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000474 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200475 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000476 try:
477 _active.remove(inst)
478 except ValueError:
479 # This can happen if two threads create a new Popen instance.
480 # It's harmless that it was already removed, so ignore.
481 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000482
483PIPE = -1
484STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200485DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000486
487
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000488def _eintr_retry_call(func, *args):
489 while True:
490 try:
491 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200492 except InterruptedError:
493 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000494
495
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200496# XXX This function is only used by multiprocessing and the test suite,
497# but it's here so that it can be imported when Python is compiled without
498# threads.
499
500def _args_from_interpreter_flags():
501 """Return a list of command-line arguments reproducing the current
502 settings in sys.flags and sys.warnoptions."""
503 flag_opt_map = {
504 'debug': 'd',
505 # 'inspect': 'i',
506 # 'interactive': 'i',
507 'optimize': 'O',
508 'dont_write_bytecode': 'B',
509 'no_user_site': 's',
510 'no_site': 'S',
511 'ignore_environment': 'E',
512 'verbose': 'v',
513 'bytes_warning': 'b',
514 'quiet': 'q',
515 'hash_randomization': 'R',
516 }
517 args = []
518 for flag, opt in flag_opt_map.items():
519 v = getattr(sys.flags, flag)
520 if v > 0:
Nick Coghlanac1a2482013-10-18 22:39:50 +1000521 if flag == 'hash_randomization':
522 v = 1 # Handle specification of an exact seed
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200523 args.append('-' + opt * v)
524 for opt in sys.warnoptions:
525 args.append('-W' + opt)
526 return args
527
528
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400529def call(*popenargs, timeout=None, **kwargs):
530 """Run command with arguments. Wait for command to complete or
531 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000532
533 The arguments are the same as for the Popen constructor. Example:
534
535 retcode = call(["ls", "-l"])
536 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200537 with Popen(*popenargs, **kwargs) as p:
538 try:
539 return p.wait(timeout=timeout)
540 except:
541 p.kill()
542 p.wait()
543 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000544
545
Peter Astrand454f7672005-01-01 09:36:35 +0000546def check_call(*popenargs, **kwargs):
547 """Run command with arguments. Wait for command to complete. If
548 the exit code was zero then return, otherwise raise
549 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000550 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000551
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400552 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000553
554 check_call(["ls", "-l"])
555 """
556 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000557 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000558 cmd = kwargs.get("args")
559 if cmd is None:
560 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000561 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000562 return 0
563
564
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400565def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700566 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000567
568 If the exit code was non-zero it raises a CalledProcessError. The
569 CalledProcessError object will have the return code in the returncode
570 attribute and output in the output attribute.
571
572 The arguments are the same as for the Popen constructor. Example:
573
574 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000575 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000576
577 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000578 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000579
580 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000581 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000582 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000583 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700584
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300585 There is an additional optional argument, "input", allowing you to
586 pass a string to the subprocess's stdin. If you use this argument
587 you may not also use the Popen constructor's "stdin" argument, as
588 it too will be used internally. Example:
589
590 >>> check_output(["sed", "-e", "s/foo/bar/"],
591 ... input=b"when in the course of fooman events\n")
592 b'when in the course of barman events\n'
593
Gregory P. Smith91110f52013-03-19 23:25:16 -0700594 If universal_newlines=True is passed, the return value will be a
595 string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000596 """
597 if 'stdout' in kwargs:
598 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300599 if 'input' in kwargs:
600 if 'stdin' in kwargs:
601 raise ValueError('stdin and input arguments may not both be used.')
602 inputdata = kwargs['input']
603 del kwargs['input']
604 kwargs['stdin'] = PIPE
605 else:
606 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200607 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
608 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300609 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200610 except TimeoutExpired:
611 process.kill()
612 output, unused_err = process.communicate()
613 raise TimeoutExpired(process.args, timeout, output=output)
614 except:
615 process.kill()
616 process.wait()
617 raise
618 retcode = process.poll()
619 if retcode:
620 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000621 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000622
623
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000624def list2cmdline(seq):
625 """
626 Translate a sequence of arguments into a command line
627 string, using the same rules as the MS C runtime:
628
629 1) Arguments are delimited by white space, which is either a
630 space or a tab.
631
632 2) A string surrounded by double quotation marks is
633 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000634 contained within. A quoted string can be embedded in an
635 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000636
637 3) A double quotation mark preceded by a backslash is
638 interpreted as a literal double quotation mark.
639
640 4) Backslashes are interpreted literally, unless they
641 immediately precede a double quotation mark.
642
643 5) If backslashes immediately precede a double quotation mark,
644 every pair of backslashes is interpreted as a literal
645 backslash. If the number of backslashes is odd, the last
646 backslash escapes the next double quotation mark as
647 described in rule 3.
648 """
649
650 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000651 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
652 # or search http://msdn.microsoft.com for
653 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000654 result = []
655 needquote = False
656 for arg in seq:
657 bs_buf = []
658
659 # Add a space to separate this argument from the others
660 if result:
661 result.append(' ')
662
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000663 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000664 if needquote:
665 result.append('"')
666
667 for c in arg:
668 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000669 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000670 bs_buf.append(c)
671 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000672 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000673 result.append('\\' * len(bs_buf)*2)
674 bs_buf = []
675 result.append('\\"')
676 else:
677 # Normal char
678 if bs_buf:
679 result.extend(bs_buf)
680 bs_buf = []
681 result.append(c)
682
Christian Heimesfdab48e2008-01-20 09:06:41 +0000683 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000684 if bs_buf:
685 result.extend(bs_buf)
686
687 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000688 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000689 result.append('"')
690
691 return ''.join(result)
692
693
Brett Cannona23810f2008-05-26 19:04:21 +0000694# Various tools for executing commands and looking at their output and status.
695#
Brett Cannona23810f2008-05-26 19:04:21 +0000696
697def getstatusoutput(cmd):
Tim Golden60798142013-11-05 12:57:25 +0000698 """ Return (status, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000699
Tim Golden60798142013-11-05 12:57:25 +0000700 Execute the string 'cmd' in a shell with 'check_output' and
701 return a 2-tuple (status, output). Universal newlines mode is used,
702 meaning that the result with be decoded to a string.
703
704 A trailing newline is stripped from the output.
705 The exit status for the command can be interpreted
706 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000707
708 >>> import subprocess
709 >>> subprocess.getstatusoutput('ls /bin/ls')
710 (0, '/bin/ls')
711 >>> subprocess.getstatusoutput('cat /bin/junk')
712 (256, 'cat: /bin/junk: No such file or directory')
713 >>> subprocess.getstatusoutput('/bin/junk')
714 (256, 'sh: /bin/junk: not found')
715 """
Tim Goldene0041752013-11-03 12:53:17 +0000716 try:
717 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
718 status = 0
719 except CalledProcessError as ex:
720 data = ex.output
721 status = ex.returncode
722 if data[-1:] == '\n':
723 data = data[:-1]
724 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000725
726def getoutput(cmd):
727 """Return output (stdout or stderr) of executing cmd in a shell.
728
729 Like getstatusoutput(), except the exit status is ignored and the return
730 value is a string containing the command's output. Example:
731
732 >>> import subprocess
733 >>> subprocess.getoutput('ls /bin/ls')
734 '/bin/ls'
735 """
736 return getstatusoutput(cmd)[1]
737
738
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000739_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000740
741
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000742class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200743
744 _child_created = False # Set here since __del__ checks it
745
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700746 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000747 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000748 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
749 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000750 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000751 restore_signals=True, start_new_session=False,
752 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000753 """Create new Popen instance."""
754 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700755 # Held while anything is calling waitpid before returncode has been
756 # updated to prevent clobbering returncode if wait() or poll() are
757 # called from multiple threads at once. After acquiring the lock,
758 # code must re-check self.returncode to see if another thread just
759 # finished a waitpid() call.
760 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000761
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400762 self._input = None
763 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000764 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700765 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000766 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000767 raise TypeError("bufsize must be an integer")
768
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000769 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000770 if preexec_fn is not None:
771 raise ValueError("preexec_fn is not supported on Windows "
772 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000773 any_stdio_set = (stdin is not None or stdout is not None or
774 stderr is not None)
775 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
776 if any_stdio_set:
777 close_fds = False
778 else:
779 close_fds = True
780 elif close_fds and any_stdio_set:
781 raise ValueError(
782 "close_fds is not supported on Windows platforms"
783 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000784 else:
785 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000786 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
787 close_fds = True
788 if pass_fds and not close_fds:
789 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
790 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000791 if startupinfo is not None:
792 raise ValueError("startupinfo is only supported on Windows "
793 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000794 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000795 raise ValueError("creationflags is only supported on Windows "
796 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000797
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400798 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000799 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000800 self.stdout = None
801 self.stderr = None
802 self.pid = None
803 self.returncode = None
804 self.universal_newlines = universal_newlines
805
806 # Input and output objects. The general principle is like
807 # this:
808 #
809 # Parent Child
810 # ------ -----
811 # p2cwrite ---stdin---> p2cread
812 # c2pread <--stdout--- c2pwrite
813 # errread <--stderr--- errwrite
814 #
815 # On POSIX, the child objects are file descriptors. On
816 # Windows, these are Windows file handles. The parent objects
817 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000818 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000819 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000820
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000821 (p2cread, p2cwrite,
822 c2pread, c2pwrite,
823 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
824
Antoine Pitrouc9982322011-01-04 19:07:07 +0000825 # We wrap OS handles *before* launching the child, otherwise a
826 # quickly terminating child could make our fds unwrappable
827 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000828
Thomas Wouterscf297e42007-02-23 15:07:44 +0000829 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000830 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000831 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000832 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000833 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000834 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000835 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000836
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000837 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000838 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300839 if universal_newlines:
Antoine Pitrouafe8d062014-09-21 21:10:56 +0200840 self.stdin = io.TextIOWrapper(self.stdin, write_through=True,
841 line_buffering=(bufsize == 1))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000842 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000843 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000844 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000845 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000846 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000847 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000848 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000849 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000850
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700851 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000852 try:
853 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300854 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000855 startupinfo, creationflags, shell,
856 p2cread, p2cwrite,
857 c2pread, c2pwrite,
858 errread, errwrite,
859 restore_signals, start_new_session)
860 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800861 # Cleanup if the child failed starting.
862 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000863 try:
864 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200865 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800866 pass # Ignore EBADF or other errors.
867
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700868 if not self._closed_child_pipe_fds:
869 to_close = []
870 if stdin == PIPE:
871 to_close.append(p2cread)
872 if stdout == PIPE:
873 to_close.append(c2pwrite)
874 if stderr == PIPE:
875 to_close.append(errwrite)
876 if hasattr(self, '_devnull'):
877 to_close.append(self._devnull)
878 for fd in to_close:
879 try:
880 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700881 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700882 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800883
Antoine Pitrouc9982322011-01-04 19:07:07 +0000884 raise
885
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000886
Guido van Rossum98297ee2007-11-06 21:34:58 +0000887 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300888 data = data.decode(encoding)
889 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000890
Brian Curtin79cdb662010-12-03 02:46:02 +0000891 def __enter__(self):
892 return self
893
894 def __exit__(self, type, value, traceback):
895 if self.stdout:
896 self.stdout.close()
897 if self.stderr:
898 self.stderr.close()
899 if self.stdin:
900 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700901 # Wait for the process to terminate, to avoid zombies.
902 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000903
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200904 def __del__(self, _maxsize=sys.maxsize):
905 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000906 # We didn't get to successfully create a child process.
907 return
908 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000909 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000910 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000911 # Child is still running, keep us alive until we can wait on it.
912 _active.append(self)
913
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200914 def _get_devnull(self):
915 if not hasattr(self, '_devnull'):
916 self._devnull = os.open(os.devnull, os.O_RDWR)
917 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000918
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400919 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000920 """Interact with process: Send data to stdin. Read data from
921 stdout and stderr, until end-of-file is reached. Wait for
Gregory P. Smitha454ef62011-05-22 22:29:49 -0700922 process to terminate. The optional input argument should be
923 bytes to be sent to the child process, or None, if no data
Peter Astrand23109f02005-03-03 20:28:59 +0000924 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000925
Peter Astrand23109f02005-03-03 20:28:59 +0000926 communicate() returns a tuple (stdout, stderr)."""
927
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400928 if self._communication_started and input:
929 raise ValueError("Cannot send input after starting communication")
930
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400931 # Optimization: If we are not worried about timeouts, we haven't
932 # started communicating, and we have one or zero pipes, using select()
933 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200934 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400935 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000936 stdout = None
937 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000938 if self.stdin:
939 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200940 try:
941 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200942 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200943 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
944 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000945 self.stdin.close()
946 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200947 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000948 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000949 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200950 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000951 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000952 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200953 else:
954 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200955 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200956 else:
957 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000958
Victor Stinner7a8d0812011-04-05 13:13:08 +0200959 try:
960 stdout, stderr = self._communicate(input, endtime, timeout)
961 finally:
962 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400963
Victor Stinner7a8d0812011-04-05 13:13:08 +0200964 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400965
966 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000967
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000968
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000969 def poll(self):
970 return self._internal_poll()
971
972
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400973 def _remaining_time(self, endtime):
974 """Convenience for _communicate when computing timeouts."""
975 if endtime is None:
976 return None
977 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200978 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400979
980
Reid Kleckner2b228f02011-03-16 16:57:54 -0400981 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400982 """Convenience for checking if a timeout has expired."""
983 if endtime is None:
984 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200985 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400986 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400987
988
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000989 if mswindows:
990 #
991 # Windows methods
992 #
993 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000994 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000995 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
996 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000997 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000998 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000999
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001000 p2cread, p2cwrite = -1, -1
1001 c2pread, c2pwrite = -1, -1
1002 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001003
Peter Astrandd38ddf42005-02-10 08:32:50 +00001004 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001005 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001006 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001007 p2cread, _ = _winapi.CreatePipe(None, 0)
1008 p2cread = Handle(p2cread)
1009 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001010 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001011 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1012 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001013 elif stdin == DEVNULL:
1014 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001015 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001016 p2cread = msvcrt.get_osfhandle(stdin)
1017 else:
1018 # Assuming file-like object
1019 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1020 p2cread = self._make_inheritable(p2cread)
1021
Peter Astrandd38ddf42005-02-10 08:32:50 +00001022 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001023 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001024 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001025 _, c2pwrite = _winapi.CreatePipe(None, 0)
1026 c2pwrite = Handle(c2pwrite)
1027 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001028 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001029 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1030 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001031 elif stdout == DEVNULL:
1032 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001033 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001034 c2pwrite = msvcrt.get_osfhandle(stdout)
1035 else:
1036 # Assuming file-like object
1037 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1038 c2pwrite = self._make_inheritable(c2pwrite)
1039
Peter Astrandd38ddf42005-02-10 08:32:50 +00001040 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001041 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001042 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001043 _, errwrite = _winapi.CreatePipe(None, 0)
1044 errwrite = Handle(errwrite)
1045 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001046 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001047 errread, errwrite = _winapi.CreatePipe(None, 0)
1048 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001049 elif stderr == STDOUT:
1050 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001051 elif stderr == DEVNULL:
1052 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001053 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001054 errwrite = msvcrt.get_osfhandle(stderr)
1055 else:
1056 # Assuming file-like object
1057 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1058 errwrite = self._make_inheritable(errwrite)
1059
1060 return (p2cread, p2cwrite,
1061 c2pread, c2pwrite,
1062 errread, errwrite)
1063
1064
1065 def _make_inheritable(self, handle):
1066 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001067 h = _winapi.DuplicateHandle(
1068 _winapi.GetCurrentProcess(), handle,
1069 _winapi.GetCurrentProcess(), 0, 1,
1070 _winapi.DUPLICATE_SAME_ACCESS)
1071 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001072
1073
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001074 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001075 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001076 startupinfo, creationflags, shell,
1077 p2cread, p2cwrite,
1078 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001079 errread, errwrite,
1080 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001081 """Execute program (MS Windows version)"""
1082
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001083 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001084
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001085 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001086 args = list2cmdline(args)
1087
Peter Astrandc1d65362004-11-07 14:30:34 +00001088 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001089 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001090 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001091 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001092 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001093 startupinfo.hStdInput = p2cread
1094 startupinfo.hStdOutput = c2pwrite
1095 startupinfo.hStdError = errwrite
1096
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001097 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001098 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1099 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001100 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001101 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001102
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001103 # Start the process
1104 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001105 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001106 # no special security
1107 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001108 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001109 creationflags,
1110 env,
1111 cwd,
1112 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001113 finally:
1114 # Child is launched. Close the parent's copy of those pipe
1115 # handles that only the child should have open. You need
1116 # to make sure that no handles to the write end of the
1117 # output pipe are maintained in this process or else the
1118 # pipe will not close when the child process exits and the
1119 # ReadFile will hang.
1120 if p2cread != -1:
1121 p2cread.Close()
1122 if c2pwrite != -1:
1123 c2pwrite.Close()
1124 if errwrite != -1:
1125 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001126 if hasattr(self, '_devnull'):
1127 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001128
1129 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001130 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001131 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001132 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001133 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001134
Brett Cannon84df1e62010-05-14 00:33:40 +00001135 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001136 _WaitForSingleObject=_winapi.WaitForSingleObject,
1137 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1138 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001139 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001140 attribute.
1141
1142 This method is called by __del__, so it can only refer to objects
1143 in its local scope.
1144
1145 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001146 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001147 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1148 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001149 return self.returncode
1150
1151
Reid Kleckner2b228f02011-03-16 16:57:54 -04001152 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001153 """Wait for child process to terminate. Returns returncode
1154 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001155 if endtime is not None:
1156 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001157 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001158 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001159 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001160 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001161 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001162 result = _winapi.WaitForSingleObject(self._handle,
1163 timeout_millis)
1164 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001165 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001166 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001167 return self.returncode
1168
1169
1170 def _readerthread(self, fh, buffer):
1171 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001172 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001173
1174
Reid Kleckner2b228f02011-03-16 16:57:54 -04001175 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001176 # Start reader threads feeding into a list hanging off of this
1177 # object, unless they've already been started.
1178 if self.stdout and not hasattr(self, "_stdout_buff"):
1179 self._stdout_buff = []
1180 self.stdout_thread = \
1181 threading.Thread(target=self._readerthread,
1182 args=(self.stdout, self._stdout_buff))
1183 self.stdout_thread.daemon = True
1184 self.stdout_thread.start()
1185 if self.stderr and not hasattr(self, "_stderr_buff"):
1186 self._stderr_buff = []
1187 self.stderr_thread = \
1188 threading.Thread(target=self._readerthread,
1189 args=(self.stderr, self._stderr_buff))
1190 self.stderr_thread.daemon = True
1191 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001192
1193 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001194 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001195 try:
1196 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001197 except OSError as e:
Victor Stinnerd5c8ce72014-02-18 22:00:53 +01001198 if e.errno == errno.EPIPE:
Victor Stinner5f47ac22014-02-18 22:06:35 +01001199 # communicate() should ignore pipe full error
Victor Stinnerd5c8ce72014-02-18 22:00:53 +01001200 pass
1201 elif (e.errno == errno.EINVAL
1202 and self.poll() is not None):
1203 # Issue #19612: stdin.write() fails with EINVAL
1204 # if the process already exited before the write
1205 pass
1206 else:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001207 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208 self.stdin.close()
1209
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001210 # Wait for the reader threads, or time out. If we time out, the
1211 # threads remain reading and the fds left open in case the user
1212 # calls communicate again.
1213 if self.stdout is not None:
1214 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001215 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001216 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001217 if self.stderr is not None:
1218 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001219 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001220 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001221
1222 # Collect the output from and close both pipes, now that we know
1223 # both have been read successfully.
1224 stdout = None
1225 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001226 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001227 stdout = self._stdout_buff
1228 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001229 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001230 stderr = self._stderr_buff
1231 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001232
1233 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001234 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001235 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001236 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237 stderr = stderr[0]
1238
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001239 return (stdout, stderr)
1240
Christian Heimesa342c012008-04-20 21:01:16 +00001241 def send_signal(self, sig):
1242 """Send a signal to the process
1243 """
1244 if sig == signal.SIGTERM:
1245 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001246 elif sig == signal.CTRL_C_EVENT:
1247 os.kill(self.pid, signal.CTRL_C_EVENT)
1248 elif sig == signal.CTRL_BREAK_EVENT:
1249 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001250 else:
Brian Curtin19651362010-09-07 13:24:38 +00001251 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001252
1253 def terminate(self):
1254 """Terminates the process
1255 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001256 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001257 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001258 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001259 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1260 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001261 rc = _winapi.GetExitCodeProcess(self._handle)
1262 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001263 raise
1264 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001265
1266 kill = terminate
1267
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001268 else:
1269 #
1270 # POSIX methods
1271 #
1272 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001273 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001274 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1275 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001276 p2cread, p2cwrite = -1, -1
1277 c2pread, c2pwrite = -1, -1
1278 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001279
Peter Astrandd38ddf42005-02-10 08:32:50 +00001280 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001281 pass
1282 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001283 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001284 elif stdin == DEVNULL:
1285 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001286 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001287 p2cread = stdin
1288 else:
1289 # Assuming file-like object
1290 p2cread = stdin.fileno()
1291
Peter Astrandd38ddf42005-02-10 08:32:50 +00001292 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001293 pass
1294 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001295 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001296 elif stdout == DEVNULL:
1297 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001298 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001299 c2pwrite = stdout
1300 else:
1301 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001302 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303
Peter Astrandd38ddf42005-02-10 08:32:50 +00001304 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001305 pass
1306 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001307 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001308 elif stderr == STDOUT:
1309 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001310 elif stderr == DEVNULL:
1311 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001312 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001313 errwrite = stderr
1314 else:
1315 # Assuming file-like object
1316 errwrite = stderr.fileno()
1317
1318 return (p2cread, p2cwrite,
1319 c2pread, c2pwrite,
1320 errread, errwrite)
1321
1322
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001323 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001324 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001325 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001326 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001327 os.closerange(start_fd, fd)
1328 start_fd = fd + 1
1329 if start_fd <= MAXFD:
1330 os.closerange(start_fd, MAXFD)
1331
1332
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001333 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001334 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001335 startupinfo, creationflags, shell,
1336 p2cread, p2cwrite,
1337 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001338 errread, errwrite,
1339 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001340 """Execute program (POSIX version)"""
1341
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001342 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001344 else:
1345 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001346
1347 if shell:
1348 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001349 if executable:
1350 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001351
Peter Astrandd38ddf42005-02-10 08:32:50 +00001352 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001353 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001354 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001355
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001356 # For transferring possible exec failure from child to parent.
1357 # Data format: "exception name:hex errno:description"
1358 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001359 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001360 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1361 low_fds_to_close = []
1362 while errpipe_write < 3:
1363 low_fds_to_close.append(errpipe_write)
1364 errpipe_write = os.dup(errpipe_write)
1365 for low_fd in low_fds_to_close:
1366 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001367 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001368 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001369 # We must avoid complex work that could involve
1370 # malloc or free in the child process to avoid
1371 # potential deadlocks, thus we do all this here.
1372 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001373
Victor Stinner372b8382011-06-21 17:24:21 +02001374 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001375 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1376 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001377 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001378 env_list = None # Use execv instead of execve.
1379 executable = os.fsencode(executable)
1380 if os.path.dirname(executable):
1381 executable_list = (executable,)
1382 else:
1383 # This matches the behavior of os._execvpe().
1384 executable_list = tuple(
1385 os.path.join(os.fsencode(dir), executable)
1386 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001387 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001388 fds_to_keep.add(errpipe_write)
1389 self.pid = _posixsubprocess.fork_exec(
1390 args, executable_list,
1391 close_fds, sorted(fds_to_keep), cwd, env_list,
1392 p2cread, p2cwrite, c2pread, c2pwrite,
1393 errread, errwrite,
1394 errpipe_read, errpipe_write,
1395 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001396 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001397 finally:
1398 # be sure the FD is closed no matter what
1399 os.close(errpipe_write)
1400
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001401 # self._devnull is not always defined.
1402 devnull_fd = getattr(self, '_devnull', None)
1403 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001404 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001405 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001406 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001407 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001408 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001409 if devnull_fd is not None:
1410 os.close(devnull_fd)
1411 # Prevent a double close of these fds from __init__ on error.
1412 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001413
1414 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001415 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001416 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001417 while True:
1418 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001419 errpipe_data += part
1420 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001421 break
Facundo Batista10706e22009-06-19 20:34:30 +00001422 finally:
1423 # be sure the FD is closed no matter what
1424 os.close(errpipe_read)
1425
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001426 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001427 try:
1428 _eintr_retry_call(os.waitpid, self.pid, 0)
1429 except OSError as e:
1430 if e.errno != errno.ECHILD:
1431 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001432 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001433 exception_name, hex_errno, err_msg = (
1434 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001435 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001436 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001437 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001438 err_msg = (b'Bad exception data from child: ' +
1439 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001440 child_exception_type = getattr(
1441 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001442 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001443 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001444 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001445 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001446 child_exec_never_called = (err_msg == "noexec")
1447 if child_exec_never_called:
1448 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001449 if errno_num != 0:
1450 err_msg = os.strerror(errno_num)
1451 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001452 if child_exec_never_called:
1453 # The error must be from chdir(cwd).
1454 err_msg += ': ' + repr(cwd)
1455 else:
1456 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001457 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001458 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001459
1460
Brett Cannon84df1e62010-05-14 00:33:40 +00001461 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1462 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1463 _WEXITSTATUS=os.WEXITSTATUS):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001464 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001465 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001466 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001467 if _WIFSIGNALED(sts):
1468 self.returncode = -_WTERMSIG(sts)
1469 elif _WIFEXITED(sts):
1470 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001471 else:
1472 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001473 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001474
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001475
Brett Cannon84df1e62010-05-14 00:33:40 +00001476 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001477 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001478 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001479 attribute.
1480
1481 This method is called by __del__, so it cannot reference anything
1482 outside of the local scope (nor can any methods it calls).
1483
1484 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001485 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001486 if not self._waitpid_lock.acquire(False):
1487 # Something else is busy calling waitpid. Don't allow two
1488 # at once. We know nothing yet.
1489 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001490 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001491 if self.returncode is not None:
1492 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001493 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001494 if pid == self.pid:
1495 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001496 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001497 if _deadstate is not None:
1498 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001499 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001500 # This happens if SIGCLD is set to be ignored or
1501 # waiting for child processes has otherwise been
1502 # disabled for our process. This child is dead, we
1503 # can't get the status.
1504 # http://bugs.python.org/issue15756
1505 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001506 finally:
1507 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001508 return self.returncode
1509
1510
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001511 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001512 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001513 try:
1514 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1515 except OSError as e:
1516 if e.errno != errno.ECHILD:
1517 raise
1518 # This happens if SIGCLD is set to be ignored or waiting
1519 # for child processes has otherwise been disabled for our
1520 # process. This child is dead, we can't get the status.
1521 pid = self.pid
1522 sts = 0
1523 return (pid, sts)
1524
1525
1526 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001527 """Wait for child process to terminate. Returns returncode
1528 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001529 if self.returncode is not None:
1530 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001531
1532 # endtime is preferred to timeout. timeout is only used for
1533 # printing.
1534 if endtime is not None or timeout is not None:
1535 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001536 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001537 elif timeout is None:
1538 timeout = self._remaining_time(endtime)
1539
1540 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001541 # Enter a busy loop if we have a timeout. This busy loop was
1542 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1543 delay = 0.0005 # 500 us -> initial delay of 1 ms
1544 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001545 if self._waitpid_lock.acquire(False):
1546 try:
1547 if self.returncode is not None:
1548 break # Another thread waited.
1549 (pid, sts) = self._try_wait(os.WNOHANG)
1550 assert pid == self.pid or pid == 0
1551 if pid == self.pid:
1552 self._handle_exitstatus(sts)
1553 break
1554 finally:
1555 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001556 remaining = self._remaining_time(endtime)
1557 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001558 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001559 delay = min(delay * 2, remaining, .05)
1560 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001561 else:
1562 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001563 with self._waitpid_lock:
1564 if self.returncode is not None:
1565 break # Another thread waited.
1566 (pid, sts) = self._try_wait(0)
1567 # Check the pid and loop as waitpid has been known to
1568 # return 0 even without WNOHANG in odd situations.
1569 # http://bugs.python.org/issue14396.
1570 if pid == self.pid:
1571 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001572 return self.returncode
1573
1574
Reid Kleckner2b228f02011-03-16 16:57:54 -04001575 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001576 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001577 # Flush stdio buffer. This might block, if the user has
1578 # been writing to .stdin in an uncontrolled fashion.
1579 self.stdin.flush()
1580 if not input:
1581 self.stdin.close()
1582
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001583 stdout = None
1584 stderr = None
1585
1586 # Only create this mapping if we haven't already.
1587 if not self._communication_started:
1588 self._fileobj2output = {}
1589 if self.stdout:
1590 self._fileobj2output[self.stdout] = []
1591 if self.stderr:
1592 self._fileobj2output[self.stderr] = []
1593
1594 if self.stdout:
1595 stdout = self._fileobj2output[self.stdout]
1596 if self.stderr:
1597 stderr = self._fileobj2output[self.stderr]
1598
1599 self._save_input(input)
1600
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001601 if self._input:
1602 input_view = memoryview(self._input)
1603
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001604 with _PopenSelector() as selector:
1605 if self.stdin and input:
1606 selector.register(self.stdin, selectors.EVENT_WRITE)
1607 if self.stdout:
1608 selector.register(self.stdout, selectors.EVENT_READ)
1609 if self.stderr:
1610 selector.register(self.stderr, selectors.EVENT_READ)
1611
1612 while selector.get_map():
1613 timeout = self._remaining_time(endtime)
1614 if timeout is not None and timeout < 0:
1615 raise TimeoutExpired(self.args, orig_timeout)
1616
1617 ready = selector.select(timeout)
1618 self._check_timeout(endtime, orig_timeout)
1619
1620 # XXX Rewrite these to use non-blocking I/O on the file
1621 # objects; they are no longer using C stdio!
1622
1623 for key, events in ready:
1624 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001625 chunk = input_view[self._input_offset :
1626 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001627 try:
1628 self._input_offset += os.write(key.fd, chunk)
1629 except OSError as e:
1630 if e.errno == errno.EPIPE:
1631 selector.unregister(key.fileobj)
1632 key.fileobj.close()
1633 else:
1634 raise
1635 else:
1636 if self._input_offset >= len(self._input):
1637 selector.unregister(key.fileobj)
1638 key.fileobj.close()
1639 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08001640 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001641 if not data:
1642 selector.unregister(key.fileobj)
1643 key.fileobj.close()
1644 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001645
1646 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001647
1648 # All data exchanged. Translate lists into strings.
1649 if stdout is not None:
1650 stdout = b''.join(stdout)
1651 if stderr is not None:
1652 stderr = b''.join(stderr)
1653
1654 # Translate newlines, if requested.
1655 # This also turns bytes into strings.
1656 if self.universal_newlines:
1657 if stdout is not None:
1658 stdout = self._translate_newlines(stdout,
1659 self.stdout.encoding)
1660 if stderr is not None:
1661 stderr = self._translate_newlines(stderr,
1662 self.stderr.encoding)
1663
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001664 return (stdout, stderr)
1665
1666
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001667 def _save_input(self, input):
1668 # This method is called from the _communicate_with_*() methods
1669 # so that if we time out while communicating, we can continue
1670 # sending input if we retry.
1671 if self.stdin and self._input is None:
1672 self._input_offset = 0
1673 self._input = input
1674 if self.universal_newlines and input is not None:
1675 self._input = self._input.encode(self.stdin.encoding)
1676
1677
Christian Heimesa342c012008-04-20 21:01:16 +00001678 def send_signal(self, sig):
1679 """Send a signal to the process
1680 """
1681 os.kill(self.pid, sig)
1682
1683 def terminate(self):
1684 """Terminate the process with SIGTERM
1685 """
1686 self.send_signal(signal.SIGTERM)
1687
1688 def kill(self):
1689 """Kill the process with SIGKILL
1690 """
1691 self.send_signal(signal.SIGKILL)