blob: 6dfa40b4b909f37e1f9f5e07cbe084eaee14b92c [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
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400107If universal_newlines is False, the file objects stdin, stdout and stderr
Ronald Oussoren385521c2013-07-07 09:26:45 +0200108are opened as binary files, and no line ending conversion is done.
109
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400110If universal_newlines is True, the file objects stdout and stderr are
111opened as a text file, 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
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400118In either case, the process being communicated with should start up
119expecting to receive bytes on its standard input and decode them with
120the same encoding they are sent in.
121
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000122The startupinfo and creationflags, if given, will be passed to the
123underlying CreateProcess() function. They can specify things such as
124appearance of the main window and priority for the new process.
125(Windows only)
126
127
Georg Brandlf9734072008-12-07 15:30:06 +0000128This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000129
Peter Astrand5f5e1412004-12-05 20:15:36 +0000130call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131 Run command with arguments. Wait for command to complete, then
132 return the returncode attribute.
133
134 The arguments are the same as for the Popen constructor. Example:
135
Florent Xicluna4886d242010-03-08 13:27:26 +0000136 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000137
Peter Astrand454f7672005-01-01 09:36:35 +0000138check_call(*popenargs, **kwargs):
139 Run command with arguments. Wait for command to complete. If the
140 exit code was zero then return, otherwise raise
141 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000142 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000143
144 The arguments are the same as for the Popen constructor. Example:
145
Florent Xicluna4886d242010-03-08 13:27:26 +0000146 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000147 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000148
Brett Cannona23810f2008-05-26 19:04:21 +0000149getstatusoutput(cmd):
150 Return (status, output) of executing cmd in a shell.
151
Tim Golden60798142013-11-05 12:57:25 +0000152 Execute the string 'cmd' in a shell with 'check_output' and
153 return a 2-tuple (status, output). Universal newlines mode is used,
154 meaning that the result with be decoded to a string.
155
156 A trailing newline is stripped from the output.
157 The exit status for the command can be interpreted
158 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000159
Brett Cannona23810f2008-05-26 19:04:21 +0000160 >>> subprocess.getstatusoutput('ls /bin/ls')
161 (0, '/bin/ls')
162 >>> subprocess.getstatusoutput('cat /bin/junk')
163 (256, 'cat: /bin/junk: No such file or directory')
164 >>> subprocess.getstatusoutput('/bin/junk')
165 (256, 'sh: /bin/junk: not found')
166
167getoutput(cmd):
168 Return output (stdout or stderr) of executing cmd in a shell.
169
170 Like getstatusoutput(), except the exit status is ignored and the return
171 value is a string containing the command's output. Example:
172
Brett Cannona23810f2008-05-26 19:04:21 +0000173 >>> subprocess.getoutput('ls /bin/ls')
174 '/bin/ls'
175
Georg Brandlf9734072008-12-07 15:30:06 +0000176check_output(*popenargs, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700177 Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Georg Brandl2708f3a2009-12-20 14:38:23 +0000179 If the exit code was non-zero it raises a CalledProcessError. The
180 CalledProcessError object will have the return code in the returncode
181 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000182
Georg Brandl2708f3a2009-12-20 14:38:23 +0000183 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000184
Georg Brandl2708f3a2009-12-20 14:38:23 +0000185 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000186
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300187 There is an additional optional argument, "input", allowing you to
188 pass a string to the subprocess's stdin. If you use this argument
189 you may not also use the Popen constructor's "stdin" argument.
Brett Cannona23810f2008-05-26 19:04:21 +0000190
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400191 If universal_newlines is set to True, the "input" argument must
192 be a string rather than bytes, and the return value will be a string.
193
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000194Exceptions
195----------
196Exceptions raised in the child process, before the new program has
197started to execute, will be re-raised in the parent. Additionally,
198the exception object will have one extra attribute called
199'child_traceback', which is a string containing traceback information
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300200from the child's point of view.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000201
202The most common exception raised is OSError. This occurs, for
203example, when trying to execute a non-existent file. Applications
204should prepare for OSErrors.
205
206A ValueError will be raised if Popen is called with invalid arguments.
207
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400208Exceptions defined within this module inherit from SubprocessError.
209check_call() and check_output() will raise CalledProcessError if the
Gregory P. Smithb4039aa2011-03-14 14:16:20 -0400210called process returns a non-zero return code. TimeoutExpired
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400211be raised if a timeout was specified and expired.
Peter Astrand454f7672005-01-01 09:36:35 +0000212
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000213
214Security
215--------
216Unlike some other popen functions, this implementation will never call
217/bin/sh implicitly. This means that all characters, including shell
218metacharacters, can safely be passed to child processes.
219
220
221Popen objects
222=============
223Instances of the Popen class have the following methods:
224
225poll()
226 Check if child process has terminated. Returns returncode
227 attribute.
228
229wait()
230 Wait for child process to terminate. Returns returncode attribute.
231
232communicate(input=None)
233 Interact with process: Send data to stdin. Read data from stdout
234 and stderr, until end-of-file is reached. Wait for process to
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400235 terminate. The optional input argument should be data to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000236 sent to the child process, or None, if no data should be sent to
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400237 the child. If the Popen instance was constructed with universal_newlines
238 set to True, the input argument should be a string and will be encoded
239 using the preferred system encoding (see locale.getpreferredencoding);
240 if universal_newlines is False, the input argument should be a
241 byte string.
Tim Peterse718f612004-10-12 21:51:32 +0000242
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000243 communicate() returns a tuple (stdout, stderr).
244
245 Note: The data read is buffered in memory, so do not use this
246 method if the data size is large or unlimited.
247
248The following attributes are also available:
249
250stdin
251 If the stdin argument is PIPE, this attribute is a file object
252 that provides input to the child process. Otherwise, it is None.
253
254stdout
255 If the stdout argument is PIPE, this attribute is a file object
256 that provides output from the child process. Otherwise, it is
257 None.
258
259stderr
260 If the stderr argument is PIPE, this attribute is file object that
261 provides error output from the child process. Otherwise, it is
262 None.
263
264pid
265 The process ID of the child process.
266
267returncode
268 The child return code. A None value indicates that the process
269 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000270 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000271
272
273Replacing older functions with the subprocess module
274====================================================
275In this section, "a ==> b" means that b can be used as a replacement
276for a.
277
278Note: All functions in this section fail (more or less) silently if
279the executed program cannot be found; this module raises an OSError
280exception.
281
282In the following examples, we assume that the subprocess module is
283imported with "from subprocess import *".
284
285
286Replacing /bin/sh shell backquote
287---------------------------------
288output=`mycmd myarg`
289==>
290output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
291
292
293Replacing shell pipe line
294-------------------------
295output=`dmesg | grep hda`
296==>
297p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000298p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000299output = p2.communicate()[0]
300
301
302Replacing os.system()
303---------------------
304sts = os.system("mycmd" + " myarg")
305==>
306p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000307pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000308
309Note:
310
311* Calling the program through the shell is usually not required.
312
313* It's easier to look at the returncode attribute than the
314 exitstatus.
315
316A more real-world example would look like this:
317
318try:
319 retcode = call("mycmd" + " myarg", shell=True)
320 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000321 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000322 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000323 print("Child returned", retcode, file=sys.stderr)
324except OSError as e:
325 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000326
327
328Replacing os.spawn*
329-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000330P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000331
332pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
333==>
334pid = Popen(["/bin/mycmd", "myarg"]).pid
335
336
337P_WAIT example:
338
339retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
340==>
341retcode = call(["/bin/mycmd", "myarg"])
342
343
Tim Peterse718f612004-10-12 21:51:32 +0000344Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000345
346os.spawnvp(os.P_NOWAIT, path, args)
347==>
348Popen([path] + args[1:])
349
350
Tim Peterse718f612004-10-12 21:51:32 +0000351Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000352
353os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
354==>
355Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000356"""
357
358import sys
359mswindows = (sys.platform == "win32")
360
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000361import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000362import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400363import time
Christian Heimesa342c012008-04-20 21:01:16 +0000364import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000365import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000366import warnings
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200367import errno
Victor Stinner949d8c92012-05-30 13:30:32 +0200368try:
369 from time import monotonic as _time
Brett Cannoncd171c82013-07-04 17:43:24 -0400370except ImportError:
Victor Stinner949d8c92012-05-30 13:30:32 +0200371 from time import time as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000372
Peter Astrand454f7672005-01-01 09:36:35 +0000373# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400374class SubprocessError(Exception): pass
375
376
377class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000378 """This exception is raised when a process run by check_call() or
379 check_output() returns a non-zero exit status.
380 The exit status will be stored in the returncode attribute;
381 check_output() will also store the output in the output attribute.
382 """
383 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000384 self.returncode = returncode
385 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000386 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000387 def __str__(self):
388 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
389
Peter Astrand454f7672005-01-01 09:36:35 +0000390
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400391class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400392 """This exception is raised when the timeout expires while waiting for a
393 child process.
394 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400395 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400396 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400397 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400398 self.output = output
399
400 def __str__(self):
401 return ("Command '%s' timed out after %s seconds" %
402 (self.cmd, self.timeout))
403
404
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000405if mswindows:
406 import threading
407 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200408 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000409 class STARTUPINFO:
410 dwFlags = 0
411 hStdInput = None
412 hStdOutput = None
413 hStdError = None
414 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000415else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700416 import _posixsubprocess
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100417 import select
418 import selectors
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700419 try:
420 import threading
421 except ImportError:
422 import dummy_threading as threading
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000423
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000424 # When select or poll has indicated that the file is writable,
425 # we can write up to _PIPE_BUF bytes without risk of blocking.
426 # POSIX defines PIPE_BUF as >= 512.
427 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
428
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100429 # poll/select have the advantage of not requiring any extra file
430 # descriptor, contrarily to epoll/kqueue (also, they require a single
431 # syscall).
432 if hasattr(selectors, 'PollSelector'):
433 _PopenSelector = selectors.PollSelector
434 else:
435 _PopenSelector = selectors.SelectSelector
436
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000437
Brett Cannona23810f2008-05-26 19:04:21 +0000438__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200439 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000440
Brian Curtin1ce6b582010-04-24 16:19:22 +0000441if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200442 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
443 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
444 STD_ERROR_HANDLE, SW_HIDE,
445 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500446
Brian Curtin08fd8d92011-04-29 16:11:30 -0500447 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500448 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
449 "STD_ERROR_HANDLE", "SW_HIDE",
450 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200451
452 class Handle(int):
453 closed = False
454
455 def Close(self, CloseHandle=_winapi.CloseHandle):
456 if not self.closed:
457 self.closed = True
458 CloseHandle(self)
459
460 def Detach(self):
461 if not self.closed:
462 self.closed = True
463 return int(self)
464 raise ValueError("already closed")
465
466 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300467 return "%s(%d)" % (self.__class__.__name__, int(self))
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200468
469 __del__ = Close
470 __str__ = __repr__
471
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000472
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200473# This lists holds Popen instances for which the underlying process had not
474# exited at the time its __del__ method got called: those processes are wait()ed
475# for synchronously from _cleanup() when a new Popen object is created, to avoid
476# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000477_active = []
478
479def _cleanup():
480 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000481 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200482 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000483 try:
484 _active.remove(inst)
485 except ValueError:
486 # This can happen if two threads create a new Popen instance.
487 # It's harmless that it was already removed, so ignore.
488 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000489
490PIPE = -1
491STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200492DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000493
494
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000495def _eintr_retry_call(func, *args):
496 while True:
497 try:
498 return func(*args)
Antoine Pitrou24d659d2011-10-23 23:49:42 +0200499 except InterruptedError:
500 continue
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000501
502
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200503# XXX This function is only used by multiprocessing and the test suite,
504# but it's here so that it can be imported when Python is compiled without
505# threads.
506
507def _args_from_interpreter_flags():
508 """Return a list of command-line arguments reproducing the current
509 settings in sys.flags and sys.warnoptions."""
510 flag_opt_map = {
511 'debug': 'd',
512 # 'inspect': 'i',
513 # 'interactive': 'i',
514 'optimize': 'O',
515 'dont_write_bytecode': 'B',
516 'no_user_site': 's',
517 'no_site': 'S',
518 'ignore_environment': 'E',
519 'verbose': 'v',
520 'bytes_warning': 'b',
521 'quiet': 'q',
522 'hash_randomization': 'R',
523 }
524 args = []
525 for flag, opt in flag_opt_map.items():
526 v = getattr(sys.flags, flag)
527 if v > 0:
Nick Coghlanac1a2482013-10-18 22:39:50 +1000528 if flag == 'hash_randomization':
529 v = 1 # Handle specification of an exact seed
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200530 args.append('-' + opt * v)
531 for opt in sys.warnoptions:
532 args.append('-W' + opt)
533 return args
534
535
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400536def call(*popenargs, timeout=None, **kwargs):
537 """Run command with arguments. Wait for command to complete or
538 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000539
540 The arguments are the same as for the Popen constructor. Example:
541
542 retcode = call(["ls", "-l"])
543 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200544 with Popen(*popenargs, **kwargs) as p:
545 try:
546 return p.wait(timeout=timeout)
547 except:
548 p.kill()
549 p.wait()
550 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000551
552
Peter Astrand454f7672005-01-01 09:36:35 +0000553def check_call(*popenargs, **kwargs):
554 """Run command with arguments. Wait for command to complete. If
555 the exit code was zero then return, otherwise raise
556 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000557 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000558
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400559 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000560
561 check_call(["ls", "-l"])
562 """
563 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000564 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000565 cmd = kwargs.get("args")
566 if cmd is None:
567 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000568 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000569 return 0
570
571
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400572def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700573 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000574
575 If the exit code was non-zero it raises a CalledProcessError. The
576 CalledProcessError object will have the return code in the returncode
577 attribute and output in the output attribute.
578
579 The arguments are the same as for the Popen constructor. Example:
580
581 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000582 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000583
584 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000585 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000586
587 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000588 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000589 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000590 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700591
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300592 There is an additional optional argument, "input", allowing you to
593 pass a string to the subprocess's stdin. If you use this argument
594 you may not also use the Popen constructor's "stdin" argument, as
595 it too will be used internally. Example:
596
597 >>> check_output(["sed", "-e", "s/foo/bar/"],
598 ... input=b"when in the course of fooman events\n")
599 b'when in the course of barman events\n'
600
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400601 If universal_newlines=True is passed, the "input" argument must be a
602 string and the return value will be a string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000603 """
604 if 'stdout' in kwargs:
605 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300606 if 'input' in kwargs:
607 if 'stdin' in kwargs:
608 raise ValueError('stdin and input arguments may not both be used.')
609 inputdata = kwargs['input']
610 del kwargs['input']
611 kwargs['stdin'] = PIPE
612 else:
613 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200614 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
615 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300616 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200617 except TimeoutExpired:
618 process.kill()
619 output, unused_err = process.communicate()
620 raise TimeoutExpired(process.args, timeout, output=output)
621 except:
622 process.kill()
623 process.wait()
624 raise
625 retcode = process.poll()
626 if retcode:
627 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000628 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000629
630
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000631def list2cmdline(seq):
632 """
633 Translate a sequence of arguments into a command line
634 string, using the same rules as the MS C runtime:
635
636 1) Arguments are delimited by white space, which is either a
637 space or a tab.
638
639 2) A string surrounded by double quotation marks is
640 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000641 contained within. A quoted string can be embedded in an
642 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000643
644 3) A double quotation mark preceded by a backslash is
645 interpreted as a literal double quotation mark.
646
647 4) Backslashes are interpreted literally, unless they
648 immediately precede a double quotation mark.
649
650 5) If backslashes immediately precede a double quotation mark,
651 every pair of backslashes is interpreted as a literal
652 backslash. If the number of backslashes is odd, the last
653 backslash escapes the next double quotation mark as
654 described in rule 3.
655 """
656
657 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000658 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
659 # or search http://msdn.microsoft.com for
660 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000661 result = []
662 needquote = False
663 for arg in seq:
664 bs_buf = []
665
666 # Add a space to separate this argument from the others
667 if result:
668 result.append(' ')
669
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000670 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000671 if needquote:
672 result.append('"')
673
674 for c in arg:
675 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000676 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000677 bs_buf.append(c)
678 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000679 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000680 result.append('\\' * len(bs_buf)*2)
681 bs_buf = []
682 result.append('\\"')
683 else:
684 # Normal char
685 if bs_buf:
686 result.extend(bs_buf)
687 bs_buf = []
688 result.append(c)
689
Christian Heimesfdab48e2008-01-20 09:06:41 +0000690 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000691 if bs_buf:
692 result.extend(bs_buf)
693
694 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000695 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000696 result.append('"')
697
698 return ''.join(result)
699
700
Brett Cannona23810f2008-05-26 19:04:21 +0000701# Various tools for executing commands and looking at their output and status.
702#
Brett Cannona23810f2008-05-26 19:04:21 +0000703
704def getstatusoutput(cmd):
Tim Golden60798142013-11-05 12:57:25 +0000705 """ Return (status, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000706
Tim Golden60798142013-11-05 12:57:25 +0000707 Execute the string 'cmd' in a shell with 'check_output' and
708 return a 2-tuple (status, output). Universal newlines mode is used,
709 meaning that the result with be decoded to a string.
710
711 A trailing newline is stripped from the output.
712 The exit status for the command can be interpreted
713 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000714
715 >>> import subprocess
716 >>> subprocess.getstatusoutput('ls /bin/ls')
717 (0, '/bin/ls')
718 >>> subprocess.getstatusoutput('cat /bin/junk')
719 (256, 'cat: /bin/junk: No such file or directory')
720 >>> subprocess.getstatusoutput('/bin/junk')
721 (256, 'sh: /bin/junk: not found')
722 """
Tim Goldene0041752013-11-03 12:53:17 +0000723 try:
724 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
725 status = 0
726 except CalledProcessError as ex:
727 data = ex.output
728 status = ex.returncode
729 if data[-1:] == '\n':
730 data = data[:-1]
731 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000732
733def getoutput(cmd):
734 """Return output (stdout or stderr) of executing cmd in a shell.
735
736 Like getstatusoutput(), except the exit status is ignored and the return
737 value is a string containing the command's output. Example:
738
739 >>> import subprocess
740 >>> subprocess.getoutput('ls /bin/ls')
741 '/bin/ls'
742 """
743 return getstatusoutput(cmd)[1]
744
745
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000746_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000747
748
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000749class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200750
751 _child_created = False # Set here since __del__ checks it
752
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700753 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000754 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000755 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
756 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000757 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000758 restore_signals=True, start_new_session=False,
759 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000760 """Create new Popen instance."""
761 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700762 # Held while anything is calling waitpid before returncode has been
763 # updated to prevent clobbering returncode if wait() or poll() are
764 # called from multiple threads at once. After acquiring the lock,
765 # code must re-check self.returncode to see if another thread just
766 # finished a waitpid() call.
767 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000768
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400769 self._input = None
770 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000771 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700772 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000773 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000774 raise TypeError("bufsize must be an integer")
775
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000776 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000777 if preexec_fn is not None:
778 raise ValueError("preexec_fn is not supported on Windows "
779 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000780 any_stdio_set = (stdin is not None or stdout is not None or
781 stderr is not None)
782 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
783 if any_stdio_set:
784 close_fds = False
785 else:
786 close_fds = True
787 elif close_fds and any_stdio_set:
788 raise ValueError(
789 "close_fds is not supported on Windows platforms"
790 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000791 else:
792 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000793 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
794 close_fds = True
795 if pass_fds and not close_fds:
796 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
797 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000798 if startupinfo is not None:
799 raise ValueError("startupinfo is only supported on Windows "
800 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000801 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000802 raise ValueError("creationflags is only supported on Windows "
803 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400805 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000806 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000807 self.stdout = None
808 self.stderr = None
809 self.pid = None
810 self.returncode = None
811 self.universal_newlines = universal_newlines
812
813 # Input and output objects. The general principle is like
814 # this:
815 #
816 # Parent Child
817 # ------ -----
818 # p2cwrite ---stdin---> p2cread
819 # c2pread <--stdout--- c2pwrite
820 # errread <--stderr--- errwrite
821 #
822 # On POSIX, the child objects are file descriptors. On
823 # Windows, these are Windows file handles. The parent objects
824 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000825 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000826 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000827
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000828 (p2cread, p2cwrite,
829 c2pread, c2pwrite,
830 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
831
Antoine Pitrouc9982322011-01-04 19:07:07 +0000832 # We wrap OS handles *before* launching the child, otherwise a
833 # quickly terminating child could make our fds unwrappable
834 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000835
Thomas Wouterscf297e42007-02-23 15:07:44 +0000836 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000837 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000838 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000839 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000840 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000841 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000842 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000843
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000844 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000845 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300846 if universal_newlines:
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200847 self.stdin = io.TextIOWrapper(self.stdin, write_through=True)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000848 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000849 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000850 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000851 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000852 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000853 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000854 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000855 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000856
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700857 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000858 try:
859 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300860 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000861 startupinfo, creationflags, shell,
862 p2cread, p2cwrite,
863 c2pread, c2pwrite,
864 errread, errwrite,
865 restore_signals, start_new_session)
866 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800867 # Cleanup if the child failed starting.
868 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000869 try:
870 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200871 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800872 pass # Ignore EBADF or other errors.
873
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700874 if not self._closed_child_pipe_fds:
875 to_close = []
876 if stdin == PIPE:
877 to_close.append(p2cread)
878 if stdout == PIPE:
879 to_close.append(c2pwrite)
880 if stderr == PIPE:
881 to_close.append(errwrite)
882 if hasattr(self, '_devnull'):
883 to_close.append(self._devnull)
884 for fd in to_close:
885 try:
886 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700887 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700888 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800889
Antoine Pitrouc9982322011-01-04 19:07:07 +0000890 raise
891
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000892
Guido van Rossum98297ee2007-11-06 21:34:58 +0000893 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300894 data = data.decode(encoding)
895 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000896
Brian Curtin79cdb662010-12-03 02:46:02 +0000897 def __enter__(self):
898 return self
899
900 def __exit__(self, type, value, traceback):
901 if self.stdout:
902 self.stdout.close()
903 if self.stderr:
904 self.stderr.close()
905 if self.stdin:
906 self.stdin.close()
Gregory P. Smith6b657452011-05-11 21:42:08 -0700907 # Wait for the process to terminate, to avoid zombies.
908 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000909
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200910 def __del__(self, _maxsize=sys.maxsize):
911 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000912 # We didn't get to successfully create a child process.
913 return
914 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000915 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000916 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000917 # Child is still running, keep us alive until we can wait on it.
918 _active.append(self)
919
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200920 def _get_devnull(self):
921 if not hasattr(self, '_devnull'):
922 self._devnull = os.open(os.devnull, os.O_RDWR)
923 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000924
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400925 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000926 """Interact with process: Send data to stdin. Read data from
927 stdout and stderr, until end-of-file is reached. Wait for
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400928 process to terminate.
Tim Peterseba28be2005-03-28 01:08:02 +0000929
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400930 The optional "input" argument should be data to be sent to the
931 child process (if self.universal_newlines is True, this should
932 be a string; if it is False, "input" should be bytes), or
933 None, if no data should be sent to the child.
934
935 communicate() returns a tuple (stdout, stderr). These will be
936 bytes or, if self.universal_newlines was True, a string.
937 """
Peter Astrand23109f02005-03-03 20:28:59 +0000938
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400939 if self._communication_started and input:
940 raise ValueError("Cannot send input after starting communication")
941
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400942 # Optimization: If we are not worried about timeouts, we haven't
943 # started communicating, and we have one or zero pipes, using select()
944 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200945 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400946 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000947 stdout = None
948 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000949 if self.stdin:
950 if input:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200951 try:
952 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200953 except OSError as e:
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200954 if e.errno != errno.EPIPE and e.errno != errno.EINVAL:
955 raise
Peter Astrand23109f02005-03-03 20:28:59 +0000956 self.stdin.close()
957 elif self.stdout:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200958 stdout = _eintr_retry_call(self.stdout.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000959 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000960 elif self.stderr:
Victor Stinner2cfb6f32011-07-05 14:00:56 +0200961 stderr = _eintr_retry_call(self.stderr.read)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000962 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000963 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200964 else:
965 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200966 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200967 else:
968 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000969
Victor Stinner7a8d0812011-04-05 13:13:08 +0200970 try:
971 stdout, stderr = self._communicate(input, endtime, timeout)
972 finally:
973 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400974
Victor Stinner7a8d0812011-04-05 13:13:08 +0200975 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400976
977 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000978
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000979
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000980 def poll(self):
981 return self._internal_poll()
982
983
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400984 def _remaining_time(self, endtime):
985 """Convenience for _communicate when computing timeouts."""
986 if endtime is None:
987 return None
988 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200989 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400990
991
Reid Kleckner2b228f02011-03-16 16:57:54 -0400992 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400993 """Convenience for checking if a timeout has expired."""
994 if endtime is None:
995 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200996 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400997 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400998
999
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001000 if mswindows:
1001 #
1002 # Windows methods
1003 #
1004 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001005 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001006 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1007 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001008 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001009 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +00001010
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001011 p2cread, p2cwrite = -1, -1
1012 c2pread, c2pwrite = -1, -1
1013 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001014
Peter Astrandd38ddf42005-02-10 08:32:50 +00001015 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001016 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001017 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001018 p2cread, _ = _winapi.CreatePipe(None, 0)
1019 p2cread = Handle(p2cread)
1020 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001021 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001022 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1023 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001024 elif stdin == DEVNULL:
1025 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001026 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001027 p2cread = msvcrt.get_osfhandle(stdin)
1028 else:
1029 # Assuming file-like object
1030 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1031 p2cread = self._make_inheritable(p2cread)
1032
Peter Astrandd38ddf42005-02-10 08:32:50 +00001033 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001034 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001035 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001036 _, c2pwrite = _winapi.CreatePipe(None, 0)
1037 c2pwrite = Handle(c2pwrite)
1038 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001039 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001040 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1041 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001042 elif stdout == DEVNULL:
1043 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001044 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001045 c2pwrite = msvcrt.get_osfhandle(stdout)
1046 else:
1047 # Assuming file-like object
1048 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1049 c2pwrite = self._make_inheritable(c2pwrite)
1050
Peter Astrandd38ddf42005-02-10 08:32:50 +00001051 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001052 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001053 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001054 _, errwrite = _winapi.CreatePipe(None, 0)
1055 errwrite = Handle(errwrite)
1056 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001057 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001058 errread, errwrite = _winapi.CreatePipe(None, 0)
1059 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001060 elif stderr == STDOUT:
1061 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001062 elif stderr == DEVNULL:
1063 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001064 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001065 errwrite = msvcrt.get_osfhandle(stderr)
1066 else:
1067 # Assuming file-like object
1068 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1069 errwrite = self._make_inheritable(errwrite)
1070
1071 return (p2cread, p2cwrite,
1072 c2pread, c2pwrite,
1073 errread, errwrite)
1074
1075
1076 def _make_inheritable(self, handle):
1077 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001078 h = _winapi.DuplicateHandle(
1079 _winapi.GetCurrentProcess(), handle,
1080 _winapi.GetCurrentProcess(), 0, 1,
1081 _winapi.DUPLICATE_SAME_ACCESS)
1082 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001083
1084
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001085 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001086 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001087 startupinfo, creationflags, shell,
1088 p2cread, p2cwrite,
1089 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001090 errread, errwrite,
1091 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092 """Execute program (MS Windows version)"""
1093
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001094 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001095
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001096 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001097 args = list2cmdline(args)
1098
Peter Astrandc1d65362004-11-07 14:30:34 +00001099 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001100 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001101 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001102 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001103 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001104 startupinfo.hStdInput = p2cread
1105 startupinfo.hStdOutput = c2pwrite
1106 startupinfo.hStdError = errwrite
1107
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001108 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001109 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1110 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001111 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001112 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001113
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114 # Start the process
1115 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001116 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001117 # no special security
1118 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001119 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001120 creationflags,
1121 env,
1122 cwd,
1123 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001124 finally:
1125 # Child is launched. Close the parent's copy of those pipe
1126 # handles that only the child should have open. You need
1127 # to make sure that no handles to the write end of the
1128 # output pipe are maintained in this process or else the
1129 # pipe will not close when the child process exits and the
1130 # ReadFile will hang.
1131 if p2cread != -1:
1132 p2cread.Close()
1133 if c2pwrite != -1:
1134 c2pwrite.Close()
1135 if errwrite != -1:
1136 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001137 if hasattr(self, '_devnull'):
1138 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001139
1140 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001141 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001142 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001143 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001144 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001145
Brett Cannon84df1e62010-05-14 00:33:40 +00001146 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001147 _WaitForSingleObject=_winapi.WaitForSingleObject,
1148 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1149 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001150 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001151 attribute.
1152
1153 This method is called by __del__, so it can only refer to objects
1154 in its local scope.
1155
1156 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001157 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001158 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1159 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001160 return self.returncode
1161
1162
Reid Kleckner2b228f02011-03-16 16:57:54 -04001163 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001164 """Wait for child process to terminate. Returns returncode
1165 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001166 if endtime is not None:
1167 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001168 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001169 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001170 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001171 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001172 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001173 result = _winapi.WaitForSingleObject(self._handle,
1174 timeout_millis)
1175 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001176 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001177 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001178 return self.returncode
1179
1180
1181 def _readerthread(self, fh, buffer):
1182 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001183 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001184
1185
Reid Kleckner2b228f02011-03-16 16:57:54 -04001186 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001187 # Start reader threads feeding into a list hanging off of this
1188 # object, unless they've already been started.
1189 if self.stdout and not hasattr(self, "_stdout_buff"):
1190 self._stdout_buff = []
1191 self.stdout_thread = \
1192 threading.Thread(target=self._readerthread,
1193 args=(self.stdout, self._stdout_buff))
1194 self.stdout_thread.daemon = True
1195 self.stdout_thread.start()
1196 if self.stderr and not hasattr(self, "_stderr_buff"):
1197 self._stderr_buff = []
1198 self.stderr_thread = \
1199 threading.Thread(target=self._readerthread,
1200 args=(self.stderr, self._stderr_buff))
1201 self.stderr_thread.daemon = True
1202 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001203
1204 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001205 if input is not None:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001206 try:
1207 self.stdin.write(input)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001208 except OSError as e:
Victor Stinnerd5c8ce72014-02-18 22:00:53 +01001209 if e.errno == errno.EPIPE:
Victor Stinner5f47ac22014-02-18 22:06:35 +01001210 # communicate() should ignore pipe full error
Victor Stinnerd5c8ce72014-02-18 22:00:53 +01001211 pass
1212 elif (e.errno == errno.EINVAL
1213 and self.poll() is not None):
1214 # Issue #19612: stdin.write() fails with EINVAL
1215 # if the process already exited before the write
1216 pass
1217 else:
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001218 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001219 self.stdin.close()
1220
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001221 # Wait for the reader threads, or time out. If we time out, the
1222 # threads remain reading and the fds left open in case the user
1223 # calls communicate again.
1224 if self.stdout is not None:
1225 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001226 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001227 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001228 if self.stderr is not None:
1229 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001230 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001231 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001232
1233 # Collect the output from and close both pipes, now that we know
1234 # both have been read successfully.
1235 stdout = None
1236 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001238 stdout = self._stdout_buff
1239 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001240 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001241 stderr = self._stderr_buff
1242 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001243
1244 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001245 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001246 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001247 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001248 stderr = stderr[0]
1249
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001250 return (stdout, stderr)
1251
Christian Heimesa342c012008-04-20 21:01:16 +00001252 def send_signal(self, sig):
1253 """Send a signal to the process
1254 """
1255 if sig == signal.SIGTERM:
1256 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001257 elif sig == signal.CTRL_C_EVENT:
1258 os.kill(self.pid, signal.CTRL_C_EVENT)
1259 elif sig == signal.CTRL_BREAK_EVENT:
1260 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001261 else:
Brian Curtin19651362010-09-07 13:24:38 +00001262 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001263
1264 def terminate(self):
1265 """Terminates the process
1266 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001267 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001268 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001269 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001270 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1271 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001272 rc = _winapi.GetExitCodeProcess(self._handle)
1273 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001274 raise
1275 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001276
1277 kill = terminate
1278
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001279 else:
1280 #
1281 # POSIX methods
1282 #
1283 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001284 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001285 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1286 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001287 p2cread, p2cwrite = -1, -1
1288 c2pread, c2pwrite = -1, -1
1289 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001290
Peter Astrandd38ddf42005-02-10 08:32:50 +00001291 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001292 pass
1293 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001294 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001295 elif stdin == DEVNULL:
1296 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001297 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001298 p2cread = stdin
1299 else:
1300 # Assuming file-like object
1301 p2cread = stdin.fileno()
1302
Peter Astrandd38ddf42005-02-10 08:32:50 +00001303 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001304 pass
1305 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001306 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001307 elif stdout == DEVNULL:
1308 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001309 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001310 c2pwrite = stdout
1311 else:
1312 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001313 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001314
Peter Astrandd38ddf42005-02-10 08:32:50 +00001315 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001316 pass
1317 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001318 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001319 elif stderr == STDOUT:
1320 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001321 elif stderr == DEVNULL:
1322 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001323 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001324 errwrite = stderr
1325 else:
1326 # Assuming file-like object
1327 errwrite = stderr.fileno()
1328
1329 return (p2cread, p2cwrite,
1330 c2pread, c2pwrite,
1331 errread, errwrite)
1332
1333
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001334 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001335 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001336 startupinfo, creationflags, shell,
1337 p2cread, p2cwrite,
1338 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001339 errread, errwrite,
1340 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001341 """Execute program (POSIX version)"""
1342
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001343 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001345 else:
1346 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001347
1348 if shell:
1349 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001350 if executable:
1351 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001352
Peter Astrandd38ddf42005-02-10 08:32:50 +00001353 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001354 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001355 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001356
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001357 # For transferring possible exec failure from child to parent.
1358 # Data format: "exception name:hex errno:description"
1359 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001360 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001361 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1362 low_fds_to_close = []
1363 while errpipe_write < 3:
1364 low_fds_to_close.append(errpipe_write)
1365 errpipe_write = os.dup(errpipe_write)
1366 for low_fd in low_fds_to_close:
1367 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001368 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001369 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001370 # We must avoid complex work that could involve
1371 # malloc or free in the child process to avoid
1372 # potential deadlocks, thus we do all this here.
1373 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001374
Victor Stinner372b8382011-06-21 17:24:21 +02001375 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001376 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1377 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001378 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001379 env_list = None # Use execv instead of execve.
1380 executable = os.fsencode(executable)
1381 if os.path.dirname(executable):
1382 executable_list = (executable,)
1383 else:
1384 # This matches the behavior of os._execvpe().
1385 executable_list = tuple(
1386 os.path.join(os.fsencode(dir), executable)
1387 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001388 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001389 fds_to_keep.add(errpipe_write)
1390 self.pid = _posixsubprocess.fork_exec(
1391 args, executable_list,
1392 close_fds, sorted(fds_to_keep), cwd, env_list,
1393 p2cread, p2cwrite, c2pread, c2pwrite,
1394 errread, errwrite,
1395 errpipe_read, errpipe_write,
1396 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001397 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001398 finally:
1399 # be sure the FD is closed no matter what
1400 os.close(errpipe_write)
1401
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001402 # self._devnull is not always defined.
1403 devnull_fd = getattr(self, '_devnull', None)
1404 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001405 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001406 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001407 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001408 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001409 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001410 if devnull_fd is not None:
1411 os.close(devnull_fd)
1412 # Prevent a double close of these fds from __init__ on error.
1413 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001414
1415 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001416 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001417 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001418 while True:
1419 part = _eintr_retry_call(os.read, errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001420 errpipe_data += part
1421 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001422 break
Facundo Batista10706e22009-06-19 20:34:30 +00001423 finally:
1424 # be sure the FD is closed no matter what
1425 os.close(errpipe_read)
1426
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001427 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001428 try:
1429 _eintr_retry_call(os.waitpid, self.pid, 0)
1430 except OSError as e:
1431 if e.errno != errno.ECHILD:
1432 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001433 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001434 exception_name, hex_errno, err_msg = (
1435 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001436 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001437 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001438 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001439 err_msg = (b'Bad exception data from child: ' +
1440 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001441 child_exception_type = getattr(
1442 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001443 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001444 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001445 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001446 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001447 child_exec_never_called = (err_msg == "noexec")
1448 if child_exec_never_called:
1449 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001450 if errno_num != 0:
1451 err_msg = os.strerror(errno_num)
1452 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001453 if child_exec_never_called:
1454 # The error must be from chdir(cwd).
1455 err_msg += ': ' + repr(cwd)
1456 else:
1457 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001458 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001459 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001460
1461
Brett Cannon84df1e62010-05-14 00:33:40 +00001462 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1463 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1464 _WEXITSTATUS=os.WEXITSTATUS):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001465 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001466 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001467 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001468 if _WIFSIGNALED(sts):
1469 self.returncode = -_WTERMSIG(sts)
1470 elif _WIFEXITED(sts):
1471 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001472 else:
1473 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001474 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001475
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001476
Brett Cannon84df1e62010-05-14 00:33:40 +00001477 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001478 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001479 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001480 attribute.
1481
1482 This method is called by __del__, so it cannot reference anything
1483 outside of the local scope (nor can any methods it calls).
1484
1485 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001486 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001487 if not self._waitpid_lock.acquire(False):
1488 # Something else is busy calling waitpid. Don't allow two
1489 # at once. We know nothing yet.
1490 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001491 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001492 if self.returncode is not None:
1493 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001494 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001495 if pid == self.pid:
1496 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001497 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001498 if _deadstate is not None:
1499 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001500 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001501 # This happens if SIGCLD is set to be ignored or
1502 # waiting for child processes has otherwise been
1503 # disabled for our process. This child is dead, we
1504 # can't get the status.
1505 # http://bugs.python.org/issue15756
1506 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001507 finally:
1508 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001509 return self.returncode
1510
1511
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001512 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001513 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001514 try:
1515 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1516 except OSError as e:
1517 if e.errno != errno.ECHILD:
1518 raise
1519 # This happens if SIGCLD is set to be ignored or waiting
1520 # for child processes has otherwise been disabled for our
1521 # process. This child is dead, we can't get the status.
1522 pid = self.pid
1523 sts = 0
1524 return (pid, sts)
1525
1526
1527 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001528 """Wait for child process to terminate. Returns returncode
1529 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001530 if self.returncode is not None:
1531 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001532
1533 # endtime is preferred to timeout. timeout is only used for
1534 # printing.
1535 if endtime is not None or timeout is not None:
1536 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001537 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001538 elif timeout is None:
1539 timeout = self._remaining_time(endtime)
1540
1541 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001542 # Enter a busy loop if we have a timeout. This busy loop was
1543 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1544 delay = 0.0005 # 500 us -> initial delay of 1 ms
1545 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001546 if self._waitpid_lock.acquire(False):
1547 try:
1548 if self.returncode is not None:
1549 break # Another thread waited.
1550 (pid, sts) = self._try_wait(os.WNOHANG)
1551 assert pid == self.pid or pid == 0
1552 if pid == self.pid:
1553 self._handle_exitstatus(sts)
1554 break
1555 finally:
1556 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001557 remaining = self._remaining_time(endtime)
1558 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001559 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001560 delay = min(delay * 2, remaining, .05)
1561 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001562 else:
1563 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001564 with self._waitpid_lock:
1565 if self.returncode is not None:
1566 break # Another thread waited.
1567 (pid, sts) = self._try_wait(0)
1568 # Check the pid and loop as waitpid has been known to
1569 # return 0 even without WNOHANG in odd situations.
1570 # http://bugs.python.org/issue14396.
1571 if pid == self.pid:
1572 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001573 return self.returncode
1574
1575
Reid Kleckner2b228f02011-03-16 16:57:54 -04001576 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001577 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001578 # Flush stdio buffer. This might block, if the user has
1579 # been writing to .stdin in an uncontrolled fashion.
1580 self.stdin.flush()
1581 if not input:
1582 self.stdin.close()
1583
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001584 stdout = None
1585 stderr = None
1586
1587 # Only create this mapping if we haven't already.
1588 if not self._communication_started:
1589 self._fileobj2output = {}
1590 if self.stdout:
1591 self._fileobj2output[self.stdout] = []
1592 if self.stderr:
1593 self._fileobj2output[self.stderr] = []
1594
1595 if self.stdout:
1596 stdout = self._fileobj2output[self.stdout]
1597 if self.stderr:
1598 stderr = self._fileobj2output[self.stderr]
1599
1600 self._save_input(input)
1601
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001602 if self._input:
1603 input_view = memoryview(self._input)
1604
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001605 with _PopenSelector() as selector:
1606 if self.stdin and input:
1607 selector.register(self.stdin, selectors.EVENT_WRITE)
1608 if self.stdout:
1609 selector.register(self.stdout, selectors.EVENT_READ)
1610 if self.stderr:
1611 selector.register(self.stderr, selectors.EVENT_READ)
1612
1613 while selector.get_map():
1614 timeout = self._remaining_time(endtime)
1615 if timeout is not None and timeout < 0:
1616 raise TimeoutExpired(self.args, orig_timeout)
1617
1618 ready = selector.select(timeout)
1619 self._check_timeout(endtime, orig_timeout)
1620
1621 # XXX Rewrite these to use non-blocking I/O on the file
1622 # objects; they are no longer using C stdio!
1623
1624 for key, events in ready:
1625 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001626 chunk = input_view[self._input_offset :
1627 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001628 try:
1629 self._input_offset += os.write(key.fd, chunk)
1630 except OSError as e:
1631 if e.errno == errno.EPIPE:
1632 selector.unregister(key.fileobj)
1633 key.fileobj.close()
1634 else:
1635 raise
1636 else:
1637 if self._input_offset >= len(self._input):
1638 selector.unregister(key.fileobj)
1639 key.fileobj.close()
1640 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08001641 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001642 if not data:
1643 selector.unregister(key.fileobj)
1644 key.fileobj.close()
1645 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001646
1647 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001648
1649 # All data exchanged. Translate lists into strings.
1650 if stdout is not None:
1651 stdout = b''.join(stdout)
1652 if stderr is not None:
1653 stderr = b''.join(stderr)
1654
1655 # Translate newlines, if requested.
1656 # This also turns bytes into strings.
1657 if self.universal_newlines:
1658 if stdout is not None:
1659 stdout = self._translate_newlines(stdout,
1660 self.stdout.encoding)
1661 if stderr is not None:
1662 stderr = self._translate_newlines(stderr,
1663 self.stderr.encoding)
1664
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001665 return (stdout, stderr)
1666
1667
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001668 def _save_input(self, input):
1669 # This method is called from the _communicate_with_*() methods
1670 # so that if we time out while communicating, we can continue
1671 # sending input if we retry.
1672 if self.stdin and self._input is None:
1673 self._input_offset = 0
1674 self._input = input
1675 if self.universal_newlines and input is not None:
1676 self._input = self._input.encode(self.stdin.encoding)
1677
1678
Christian Heimesa342c012008-04-20 21:01:16 +00001679 def send_signal(self, sig):
1680 """Send a signal to the process
1681 """
1682 os.kill(self.pid, sig)
1683
1684 def terminate(self):
1685 """Terminate the process with SIGTERM
1686 """
1687 self.send_signal(signal.SIGTERM)
1688
1689 def kill(self):
1690 """Kill the process with SIGKILL
1691 """
1692 self.send_signal(signal.SIGKILL)