blob: 6d2c4f5587de860a7b8ebc00b2f002f99e85b2c3 [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 Stinnerae586492014-09-02 23:18:25 +0200368from time import monotonic as _time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000369
Peter Astrand454f7672005-01-01 09:36:35 +0000370# Exception classes used by this module.
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400371class SubprocessError(Exception): pass
372
373
374class CalledProcessError(SubprocessError):
Georg Brandlf9734072008-12-07 15:30:06 +0000375 """This exception is raised when a process run by check_call() or
376 check_output() returns a non-zero exit status.
377 The exit status will be stored in the returncode attribute;
378 check_output() will also store the output in the output attribute.
379 """
380 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000381 self.returncode = returncode
382 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000383 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000384 def __str__(self):
385 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
386
Peter Astrand454f7672005-01-01 09:36:35 +0000387
Gregory P. Smith54d412e2011-03-14 14:08:43 -0400388class TimeoutExpired(SubprocessError):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400389 """This exception is raised when the timeout expires while waiting for a
390 child process.
391 """
Reid Kleckner2b228f02011-03-16 16:57:54 -0400392 def __init__(self, cmd, timeout, output=None):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400393 self.cmd = cmd
Reid Kleckner2b228f02011-03-16 16:57:54 -0400394 self.timeout = timeout
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400395 self.output = output
396
397 def __str__(self):
398 return ("Command '%s' timed out after %s seconds" %
399 (self.cmd, self.timeout))
400
401
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000402if mswindows:
403 import threading
404 import msvcrt
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200405 import _winapi
Brian Curtin1ce6b582010-04-24 16:19:22 +0000406 class STARTUPINFO:
407 dwFlags = 0
408 hStdInput = None
409 hStdOutput = None
410 hStdError = None
411 wShowWindow = 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000412else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -0700413 import _posixsubprocess
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100414 import select
415 import selectors
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700416 try:
417 import threading
418 except ImportError:
419 import dummy_threading as threading
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000420
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000421 # When select or poll has indicated that the file is writable,
422 # we can write up to _PIPE_BUF bytes without risk of blocking.
423 # POSIX defines PIPE_BUF as >= 512.
424 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
425
Charles-François Natali3a4586a2013-11-08 19:56:59 +0100426 # poll/select have the advantage of not requiring any extra file
427 # descriptor, contrarily to epoll/kqueue (also, they require a single
428 # syscall).
429 if hasattr(selectors, 'PollSelector'):
430 _PopenSelector = selectors.PollSelector
431 else:
432 _PopenSelector = selectors.SelectSelector
433
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000434
Brett Cannona23810f2008-05-26 19:04:21 +0000435__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200436 "getoutput", "check_output", "CalledProcessError", "DEVNULL"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000437
Brian Curtin1ce6b582010-04-24 16:19:22 +0000438if mswindows:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200439 from _winapi import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
440 STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
441 STD_ERROR_HANDLE, SW_HIDE,
442 STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
Brian Curtin5d9deaa2011-04-29 16:24:07 -0500443
Brian Curtin08fd8d92011-04-29 16:11:30 -0500444 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
Brian Curtin8b8e7f42011-04-29 15:48:13 -0500445 "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
446 "STD_ERROR_HANDLE", "SW_HIDE",
447 "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200448
449 class Handle(int):
450 closed = False
451
452 def Close(self, CloseHandle=_winapi.CloseHandle):
453 if not self.closed:
454 self.closed = True
455 CloseHandle(self)
456
457 def Detach(self):
458 if not self.closed:
459 self.closed = True
460 return int(self)
461 raise ValueError("already closed")
462
463 def __repr__(self):
Serhiy Storchaka465e60e2014-07-25 23:36:00 +0300464 return "%s(%d)" % (self.__class__.__name__, int(self))
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200465
466 __del__ = Close
467 __str__ = __repr__
468
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000469
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200470# This lists holds Popen instances for which the underlying process had not
471# exited at the time its __del__ method got called: those processes are wait()ed
472# for synchronously from _cleanup() when a new Popen object is created, to avoid
473# zombie processes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000474_active = []
475
476def _cleanup():
477 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000478 res = inst._internal_poll(_deadstate=sys.maxsize)
Charles-François Natali134a8ba2011-08-18 18:49:39 +0200479 if res is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000480 try:
481 _active.remove(inst)
482 except ValueError:
483 # This can happen if two threads create a new Popen instance.
484 # It's harmless that it was already removed, so ignore.
485 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000486
487PIPE = -1
488STDOUT = -2
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200489DEVNULL = -3
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000490
491
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200492# XXX This function is only used by multiprocessing and the test suite,
493# but it's here so that it can be imported when Python is compiled without
494# threads.
495
496def _args_from_interpreter_flags():
497 """Return a list of command-line arguments reproducing the current
498 settings in sys.flags and sys.warnoptions."""
499 flag_opt_map = {
500 'debug': 'd',
501 # 'inspect': 'i',
502 # 'interactive': 'i',
503 'optimize': 'O',
504 'dont_write_bytecode': 'B',
505 'no_user_site': 's',
506 'no_site': 'S',
507 'ignore_environment': 'E',
508 'verbose': 'v',
509 'bytes_warning': 'b',
510 'quiet': 'q',
511 'hash_randomization': 'R',
512 }
513 args = []
514 for flag, opt in flag_opt_map.items():
515 v = getattr(sys.flags, flag)
516 if v > 0:
Nick Coghlanac1a2482013-10-18 22:39:50 +1000517 if flag == 'hash_randomization':
518 v = 1 # Handle specification of an exact seed
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200519 args.append('-' + opt * v)
520 for opt in sys.warnoptions:
521 args.append('-W' + opt)
522 return args
523
524
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400525def call(*popenargs, timeout=None, **kwargs):
526 """Run command with arguments. Wait for command to complete or
527 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000528
529 The arguments are the same as for the Popen constructor. Example:
530
531 retcode = call(["ls", "-l"])
532 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200533 with Popen(*popenargs, **kwargs) as p:
534 try:
535 return p.wait(timeout=timeout)
536 except:
537 p.kill()
538 p.wait()
539 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000540
541
Peter Astrand454f7672005-01-01 09:36:35 +0000542def check_call(*popenargs, **kwargs):
543 """Run command with arguments. Wait for command to complete. If
544 the exit code was zero then return, otherwise raise
545 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000546 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000547
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400548 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000549
550 check_call(["ls", "-l"])
551 """
552 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000553 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000554 cmd = kwargs.get("args")
555 if cmd is None:
556 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000557 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000558 return 0
559
560
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400561def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700562 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000563
564 If the exit code was non-zero it raises a CalledProcessError. The
565 CalledProcessError object will have the return code in the returncode
566 attribute and output in the output attribute.
567
568 The arguments are the same as for the Popen constructor. Example:
569
570 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000571 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000572
573 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000574 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000575
576 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000577 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000578 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000579 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700580
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300581 There is an additional optional argument, "input", allowing you to
582 pass a string to the subprocess's stdin. If you use this argument
583 you may not also use the Popen constructor's "stdin" argument, as
584 it too will be used internally. Example:
585
586 >>> check_output(["sed", "-e", "s/foo/bar/"],
587 ... input=b"when in the course of fooman events\n")
588 b'when in the course of barman events\n'
589
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400590 If universal_newlines=True is passed, the "input" argument must be a
591 string and the return value will be a string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000592 """
593 if 'stdout' in kwargs:
594 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300595 if 'input' in kwargs:
596 if 'stdin' in kwargs:
597 raise ValueError('stdin and input arguments may not both be used.')
598 inputdata = kwargs['input']
599 del kwargs['input']
600 kwargs['stdin'] = PIPE
601 else:
602 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200603 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
604 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300605 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200606 except TimeoutExpired:
607 process.kill()
608 output, unused_err = process.communicate()
609 raise TimeoutExpired(process.args, timeout, output=output)
610 except:
611 process.kill()
612 process.wait()
613 raise
614 retcode = process.poll()
615 if retcode:
616 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000617 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000618
619
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000620def list2cmdline(seq):
621 """
622 Translate a sequence of arguments into a command line
623 string, using the same rules as the MS C runtime:
624
625 1) Arguments are delimited by white space, which is either a
626 space or a tab.
627
628 2) A string surrounded by double quotation marks is
629 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000630 contained within. A quoted string can be embedded in an
631 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000632
633 3) A double quotation mark preceded by a backslash is
634 interpreted as a literal double quotation mark.
635
636 4) Backslashes are interpreted literally, unless they
637 immediately precede a double quotation mark.
638
639 5) If backslashes immediately precede a double quotation mark,
640 every pair of backslashes is interpreted as a literal
641 backslash. If the number of backslashes is odd, the last
642 backslash escapes the next double quotation mark as
643 described in rule 3.
644 """
645
646 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000647 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
648 # or search http://msdn.microsoft.com for
649 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000650 result = []
651 needquote = False
652 for arg in seq:
653 bs_buf = []
654
655 # Add a space to separate this argument from the others
656 if result:
657 result.append(' ')
658
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000659 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000660 if needquote:
661 result.append('"')
662
663 for c in arg:
664 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000665 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000666 bs_buf.append(c)
667 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000668 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000669 result.append('\\' * len(bs_buf)*2)
670 bs_buf = []
671 result.append('\\"')
672 else:
673 # Normal char
674 if bs_buf:
675 result.extend(bs_buf)
676 bs_buf = []
677 result.append(c)
678
Christian Heimesfdab48e2008-01-20 09:06:41 +0000679 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000680 if bs_buf:
681 result.extend(bs_buf)
682
683 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000684 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000685 result.append('"')
686
687 return ''.join(result)
688
689
Brett Cannona23810f2008-05-26 19:04:21 +0000690# Various tools for executing commands and looking at their output and status.
691#
Brett Cannona23810f2008-05-26 19:04:21 +0000692
693def getstatusoutput(cmd):
Tim Golden60798142013-11-05 12:57:25 +0000694 """ Return (status, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000695
Tim Golden60798142013-11-05 12:57:25 +0000696 Execute the string 'cmd' in a shell with 'check_output' and
697 return a 2-tuple (status, output). Universal newlines mode is used,
698 meaning that the result with be decoded to a string.
699
700 A trailing newline is stripped from the output.
701 The exit status for the command can be interpreted
702 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000703
704 >>> import subprocess
705 >>> subprocess.getstatusoutput('ls /bin/ls')
706 (0, '/bin/ls')
707 >>> subprocess.getstatusoutput('cat /bin/junk')
708 (256, 'cat: /bin/junk: No such file or directory')
709 >>> subprocess.getstatusoutput('/bin/junk')
710 (256, 'sh: /bin/junk: not found')
711 """
Tim Goldene0041752013-11-03 12:53:17 +0000712 try:
713 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
714 status = 0
715 except CalledProcessError as ex:
716 data = ex.output
717 status = ex.returncode
718 if data[-1:] == '\n':
719 data = data[:-1]
720 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000721
722def getoutput(cmd):
723 """Return output (stdout or stderr) of executing cmd in a shell.
724
725 Like getstatusoutput(), except the exit status is ignored and the return
726 value is a string containing the command's output. Example:
727
728 >>> import subprocess
729 >>> subprocess.getoutput('ls /bin/ls')
730 '/bin/ls'
731 """
732 return getstatusoutput(cmd)[1]
733
734
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000735_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000736
737
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000738class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200739
740 _child_created = False # Set here since __del__ checks it
741
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700742 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000743 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000744 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
745 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000746 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000747 restore_signals=True, start_new_session=False,
748 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000749 """Create new Popen instance."""
750 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700751 # Held while anything is calling waitpid before returncode has been
752 # updated to prevent clobbering returncode if wait() or poll() are
753 # called from multiple threads at once. After acquiring the lock,
754 # code must re-check self.returncode to see if another thread just
755 # finished a waitpid() call.
756 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000757
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400758 self._input = None
759 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000760 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700761 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000762 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000763 raise TypeError("bufsize must be an integer")
764
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000765 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000766 if preexec_fn is not None:
767 raise ValueError("preexec_fn is not supported on Windows "
768 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000769 any_stdio_set = (stdin is not None or stdout is not None or
770 stderr is not None)
771 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
772 if any_stdio_set:
773 close_fds = False
774 else:
775 close_fds = True
776 elif close_fds and any_stdio_set:
777 raise ValueError(
778 "close_fds is not supported on Windows platforms"
779 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000780 else:
781 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000782 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
783 close_fds = True
784 if pass_fds and not close_fds:
785 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
786 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000787 if startupinfo is not None:
788 raise ValueError("startupinfo is only supported on Windows "
789 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000790 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000791 raise ValueError("creationflags is only supported on Windows "
792 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000793
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400794 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000795 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000796 self.stdout = None
797 self.stderr = None
798 self.pid = None
799 self.returncode = None
800 self.universal_newlines = universal_newlines
801
802 # Input and output objects. The general principle is like
803 # this:
804 #
805 # Parent Child
806 # ------ -----
807 # p2cwrite ---stdin---> p2cread
808 # c2pread <--stdout--- c2pwrite
809 # errread <--stderr--- errwrite
810 #
811 # On POSIX, the child objects are file descriptors. On
812 # Windows, these are Windows file handles. The parent objects
813 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000814 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000815 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000816
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000817 (p2cread, p2cwrite,
818 c2pread, c2pwrite,
819 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
820
Antoine Pitrouc9982322011-01-04 19:07:07 +0000821 # We wrap OS handles *before* launching the child, otherwise a
822 # quickly terminating child could make our fds unwrappable
823 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000824
Thomas Wouterscf297e42007-02-23 15:07:44 +0000825 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000826 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000827 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000828 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000829 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000830 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000831 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000832
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000833 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000834 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300835 if universal_newlines:
Antoine Pitrouafe8d062014-09-21 21:10:56 +0200836 self.stdin = io.TextIOWrapper(self.stdin, write_through=True,
837 line_buffering=(bufsize == 1))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000838 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000839 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000840 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000841 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000842 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000843 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000844 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000845 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000846
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700847 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000848 try:
849 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300850 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000851 startupinfo, creationflags, shell,
852 p2cread, p2cwrite,
853 c2pread, c2pwrite,
854 errread, errwrite,
855 restore_signals, start_new_session)
856 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800857 # Cleanup if the child failed starting.
858 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000859 try:
860 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200861 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800862 pass # Ignore EBADF or other errors.
863
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700864 if not self._closed_child_pipe_fds:
865 to_close = []
866 if stdin == PIPE:
867 to_close.append(p2cread)
868 if stdout == PIPE:
869 to_close.append(c2pwrite)
870 if stderr == PIPE:
871 to_close.append(errwrite)
872 if hasattr(self, '_devnull'):
873 to_close.append(self._devnull)
874 for fd in to_close:
875 try:
876 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700877 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700878 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800879
Antoine Pitrouc9982322011-01-04 19:07:07 +0000880 raise
881
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000882
Guido van Rossum98297ee2007-11-06 21:34:58 +0000883 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300884 data = data.decode(encoding)
885 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000886
Brian Curtin79cdb662010-12-03 02:46:02 +0000887 def __enter__(self):
888 return self
889
890 def __exit__(self, type, value, traceback):
891 if self.stdout:
892 self.stdout.close()
893 if self.stderr:
894 self.stderr.close()
Serhiy Storchakaab900c22015-02-28 12:43:08 +0200895 try: # Flushing a BufferedWriter may raise an error
896 if self.stdin:
897 self.stdin.close()
898 finally:
899 # Wait for the process to terminate, to avoid zombies.
900 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000901
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200902 def __del__(self, _maxsize=sys.maxsize):
903 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000904 # We didn't get to successfully create a child process.
905 return
906 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000907 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000908 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000909 # Child is still running, keep us alive until we can wait on it.
910 _active.append(self)
911
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200912 def _get_devnull(self):
913 if not hasattr(self, '_devnull'):
914 self._devnull = os.open(os.devnull, os.O_RDWR)
915 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000916
Victor Stinnera5e881d2015-01-14 17:07:59 +0100917 def _stdin_write(self, input):
918 if input:
919 try:
920 self.stdin.write(input)
921 except BrokenPipeError:
922 # communicate() must ignore broken pipe error
923 pass
924 except OSError as e:
925 if e.errno == errno.EINVAL and self.poll() is not None:
926 # Issue #19612: On Windows, stdin.write() fails with EINVAL
927 # if the process already exited before the write
928 pass
929 else:
930 raise
931 self.stdin.close()
932
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400933 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000934 """Interact with process: Send data to stdin. Read data from
935 stdout and stderr, until end-of-file is reached. Wait for
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400936 process to terminate.
Tim Peterseba28be2005-03-28 01:08:02 +0000937
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400938 The optional "input" argument should be data to be sent to the
939 child process (if self.universal_newlines is True, this should
940 be a string; if it is False, "input" should be bytes), or
941 None, if no data should be sent to the child.
942
943 communicate() returns a tuple (stdout, stderr). These will be
944 bytes or, if self.universal_newlines was True, a string.
945 """
Peter Astrand23109f02005-03-03 20:28:59 +0000946
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400947 if self._communication_started and input:
948 raise ValueError("Cannot send input after starting communication")
949
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400950 # Optimization: If we are not worried about timeouts, we haven't
951 # started communicating, and we have one or zero pipes, using select()
952 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200953 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400954 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000955 stdout = None
956 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000957 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +0100958 self._stdin_write(input)
Peter Astrand23109f02005-03-03 20:28:59 +0000959 elif self.stdout:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000960 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000961 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000962 elif self.stderr:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000963 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000964 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000965 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200966 else:
967 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200968 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200969 else:
970 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000971
Victor Stinner7a8d0812011-04-05 13:13:08 +0200972 try:
973 stdout, stderr = self._communicate(input, endtime, timeout)
974 finally:
975 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400976
Victor Stinner7a8d0812011-04-05 13:13:08 +0200977 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400978
979 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000980
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000981
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000982 def poll(self):
983 return self._internal_poll()
984
985
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400986 def _remaining_time(self, endtime):
987 """Convenience for _communicate when computing timeouts."""
988 if endtime is None:
989 return None
990 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200991 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400992
993
Reid Kleckner2b228f02011-03-16 16:57:54 -0400994 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400995 """Convenience for checking if a timeout has expired."""
996 if endtime is None:
997 return
Victor Stinner949d8c92012-05-30 13:30:32 +0200998 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -0400999 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001000
1001
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001002 if mswindows:
1003 #
1004 # Windows methods
1005 #
1006 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001007 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001008 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1009 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001010 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001011 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +00001012
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001013 p2cread, p2cwrite = -1, -1
1014 c2pread, c2pwrite = -1, -1
1015 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001016
Peter Astrandd38ddf42005-02-10 08:32:50 +00001017 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001018 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001019 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001020 p2cread, _ = _winapi.CreatePipe(None, 0)
1021 p2cread = Handle(p2cread)
1022 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001023 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001024 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1025 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001026 elif stdin == DEVNULL:
1027 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001028 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001029 p2cread = msvcrt.get_osfhandle(stdin)
1030 else:
1031 # Assuming file-like object
1032 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1033 p2cread = self._make_inheritable(p2cread)
1034
Peter Astrandd38ddf42005-02-10 08:32:50 +00001035 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001036 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001037 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001038 _, c2pwrite = _winapi.CreatePipe(None, 0)
1039 c2pwrite = Handle(c2pwrite)
1040 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001041 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001042 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1043 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001044 elif stdout == DEVNULL:
1045 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001046 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001047 c2pwrite = msvcrt.get_osfhandle(stdout)
1048 else:
1049 # Assuming file-like object
1050 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1051 c2pwrite = self._make_inheritable(c2pwrite)
1052
Peter Astrandd38ddf42005-02-10 08:32:50 +00001053 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001054 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001055 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001056 _, errwrite = _winapi.CreatePipe(None, 0)
1057 errwrite = Handle(errwrite)
1058 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001059 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001060 errread, errwrite = _winapi.CreatePipe(None, 0)
1061 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001062 elif stderr == STDOUT:
1063 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001064 elif stderr == DEVNULL:
1065 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001066 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001067 errwrite = msvcrt.get_osfhandle(stderr)
1068 else:
1069 # Assuming file-like object
1070 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1071 errwrite = self._make_inheritable(errwrite)
1072
1073 return (p2cread, p2cwrite,
1074 c2pread, c2pwrite,
1075 errread, errwrite)
1076
1077
1078 def _make_inheritable(self, handle):
1079 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001080 h = _winapi.DuplicateHandle(
1081 _winapi.GetCurrentProcess(), handle,
1082 _winapi.GetCurrentProcess(), 0, 1,
1083 _winapi.DUPLICATE_SAME_ACCESS)
1084 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001085
1086
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001087 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001088 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001089 startupinfo, creationflags, shell,
1090 p2cread, p2cwrite,
1091 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001092 errread, errwrite,
1093 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001094 """Execute program (MS Windows version)"""
1095
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001096 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001097
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001098 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001099 args = list2cmdline(args)
1100
Peter Astrandc1d65362004-11-07 14:30:34 +00001101 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001102 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001103 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001104 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001105 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001106 startupinfo.hStdInput = p2cread
1107 startupinfo.hStdOutput = c2pwrite
1108 startupinfo.hStdError = errwrite
1109
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001110 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001111 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1112 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001113 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001114 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001115
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001116 # Start the process
1117 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001118 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001119 # no special security
1120 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001121 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001122 creationflags,
1123 env,
1124 cwd,
1125 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001126 finally:
1127 # Child is launched. Close the parent's copy of those pipe
1128 # handles that only the child should have open. You need
1129 # to make sure that no handles to the write end of the
1130 # output pipe are maintained in this process or else the
1131 # pipe will not close when the child process exits and the
1132 # ReadFile will hang.
1133 if p2cread != -1:
1134 p2cread.Close()
1135 if c2pwrite != -1:
1136 c2pwrite.Close()
1137 if errwrite != -1:
1138 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001139 if hasattr(self, '_devnull'):
1140 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001141
1142 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001143 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001144 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001145 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001146 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001147
Brett Cannon84df1e62010-05-14 00:33:40 +00001148 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001149 _WaitForSingleObject=_winapi.WaitForSingleObject,
1150 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1151 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001153 attribute.
1154
1155 This method is called by __del__, so it can only refer to objects
1156 in its local scope.
1157
1158 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001159 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001160 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1161 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001162 return self.returncode
1163
1164
Reid Kleckner2b228f02011-03-16 16:57:54 -04001165 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001166 """Wait for child process to terminate. Returns returncode
1167 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001168 if endtime is not None:
1169 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001170 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001171 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001172 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001173 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001174 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001175 result = _winapi.WaitForSingleObject(self._handle,
1176 timeout_millis)
1177 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001178 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001179 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180 return self.returncode
1181
1182
1183 def _readerthread(self, fh, buffer):
1184 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001185 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001186
1187
Reid Kleckner2b228f02011-03-16 16:57:54 -04001188 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001189 # Start reader threads feeding into a list hanging off of this
1190 # object, unless they've already been started.
1191 if self.stdout and not hasattr(self, "_stdout_buff"):
1192 self._stdout_buff = []
1193 self.stdout_thread = \
1194 threading.Thread(target=self._readerthread,
1195 args=(self.stdout, self._stdout_buff))
1196 self.stdout_thread.daemon = True
1197 self.stdout_thread.start()
1198 if self.stderr and not hasattr(self, "_stderr_buff"):
1199 self._stderr_buff = []
1200 self.stderr_thread = \
1201 threading.Thread(target=self._readerthread,
1202 args=(self.stderr, self._stderr_buff))
1203 self.stderr_thread.daemon = True
1204 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001205
1206 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001207 self._stdin_write(input)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001209 # Wait for the reader threads, or time out. If we time out, the
1210 # threads remain reading and the fds left open in case the user
1211 # calls communicate again.
1212 if self.stdout is not None:
1213 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001214 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001215 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001216 if self.stderr is not None:
1217 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001218 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001219 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001220
1221 # Collect the output from and close both pipes, now that we know
1222 # both have been read successfully.
1223 stdout = None
1224 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001225 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001226 stdout = self._stdout_buff
1227 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001228 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001229 stderr = self._stderr_buff
1230 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001231
1232 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001233 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001234 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001235 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001236 stderr = stderr[0]
1237
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001238 return (stdout, stderr)
1239
Christian Heimesa342c012008-04-20 21:01:16 +00001240 def send_signal(self, sig):
1241 """Send a signal to the process
1242 """
1243 if sig == signal.SIGTERM:
1244 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001245 elif sig == signal.CTRL_C_EVENT:
1246 os.kill(self.pid, signal.CTRL_C_EVENT)
1247 elif sig == signal.CTRL_BREAK_EVENT:
1248 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001249 else:
Brian Curtin19651362010-09-07 13:24:38 +00001250 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001251
1252 def terminate(self):
1253 """Terminates the process
1254 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001255 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001256 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001257 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001258 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1259 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001260 rc = _winapi.GetExitCodeProcess(self._handle)
1261 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001262 raise
1263 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001264
1265 kill = terminate
1266
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001267 else:
1268 #
1269 # POSIX methods
1270 #
1271 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001272 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001273 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1274 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001275 p2cread, p2cwrite = -1, -1
1276 c2pread, c2pwrite = -1, -1
1277 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001278
Peter Astrandd38ddf42005-02-10 08:32:50 +00001279 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001280 pass
1281 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001282 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001283 elif stdin == DEVNULL:
1284 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001285 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001286 p2cread = stdin
1287 else:
1288 # Assuming file-like object
1289 p2cread = stdin.fileno()
1290
Peter Astrandd38ddf42005-02-10 08:32:50 +00001291 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001292 pass
1293 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001294 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001295 elif stdout == DEVNULL:
1296 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001297 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001298 c2pwrite = stdout
1299 else:
1300 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001301 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001302
Peter Astrandd38ddf42005-02-10 08:32:50 +00001303 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001304 pass
1305 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001306 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001307 elif stderr == STDOUT:
1308 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001309 elif stderr == DEVNULL:
1310 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001311 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001312 errwrite = stderr
1313 else:
1314 # Assuming file-like object
1315 errwrite = stderr.fileno()
1316
1317 return (p2cread, p2cwrite,
1318 c2pread, c2pwrite,
1319 errread, errwrite)
1320
1321
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001322 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001323 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001324 startupinfo, creationflags, shell,
1325 p2cread, p2cwrite,
1326 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001327 errread, errwrite,
1328 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001329 """Execute program (POSIX version)"""
1330
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001331 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001332 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001333 else:
1334 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001335
1336 if shell:
1337 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001338 if executable:
1339 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001340
Peter Astrandd38ddf42005-02-10 08:32:50 +00001341 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001342 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001343 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001344
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001345 # For transferring possible exec failure from child to parent.
1346 # Data format: "exception name:hex errno:description"
1347 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001348 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001349 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1350 low_fds_to_close = []
1351 while errpipe_write < 3:
1352 low_fds_to_close.append(errpipe_write)
1353 errpipe_write = os.dup(errpipe_write)
1354 for low_fd in low_fds_to_close:
1355 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001356 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001357 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001358 # We must avoid complex work that could involve
1359 # malloc or free in the child process to avoid
1360 # potential deadlocks, thus we do all this here.
1361 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001362
Victor Stinner372b8382011-06-21 17:24:21 +02001363 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001364 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1365 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001366 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001367 env_list = None # Use execv instead of execve.
1368 executable = os.fsencode(executable)
1369 if os.path.dirname(executable):
1370 executable_list = (executable,)
1371 else:
1372 # This matches the behavior of os._execvpe().
1373 executable_list = tuple(
1374 os.path.join(os.fsencode(dir), executable)
1375 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001376 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001377 fds_to_keep.add(errpipe_write)
1378 self.pid = _posixsubprocess.fork_exec(
1379 args, executable_list,
1380 close_fds, sorted(fds_to_keep), cwd, env_list,
1381 p2cread, p2cwrite, c2pread, c2pwrite,
1382 errread, errwrite,
1383 errpipe_read, errpipe_write,
1384 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001385 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001386 finally:
1387 # be sure the FD is closed no matter what
1388 os.close(errpipe_write)
1389
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001390 # self._devnull is not always defined.
1391 devnull_fd = getattr(self, '_devnull', None)
1392 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001393 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001394 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001395 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001396 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001397 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001398 if devnull_fd is not None:
1399 os.close(devnull_fd)
1400 # Prevent a double close of these fds from __init__ on error.
1401 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001402
1403 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001404 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001405 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001406 while True:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001407 part = os.read(errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001408 errpipe_data += part
1409 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001410 break
Facundo Batista10706e22009-06-19 20:34:30 +00001411 finally:
1412 # be sure the FD is closed no matter what
1413 os.close(errpipe_read)
1414
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001415 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001416 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001417 os.waitpid(self.pid, 0)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001418 except ChildProcessError:
1419 pass
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001420 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001421 exception_name, hex_errno, err_msg = (
1422 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001423 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001424 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001425 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001426 err_msg = (b'Bad exception data from child: ' +
1427 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001428 child_exception_type = getattr(
1429 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001430 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001431 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001432 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001433 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001434 child_exec_never_called = (err_msg == "noexec")
1435 if child_exec_never_called:
1436 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001437 if errno_num != 0:
1438 err_msg = os.strerror(errno_num)
1439 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001440 if child_exec_never_called:
1441 # The error must be from chdir(cwd).
1442 err_msg += ': ' + repr(cwd)
1443 else:
1444 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001445 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001446 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001447
1448
Brett Cannon84df1e62010-05-14 00:33:40 +00001449 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1450 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1451 _WEXITSTATUS=os.WEXITSTATUS):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001452 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001453 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001454 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001455 if _WIFSIGNALED(sts):
1456 self.returncode = -_WTERMSIG(sts)
1457 elif _WIFEXITED(sts):
1458 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001459 else:
1460 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001461 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001462
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001463
Brett Cannon84df1e62010-05-14 00:33:40 +00001464 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001465 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001466 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001467 attribute.
1468
1469 This method is called by __del__, so it cannot reference anything
1470 outside of the local scope (nor can any methods it calls).
1471
1472 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001473 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001474 if not self._waitpid_lock.acquire(False):
1475 # Something else is busy calling waitpid. Don't allow two
1476 # at once. We know nothing yet.
1477 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001478 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001479 if self.returncode is not None:
1480 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001481 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001482 if pid == self.pid:
1483 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001484 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001485 if _deadstate is not None:
1486 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001487 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001488 # This happens if SIGCLD is set to be ignored or
1489 # waiting for child processes has otherwise been
1490 # disabled for our process. This child is dead, we
1491 # can't get the status.
1492 # http://bugs.python.org/issue15756
1493 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001494 finally:
1495 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001496 return self.returncode
1497
1498
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001499 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001500 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001501 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001502 (pid, sts) = os.waitpid(self.pid, wait_flags)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001503 except ChildProcessError:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001504 # This happens if SIGCLD is set to be ignored or waiting
1505 # for child processes has otherwise been disabled for our
1506 # process. This child is dead, we can't get the status.
1507 pid = self.pid
1508 sts = 0
1509 return (pid, sts)
1510
1511
1512 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001513 """Wait for child process to terminate. Returns returncode
1514 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001515 if self.returncode is not None:
1516 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001517
1518 # endtime is preferred to timeout. timeout is only used for
1519 # printing.
1520 if endtime is not None or timeout is not None:
1521 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001522 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001523 elif timeout is None:
1524 timeout = self._remaining_time(endtime)
1525
1526 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001527 # Enter a busy loop if we have a timeout. This busy loop was
1528 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1529 delay = 0.0005 # 500 us -> initial delay of 1 ms
1530 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001531 if self._waitpid_lock.acquire(False):
1532 try:
1533 if self.returncode is not None:
1534 break # Another thread waited.
1535 (pid, sts) = self._try_wait(os.WNOHANG)
1536 assert pid == self.pid or pid == 0
1537 if pid == self.pid:
1538 self._handle_exitstatus(sts)
1539 break
1540 finally:
1541 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001542 remaining = self._remaining_time(endtime)
1543 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001544 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001545 delay = min(delay * 2, remaining, .05)
1546 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001547 else:
1548 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001549 with self._waitpid_lock:
1550 if self.returncode is not None:
1551 break # Another thread waited.
1552 (pid, sts) = self._try_wait(0)
1553 # Check the pid and loop as waitpid has been known to
1554 # return 0 even without WNOHANG in odd situations.
1555 # http://bugs.python.org/issue14396.
1556 if pid == self.pid:
1557 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001558 return self.returncode
1559
1560
Reid Kleckner2b228f02011-03-16 16:57:54 -04001561 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001562 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001563 # Flush stdio buffer. This might block, if the user has
1564 # been writing to .stdin in an uncontrolled fashion.
1565 self.stdin.flush()
1566 if not input:
1567 self.stdin.close()
1568
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001569 stdout = None
1570 stderr = None
1571
1572 # Only create this mapping if we haven't already.
1573 if not self._communication_started:
1574 self._fileobj2output = {}
1575 if self.stdout:
1576 self._fileobj2output[self.stdout] = []
1577 if self.stderr:
1578 self._fileobj2output[self.stderr] = []
1579
1580 if self.stdout:
1581 stdout = self._fileobj2output[self.stdout]
1582 if self.stderr:
1583 stderr = self._fileobj2output[self.stderr]
1584
1585 self._save_input(input)
1586
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001587 if self._input:
1588 input_view = memoryview(self._input)
1589
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001590 with _PopenSelector() as selector:
1591 if self.stdin and input:
1592 selector.register(self.stdin, selectors.EVENT_WRITE)
1593 if self.stdout:
1594 selector.register(self.stdout, selectors.EVENT_READ)
1595 if self.stderr:
1596 selector.register(self.stderr, selectors.EVENT_READ)
1597
1598 while selector.get_map():
1599 timeout = self._remaining_time(endtime)
1600 if timeout is not None and timeout < 0:
1601 raise TimeoutExpired(self.args, orig_timeout)
1602
1603 ready = selector.select(timeout)
1604 self._check_timeout(endtime, orig_timeout)
1605
1606 # XXX Rewrite these to use non-blocking I/O on the file
1607 # objects; they are no longer using C stdio!
1608
1609 for key, events in ready:
1610 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001611 chunk = input_view[self._input_offset :
1612 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001613 try:
1614 self._input_offset += os.write(key.fd, chunk)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001615 except BrokenPipeError:
1616 selector.unregister(key.fileobj)
1617 key.fileobj.close()
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001618 else:
1619 if self._input_offset >= len(self._input):
1620 selector.unregister(key.fileobj)
1621 key.fileobj.close()
1622 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08001623 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001624 if not data:
1625 selector.unregister(key.fileobj)
1626 key.fileobj.close()
1627 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001628
1629 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001630
1631 # All data exchanged. Translate lists into strings.
1632 if stdout is not None:
1633 stdout = b''.join(stdout)
1634 if stderr is not None:
1635 stderr = b''.join(stderr)
1636
1637 # Translate newlines, if requested.
1638 # This also turns bytes into strings.
1639 if self.universal_newlines:
1640 if stdout is not None:
1641 stdout = self._translate_newlines(stdout,
1642 self.stdout.encoding)
1643 if stderr is not None:
1644 stderr = self._translate_newlines(stderr,
1645 self.stderr.encoding)
1646
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001647 return (stdout, stderr)
1648
1649
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001650 def _save_input(self, input):
1651 # This method is called from the _communicate_with_*() methods
1652 # so that if we time out while communicating, we can continue
1653 # sending input if we retry.
1654 if self.stdin and self._input is None:
1655 self._input_offset = 0
1656 self._input = input
1657 if self.universal_newlines and input is not None:
1658 self._input = self._input.encode(self.stdin.encoding)
1659
1660
Christian Heimesa342c012008-04-20 21:01:16 +00001661 def send_signal(self, sig):
1662 """Send a signal to the process
1663 """
1664 os.kill(self.pid, sig)
1665
1666 def terminate(self):
1667 """Terminate the process with SIGTERM
1668 """
1669 self.send_signal(signal.SIGTERM)
1670
1671 def kill(self):
1672 """Kill the process with SIGKILL
1673 """
1674 self.send_signal(signal.SIGKILL)