blob: e92928e9da9fba04440f5e4db3d616f039d6cd63 [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
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700359_mswindows = (sys.platform == "win32")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000360
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
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700402if _mswindows:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000403 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",
Gregory P. Smithace55862015-04-07 15:57:54 -0700436 "getoutput", "check_output", "CalledProcessError", "DEVNULL",
437 "SubprocessError", "TimeoutExpired"]
438 # NOTE: We intentionally exclude list2cmdline as it is
439 # considered an internal implementation detail. issue10838.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000440
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700441if _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
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200495# XXX This function is only used by multiprocessing and the test suite,
496# but it's here so that it can be imported when Python is compiled without
497# threads.
498
499def _args_from_interpreter_flags():
500 """Return a list of command-line arguments reproducing the current
501 settings in sys.flags and sys.warnoptions."""
502 flag_opt_map = {
503 'debug': 'd',
504 # 'inspect': 'i',
505 # 'interactive': 'i',
506 'optimize': 'O',
507 'dont_write_bytecode': 'B',
508 'no_user_site': 's',
509 'no_site': 'S',
510 'ignore_environment': 'E',
511 'verbose': 'v',
512 'bytes_warning': 'b',
513 'quiet': 'q',
514 'hash_randomization': 'R',
515 }
516 args = []
517 for flag, opt in flag_opt_map.items():
518 v = getattr(sys.flags, flag)
519 if v > 0:
Nick Coghlanac1a2482013-10-18 22:39:50 +1000520 if flag == 'hash_randomization':
521 v = 1 # Handle specification of an exact seed
Antoine Pitrouebdcd852012-05-18 18:33:07 +0200522 args.append('-' + opt * v)
523 for opt in sys.warnoptions:
524 args.append('-W' + opt)
525 return args
526
527
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400528def call(*popenargs, timeout=None, **kwargs):
529 """Run command with arguments. Wait for command to complete or
530 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000531
532 The arguments are the same as for the Popen constructor. Example:
533
534 retcode = call(["ls", "-l"])
535 """
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200536 with Popen(*popenargs, **kwargs) as p:
537 try:
538 return p.wait(timeout=timeout)
539 except:
540 p.kill()
541 p.wait()
542 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000543
544
Peter Astrand454f7672005-01-01 09:36:35 +0000545def check_call(*popenargs, **kwargs):
546 """Run command with arguments. Wait for command to complete. If
547 the exit code was zero then return, otherwise raise
548 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000549 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000550
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400551 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000552
553 check_call(["ls", "-l"])
554 """
555 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000556 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000557 cmd = kwargs.get("args")
558 if cmd is None:
559 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000560 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000561 return 0
562
563
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400564def check_output(*popenargs, timeout=None, **kwargs):
Gregory P. Smith91110f52013-03-19 23:25:16 -0700565 r"""Run command with arguments and return its output.
Georg Brandlf9734072008-12-07 15:30:06 +0000566
567 If the exit code was non-zero it raises a CalledProcessError. The
568 CalledProcessError object will have the return code in the returncode
569 attribute and output in the output attribute.
570
571 The arguments are the same as for the Popen constructor. Example:
572
573 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000574 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000575
576 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000577 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000578
579 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000580 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000581 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000582 b'ls: non_existent_file: No such file or directory\n'
Gregory P. Smith91110f52013-03-19 23:25:16 -0700583
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300584 There is an additional optional argument, "input", allowing you to
585 pass a string to the subprocess's stdin. If you use this argument
586 you may not also use the Popen constructor's "stdin" argument, as
587 it too will be used internally. Example:
588
589 >>> check_output(["sed", "-e", "s/foo/bar/"],
590 ... input=b"when in the course of fooman events\n")
591 b'when in the course of barman events\n'
592
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400593 If universal_newlines=True is passed, the "input" argument must be a
594 string and the return value will be a string rather than bytes.
Georg Brandlf9734072008-12-07 15:30:06 +0000595 """
596 if 'stdout' in kwargs:
597 raise ValueError('stdout argument not allowed, it will be overridden.')
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300598 if 'input' in kwargs:
599 if 'stdin' in kwargs:
600 raise ValueError('stdin and input arguments may not both be used.')
601 inputdata = kwargs['input']
602 del kwargs['input']
603 kwargs['stdin'] = PIPE
604 else:
605 inputdata = None
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200606 with Popen(*popenargs, stdout=PIPE, **kwargs) as process:
607 try:
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300608 output, unused_err = process.communicate(inputdata, timeout=timeout)
Victor Stinnerc15c88c2011-09-01 23:45:04 +0200609 except TimeoutExpired:
610 process.kill()
611 output, unused_err = process.communicate()
612 raise TimeoutExpired(process.args, timeout, output=output)
613 except:
614 process.kill()
615 process.wait()
616 raise
617 retcode = process.poll()
618 if retcode:
619 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000620 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000621
622
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000623def list2cmdline(seq):
624 """
625 Translate a sequence of arguments into a command line
626 string, using the same rules as the MS C runtime:
627
628 1) Arguments are delimited by white space, which is either a
629 space or a tab.
630
631 2) A string surrounded by double quotation marks is
632 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000633 contained within. A quoted string can be embedded in an
634 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000635
636 3) A double quotation mark preceded by a backslash is
637 interpreted as a literal double quotation mark.
638
639 4) Backslashes are interpreted literally, unless they
640 immediately precede a double quotation mark.
641
642 5) If backslashes immediately precede a double quotation mark,
643 every pair of backslashes is interpreted as a literal
644 backslash. If the number of backslashes is odd, the last
645 backslash escapes the next double quotation mark as
646 described in rule 3.
647 """
648
649 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000650 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
651 # or search http://msdn.microsoft.com for
652 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000653 result = []
654 needquote = False
655 for arg in seq:
656 bs_buf = []
657
658 # Add a space to separate this argument from the others
659 if result:
660 result.append(' ')
661
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000662 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000663 if needquote:
664 result.append('"')
665
666 for c in arg:
667 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000668 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000669 bs_buf.append(c)
670 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000671 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000672 result.append('\\' * len(bs_buf)*2)
673 bs_buf = []
674 result.append('\\"')
675 else:
676 # Normal char
677 if bs_buf:
678 result.extend(bs_buf)
679 bs_buf = []
680 result.append(c)
681
Christian Heimesfdab48e2008-01-20 09:06:41 +0000682 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000683 if bs_buf:
684 result.extend(bs_buf)
685
686 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000687 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000688 result.append('"')
689
690 return ''.join(result)
691
692
Brett Cannona23810f2008-05-26 19:04:21 +0000693# Various tools for executing commands and looking at their output and status.
694#
Brett Cannona23810f2008-05-26 19:04:21 +0000695
696def getstatusoutput(cmd):
Tim Golden60798142013-11-05 12:57:25 +0000697 """ Return (status, output) of executing cmd in a shell.
Brett Cannona23810f2008-05-26 19:04:21 +0000698
Tim Golden60798142013-11-05 12:57:25 +0000699 Execute the string 'cmd' in a shell with 'check_output' and
700 return a 2-tuple (status, output). Universal newlines mode is used,
701 meaning that the result with be decoded to a string.
702
703 A trailing newline is stripped from the output.
704 The exit status for the command can be interpreted
705 according to the rules for the function 'wait'. Example:
Brett Cannona23810f2008-05-26 19:04:21 +0000706
707 >>> import subprocess
708 >>> subprocess.getstatusoutput('ls /bin/ls')
709 (0, '/bin/ls')
710 >>> subprocess.getstatusoutput('cat /bin/junk')
711 (256, 'cat: /bin/junk: No such file or directory')
712 >>> subprocess.getstatusoutput('/bin/junk')
713 (256, 'sh: /bin/junk: not found')
714 """
Tim Goldene0041752013-11-03 12:53:17 +0000715 try:
716 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
717 status = 0
718 except CalledProcessError as ex:
719 data = ex.output
720 status = ex.returncode
721 if data[-1:] == '\n':
722 data = data[:-1]
723 return status, data
Brett Cannona23810f2008-05-26 19:04:21 +0000724
725def getoutput(cmd):
726 """Return output (stdout or stderr) of executing cmd in a shell.
727
728 Like getstatusoutput(), except the exit status is ignored and the return
729 value is a string containing the command's output. Example:
730
731 >>> import subprocess
732 >>> subprocess.getoutput('ls /bin/ls')
733 '/bin/ls'
734 """
735 return getstatusoutput(cmd)[1]
736
737
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000738_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000739
740
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000741class Popen(object):
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200742
743 _child_created = False # Set here since __del__ checks it
744
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700745 def __init__(self, args, bufsize=-1, executable=None,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000746 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000747 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
748 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000749 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000750 restore_signals=True, start_new_session=False,
751 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000752 """Create new Popen instance."""
753 _cleanup()
Gregory P. Smithd65ba512014-04-23 00:27:17 -0700754 # Held while anything is calling waitpid before returncode has been
755 # updated to prevent clobbering returncode if wait() or poll() are
756 # called from multiple threads at once. After acquiring the lock,
757 # code must re-check self.returncode to see if another thread just
758 # finished a waitpid() call.
759 self._waitpid_lock = threading.Lock()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000760
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400761 self._input = None
762 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000763 if bufsize is None:
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700764 bufsize = -1 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000765 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000766 raise TypeError("bufsize must be an integer")
767
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700768 if _mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000769 if preexec_fn is not None:
770 raise ValueError("preexec_fn is not supported on Windows "
771 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000772 any_stdio_set = (stdin is not None or stdout is not None or
773 stderr is not None)
774 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
775 if any_stdio_set:
776 close_fds = False
777 else:
778 close_fds = True
779 elif close_fds and any_stdio_set:
780 raise ValueError(
781 "close_fds is not supported on Windows platforms"
782 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000783 else:
784 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000785 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
786 close_fds = True
787 if pass_fds and not close_fds:
788 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
789 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000790 if startupinfo is not None:
791 raise ValueError("startupinfo is only supported on Windows "
792 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000793 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000794 raise ValueError("creationflags is only supported on Windows "
795 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000796
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400797 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000798 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000799 self.stdout = None
800 self.stderr = None
801 self.pid = None
802 self.returncode = None
803 self.universal_newlines = universal_newlines
804
805 # Input and output objects. The general principle is like
806 # this:
807 #
808 # Parent Child
809 # ------ -----
810 # p2cwrite ---stdin---> p2cread
811 # c2pread <--stdout--- c2pwrite
812 # errread <--stderr--- errwrite
813 #
814 # On POSIX, the child objects are file descriptors. On
815 # Windows, these are Windows file handles. The parent objects
816 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000817 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000818 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000819
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000820 (p2cread, p2cwrite,
821 c2pread, c2pwrite,
822 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
823
Antoine Pitrouc9982322011-01-04 19:07:07 +0000824 # We wrap OS handles *before* launching the child, otherwise a
825 # quickly terminating child could make our fds unwrappable
826 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000827
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -0700828 if _mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000829 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000830 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000831 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000832 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000833 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000834 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000835
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000836 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000837 self.stdin = io.open(p2cwrite, 'wb', bufsize)
Andrew Svetlov592df202012-08-15 17:36:15 +0300838 if universal_newlines:
Antoine Pitrouafe8d062014-09-21 21:10:56 +0200839 self.stdin = io.TextIOWrapper(self.stdin, write_through=True,
840 line_buffering=(bufsize == 1))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000841 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000842 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000843 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000844 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000845 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000846 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000847 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000848 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000849
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700850 self._closed_child_pipe_fds = False
Antoine Pitrouc9982322011-01-04 19:07:07 +0000851 try:
852 self._execute_child(args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +0300853 pass_fds, cwd, env,
Antoine Pitrouc9982322011-01-04 19:07:07 +0000854 startupinfo, creationflags, shell,
855 p2cread, p2cwrite,
856 c2pread, c2pwrite,
857 errread, errwrite,
858 restore_signals, start_new_session)
859 except:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800860 # Cleanup if the child failed starting.
861 for f in filter(None, (self.stdin, self.stdout, self.stderr)):
Antoine Pitrouc9982322011-01-04 19:07:07 +0000862 try:
863 f.close()
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200864 except OSError:
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800865 pass # Ignore EBADF or other errors.
866
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700867 if not self._closed_child_pipe_fds:
868 to_close = []
869 if stdin == PIPE:
870 to_close.append(p2cread)
871 if stdout == PIPE:
872 to_close.append(c2pwrite)
873 if stderr == PIPE:
874 to_close.append(errwrite)
875 if hasattr(self, '_devnull'):
876 to_close.append(self._devnull)
877 for fd in to_close:
878 try:
879 os.close(fd)
Gregory P. Smith22ba31a2013-06-15 18:14:56 -0700880 except OSError:
Gregory P. Smithb5461b92013-06-15 18:04:26 -0700881 pass
Gregory P. Smith3d8e7762012-11-10 22:32:22 -0800882
Antoine Pitrouc9982322011-01-04 19:07:07 +0000883 raise
884
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000885
Guido van Rossum98297ee2007-11-06 21:34:58 +0000886 def _translate_newlines(self, data, encoding):
Andrew Svetlov82860712012-08-19 22:13:41 +0300887 data = data.decode(encoding)
888 return data.replace("\r\n", "\n").replace("\r", "\n")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000889
Brian Curtin79cdb662010-12-03 02:46:02 +0000890 def __enter__(self):
891 return self
892
893 def __exit__(self, type, value, traceback):
894 if self.stdout:
895 self.stdout.close()
896 if self.stderr:
897 self.stderr.close()
Serhiy Storchakaab900c22015-02-28 12:43:08 +0200898 try: # Flushing a BufferedWriter may raise an error
899 if self.stdin:
900 self.stdin.close()
901 finally:
902 # Wait for the process to terminate, to avoid zombies.
903 self.wait()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000904
Serhiy Storchaka72e77612014-02-10 19:20:22 +0200905 def __del__(self, _maxsize=sys.maxsize):
906 if not self._child_created:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000907 # We didn't get to successfully create a child process.
908 return
909 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000910 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000911 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000912 # Child is still running, keep us alive until we can wait on it.
913 _active.append(self)
914
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200915 def _get_devnull(self):
916 if not hasattr(self, '_devnull'):
917 self._devnull = os.open(os.devnull, os.O_RDWR)
918 return self._devnull
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000919
Victor Stinnera5e881d2015-01-14 17:07:59 +0100920 def _stdin_write(self, input):
921 if input:
922 try:
923 self.stdin.write(input)
924 except BrokenPipeError:
925 # communicate() must ignore broken pipe error
926 pass
927 except OSError as e:
928 if e.errno == errno.EINVAL and self.poll() is not None:
929 # Issue #19612: On Windows, stdin.write() fails with EINVAL
930 # if the process already exited before the write
931 pass
932 else:
933 raise
934 self.stdin.close()
935
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400936 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000937 """Interact with process: Send data to stdin. Read data from
938 stdout and stderr, until end-of-file is reached. Wait for
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400939 process to terminate.
Tim Peterseba28be2005-03-28 01:08:02 +0000940
Andrew Kuchling4f7b0c32014-04-14 15:08:18 -0400941 The optional "input" argument should be data to be sent to the
942 child process (if self.universal_newlines is True, this should
943 be a string; if it is False, "input" should be bytes), or
944 None, if no data should be sent to the child.
945
946 communicate() returns a tuple (stdout, stderr). These will be
947 bytes or, if self.universal_newlines was True, a string.
948 """
Peter Astrand23109f02005-03-03 20:28:59 +0000949
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400950 if self._communication_started and input:
951 raise ValueError("Cannot send input after starting communication")
952
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400953 # Optimization: If we are not worried about timeouts, we haven't
954 # started communicating, and we have one or zero pipes, using select()
955 # or threads is unnecessary.
Victor Stinner7a8d0812011-04-05 13:13:08 +0200956 if (timeout is None and not self._communication_started and
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400957 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000958 stdout = None
959 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000960 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +0100961 self._stdin_write(input)
Peter Astrand23109f02005-03-03 20:28:59 +0000962 elif self.stdout:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000963 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000964 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000965 elif self.stderr:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000966 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000967 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000968 self.wait()
Victor Stinner7a8d0812011-04-05 13:13:08 +0200969 else:
970 if timeout is not None:
Victor Stinner949d8c92012-05-30 13:30:32 +0200971 endtime = _time() + timeout
Victor Stinner7a8d0812011-04-05 13:13:08 +0200972 else:
973 endtime = None
Tim Peterseba28be2005-03-28 01:08:02 +0000974
Victor Stinner7a8d0812011-04-05 13:13:08 +0200975 try:
976 stdout, stderr = self._communicate(input, endtime, timeout)
977 finally:
978 self._communication_started = True
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400979
Victor Stinner7a8d0812011-04-05 13:13:08 +0200980 sts = self.wait(timeout=self._remaining_time(endtime))
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400981
982 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000983
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000984
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000985 def poll(self):
986 return self._internal_poll()
987
988
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400989 def _remaining_time(self, endtime):
990 """Convenience for _communicate when computing timeouts."""
991 if endtime is None:
992 return None
993 else:
Victor Stinner949d8c92012-05-30 13:30:32 +0200994 return endtime - _time()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400995
996
Reid Kleckner2b228f02011-03-16 16:57:54 -0400997 def _check_timeout(self, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400998 """Convenience for checking if a timeout has expired."""
999 if endtime is None:
1000 return
Victor Stinner949d8c92012-05-30 13:30:32 +02001001 if _time() > endtime:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001002 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001003
1004
Gregory P. Smithcb6fdf22015-04-07 16:11:33 -07001005 if _mswindows:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001006 #
1007 # Windows methods
1008 #
1009 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001010 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001011 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1012 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001013 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001014 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +00001015
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001016 p2cread, p2cwrite = -1, -1
1017 c2pread, c2pwrite = -1, -1
1018 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001019
Peter Astrandd38ddf42005-02-10 08:32:50 +00001020 if stdin is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001021 p2cread = _winapi.GetStdHandle(_winapi.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001022 if p2cread is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001023 p2cread, _ = _winapi.CreatePipe(None, 0)
1024 p2cread = Handle(p2cread)
1025 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001026 elif stdin == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001027 p2cread, p2cwrite = _winapi.CreatePipe(None, 0)
1028 p2cread, p2cwrite = Handle(p2cread), Handle(p2cwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001029 elif stdin == DEVNULL:
1030 p2cread = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001031 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001032 p2cread = msvcrt.get_osfhandle(stdin)
1033 else:
1034 # Assuming file-like object
1035 p2cread = msvcrt.get_osfhandle(stdin.fileno())
1036 p2cread = self._make_inheritable(p2cread)
1037
Peter Astrandd38ddf42005-02-10 08:32:50 +00001038 if stdout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001039 c2pwrite = _winapi.GetStdHandle(_winapi.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001040 if c2pwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001041 _, c2pwrite = _winapi.CreatePipe(None, 0)
1042 c2pwrite = Handle(c2pwrite)
1043 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001044 elif stdout == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001045 c2pread, c2pwrite = _winapi.CreatePipe(None, 0)
1046 c2pread, c2pwrite = Handle(c2pread), Handle(c2pwrite)
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001047 elif stdout == DEVNULL:
1048 c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001049 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001050 c2pwrite = msvcrt.get_osfhandle(stdout)
1051 else:
1052 # Assuming file-like object
1053 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
1054 c2pwrite = self._make_inheritable(c2pwrite)
1055
Peter Astrandd38ddf42005-02-10 08:32:50 +00001056 if stderr is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001057 errwrite = _winapi.GetStdHandle(_winapi.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001058 if errwrite is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001059 _, errwrite = _winapi.CreatePipe(None, 0)
1060 errwrite = Handle(errwrite)
1061 _winapi.CloseHandle(_)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +00001062 elif stderr == PIPE:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001063 errread, errwrite = _winapi.CreatePipe(None, 0)
1064 errread, errwrite = Handle(errread), Handle(errwrite)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001065 elif stderr == STDOUT:
1066 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001067 elif stderr == DEVNULL:
1068 errwrite = msvcrt.get_osfhandle(self._get_devnull())
Peter Astrandd38ddf42005-02-10 08:32:50 +00001069 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001070 errwrite = msvcrt.get_osfhandle(stderr)
1071 else:
1072 # Assuming file-like object
1073 errwrite = msvcrt.get_osfhandle(stderr.fileno())
1074 errwrite = self._make_inheritable(errwrite)
1075
1076 return (p2cread, p2cwrite,
1077 c2pread, c2pwrite,
1078 errread, errwrite)
1079
1080
1081 def _make_inheritable(self, handle):
1082 """Return a duplicate of handle, which is inheritable"""
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001083 h = _winapi.DuplicateHandle(
1084 _winapi.GetCurrentProcess(), handle,
1085 _winapi.GetCurrentProcess(), 0, 1,
1086 _winapi.DUPLICATE_SAME_ACCESS)
1087 return Handle(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001088
1089
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001090 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001091 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001092 startupinfo, creationflags, shell,
1093 p2cread, p2cwrite,
1094 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001095 errread, errwrite,
1096 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001097 """Execute program (MS Windows version)"""
1098
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001099 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001100
Guido van Rossum3172c5d2007-10-16 18:12:55 +00001101 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001102 args = list2cmdline(args)
1103
Peter Astrandc1d65362004-11-07 14:30:34 +00001104 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +00001105 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001106 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +00001107 if -1 not in (p2cread, c2pwrite, errwrite):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001108 startupinfo.dwFlags |= _winapi.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +00001109 startupinfo.hStdInput = p2cread
1110 startupinfo.hStdOutput = c2pwrite
1111 startupinfo.hStdError = errwrite
1112
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001113 if shell:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001114 startupinfo.dwFlags |= _winapi.STARTF_USESHOWWINDOW
1115 startupinfo.wShowWindow = _winapi.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001116 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +00001117 args = '{} /c "{}"'.format (comspec, args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001118
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001119 # Start the process
1120 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001121 hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +00001122 # no special security
1123 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001124 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001125 creationflags,
1126 env,
1127 cwd,
1128 startupinfo)
Tim Goldenad537f22010-08-08 11:18:16 +00001129 finally:
1130 # Child is launched. Close the parent's copy of those pipe
1131 # handles that only the child should have open. You need
1132 # to make sure that no handles to the write end of the
1133 # output pipe are maintained in this process or else the
1134 # pipe will not close when the child process exits and the
1135 # ReadFile will hang.
1136 if p2cread != -1:
1137 p2cread.Close()
1138 if c2pwrite != -1:
1139 c2pwrite.Close()
1140 if errwrite != -1:
1141 errwrite.Close()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001142 if hasattr(self, '_devnull'):
1143 os.close(self._devnull)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001144
1145 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001146 self._child_created = True
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001147 self._handle = Handle(hp)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001148 self.pid = pid
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001149 _winapi.CloseHandle(ht)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001150
Brett Cannon84df1e62010-05-14 00:33:40 +00001151 def _internal_poll(self, _deadstate=None,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001152 _WaitForSingleObject=_winapi.WaitForSingleObject,
1153 _WAIT_OBJECT_0=_winapi.WAIT_OBJECT_0,
1154 _GetExitCodeProcess=_winapi.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001155 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001156 attribute.
1157
1158 This method is called by __del__, so it can only refer to objects
1159 in its local scope.
1160
1161 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001162 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001163 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1164 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001165 return self.returncode
1166
1167
Reid Kleckner2b228f02011-03-16 16:57:54 -04001168 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001169 """Wait for child process to terminate. Returns returncode
1170 attribute."""
Reid Kleckner2b228f02011-03-16 16:57:54 -04001171 if endtime is not None:
1172 timeout = self._remaining_time(endtime)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001173 if timeout is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001174 timeout_millis = _winapi.INFINITE
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001175 else:
Reid Kleckner91156ff2011-03-21 10:06:10 -07001176 timeout_millis = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001177 if self.returncode is None:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001178 result = _winapi.WaitForSingleObject(self._handle,
1179 timeout_millis)
1180 if result == _winapi.WAIT_TIMEOUT:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001181 raise TimeoutExpired(self.args, timeout)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001182 self.returncode = _winapi.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001183 return self.returncode
1184
1185
1186 def _readerthread(self, fh, buffer):
1187 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001188 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001189
1190
Reid Kleckner2b228f02011-03-16 16:57:54 -04001191 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001192 # Start reader threads feeding into a list hanging off of this
1193 # object, unless they've already been started.
1194 if self.stdout and not hasattr(self, "_stdout_buff"):
1195 self._stdout_buff = []
1196 self.stdout_thread = \
1197 threading.Thread(target=self._readerthread,
1198 args=(self.stdout, self._stdout_buff))
1199 self.stdout_thread.daemon = True
1200 self.stdout_thread.start()
1201 if self.stderr and not hasattr(self, "_stderr_buff"):
1202 self._stderr_buff = []
1203 self.stderr_thread = \
1204 threading.Thread(target=self._readerthread,
1205 args=(self.stderr, self._stderr_buff))
1206 self.stderr_thread.daemon = True
1207 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001208
1209 if self.stdin:
Victor Stinnera5e881d2015-01-14 17:07:59 +01001210 self._stdin_write(input)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001211
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001212 # Wait for the reader threads, or time out. If we time out, the
1213 # threads remain reading and the fds left open in case the user
1214 # calls communicate again.
1215 if self.stdout is not None:
1216 self.stdout_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001217 if self.stdout_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001218 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001219 if self.stderr is not None:
1220 self.stderr_thread.join(self._remaining_time(endtime))
Andrew Svetlov377a1522012-08-19 20:49:39 +03001221 if self.stderr_thread.is_alive():
Reid Kleckner9a67e6c2011-03-20 08:28:07 -07001222 raise TimeoutExpired(self.args, orig_timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001223
1224 # Collect the output from and close both pipes, now that we know
1225 # both have been read successfully.
1226 stdout = None
1227 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001228 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001229 stdout = self._stdout_buff
1230 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001231 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001232 stderr = self._stderr_buff
1233 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001234
1235 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001236 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001237 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001238 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001239 stderr = stderr[0]
1240
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001241 return (stdout, stderr)
1242
Christian Heimesa342c012008-04-20 21:01:16 +00001243 def send_signal(self, sig):
1244 """Send a signal to the process
1245 """
1246 if sig == signal.SIGTERM:
1247 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001248 elif sig == signal.CTRL_C_EVENT:
1249 os.kill(self.pid, signal.CTRL_C_EVENT)
1250 elif sig == signal.CTRL_BREAK_EVENT:
1251 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001252 else:
Brian Curtin19651362010-09-07 13:24:38 +00001253 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001254
1255 def terminate(self):
1256 """Terminates the process
1257 """
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001258 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001259 _winapi.TerminateProcess(self._handle, 1)
Antoine Pitroub69ef162012-03-11 19:33:29 +01001260 except PermissionError:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001261 # ERROR_ACCESS_DENIED (winerror 5) is received when the
1262 # process already died.
Antoine Pitrou23bba4c2012-04-18 20:51:15 +02001263 rc = _winapi.GetExitCodeProcess(self._handle)
1264 if rc == _winapi.STILL_ACTIVE:
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001265 raise
1266 self.returncode = rc
Christian Heimesa342c012008-04-20 21:01:16 +00001267
1268 kill = terminate
1269
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001270 else:
1271 #
1272 # POSIX methods
1273 #
1274 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001275 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001276 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1277 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001278 p2cread, p2cwrite = -1, -1
1279 c2pread, c2pwrite = -1, -1
1280 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001281
Peter Astrandd38ddf42005-02-10 08:32:50 +00001282 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001283 pass
1284 elif stdin == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001285 p2cread, p2cwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001286 elif stdin == DEVNULL:
1287 p2cread = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001288 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001289 p2cread = stdin
1290 else:
1291 # Assuming file-like object
1292 p2cread = stdin.fileno()
1293
Peter Astrandd38ddf42005-02-10 08:32:50 +00001294 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001295 pass
1296 elif stdout == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001297 c2pread, c2pwrite = os.pipe()
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001298 elif stdout == DEVNULL:
1299 c2pwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001300 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001301 c2pwrite = stdout
1302 else:
1303 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001304 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001305
Peter Astrandd38ddf42005-02-10 08:32:50 +00001306 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001307 pass
1308 elif stderr == PIPE:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001309 errread, errwrite = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001310 elif stderr == STDOUT:
1311 errwrite = c2pwrite
Ross Lagerwallba102ec2011-03-16 18:40:25 +02001312 elif stderr == DEVNULL:
1313 errwrite = self._get_devnull()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001314 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001315 errwrite = stderr
1316 else:
1317 # Assuming file-like object
1318 errwrite = stderr.fileno()
1319
1320 return (p2cread, p2cwrite,
1321 c2pread, c2pwrite,
1322 errread, errwrite)
1323
1324
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001325 def _execute_child(self, args, executable, preexec_fn, close_fds,
Andrew Svetlov592df202012-08-15 17:36:15 +03001326 pass_fds, cwd, env,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001327 startupinfo, creationflags, shell,
1328 p2cread, p2cwrite,
1329 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001330 errread, errwrite,
1331 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001332 """Execute program (POSIX version)"""
1333
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001334 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001335 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001336 else:
1337 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001338
1339 if shell:
1340 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001341 if executable:
1342 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001343
Peter Astrandd38ddf42005-02-10 08:32:50 +00001344 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001345 executable = args[0]
Gregory P. Smith5591b022012-10-10 03:34:47 -07001346 orig_executable = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001347
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001348 # For transferring possible exec failure from child to parent.
1349 # Data format: "exception name:hex errno:description"
1350 # Pickle is not used; it is complex and involves memory allocation.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001351 errpipe_read, errpipe_write = os.pipe()
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001352 # errpipe_write must not be in the standard io 0, 1, or 2 fd range.
1353 low_fds_to_close = []
1354 while errpipe_write < 3:
1355 low_fds_to_close.append(errpipe_write)
1356 errpipe_write = os.dup(errpipe_write)
1357 for low_fd in low_fds_to_close:
1358 os.close(low_fd)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001359 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001360 try:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001361 # We must avoid complex work that could involve
1362 # malloc or free in the child process to avoid
1363 # potential deadlocks, thus we do all this here.
1364 # and pass it to fork_exec()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001365
Victor Stinner372b8382011-06-21 17:24:21 +02001366 if env is not None:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001367 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
1368 for k, v in env.items()]
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001369 else:
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001370 env_list = None # Use execv instead of execve.
1371 executable = os.fsencode(executable)
1372 if os.path.dirname(executable):
1373 executable_list = (executable,)
1374 else:
1375 # This matches the behavior of os._execvpe().
1376 executable_list = tuple(
1377 os.path.join(os.fsencode(dir), executable)
1378 for dir in os.get_exec_path(env))
Gregory P. Smith361e30c2013-12-01 00:12:24 -08001379 fds_to_keep = set(pass_fds)
Gregory P. Smith59fd1bf2011-05-28 09:32:39 -07001380 fds_to_keep.add(errpipe_write)
1381 self.pid = _posixsubprocess.fork_exec(
1382 args, executable_list,
1383 close_fds, sorted(fds_to_keep), cwd, env_list,
1384 p2cread, p2cwrite, c2pread, c2pwrite,
1385 errread, errwrite,
1386 errpipe_read, errpipe_write,
1387 restore_signals, start_new_session, preexec_fn)
Charles-François Natali558639f2011-08-18 19:11:29 +02001388 self._child_created = True
Facundo Batista10706e22009-06-19 20:34:30 +00001389 finally:
1390 # be sure the FD is closed no matter what
1391 os.close(errpipe_write)
1392
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001393 # self._devnull is not always defined.
1394 devnull_fd = getattr(self, '_devnull', None)
1395 if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001396 os.close(p2cread)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001397 if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001398 os.close(c2pwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001399 if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
Facundo Batista10706e22009-06-19 20:34:30 +00001400 os.close(errwrite)
Gregory P. Smithb5461b92013-06-15 18:04:26 -07001401 if devnull_fd is not None:
1402 os.close(devnull_fd)
1403 # Prevent a double close of these fds from __init__ on error.
1404 self._closed_child_pipe_fds = True
Facundo Batista10706e22009-06-19 20:34:30 +00001405
1406 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001407 # exception (limited in size)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001408 errpipe_data = bytearray()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001409 while True:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001410 part = os.read(errpipe_read, 50000)
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001411 errpipe_data += part
1412 if not part or len(errpipe_data) > 50000:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001413 break
Facundo Batista10706e22009-06-19 20:34:30 +00001414 finally:
1415 # be sure the FD is closed no matter what
1416 os.close(errpipe_read)
1417
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001418 if errpipe_data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001419 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001420 os.waitpid(self.pid, 0)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001421 except ChildProcessError:
1422 pass
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001423 try:
Gregory P. Smithf44c9da2012-11-10 23:33:17 -08001424 exception_name, hex_errno, err_msg = (
1425 errpipe_data.split(b':', 2))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001426 except ValueError:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001427 exception_name = b'SubprocessError'
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001428 hex_errno = b'0'
Gregory P. Smith3aee2222012-11-11 00:04:13 -08001429 err_msg = (b'Bad exception data from child: ' +
1430 repr(errpipe_data))
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001431 child_exception_type = getattr(
1432 builtins, exception_name.decode('ascii'),
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001433 SubprocessError)
Victor Stinner4d078042010-04-23 19:28:32 +00001434 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001435 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001436 errno_num = int(hex_errno, 16)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001437 child_exec_never_called = (err_msg == "noexec")
1438 if child_exec_never_called:
1439 err_msg = ""
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001440 if errno_num != 0:
1441 err_msg = os.strerror(errno_num)
1442 if errno_num == errno.ENOENT:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001443 if child_exec_never_called:
1444 # The error must be from chdir(cwd).
1445 err_msg += ': ' + repr(cwd)
1446 else:
1447 err_msg += ': ' + repr(orig_executable)
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001448 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001449 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001450
1451
Brett Cannon84df1e62010-05-14 00:33:40 +00001452 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1453 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1454 _WEXITSTATUS=os.WEXITSTATUS):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001455 """All callers to this function MUST hold self._waitpid_lock."""
Brett Cannon84df1e62010-05-14 00:33:40 +00001456 # This method is called (indirectly) by __del__, so it cannot
Serhiy Storchaka72e77612014-02-10 19:20:22 +02001457 # refer to anything outside of its local scope.
Brett Cannon84df1e62010-05-14 00:33:40 +00001458 if _WIFSIGNALED(sts):
1459 self.returncode = -_WTERMSIG(sts)
1460 elif _WIFEXITED(sts):
1461 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001462 else:
1463 # Should never happen
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001464 raise SubprocessError("Unknown child exit status!")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001465
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001466
Brett Cannon84df1e62010-05-14 00:33:40 +00001467 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
Andrew Svetlov1d960fe2012-12-24 20:08:53 +02001468 _WNOHANG=os.WNOHANG, _ECHILD=errno.ECHILD):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001469 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001470 attribute.
1471
1472 This method is called by __del__, so it cannot reference anything
1473 outside of the local scope (nor can any methods it calls).
1474
1475 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001476 if self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001477 if not self._waitpid_lock.acquire(False):
1478 # Something else is busy calling waitpid. Don't allow two
1479 # at once. We know nothing yet.
1480 return None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001481 try:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001482 if self.returncode is not None:
1483 return self.returncode # Another thread waited.
Brett Cannon84df1e62010-05-14 00:33:40 +00001484 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001485 if pid == self.pid:
1486 self._handle_exitstatus(sts)
Andrew Svetlovad28c7f2012-12-18 22:02:39 +02001487 except OSError as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001488 if _deadstate is not None:
1489 self.returncode = _deadstate
Andrew Svetlov08bab072012-12-24 20:06:35 +02001490 elif e.errno == _ECHILD:
Gregory P. Smith39051712012-09-29 11:40:38 -07001491 # This happens if SIGCLD is set to be ignored or
1492 # waiting for child processes has otherwise been
1493 # disabled for our process. This child is dead, we
1494 # can't get the status.
1495 # http://bugs.python.org/issue15756
1496 self.returncode = 0
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001497 finally:
1498 self._waitpid_lock.release()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001499 return self.returncode
1500
1501
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001502 def _try_wait(self, wait_flags):
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001503 """All callers to this function MUST hold self._waitpid_lock."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001504 try:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001505 (pid, sts) = os.waitpid(self.pid, wait_flags)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001506 except ChildProcessError:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001507 # This happens if SIGCLD is set to be ignored or waiting
1508 # for child processes has otherwise been disabled for our
1509 # process. This child is dead, we can't get the status.
1510 pid = self.pid
1511 sts = 0
1512 return (pid, sts)
1513
1514
1515 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001516 """Wait for child process to terminate. Returns returncode
1517 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001518 if self.returncode is not None:
1519 return self.returncode
Reid Kleckner2b228f02011-03-16 16:57:54 -04001520
1521 # endtime is preferred to timeout. timeout is only used for
1522 # printing.
1523 if endtime is not None or timeout is not None:
1524 if endtime is None:
Victor Stinner949d8c92012-05-30 13:30:32 +02001525 endtime = _time() + timeout
Reid Kleckner2b228f02011-03-16 16:57:54 -04001526 elif timeout is None:
1527 timeout = self._remaining_time(endtime)
1528
1529 if endtime is not None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001530 # Enter a busy loop if we have a timeout. This busy loop was
1531 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1532 delay = 0.0005 # 500 us -> initial delay of 1 ms
1533 while True:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001534 if self._waitpid_lock.acquire(False):
1535 try:
1536 if self.returncode is not None:
1537 break # Another thread waited.
1538 (pid, sts) = self._try_wait(os.WNOHANG)
1539 assert pid == self.pid or pid == 0
1540 if pid == self.pid:
1541 self._handle_exitstatus(sts)
1542 break
1543 finally:
1544 self._waitpid_lock.release()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001545 remaining = self._remaining_time(endtime)
1546 if remaining <= 0:
Reid Kleckner2b228f02011-03-16 16:57:54 -04001547 raise TimeoutExpired(self.args, timeout)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001548 delay = min(delay * 2, remaining, .05)
1549 time.sleep(delay)
Gregory P. Smithf328d792012-11-10 21:06:18 -08001550 else:
1551 while self.returncode is None:
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001552 with self._waitpid_lock:
1553 if self.returncode is not None:
1554 break # Another thread waited.
1555 (pid, sts) = self._try_wait(0)
1556 # Check the pid and loop as waitpid has been known to
1557 # return 0 even without WNOHANG in odd situations.
1558 # http://bugs.python.org/issue14396.
1559 if pid == self.pid:
1560 self._handle_exitstatus(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001561 return self.returncode
1562
1563
Reid Kleckner2b228f02011-03-16 16:57:54 -04001564 def _communicate(self, input, endtime, orig_timeout):
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001565 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001566 # Flush stdio buffer. This might block, if the user has
1567 # been writing to .stdin in an uncontrolled fashion.
1568 self.stdin.flush()
1569 if not input:
1570 self.stdin.close()
1571
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001572 stdout = None
1573 stderr = None
1574
1575 # Only create this mapping if we haven't already.
1576 if not self._communication_started:
1577 self._fileobj2output = {}
1578 if self.stdout:
1579 self._fileobj2output[self.stdout] = []
1580 if self.stderr:
1581 self._fileobj2output[self.stderr] = []
1582
1583 if self.stdout:
1584 stdout = self._fileobj2output[self.stdout]
1585 if self.stderr:
1586 stderr = self._fileobj2output[self.stderr]
1587
1588 self._save_input(input)
1589
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001590 if self._input:
1591 input_view = memoryview(self._input)
1592
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001593 with _PopenSelector() as selector:
1594 if self.stdin and input:
1595 selector.register(self.stdin, selectors.EVENT_WRITE)
1596 if self.stdout:
1597 selector.register(self.stdout, selectors.EVENT_READ)
1598 if self.stderr:
1599 selector.register(self.stderr, selectors.EVENT_READ)
1600
1601 while selector.get_map():
1602 timeout = self._remaining_time(endtime)
1603 if timeout is not None and timeout < 0:
1604 raise TimeoutExpired(self.args, orig_timeout)
1605
1606 ready = selector.select(timeout)
1607 self._check_timeout(endtime, orig_timeout)
1608
1609 # XXX Rewrite these to use non-blocking I/O on the file
1610 # objects; they are no longer using C stdio!
1611
1612 for key, events in ready:
1613 if key.fileobj is self.stdin:
Gregory P. Smith5ca129b2013-12-07 19:14:59 -08001614 chunk = input_view[self._input_offset :
1615 self._input_offset + _PIPE_BUF]
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001616 try:
1617 self._input_offset += os.write(key.fd, chunk)
Victor Stinnera5e881d2015-01-14 17:07:59 +01001618 except BrokenPipeError:
1619 selector.unregister(key.fileobj)
1620 key.fileobj.close()
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001621 else:
1622 if self._input_offset >= len(self._input):
1623 selector.unregister(key.fileobj)
1624 key.fileobj.close()
1625 elif key.fileobj in (self.stdout, self.stderr):
Gregory P. Smith7b83b182013-12-08 10:58:28 -08001626 data = os.read(key.fd, 32768)
Charles-François Natali3a4586a2013-11-08 19:56:59 +01001627 if not data:
1628 selector.unregister(key.fileobj)
1629 key.fileobj.close()
1630 self._fileobj2output[key.fileobj].append(data)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001631
1632 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001633
1634 # All data exchanged. Translate lists into strings.
1635 if stdout is not None:
1636 stdout = b''.join(stdout)
1637 if stderr is not None:
1638 stderr = b''.join(stderr)
1639
1640 # Translate newlines, if requested.
1641 # This also turns bytes into strings.
1642 if self.universal_newlines:
1643 if stdout is not None:
1644 stdout = self._translate_newlines(stdout,
1645 self.stdout.encoding)
1646 if stderr is not None:
1647 stderr = self._translate_newlines(stderr,
1648 self.stderr.encoding)
1649
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001650 return (stdout, stderr)
1651
1652
Andrew Svetlovaa0dbdc2012-08-14 18:40:21 +03001653 def _save_input(self, input):
1654 # This method is called from the _communicate_with_*() methods
1655 # so that if we time out while communicating, we can continue
1656 # sending input if we retry.
1657 if self.stdin and self._input is None:
1658 self._input_offset = 0
1659 self._input = input
1660 if self.universal_newlines and input is not None:
1661 self._input = self._input.encode(self.stdin.encoding)
1662
1663
Christian Heimesa342c012008-04-20 21:01:16 +00001664 def send_signal(self, sig):
1665 """Send a signal to the process
1666 """
1667 os.kill(self.pid, sig)
1668
1669 def terminate(self):
1670 """Terminate the process with SIGTERM
1671 """
1672 self.send_signal(signal.SIGTERM)
1673
1674 def kill(self):
1675 """Kill the process with SIGKILL
1676 """
1677 self.send_signal(signal.SIGKILL)