blob: c8af5d16b9b7046ddb50e945a7e315900565d9e4 [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001# subprocess - Subprocesses with accessible I/O streams
2#
Tim Peterse718f612004-10-12 21:51:32 +00003# For more information about this module, see PEP 324.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00004#
Peter Astrand3a708df2005-09-23 17:37:29 +00005# Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00006#
Peter Astrand69bf13f2005-02-14 08:56:32 +00007# Licensed to PSF under a Contributor Agreement.
Peter Astrand3a708df2005-09-23 17:37:29 +00008# See http://www.python.org/2.4/license for licensing details.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009
Raymond Hettinger837dd932004-10-17 16:36:53 +000010r"""subprocess - Subprocesses with accessible I/O streams
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000011
Fredrik Lundh15aaacc2004-10-17 14:47:05 +000012This module allows you to spawn processes, connect to their
13input/output/error pipes, and obtain their return codes. This module
14intends to replace several other, older modules and functions, like:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000015
16os.system
17os.spawn*
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000018
19Information about how the subprocess module can be used to replace these
20modules and functions can be found below.
21
22
23
24Using the subprocess module
25===========================
26This module defines one class called Popen:
27
28class Popen(args, bufsize=0, executable=None,
29 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000030 preexec_fn=None, close_fds=True, shell=False,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000031 cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000032 startupinfo=None, creationflags=0,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000033 restore_signals=True, start_new_session=False, pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000034
35
36Arguments are:
37
38args should be a string, or a sequence of program arguments. The
39program to execute is normally the first item in the args sequence or
40string, but can be explicitly set by using the executable argument.
41
Gregory P. Smithf5604852010-12-13 06:45:02 +000042On POSIX, with shell=False (default): In this case, the Popen class
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000043uses os.execvp() to execute the child program. args should normally
44be a sequence. A string will be treated as a sequence with the string
45as the only item (the program to execute).
46
Gregory P. Smithf5604852010-12-13 06:45:02 +000047On POSIX, with shell=True: If args is a string, it specifies the
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000048command string to execute through the shell. If args is a sequence,
49the first item specifies the command string, and any additional items
50will be treated as additional shell arguments.
51
52On Windows: the Popen class uses CreateProcess() to execute the child
53program, which operates on strings. If args is a sequence, it will be
54converted to a string using the list2cmdline method. Please note that
55not all MS Windows applications interpret the command line the same
56way: The list2cmdline is designed for applications using the same
57rules as the MS C runtime.
58
59bufsize, if given, has the same meaning as the corresponding argument
60to the built-in open() function: 0 means unbuffered, 1 means line
61buffered, any other positive value means use a buffer of
62(approximately) that size. A negative bufsize means to use the system
63default, which usually means fully buffered. The default value for
64bufsize is 0 (unbuffered).
65
66stdin, stdout and stderr specify the executed programs' standard
67input, standard output and standard error file handles, respectively.
68Valid values are PIPE, an existing file descriptor (a positive
69integer), an existing file object, and None. PIPE indicates that a
70new pipe to the child should be created. With None, no redirection
71will occur; the child's file handles will be inherited from the
72parent. Additionally, stderr can be STDOUT, which indicates that the
73stderr data from the applications should be captured into the same
74file handle as for stdout.
75
Gregory P. Smithf5604852010-12-13 06:45:02 +000076On POSIX, if preexec_fn is set to a callable object, this object will be
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000077called in the child process just before the child is executed. The use
78of preexec_fn is not thread safe, using it in the presence of threads
79could lead to a deadlock in the child process before the new executable
80is executed.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000081
82If close_fds is true, all file descriptors except 0, 1 and 2 will be
Gregory P. Smithf5604852010-12-13 06:45:02 +000083closed before the child process is executed. The default for close_fds
Gregory P. Smith8edd99d2010-12-14 13:43:30 +000084varies by platform: Always true on POSIX. True when stdin/stdout/stderr
85are None on Windows, false otherwise.
86
87pass_fds is an optional sequence of file descriptors to keep open between the
88parent and child. Providing any pass_fds implicitly sets close_fds to true.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000089
90if shell is true, the specified command will be executed through the
91shell.
92
93If cwd is not None, the current directory will be changed to cwd
94before the child is executed.
95
Gregory P. Smithf5604852010-12-13 06:45:02 +000096On POSIX, if restore_signals is True all signals that Python sets to
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +000097SIG_IGN are restored to SIG_DFL in the child process before the exec.
98Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. This
99parameter does nothing on Windows.
100
Gregory P. Smithf5604852010-12-13 06:45:02 +0000101On POSIX, if start_new_session is True, the setsid() system call will be made
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000102in the child process prior to executing the command.
103
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000104If env is not None, it defines the environment variables for the new
105process.
106
107If universal_newlines is true, the file objects stdout and stderr are
108opened as a text files, but lines may be terminated by any of '\n',
Gregory P. Smithf5604852010-12-13 06:45:02 +0000109the Unix end-of-line convention, '\r', the old Macintosh convention or
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000110'\r\n', the Windows convention. All of these external representations
111are seen as '\n' by the Python program. Note: This feature is only
112available if Python is built with universal newline support (the
113default). Also, the newlines attribute of the file objects stdout,
114stdin and stderr are not updated by the communicate() method.
115
116The startupinfo and creationflags, if given, will be passed to the
117underlying CreateProcess() function. They can specify things such as
118appearance of the main window and priority for the new process.
119(Windows only)
120
121
Georg Brandlf9734072008-12-07 15:30:06 +0000122This module also defines some shortcut functions:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000123
Peter Astrand5f5e1412004-12-05 20:15:36 +0000124call(*popenargs, **kwargs):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125 Run command with arguments. Wait for command to complete, then
126 return the returncode attribute.
127
128 The arguments are the same as for the Popen constructor. Example:
129
Florent Xicluna4886d242010-03-08 13:27:26 +0000130 >>> retcode = subprocess.call(["ls", "-l"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131
Peter Astrand454f7672005-01-01 09:36:35 +0000132check_call(*popenargs, **kwargs):
133 Run command with arguments. Wait for command to complete. If the
134 exit code was zero then return, otherwise raise
135 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000136 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000137
138 The arguments are the same as for the Popen constructor. Example:
139
Florent Xicluna4886d242010-03-08 13:27:26 +0000140 >>> subprocess.check_call(["ls", "-l"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000141 0
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000142
Brett Cannona23810f2008-05-26 19:04:21 +0000143getstatusoutput(cmd):
144 Return (status, output) of executing cmd in a shell.
145
146 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
147 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
148 returned output will contain output or error messages. A trailing newline
149 is stripped from the output. The exit status for the command can be
150 interpreted according to the rules for the C function wait(). Example:
151
Brett Cannona23810f2008-05-26 19:04:21 +0000152 >>> subprocess.getstatusoutput('ls /bin/ls')
153 (0, '/bin/ls')
154 >>> subprocess.getstatusoutput('cat /bin/junk')
155 (256, 'cat: /bin/junk: No such file or directory')
156 >>> subprocess.getstatusoutput('/bin/junk')
157 (256, 'sh: /bin/junk: not found')
158
159getoutput(cmd):
160 Return output (stdout or stderr) of executing cmd in a shell.
161
162 Like getstatusoutput(), except the exit status is ignored and the return
163 value is a string containing the command's output. Example:
164
Brett Cannona23810f2008-05-26 19:04:21 +0000165 >>> subprocess.getoutput('ls /bin/ls')
166 '/bin/ls'
167
Georg Brandlf9734072008-12-07 15:30:06 +0000168check_output(*popenargs, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000169 Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000170
Georg Brandl2708f3a2009-12-20 14:38:23 +0000171 If the exit code was non-zero it raises a CalledProcessError. The
172 CalledProcessError object will have the return code in the returncode
173 attribute and output in the output attribute.
Georg Brandlf9734072008-12-07 15:30:06 +0000174
Georg Brandl2708f3a2009-12-20 14:38:23 +0000175 The arguments are the same as for the Popen constructor. Example:
Georg Brandlf9734072008-12-07 15:30:06 +0000176
Georg Brandl2708f3a2009-12-20 14:38:23 +0000177 >>> output = subprocess.check_output(["ls", "-l", "/dev/null"])
Georg Brandlf9734072008-12-07 15:30:06 +0000178
Brett Cannona23810f2008-05-26 19:04:21 +0000179
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000180Exceptions
181----------
182Exceptions raised in the child process, before the new program has
183started to execute, will be re-raised in the parent. Additionally,
184the exception object will have one extra attribute called
185'child_traceback', which is a string containing traceback information
186from the childs point of view.
187
188The most common exception raised is OSError. This occurs, for
189example, when trying to execute a non-existent file. Applications
190should prepare for OSErrors.
191
192A ValueError will be raised if Popen is called with invalid arguments.
193
Georg Brandlf9734072008-12-07 15:30:06 +0000194check_call() and check_output() will raise CalledProcessError, if the
195called process returns a non-zero return code.
Peter Astrand454f7672005-01-01 09:36:35 +0000196
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000197
198Security
199--------
200Unlike some other popen functions, this implementation will never call
201/bin/sh implicitly. This means that all characters, including shell
202metacharacters, can safely be passed to child processes.
203
204
205Popen objects
206=============
207Instances of the Popen class have the following methods:
208
209poll()
210 Check if child process has terminated. Returns returncode
211 attribute.
212
213wait()
214 Wait for child process to terminate. Returns returncode attribute.
215
216communicate(input=None)
217 Interact with process: Send data to stdin. Read data from stdout
218 and stderr, until end-of-file is reached. Wait for process to
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000219 terminate. The optional input argument should be a string to be
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000220 sent to the child process, or None, if no data should be sent to
221 the child.
Tim Peterse718f612004-10-12 21:51:32 +0000222
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000223 communicate() returns a tuple (stdout, stderr).
224
225 Note: The data read is buffered in memory, so do not use this
226 method if the data size is large or unlimited.
227
228The following attributes are also available:
229
230stdin
231 If the stdin argument is PIPE, this attribute is a file object
232 that provides input to the child process. Otherwise, it is None.
233
234stdout
235 If the stdout argument is PIPE, this attribute is a file object
236 that provides output from the child process. Otherwise, it is
237 None.
238
239stderr
240 If the stderr argument is PIPE, this attribute is file object that
241 provides error output from the child process. Otherwise, it is
242 None.
243
244pid
245 The process ID of the child process.
246
247returncode
248 The child return code. A None value indicates that the process
249 hasn't terminated yet. A negative value -N indicates that the
Gregory P. Smithf5604852010-12-13 06:45:02 +0000250 child was terminated by signal N (POSIX only).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000251
252
253Replacing older functions with the subprocess module
254====================================================
255In this section, "a ==> b" means that b can be used as a replacement
256for a.
257
258Note: All functions in this section fail (more or less) silently if
259the executed program cannot be found; this module raises an OSError
260exception.
261
262In the following examples, we assume that the subprocess module is
263imported with "from subprocess import *".
264
265
266Replacing /bin/sh shell backquote
267---------------------------------
268output=`mycmd myarg`
269==>
270output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
271
272
273Replacing shell pipe line
274-------------------------
275output=`dmesg | grep hda`
276==>
277p1 = Popen(["dmesg"], stdout=PIPE)
Peter Astrand6fdf3cb2004-11-30 18:06:42 +0000278p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000279output = p2.communicate()[0]
280
281
282Replacing os.system()
283---------------------
284sts = os.system("mycmd" + " myarg")
285==>
286p = Popen("mycmd" + " myarg", shell=True)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000287pid, sts = os.waitpid(p.pid, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000288
289Note:
290
291* Calling the program through the shell is usually not required.
292
293* It's easier to look at the returncode attribute than the
294 exitstatus.
295
296A more real-world example would look like this:
297
298try:
299 retcode = call("mycmd" + " myarg", shell=True)
300 if retcode < 0:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000301 print("Child was terminated by signal", -retcode, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000302 else:
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000303 print("Child returned", retcode, file=sys.stderr)
304except OSError as e:
305 print("Execution failed:", e, file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000306
307
308Replacing os.spawn*
309-------------------
Tim Peterse718f612004-10-12 21:51:32 +0000310P_NOWAIT example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000311
312pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
313==>
314pid = Popen(["/bin/mycmd", "myarg"]).pid
315
316
317P_WAIT example:
318
319retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
320==>
321retcode = call(["/bin/mycmd", "myarg"])
322
323
Tim Peterse718f612004-10-12 21:51:32 +0000324Vector example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000325
326os.spawnvp(os.P_NOWAIT, path, args)
327==>
328Popen([path] + args[1:])
329
330
Tim Peterse718f612004-10-12 21:51:32 +0000331Environment example:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000332
333os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
334==>
335Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000336"""
337
338import sys
339mswindows = (sys.platform == "win32")
340
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000341import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000342import os
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400343import time
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000344import traceback
Christian Heimesfdab48e2008-01-20 09:06:41 +0000345import gc
Christian Heimesa342c012008-04-20 21:01:16 +0000346import signal
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000347import builtins
Gregory P. Smithd23047b2010-12-04 09:10:44 +0000348import warnings
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000349
Peter Astrand454f7672005-01-01 09:36:35 +0000350# Exception classes used by this module.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000351class CalledProcessError(Exception):
Georg Brandlf9734072008-12-07 15:30:06 +0000352 """This exception is raised when a process run by check_call() or
353 check_output() returns a non-zero exit status.
354 The exit status will be stored in the returncode attribute;
355 check_output() will also store the output in the output attribute.
356 """
357 def __init__(self, returncode, cmd, output=None):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000358 self.returncode = returncode
359 self.cmd = cmd
Georg Brandlf9734072008-12-07 15:30:06 +0000360 self.output = output
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000361 def __str__(self):
362 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
363
Peter Astrand454f7672005-01-01 09:36:35 +0000364
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400365class TimeoutExpired(Exception):
366 """This exception is raised when the timeout expires while waiting for a
367 child process.
368 """
369 def __init__(self, cmd, output=None):
370 self.cmd = cmd
371 self.output = output
372
373 def __str__(self):
374 return ("Command '%s' timed out after %s seconds" %
375 (self.cmd, self.timeout))
376
377
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000378if mswindows:
379 import threading
380 import msvcrt
Brian Curtin1ce6b582010-04-24 16:19:22 +0000381 import _subprocess
382 class STARTUPINFO:
383 dwFlags = 0
384 hStdInput = None
385 hStdOutput = None
386 hStdError = None
387 wShowWindow = 0
388 class pywintypes:
389 error = IOError
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000390else:
391 import select
Gregory P. Smithd06fa472009-07-04 02:46:54 +0000392 _has_poll = hasattr(select, 'poll')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000393 import errno
394 import fcntl
395 import pickle
396
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000397 try:
398 import _posixsubprocess
399 except ImportError:
400 _posixsubprocess = None
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000401 warnings.warn("The _posixsubprocess module is not being used. "
402 "Child process reliability may suffer if your "
403 "program uses threads.", RuntimeWarning)
404
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000405 # When select or poll has indicated that the file is writable,
406 # we can write up to _PIPE_BUF bytes without risk of blocking.
407 # POSIX defines PIPE_BUF as >= 512.
408 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
409
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000410 _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1)
411
412 def _set_cloexec(fd, cloexec):
413 old = fcntl.fcntl(fd, fcntl.F_GETFD)
414 if cloexec:
415 fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC)
416 else:
417 fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC)
418
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000419 if _posixsubprocess:
420 _create_pipe = _posixsubprocess.cloexec_pipe
421 else:
422 def _create_pipe():
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000423 fds = os.pipe()
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000424 _set_cloexec(fds[0], True)
425 _set_cloexec(fds[1], True)
Gregory P. Smith51ee2702010-12-13 07:59:39 +0000426 return fds
Amaury Forgeot d'Arcace31022009-07-09 22:44:11 +0000427
Brett Cannona23810f2008-05-26 19:04:21 +0000428__all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput",
Georg Brandlf9734072008-12-07 15:30:06 +0000429 "getoutput", "check_output", "CalledProcessError"]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000430
Brian Curtin1ce6b582010-04-24 16:19:22 +0000431if mswindows:
Brett Cannon84df1e62010-05-14 00:33:40 +0000432 from _subprocess import CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP
Brian Curtin1ce6b582010-04-24 16:19:22 +0000433 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000434try:
435 MAXFD = os.sysconf("SC_OPEN_MAX")
436except:
437 MAXFD = 256
438
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000439_active = []
440
441def _cleanup():
442 for inst in _active[:]:
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000443 res = inst._internal_poll(_deadstate=sys.maxsize)
Guido van Rossumb5d47ef2006-08-24 02:27:45 +0000444 if res is not None and res >= 0:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000445 try:
446 _active.remove(inst)
447 except ValueError:
448 # This can happen if two threads create a new Popen instance.
449 # It's harmless that it was already removed, so ignore.
450 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000451
452PIPE = -1
453STDOUT = -2
454
455
Gregory P. Smitha59c59f2010-03-01 00:17:40 +0000456def _eintr_retry_call(func, *args):
457 while True:
458 try:
459 return func(*args)
460 except OSError as e:
461 if e.errno == errno.EINTR:
462 continue
463 raise
464
465
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400466def call(*popenargs, timeout=None, **kwargs):
467 """Run command with arguments. Wait for command to complete or
468 timeout, then return the returncode attribute.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000469
470 The arguments are the same as for the Popen constructor. Example:
471
472 retcode = call(["ls", "-l"])
473 """
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400474 p = Popen(*popenargs, **kwargs)
475 try:
476 return p.wait(timeout=timeout)
477 except TimeoutExpired:
478 p.kill()
479 p.wait()
480 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000481
482
Peter Astrand454f7672005-01-01 09:36:35 +0000483def check_call(*popenargs, **kwargs):
484 """Run command with arguments. Wait for command to complete. If
485 the exit code was zero then return, otherwise raise
486 CalledProcessError. The CalledProcessError object will have the
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000487 return code in the returncode attribute.
Peter Astrand454f7672005-01-01 09:36:35 +0000488
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400489 The arguments are the same as for the call function. Example:
Peter Astrand454f7672005-01-01 09:36:35 +0000490
491 check_call(["ls", "-l"])
492 """
493 retcode = call(*popenargs, **kwargs)
Peter Astrand454f7672005-01-01 09:36:35 +0000494 if retcode:
Georg Brandlf9734072008-12-07 15:30:06 +0000495 cmd = kwargs.get("args")
496 if cmd is None:
497 cmd = popenargs[0]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000498 raise CalledProcessError(retcode, cmd)
Georg Brandlf9734072008-12-07 15:30:06 +0000499 return 0
500
501
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400502def check_output(*popenargs, timeout=None, **kwargs):
Georg Brandl2708f3a2009-12-20 14:38:23 +0000503 r"""Run command with arguments and return its output as a byte string.
Georg Brandlf9734072008-12-07 15:30:06 +0000504
505 If the exit code was non-zero it raises a CalledProcessError. The
506 CalledProcessError object will have the return code in the returncode
507 attribute and output in the output attribute.
508
509 The arguments are the same as for the Popen constructor. Example:
510
511 >>> check_output(["ls", "-l", "/dev/null"])
Georg Brandl2708f3a2009-12-20 14:38:23 +0000512 b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000513
514 The stdout argument is not allowed as it is used internally.
Georg Brandl127d4702009-12-28 08:10:38 +0000515 To capture standard error in the result, use stderr=STDOUT.
Georg Brandlf9734072008-12-07 15:30:06 +0000516
517 >>> check_output(["/bin/sh", "-c",
Georg Brandl2708f3a2009-12-20 14:38:23 +0000518 ... "ls -l non_existent_file ; exit 0"],
Georg Brandl127d4702009-12-28 08:10:38 +0000519 ... stderr=STDOUT)
Georg Brandl2708f3a2009-12-20 14:38:23 +0000520 b'ls: non_existent_file: No such file or directory\n'
Georg Brandlf9734072008-12-07 15:30:06 +0000521 """
522 if 'stdout' in kwargs:
523 raise ValueError('stdout argument not allowed, it will be overridden.')
524 process = Popen(*popenargs, stdout=PIPE, **kwargs)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400525 try:
526 output, unused_err = process.communicate(timeout=timeout)
527 except TimeoutExpired:
528 process.kill()
529 output, unused_err = process.communicate()
530 raise TimeoutExpired(process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000531 retcode = process.poll()
532 if retcode:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400533 raise CalledProcessError(retcode, process.args, output=output)
Georg Brandlf9734072008-12-07 15:30:06 +0000534 return output
Peter Astrand454f7672005-01-01 09:36:35 +0000535
536
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000537def list2cmdline(seq):
538 """
539 Translate a sequence of arguments into a command line
540 string, using the same rules as the MS C runtime:
541
542 1) Arguments are delimited by white space, which is either a
543 space or a tab.
544
545 2) A string surrounded by double quotation marks is
546 interpreted as a single argument, regardless of white space
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000547 contained within. A quoted string can be embedded in an
548 argument.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000549
550 3) A double quotation mark preceded by a backslash is
551 interpreted as a literal double quotation mark.
552
553 4) Backslashes are interpreted literally, unless they
554 immediately precede a double quotation mark.
555
556 5) If backslashes immediately precede a double quotation mark,
557 every pair of backslashes is interpreted as a literal
558 backslash. If the number of backslashes is odd, the last
559 backslash escapes the next double quotation mark as
560 described in rule 3.
561 """
562
563 # See
Eric Smith3c573af2009-11-09 15:23:15 +0000564 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
565 # or search http://msdn.microsoft.com for
566 # "Parsing C++ Command-Line Arguments"
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000567 result = []
568 needquote = False
569 for arg in seq:
570 bs_buf = []
571
572 # Add a space to separate this argument from the others
573 if result:
574 result.append(' ')
575
Jean-Paul Calderone1ddd4072010-06-18 20:03:54 +0000576 needquote = (" " in arg) or ("\t" in arg) or not arg
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000577 if needquote:
578 result.append('"')
579
580 for c in arg:
581 if c == '\\':
Tim Peterse718f612004-10-12 21:51:32 +0000582 # Don't know if we need to double yet.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000583 bs_buf.append(c)
584 elif c == '"':
Christian Heimesfdab48e2008-01-20 09:06:41 +0000585 # Double backslashes.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000586 result.append('\\' * len(bs_buf)*2)
587 bs_buf = []
588 result.append('\\"')
589 else:
590 # Normal char
591 if bs_buf:
592 result.extend(bs_buf)
593 bs_buf = []
594 result.append(c)
595
Christian Heimesfdab48e2008-01-20 09:06:41 +0000596 # Add remaining backslashes, if any.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000597 if bs_buf:
598 result.extend(bs_buf)
599
600 if needquote:
Peter Astrand7e78ade2005-03-03 21:10:23 +0000601 result.extend(bs_buf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000602 result.append('"')
603
604 return ''.join(result)
605
606
Brett Cannona23810f2008-05-26 19:04:21 +0000607# Various tools for executing commands and looking at their output and status.
608#
Gregory P. Smithf5604852010-12-13 06:45:02 +0000609# NB This only works (and is only relevant) for POSIX.
Brett Cannona23810f2008-05-26 19:04:21 +0000610
611def getstatusoutput(cmd):
612 """Return (status, output) of executing cmd in a shell.
613
614 Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple
615 (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the
616 returned output will contain output or error messages. A trailing newline
617 is stripped from the output. The exit status for the command can be
618 interpreted according to the rules for the C function wait(). Example:
619
620 >>> import subprocess
621 >>> subprocess.getstatusoutput('ls /bin/ls')
622 (0, '/bin/ls')
623 >>> subprocess.getstatusoutput('cat /bin/junk')
624 (256, 'cat: /bin/junk: No such file or directory')
625 >>> subprocess.getstatusoutput('/bin/junk')
626 (256, 'sh: /bin/junk: not found')
627 """
628 pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r')
629 text = pipe.read()
630 sts = pipe.close()
631 if sts is None: sts = 0
632 if text[-1:] == '\n': text = text[:-1]
633 return sts, text
634
635
636def getoutput(cmd):
637 """Return output (stdout or stderr) of executing cmd in a shell.
638
639 Like getstatusoutput(), except the exit status is ignored and the return
640 value is a string containing the command's output. Example:
641
642 >>> import subprocess
643 >>> subprocess.getoutput('ls /bin/ls')
644 '/bin/ls'
645 """
646 return getstatusoutput(cmd)[1]
647
648
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000649_PLATFORM_DEFAULT_CLOSE_FDS = object()
Gregory P. Smithf5604852010-12-13 06:45:02 +0000650
651
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000652class Popen(object):
653 def __init__(self, args, bufsize=0, executable=None,
654 stdin=None, stdout=None, stderr=None,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000655 preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
656 shell=False, cwd=None, env=None, universal_newlines=False,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000657 startupinfo=None, creationflags=0,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000658 restore_signals=True, start_new_session=False,
659 pass_fds=()):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000660 """Create new Popen instance."""
661 _cleanup()
662
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000663 self._child_created = False
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400664 self._input = None
665 self._communication_started = False
Guido van Rossum46a05a72007-06-07 21:56:45 +0000666 if bufsize is None:
667 bufsize = 0 # Restore default
Walter Dörwaldaa97f042007-05-03 21:05:51 +0000668 if not isinstance(bufsize, int):
Peter Astrand738131d2004-11-30 21:04:45 +0000669 raise TypeError("bufsize must be an integer")
670
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000671 if mswindows:
Tim Peterse8374a52004-10-13 03:15:00 +0000672 if preexec_fn is not None:
673 raise ValueError("preexec_fn is not supported on Windows "
674 "platforms")
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000675 any_stdio_set = (stdin is not None or stdout is not None or
676 stderr is not None)
677 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
678 if any_stdio_set:
679 close_fds = False
680 else:
681 close_fds = True
682 elif close_fds and any_stdio_set:
683 raise ValueError(
684 "close_fds is not supported on Windows platforms"
685 " if you redirect stdin/stdout/stderr")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000686 else:
687 # POSIX
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000688 if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
689 close_fds = True
690 if pass_fds and not close_fds:
691 warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
692 close_fds = True
Tim Peterse8374a52004-10-13 03:15:00 +0000693 if startupinfo is not None:
694 raise ValueError("startupinfo is only supported on Windows "
695 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000696 if creationflags != 0:
Tim Peterse8374a52004-10-13 03:15:00 +0000697 raise ValueError("creationflags is only supported on Windows "
698 "platforms")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000699
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400700 self.args = args
Tim Peterse718f612004-10-12 21:51:32 +0000701 self.stdin = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000702 self.stdout = None
703 self.stderr = None
704 self.pid = None
705 self.returncode = None
706 self.universal_newlines = universal_newlines
707
708 # Input and output objects. The general principle is like
709 # this:
710 #
711 # Parent Child
712 # ------ -----
713 # p2cwrite ---stdin---> p2cread
714 # c2pread <--stdout--- c2pwrite
715 # errread <--stderr--- errwrite
716 #
717 # On POSIX, the child objects are file descriptors. On
718 # Windows, these are Windows file handles. The parent objects
719 # are file descriptors on both platforms. The parent objects
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000720 # are -1 when not using PIPEs. The child objects are -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000721 # when not redirecting.
Tim Peterse718f612004-10-12 21:51:32 +0000722
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000723 (p2cread, p2cwrite,
724 c2pread, c2pwrite,
725 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
726
Antoine Pitrouc9982322011-01-04 19:07:07 +0000727 # We wrap OS handles *before* launching the child, otherwise a
728 # quickly terminating child could make our fds unwrappable
729 # (see #8458).
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000730
Thomas Wouterscf297e42007-02-23 15:07:44 +0000731 if mswindows:
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000732 if p2cwrite != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000733 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000734 if c2pread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000735 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
Florent Xicluna3b8bfef2010-03-14 12:31:06 +0000736 if errread != -1:
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000737 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000738
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000739 if bufsize == 0:
740 bufsize = 1 # Nearly unbuffered (XXX for now)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000741 if p2cwrite != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000742 self.stdin = io.open(p2cwrite, 'wb', bufsize)
743 if self.universal_newlines:
744 self.stdin = io.TextIOWrapper(self.stdin)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000745 if c2pread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000746 self.stdout = io.open(c2pread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000747 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000748 self.stdout = io.TextIOWrapper(self.stdout)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000749 if errread != -1:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000750 self.stderr = io.open(errread, 'rb', bufsize)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000751 if universal_newlines:
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000752 self.stderr = io.TextIOWrapper(self.stderr)
Tim Peterse718f612004-10-12 21:51:32 +0000753
Antoine Pitrouc9982322011-01-04 19:07:07 +0000754 try:
755 self._execute_child(args, executable, preexec_fn, close_fds,
756 pass_fds, cwd, env, universal_newlines,
757 startupinfo, creationflags, shell,
758 p2cread, p2cwrite,
759 c2pread, c2pwrite,
760 errread, errwrite,
761 restore_signals, start_new_session)
762 except:
763 # Cleanup if the child failed starting
764 for f in filter(None, [self.stdin, self.stdout, self.stderr]):
765 try:
766 f.close()
767 except EnvironmentError:
768 # Ignore EBADF or other errors
769 pass
770 raise
771
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000772
Guido van Rossum98297ee2007-11-06 21:34:58 +0000773 def _translate_newlines(self, data, encoding):
774 data = data.replace(b"\r\n", b"\n").replace(b"\r", b"\n")
775 return data.decode(encoding)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000776
Brian Curtin79cdb662010-12-03 02:46:02 +0000777 def __enter__(self):
778 return self
779
780 def __exit__(self, type, value, traceback):
781 if self.stdout:
782 self.stdout.close()
783 if self.stderr:
784 self.stderr.close()
785 if self.stdin:
786 self.stdin.close()
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000787
Brett Cannon84df1e62010-05-14 00:33:40 +0000788 def __del__(self, _maxsize=sys.maxsize, _active=_active):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000789 if not self._child_created:
790 # We didn't get to successfully create a child process.
791 return
792 # In case the child hasn't been waited on, check if it's done.
Brett Cannon84df1e62010-05-14 00:33:40 +0000793 self._internal_poll(_deadstate=_maxsize)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000794 if self.returncode is None and _active is not None:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000795 # Child is still running, keep us alive until we can wait on it.
796 _active.append(self)
797
798
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400799 def communicate(self, input=None, timeout=None):
Peter Astrand23109f02005-03-03 20:28:59 +0000800 """Interact with process: Send data to stdin. Read data from
801 stdout and stderr, until end-of-file is reached. Wait for
802 process to terminate. The optional input argument should be a
803 string to be sent to the child process, or None, if no data
804 should be sent to the child.
Tim Peterseba28be2005-03-28 01:08:02 +0000805
Peter Astrand23109f02005-03-03 20:28:59 +0000806 communicate() returns a tuple (stdout, stderr)."""
807
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400808 if self._communication_started and input:
809 raise ValueError("Cannot send input after starting communication")
810
811 if timeout is not None:
812 endtime = time.time() + timeout
813 else:
814 endtime = None
815
816 # Optimization: If we are not worried about timeouts, we haven't
817 # started communicating, and we have one or zero pipes, using select()
818 # or threads is unnecessary.
819 if (endtime is None and not self._communication_started and
820 [self.stdin, self.stdout, self.stderr].count(None) >= 2):
Tim Peterseba28be2005-03-28 01:08:02 +0000821 stdout = None
822 stderr = None
Peter Astrand23109f02005-03-03 20:28:59 +0000823 if self.stdin:
824 if input:
825 self.stdin.write(input)
826 self.stdin.close()
827 elif self.stdout:
828 stdout = self.stdout.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000829 self.stdout.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000830 elif self.stderr:
831 stderr = self.stderr.read()
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000832 self.stderr.close()
Peter Astrand23109f02005-03-03 20:28:59 +0000833 self.wait()
834 return (stdout, stderr)
Tim Peterseba28be2005-03-28 01:08:02 +0000835
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400836 try:
837 stdout, stderr = self._communicate(input, endtime)
838 finally:
839 self._communication_started = True
840
841 sts = self.wait(timeout=self._remaining_time(endtime))
842
843 return (stdout, stderr)
Peter Astrand23109f02005-03-03 20:28:59 +0000844
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000845
Georg Brandl6aa2d1f2008-08-12 08:35:52 +0000846 def poll(self):
847 return self._internal_poll()
848
849
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400850 def _remaining_time(self, endtime):
851 """Convenience for _communicate when computing timeouts."""
852 if endtime is None:
853 return None
854 else:
855 return endtime - time.time()
856
857
858 def _check_timeout(self, endtime):
859 """Convenience for checking if a timeout has expired."""
860 if endtime is None:
861 return
862 if time.time() > endtime:
863 raise TimeoutExpired(self.args)
864
865
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000866 if mswindows:
867 #
868 # Windows methods
869 #
870 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +0000871 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000872 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
873 """
Peter Astrandd38ddf42005-02-10 08:32:50 +0000874 if stdin is None and stdout is None and stderr is None:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000875 return (-1, -1, -1, -1, -1, -1)
Tim Peterse718f612004-10-12 21:51:32 +0000876
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000877 p2cread, p2cwrite = -1, -1
878 c2pread, c2pwrite = -1, -1
879 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000880
Peter Astrandd38ddf42005-02-10 08:32:50 +0000881 if stdin is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000882 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000883 if p2cread is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000884 p2cread, _ = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000885 elif stdin == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000886 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
Peter Astrandd38ddf42005-02-10 08:32:50 +0000887 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000888 p2cread = msvcrt.get_osfhandle(stdin)
889 else:
890 # Assuming file-like object
891 p2cread = msvcrt.get_osfhandle(stdin.fileno())
892 p2cread = self._make_inheritable(p2cread)
893
Peter Astrandd38ddf42005-02-10 08:32:50 +0000894 if stdout is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000895 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000896 if c2pwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000897 _, c2pwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000898 elif stdout == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000899 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
Peter Astrandd38ddf42005-02-10 08:32:50 +0000900 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000901 c2pwrite = msvcrt.get_osfhandle(stdout)
902 else:
903 # Assuming file-like object
904 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
905 c2pwrite = self._make_inheritable(c2pwrite)
906
Peter Astrandd38ddf42005-02-10 08:32:50 +0000907 if stderr is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000908 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000909 if errwrite is None:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000910 _, errwrite = _subprocess.CreatePipe(None, 0)
Hirokazu Yamamoto0c988172009-03-03 22:41:26 +0000911 elif stderr == PIPE:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000912 errread, errwrite = _subprocess.CreatePipe(None, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000913 elif stderr == STDOUT:
914 errwrite = c2pwrite
Peter Astrandd38ddf42005-02-10 08:32:50 +0000915 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000916 errwrite = msvcrt.get_osfhandle(stderr)
917 else:
918 # Assuming file-like object
919 errwrite = msvcrt.get_osfhandle(stderr.fileno())
920 errwrite = self._make_inheritable(errwrite)
921
922 return (p2cread, p2cwrite,
923 c2pread, c2pwrite,
924 errread, errwrite)
925
926
927 def _make_inheritable(self, handle):
928 """Return a duplicate of handle, which is inheritable"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000929 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
930 handle, _subprocess.GetCurrentProcess(), 0, 1,
931 _subprocess.DUPLICATE_SAME_ACCESS)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000932
933
934 def _find_w9xpopen(self):
935 """Find and return absolut path to w9xpopen.exe"""
Brian Curtin1ce6b582010-04-24 16:19:22 +0000936 w9xpopen = os.path.join(
937 os.path.dirname(_subprocess.GetModuleFileName(0)),
Tim Peterse8374a52004-10-13 03:15:00 +0000938 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000939 if not os.path.exists(w9xpopen):
940 # Eeek - file-not-found - possibly an embedding
941 # situation - see if we can locate it in sys.exec_prefix
Tim Peterse8374a52004-10-13 03:15:00 +0000942 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
943 "w9xpopen.exe")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000944 if not os.path.exists(w9xpopen):
Tim Peterse8374a52004-10-13 03:15:00 +0000945 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
946 "needed for Popen to work with your "
947 "shell or platform.")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000948 return w9xpopen
949
Tim Peterse718f612004-10-12 21:51:32 +0000950
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000951 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000952 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000953 startupinfo, creationflags, shell,
954 p2cread, p2cwrite,
955 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000956 errread, errwrite,
957 unused_restore_signals, unused_start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000958 """Execute program (MS Windows version)"""
959
Gregory P. Smith8edd99d2010-12-14 13:43:30 +0000960 assert not pass_fds, "pass_fds not supported on Windows."
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +0000961
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000962 if not isinstance(args, str):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000963 args = list2cmdline(args)
964
Peter Astrandc1d65362004-11-07 14:30:34 +0000965 # Process startup details
Peter Astrandd38ddf42005-02-10 08:32:50 +0000966 if startupinfo is None:
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000967 startupinfo = STARTUPINFO()
Victor Stinnerb3693582010-05-21 20:13:12 +0000968 if -1 not in (p2cread, c2pwrite, errwrite):
Brian Curtin1ce6b582010-04-24 16:19:22 +0000969 startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
Peter Astrandc1d65362004-11-07 14:30:34 +0000970 startupinfo.hStdInput = p2cread
971 startupinfo.hStdOutput = c2pwrite
972 startupinfo.hStdError = errwrite
973
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000974 if shell:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000975 startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
976 startupinfo.wShowWindow = _subprocess.SW_HIDE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000977 comspec = os.environ.get("COMSPEC", "cmd.exe")
Tim Golden126c2962010-08-11 14:20:40 +0000978 args = '{} /c "{}"'.format (comspec, args)
Brian Curtin1ce6b582010-04-24 16:19:22 +0000979 if (_subprocess.GetVersion() >= 0x80000000 or
Tim Peterse8374a52004-10-13 03:15:00 +0000980 os.path.basename(comspec).lower() == "command.com"):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000981 # Win9x, or using command.com on NT. We need to
982 # use the w9xpopen intermediate program. For more
983 # information, see KB Q150956
984 # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
985 w9xpopen = self._find_w9xpopen()
986 args = '"%s" %s' % (w9xpopen, args)
987 # Not passing CREATE_NEW_CONSOLE has been known to
988 # cause random failures on win9x. Specifically a
989 # dialog: "Your program accessed mem currently in
990 # use at xxx" and a hopeful warning about the
Mark Dickinson934896d2009-02-21 20:59:32 +0000991 # stability of your system. Cost is Ctrl+C won't
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000992 # kill children.
Brian Curtin1ce6b582010-04-24 16:19:22 +0000993 creationflags |= _subprocess.CREATE_NEW_CONSOLE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000994
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000995 # Start the process
996 try:
Brian Curtin1ce6b582010-04-24 16:19:22 +0000997 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
Tim Peterse8374a52004-10-13 03:15:00 +0000998 # no special security
999 None, None,
Guido van Rossume7ba4952007-06-06 23:52:48 +00001000 int(not close_fds),
Tim Peterse8374a52004-10-13 03:15:00 +00001001 creationflags,
1002 env,
1003 cwd,
1004 startupinfo)
Guido van Rossumb940e112007-01-10 16:19:56 +00001005 except pywintypes.error as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001006 # Translate pywintypes.error to WindowsError, which is
1007 # a subclass of OSError. FIXME: We should really
1008 # translate errno using _sys_errlist (or simliar), but
1009 # how can this be done from Python?
1010 raise WindowsError(*e.args)
Tim Goldenad537f22010-08-08 11:18:16 +00001011 finally:
1012 # Child is launched. Close the parent's copy of those pipe
1013 # handles that only the child should have open. You need
1014 # to make sure that no handles to the write end of the
1015 # output pipe are maintained in this process or else the
1016 # pipe will not close when the child process exits and the
1017 # ReadFile will hang.
1018 if p2cread != -1:
1019 p2cread.Close()
1020 if c2pwrite != -1:
1021 c2pwrite.Close()
1022 if errwrite != -1:
1023 errwrite.Close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001024
1025 # Retain the process handle, but close the thread handle
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001026 self._child_created = True
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001027 self._handle = hp
1028 self.pid = pid
1029 ht.Close()
1030
Brett Cannon84df1e62010-05-14 00:33:40 +00001031 def _internal_poll(self, _deadstate=None,
Victor Stinnerc807a612010-05-14 21:53:45 +00001032 _WaitForSingleObject=_subprocess.WaitForSingleObject,
1033 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
1034 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001035 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001036 attribute.
1037
1038 This method is called by __del__, so it can only refer to objects
1039 in its local scope.
1040
1041 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001042 if self.returncode is None:
Brett Cannon84df1e62010-05-14 00:33:40 +00001043 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
1044 self.returncode = _GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001045 return self.returncode
1046
1047
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001048 def wait(self, timeout=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001049 """Wait for child process to terminate. Returns returncode
1050 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001051 if timeout is None:
1052 timeout = _subprocess.INFINITE
1053 else:
1054 timeout = int(timeout * 1000)
Peter Astrandd38ddf42005-02-10 08:32:50 +00001055 if self.returncode is None:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001056 result = _subprocess.WaitForSingleObject(self._handle, timeout)
1057 if result == _subprocess.WAIT_TIMEOUT:
1058 raise TimeoutExpired(self.args)
Brian Curtin1ce6b582010-04-24 16:19:22 +00001059 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001060 return self.returncode
1061
1062
1063 def _readerthread(self, fh, buffer):
1064 buffer.append(fh.read())
Victor Stinner667d4b52010-12-25 22:40:32 +00001065 fh.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001066
1067
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001068 def _communicate(self, input, endtime):
1069 # Start reader threads feeding into a list hanging off of this
1070 # object, unless they've already been started.
1071 if self.stdout and not hasattr(self, "_stdout_buff"):
1072 self._stdout_buff = []
1073 self.stdout_thread = \
1074 threading.Thread(target=self._readerthread,
1075 args=(self.stdout, self._stdout_buff))
1076 self.stdout_thread.daemon = True
1077 self.stdout_thread.start()
1078 if self.stderr and not hasattr(self, "_stderr_buff"):
1079 self._stderr_buff = []
1080 self.stderr_thread = \
1081 threading.Thread(target=self._readerthread,
1082 args=(self.stderr, self._stderr_buff))
1083 self.stderr_thread.daemon = True
1084 self.stderr_thread.start()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001085
1086 if self.stdin:
Peter Astrandd38ddf42005-02-10 08:32:50 +00001087 if input is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001088 self.stdin.write(input)
1089 self.stdin.close()
1090
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001091 # Wait for the reader threads, or time out. If we time out, the
1092 # threads remain reading and the fds left open in case the user
1093 # calls communicate again.
1094 if self.stdout is not None:
1095 self.stdout_thread.join(self._remaining_time(endtime))
1096 if self.stdout_thread.isAlive():
1097 raise TimeoutExpired(self.args)
1098 if self.stderr is not None:
1099 self.stderr_thread.join(self._remaining_time(endtime))
1100 if self.stderr_thread.isAlive():
1101 raise TimeoutExpired(self.args)
1102
1103 # Collect the output from and close both pipes, now that we know
1104 # both have been read successfully.
1105 stdout = None
1106 stderr = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001107 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001108 stdout = self._stdout_buff
1109 self.stdout.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001110 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001111 stderr = self._stderr_buff
1112 self.stderr.close()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001113
1114 # All data exchanged. Translate lists into strings.
Peter Astrandd38ddf42005-02-10 08:32:50 +00001115 if stdout is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001116 stdout = stdout[0]
Peter Astrandd38ddf42005-02-10 08:32:50 +00001117 if stderr is not None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001118 stderr = stderr[0]
1119
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001120 return (stdout, stderr)
1121
Christian Heimesa342c012008-04-20 21:01:16 +00001122 def send_signal(self, sig):
1123 """Send a signal to the process
1124 """
1125 if sig == signal.SIGTERM:
1126 self.terminate()
Brian Curtineb24d742010-04-12 17:16:38 +00001127 elif sig == signal.CTRL_C_EVENT:
1128 os.kill(self.pid, signal.CTRL_C_EVENT)
1129 elif sig == signal.CTRL_BREAK_EVENT:
1130 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
Christian Heimesa342c012008-04-20 21:01:16 +00001131 else:
Brian Curtin19651362010-09-07 13:24:38 +00001132 raise ValueError("Unsupported signal: {}".format(sig))
Christian Heimesa342c012008-04-20 21:01:16 +00001133
1134 def terminate(self):
1135 """Terminates the process
1136 """
Brian Curtin1ce6b582010-04-24 16:19:22 +00001137 _subprocess.TerminateProcess(self._handle, 1)
Christian Heimesa342c012008-04-20 21:01:16 +00001138
1139 kill = terminate
1140
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001141 else:
1142 #
1143 # POSIX methods
1144 #
1145 def _get_handles(self, stdin, stdout, stderr):
Alexandre Vassalotti711ed4a2009-07-17 10:42:05 +00001146 """Construct and return tuple with IO objects:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001147 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
1148 """
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001149 p2cread, p2cwrite = -1, -1
1150 c2pread, c2pwrite = -1, -1
1151 errread, errwrite = -1, -1
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001152
Peter Astrandd38ddf42005-02-10 08:32:50 +00001153 if stdin is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001154 pass
1155 elif stdin == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001156 p2cread, p2cwrite = _create_pipe()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001157 elif isinstance(stdin, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001158 p2cread = stdin
1159 else:
1160 # Assuming file-like object
1161 p2cread = stdin.fileno()
1162
Peter Astrandd38ddf42005-02-10 08:32:50 +00001163 if stdout is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001164 pass
1165 elif stdout == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001166 c2pread, c2pwrite = _create_pipe()
Peter Astrandd38ddf42005-02-10 08:32:50 +00001167 elif isinstance(stdout, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001168 c2pwrite = stdout
1169 else:
1170 # Assuming file-like object
Tim Peterse718f612004-10-12 21:51:32 +00001171 c2pwrite = stdout.fileno()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001172
Peter Astrandd38ddf42005-02-10 08:32:50 +00001173 if stderr is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001174 pass
1175 elif stderr == PIPE:
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001176 errread, errwrite = _create_pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001177 elif stderr == STDOUT:
1178 errwrite = c2pwrite
Peter Astrandd38ddf42005-02-10 08:32:50 +00001179 elif isinstance(stderr, int):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001180 errwrite = stderr
1181 else:
1182 # Assuming file-like object
1183 errwrite = stderr.fileno()
1184
1185 return (p2cread, p2cwrite,
1186 c2pread, c2pwrite,
1187 errread, errwrite)
1188
1189
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001190 def _close_fds(self, fds_to_keep):
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001191 start_fd = 3
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001192 for fd in sorted(fds_to_keep):
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001193 if fd >= start_fd:
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001194 os.closerange(start_fd, fd)
1195 start_fd = fd + 1
1196 if start_fd <= MAXFD:
1197 os.closerange(start_fd, MAXFD)
1198
1199
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001200 def _execute_child(self, args, executable, preexec_fn, close_fds,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001201 pass_fds, cwd, env, universal_newlines,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001202 startupinfo, creationflags, shell,
1203 p2cread, p2cwrite,
1204 c2pread, c2pwrite,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001205 errread, errwrite,
1206 restore_signals, start_new_session):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001207 """Execute program (POSIX version)"""
1208
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001209 if isinstance(args, (str, bytes)):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001210 args = [args]
Thomas Wouters89f507f2006-12-13 04:49:30 +00001211 else:
1212 args = list(args)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001213
1214 if shell:
1215 args = ["/bin/sh", "-c"] + args
Stefan Krah9542cc62010-07-19 14:20:53 +00001216 if executable:
1217 args[0] = executable
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001218
Peter Astrandd38ddf42005-02-10 08:32:50 +00001219 if executable is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001220 executable = args[0]
1221
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001222 # For transferring possible exec failure from child to parent.
1223 # Data format: "exception name:hex errno:description"
1224 # Pickle is not used; it is complex and involves memory allocation.
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001225 errpipe_read, errpipe_write = _create_pipe()
Christian Heimesfdab48e2008-01-20 09:06:41 +00001226 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001227 try:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001228
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001229 if _posixsubprocess:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001230 # We must avoid complex work that could involve
1231 # malloc or free in the child process to avoid
1232 # potential deadlocks, thus we do all this here.
1233 # and pass it to fork_exec()
1234
1235 if env:
Victor Stinner449c4662010-05-08 11:10:09 +00001236 env_list = [os.fsencode(k) + b'=' + os.fsencode(v)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001237 for k, v in env.items()]
1238 else:
1239 env_list = None # Use execv instead of execve.
Victor Stinnerb745a742010-05-18 17:17:23 +00001240 executable = os.fsencode(executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001241 if os.path.dirname(executable):
Victor Stinnerb745a742010-05-18 17:17:23 +00001242 executable_list = (executable,)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001243 else:
1244 # This matches the behavior of os._execvpe().
Victor Stinnerb745a742010-05-18 17:17:23 +00001245 executable_list = tuple(
1246 os.path.join(os.fsencode(dir), executable)
1247 for dir in os.get_exec_path(env))
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001248 fds_to_keep = set(pass_fds)
1249 fds_to_keep.add(errpipe_write)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001250 self.pid = _posixsubprocess.fork_exec(
1251 args, executable_list,
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001252 close_fds, sorted(fds_to_keep), cwd, env_list,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001253 p2cread, p2cwrite, c2pread, c2pwrite,
1254 errread, errwrite,
1255 errpipe_read, errpipe_write,
1256 restore_signals, start_new_session, preexec_fn)
1257 else:
1258 # Pure Python implementation: It is not thread safe.
1259 # This implementation may deadlock in the child if your
1260 # parent process has any other threads running.
1261
1262 gc_was_enabled = gc.isenabled()
1263 # Disable gc to avoid bug where gc -> file_dealloc ->
1264 # write to stderr -> hang. See issue1336
1265 gc.disable()
1266 try:
1267 self.pid = os.fork()
1268 except:
1269 if gc_was_enabled:
1270 gc.enable()
1271 raise
1272 self._child_created = True
1273 if self.pid == 0:
1274 # Child
1275 try:
1276 # Close parent's pipe ends
1277 if p2cwrite != -1:
1278 os.close(p2cwrite)
1279 if c2pread != -1:
1280 os.close(c2pread)
1281 if errread != -1:
1282 os.close(errread)
1283 os.close(errpipe_read)
1284
1285 # Dup fds for child
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001286 def _dup2(a, b):
1287 # dup2() removes the CLOEXEC flag but
1288 # we must do it ourselves if dup2()
1289 # would be a no-op (issue #10806).
1290 if a == b:
1291 _set_cloexec(a, False)
1292 elif a != -1:
1293 os.dup2(a, b)
1294 _dup2(p2cread, 0)
1295 _dup2(c2pwrite, 1)
1296 _dup2(errwrite, 2)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001297
1298 # Close pipe fds. Make sure we don't close the
1299 # same fd more than once, or standard fds.
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001300 closed = set()
1301 for fd in [p2cread, c2pwrite, errwrite]:
1302 if fd > 2 and fd not in closed:
1303 os.close(fd)
1304 closed.add(fd)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001305
1306 # Close all other fds, if asked for
1307 if close_fds:
Antoine Pitrou47f14ba2011-01-03 23:42:01 +00001308 fds_to_keep = set(pass_fds)
1309 fds_to_keep.add(errpipe_write)
1310 self._close_fds(fds_to_keep)
Gregory P. Smithd4cc7bf2010-12-04 11:22:11 +00001311
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001312
1313 if cwd is not None:
1314 os.chdir(cwd)
1315
1316 # This is a copy of Python/pythonrun.c
1317 # _Py_RestoreSignals(). If that were exposed
1318 # as a sys._py_restoresignals func it would be
1319 # better.. but this pure python implementation
1320 # isn't likely to be used much anymore.
1321 if restore_signals:
1322 signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
1323 for sig in signals:
1324 if hasattr(signal, sig):
1325 signal.signal(getattr(signal, sig),
1326 signal.SIG_DFL)
1327
1328 if start_new_session and hasattr(os, 'setsid'):
1329 os.setsid()
1330
1331 if preexec_fn:
1332 preexec_fn()
1333
1334 if env is None:
1335 os.execvp(executable, args)
1336 else:
1337 os.execvpe(executable, args, env)
1338
1339 except:
1340 try:
1341 exc_type, exc_value = sys.exc_info()[:2]
1342 if isinstance(exc_value, OSError):
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001343 errno_num = exc_value.errno
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001344 else:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001345 errno_num = 0
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001346 message = '%s:%x:%s' % (exc_type.__name__,
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001347 errno_num, exc_value)
Victor Stinner4d078042010-04-23 19:28:32 +00001348 message = message.encode(errors="surrogatepass")
1349 os.write(errpipe_write, message)
1350 except Exception:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001351 # We MUST not allow anything odd happening
1352 # above to prevent us from exiting below.
1353 pass
1354
1355 # This exitcode won't be reported to applications
1356 # so it really doesn't matter what we return.
1357 os._exit(255)
1358
1359 # Parent
Facundo Batista10706e22009-06-19 20:34:30 +00001360 if gc_was_enabled:
1361 gc.enable()
Facundo Batista10706e22009-06-19 20:34:30 +00001362 finally:
1363 # be sure the FD is closed no matter what
1364 os.close(errpipe_write)
1365
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001366 if p2cread != -1 and p2cwrite != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001367 os.close(p2cread)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001368 if c2pwrite != -1 and c2pread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001369 os.close(c2pwrite)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001370 if errwrite != -1 and errread != -1:
Facundo Batista10706e22009-06-19 20:34:30 +00001371 os.close(errwrite)
1372
1373 # Wait for exec to fail or succeed; possibly raising an
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001374 # exception (limited in size)
1375 data = bytearray()
1376 while True:
1377 part = _eintr_retry_call(os.read, errpipe_read, 50000)
1378 data += part
1379 if not part or len(data) > 50000:
1380 break
Facundo Batista10706e22009-06-19 20:34:30 +00001381 finally:
1382 # be sure the FD is closed no matter what
1383 os.close(errpipe_read)
1384
Guido van Rossumaf2362a2007-05-15 22:32:02 +00001385 if data:
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001386 try:
1387 _eintr_retry_call(os.waitpid, self.pid, 0)
1388 except OSError as e:
1389 if e.errno != errno.ECHILD:
1390 raise
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001391 try:
1392 exception_name, hex_errno, err_msg = data.split(b':', 2)
1393 except ValueError:
1394 print('Bad exception data:', repr(data))
1395 exception_name = b'RuntimeError'
1396 hex_errno = b'0'
1397 err_msg = b'Unknown'
1398 child_exception_type = getattr(
1399 builtins, exception_name.decode('ascii'),
1400 RuntimeError)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001401 for fd in (p2cwrite, c2pread, errread):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001402 if fd != -1:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001403 os.close(fd)
Victor Stinner4d078042010-04-23 19:28:32 +00001404 err_msg = err_msg.decode(errors="surrogatepass")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001405 if issubclass(child_exception_type, OSError) and hex_errno:
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001406 errno_num = int(hex_errno, 16)
1407 if errno_num != 0:
1408 err_msg = os.strerror(errno_num)
1409 if errno_num == errno.ENOENT:
Benjamin Peterson5f780402010-11-20 18:07:52 +00001410 err_msg += ': ' + repr(args[0])
Benjamin Petersonb8bc4392010-11-20 18:24:54 +00001411 raise child_exception_type(errno_num, err_msg)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001412 raise child_exception_type(err_msg)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001413
1414
Brett Cannon84df1e62010-05-14 00:33:40 +00001415 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
1416 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
1417 _WEXITSTATUS=os.WEXITSTATUS):
1418 # This method is called (indirectly) by __del__, so it cannot
1419 # refer to anything outside of its local scope."""
1420 if _WIFSIGNALED(sts):
1421 self.returncode = -_WTERMSIG(sts)
1422 elif _WIFEXITED(sts):
1423 self.returncode = _WEXITSTATUS(sts)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001424 else:
1425 # Should never happen
1426 raise RuntimeError("Unknown child exit status!")
1427
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001428
Brett Cannon84df1e62010-05-14 00:33:40 +00001429 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
1430 _WNOHANG=os.WNOHANG, _os_error=os.error):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001431 """Check if child process has terminated. Returns returncode
Brett Cannon84df1e62010-05-14 00:33:40 +00001432 attribute.
1433
1434 This method is called by __del__, so it cannot reference anything
1435 outside of the local scope (nor can any methods it calls).
1436
1437 """
Peter Astrandd38ddf42005-02-10 08:32:50 +00001438 if self.returncode is None:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001439 try:
Brett Cannon84df1e62010-05-14 00:33:40 +00001440 pid, sts = _waitpid(self.pid, _WNOHANG)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001441 if pid == self.pid:
1442 self._handle_exitstatus(sts)
Brett Cannon84df1e62010-05-14 00:33:40 +00001443 except _os_error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001444 if _deadstate is not None:
1445 self.returncode = _deadstate
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001446 return self.returncode
1447
1448
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001449 def _try_wait(self, wait_flags):
1450 try:
1451 (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
1452 except OSError as e:
1453 if e.errno != errno.ECHILD:
1454 raise
1455 # This happens if SIGCLD is set to be ignored or waiting
1456 # for child processes has otherwise been disabled for our
1457 # process. This child is dead, we can't get the status.
1458 pid = self.pid
1459 sts = 0
1460 return (pid, sts)
1461
1462
1463 def wait(self, timeout=None, endtime=None):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001464 """Wait for child process to terminate. Returns returncode
1465 attribute."""
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001466 # If timeout was passed but not endtime, compute endtime in terms of
1467 # timeout.
1468 if endtime is None and timeout is not None:
1469 endtime = time.time() + timeout
1470 if self.returncode is not None:
1471 return self.returncode
1472 elif endtime is not None:
1473 # Enter a busy loop if we have a timeout. This busy loop was
1474 # cribbed from Lib/threading.py in Thread.wait() at r71065.
1475 delay = 0.0005 # 500 us -> initial delay of 1 ms
1476 while True:
1477 (pid, sts) = self._try_wait(os.WNOHANG)
1478 assert pid == self.pid or pid == 0
1479 if pid == self.pid:
1480 self._handle_exitstatus(sts)
1481 break
1482 remaining = self._remaining_time(endtime)
1483 if remaining <= 0:
1484 raise TimeoutExpired(self.args)
1485 delay = min(delay * 2, remaining, .05)
1486 time.sleep(delay)
1487 elif self.returncode is None:
1488 (pid, sts) = self._try_wait(0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001489 self._handle_exitstatus(sts)
1490 return self.returncode
1491
1492
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001493 def _communicate(self, input, endtime):
1494 if self.stdin and not self._communication_started:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001495 # Flush stdio buffer. This might block, if the user has
1496 # been writing to .stdin in an uncontrolled fashion.
1497 self.stdin.flush()
1498 if not input:
1499 self.stdin.close()
1500
1501 if _has_poll:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001502 stdout, stderr = self._communicate_with_poll(input, endtime)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001503 else:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001504 stdout, stderr = self._communicate_with_select(input, endtime)
1505
1506 self.wait(timeout=self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001507
1508 # All data exchanged. Translate lists into strings.
1509 if stdout is not None:
1510 stdout = b''.join(stdout)
1511 if stderr is not None:
1512 stderr = b''.join(stderr)
1513
1514 # Translate newlines, if requested.
1515 # This also turns bytes into strings.
1516 if self.universal_newlines:
1517 if stdout is not None:
1518 stdout = self._translate_newlines(stdout,
1519 self.stdout.encoding)
1520 if stderr is not None:
1521 stderr = self._translate_newlines(stderr,
1522 self.stderr.encoding)
1523
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001524 return (stdout, stderr)
1525
1526
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001527 def _communicate_with_poll(self, input, endtime):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001528 stdout = None # Return
1529 stderr = None # Return
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001530
1531 if not self._communication_started:
1532 self._fd2file = {}
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001533
1534 poller = select.poll()
1535 def register_and_append(file_obj, eventmask):
1536 poller.register(file_obj.fileno(), eventmask)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001537 self._fd2file[file_obj.fileno()] = file_obj
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001538
1539 def close_unregister_and_remove(fd):
1540 poller.unregister(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001541 self._fd2file[fd].close()
1542 self._fd2file.pop(fd)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001543
1544 if self.stdin and input:
1545 register_and_append(self.stdin, select.POLLOUT)
1546
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001547 # Only create this mapping if we haven't already.
1548 if not self._communication_started:
1549 self._fd2output = {}
1550 if self.stdout:
1551 self._fd2output[self.stdout.fileno()] = []
1552 if self.stderr:
1553 self._fd2output[self.stderr.fileno()] = []
1554
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001555 select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
1556 if self.stdout:
1557 register_and_append(self.stdout, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001558 stdout = self._fd2output[self.stdout.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001559 if self.stderr:
1560 register_and_append(self.stderr, select_POLLIN_POLLPRI)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001561 stderr = self._fd2output[self.stderr.fileno()]
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001562
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001563 # Save the input here so that if we time out while communicating,
1564 # we can continue sending input if we retry.
1565 if self.stdin and self._input is None:
1566 self._input_offset = 0
1567 self._input = input
1568 if self.universal_newlines:
1569 self._input = self._input.encode(self.stdin.encoding)
1570
1571 while self._fd2file:
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001572 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001573 ready = poller.poll(self._remaining_time(endtime))
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001574 except select.error as e:
1575 if e.args[0] == errno.EINTR:
1576 continue
1577 raise
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001578 self._check_timeout(endtime)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001579
1580 # XXX Rewrite these to use non-blocking I/O on the
1581 # file objects; they are no longer using C stdio!
1582
1583 for fd, mode in ready:
1584 if mode & select.POLLOUT:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001585 chunk = self._input[self._input_offset :
1586 self._input_offset + _PIPE_BUF]
1587 self._input_offset += os.write(fd, chunk)
1588 if self._input_offset >= len(self._input):
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001589 close_unregister_and_remove(fd)
1590 elif mode & select_POLLIN_POLLPRI:
1591 data = os.read(fd, 4096)
1592 if not data:
1593 close_unregister_and_remove(fd)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001594 self._fd2output[fd].append(data)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001595 else:
1596 # Ignore hang up or errors.
1597 close_unregister_and_remove(fd)
1598
1599 return (stdout, stderr)
1600
1601
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001602 def _communicate_with_select(self, input, endtime):
1603 if not self._communication_started:
1604 self._read_set = []
1605 self._write_set = []
1606 if self.stdin and input:
1607 self._write_set.append(self.stdin)
1608 if self.stdout:
1609 self._read_set.append(self.stdout)
1610 if self.stderr:
1611 self._read_set.append(self.stderr)
1612
1613 if self.stdin and self._input is None:
1614 self._input_offset = 0
1615 self._input = input
1616 if self.universal_newlines:
1617 self._input = self._input.encode(self.stdin.encoding)
1618
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001619 stdout = None # Return
1620 stderr = None # Return
1621
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001622 if self.stdout:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001623 if not self._communication_started:
1624 self._stdout_buff = []
1625 stdout = self._stdout_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001626 if self.stderr:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001627 if not self._communication_started:
1628 self._stderr_buff = []
1629 stderr = self._stderr_buff
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001630
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001631 while self._read_set or self._write_set:
Georg Brandl86b2fb92008-07-16 03:43:04 +00001632 try:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001633 (rlist, wlist, xlist) = \
1634 select.select(self._read_set, self._write_set, [],
1635 self._remaining_time(endtime))
Georg Brandl86b2fb92008-07-16 03:43:04 +00001636 except select.error as e:
1637 if e.args[0] == errno.EINTR:
1638 continue
1639 raise
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001640
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001641 # According to the docs, returning three empty lists indicates
1642 # that the timeout expired.
1643 if not (rlist or wlist or xlist):
1644 raise TimeoutExpired(self.args)
1645 # We also check what time it is ourselves for good measure.
1646 self._check_timeout(endtime)
1647
Guido van Rossum98297ee2007-11-06 21:34:58 +00001648 # XXX Rewrite these to use non-blocking I/O on the
1649 # file objects; they are no longer using C stdio!
1650
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001651 if self.stdin in wlist:
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001652 chunk = self._input[self._input_offset :
1653 self._input_offset + _PIPE_BUF]
Guido van Rossumbae07c92007-10-08 02:46:15 +00001654 bytes_written = os.write(self.stdin.fileno(), chunk)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001655 self._input_offset += bytes_written
1656 if self._input_offset >= len(self._input):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001657 self.stdin.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001658 self._write_set.remove(self.stdin)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001659
1660 if self.stdout in rlist:
1661 data = os.read(self.stdout.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001662 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001663 self.stdout.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001664 self._read_set.remove(self.stdout)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001665 stdout.append(data)
1666
1667 if self.stderr in rlist:
1668 data = os.read(self.stderr.fileno(), 1024)
Guido van Rossumc9e363c2007-05-15 23:18:55 +00001669 if not data:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001670 self.stderr.close()
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001671 self._read_set.remove(self.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001672 stderr.append(data)
1673
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001674 return (stdout, stderr)
1675
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001676
Christian Heimesa342c012008-04-20 21:01:16 +00001677 def send_signal(self, sig):
1678 """Send a signal to the process
1679 """
1680 os.kill(self.pid, sig)
1681
1682 def terminate(self):
1683 """Terminate the process with SIGTERM
1684 """
1685 self.send_signal(signal.SIGTERM)
1686
1687 def kill(self):
1688 """Kill the process with SIGKILL
1689 """
1690 self.send_signal(signal.SIGKILL)
1691
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001692
1693def _demo_posix():
1694 #
1695 # Example 1: Simple redirection: Get process list
1696 #
1697 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001698 print("Process list:")
1699 print(plist)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001700
1701 #
1702 # Example 2: Change uid before executing child
1703 #
1704 if os.getuid() == 0:
1705 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
1706 p.wait()
1707
1708 #
1709 # Example 3: Connecting several subprocesses
1710 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001711 print("Looking for 'hda'...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001712 p1 = Popen(["dmesg"], stdout=PIPE)
1713 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001714 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001715
1716 #
1717 # Example 4: Catch execution error
1718 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001719 print()
1720 print("Trying a weird file...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001721 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001722 print(Popen(["/this/path/does/not/exist"]).communicate())
Guido van Rossumb940e112007-01-10 16:19:56 +00001723 except OSError as e:
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001724 if e.errno == errno.ENOENT:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001725 print("The file didn't exist. I thought so...")
1726 print("Child traceback:")
1727 print(e.child_traceback)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001728 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001729 print("Error", e.errno)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001730 else:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001731 print("Gosh. No error.", file=sys.stderr)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001732
1733
1734def _demo_windows():
1735 #
1736 # Example 1: Connecting several subprocesses
1737 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001738 print("Looking for 'PROMPT' in set output...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001739 p1 = Popen("set", stdout=PIPE, shell=True)
1740 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001741 print(repr(p2.communicate()[0]))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001742
1743 #
1744 # Example 2: Simple execution of program
1745 #
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001746 print("Executing calc...")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001747 p = Popen("calc")
1748 p.wait()
1749
1750
1751if __name__ == "__main__":
1752 if mswindows:
1753 _demo_windows()
1754 else:
1755 _demo_posix()