_scons_subprocess.py.svn-base
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:43k
源码类别:

外挂编程

开发平台:

Windows_Unix

  1. # subprocess - Subprocesses with accessible I/O streams
  2. #
  3. # For more information about this module, see PEP 324.
  4. #
  5. # This module should remain compatible with Python 2.2, see PEP 291.
  6. #
  7. # Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
  8. #
  9. # Licensed to PSF under a Contributor Agreement.
  10. # See http://www.python.org/2.4/license for licensing details.
  11. r"""subprocess - Subprocesses with accessible I/O streams
  12. This module allows you to spawn processes, connect to their
  13. input/output/error pipes, and obtain their return codes.  This module
  14. intends to replace several other, older modules and functions, like:
  15. os.system
  16. os.spawn*
  17. os.popen*
  18. popen2.*
  19. commands.*
  20. Information about how the subprocess module can be used to replace these
  21. modules and functions can be found below.
  22. Using the subprocess module
  23. ===========================
  24. This module defines one class called Popen:
  25. class Popen(args, bufsize=0, executable=None,
  26.             stdin=None, stdout=None, stderr=None,
  27.             preexec_fn=None, close_fds=False, shell=False,
  28.             cwd=None, env=None, universal_newlines=False,
  29.             startupinfo=None, creationflags=0):
  30. Arguments are:
  31. args should be a string, or a sequence of program arguments.  The
  32. program to execute is normally the first item in the args sequence or
  33. string, but can be explicitly set by using the executable argument.
  34. On UNIX, with shell=False (default): In this case, the Popen class
  35. uses os.execvp() to execute the child program.  args should normally
  36. be a sequence.  A string will be treated as a sequence with the string
  37. as the only item (the program to execute).
  38. On UNIX, with shell=True: If args is a string, it specifies the
  39. command string to execute through the shell.  If args is a sequence,
  40. the first item specifies the command string, and any additional items
  41. will be treated as additional shell arguments.
  42. On Windows: the Popen class uses CreateProcess() to execute the child
  43. program, which operates on strings.  If args is a sequence, it will be
  44. converted to a string using the list2cmdline method.  Please note that
  45. not all MS Windows applications interpret the command line the same
  46. way: The list2cmdline is designed for applications using the same
  47. rules as the MS C runtime.
  48. bufsize, if given, has the same meaning as the corresponding argument
  49. to the built-in open() function: 0 means unbuffered, 1 means line
  50. buffered, any other positive value means use a buffer of
  51. (approximately) that size.  A negative bufsize means to use the system
  52. default, which usually means fully buffered.  The default value for
  53. bufsize is 0 (unbuffered).
  54. stdin, stdout and stderr specify the executed programs' standard
  55. input, standard output and standard error file handles, respectively.
  56. Valid values are PIPE, an existing file descriptor (a positive
  57. integer), an existing file object, and None.  PIPE indicates that a
  58. new pipe to the child should be created.  With None, no redirection
  59. will occur; the child's file handles will be inherited from the
  60. parent.  Additionally, stderr can be STDOUT, which indicates that the
  61. stderr data from the applications should be captured into the same
  62. file handle as for stdout.
  63. If preexec_fn is set to a callable object, this object will be called
  64. in the child process just before the child is executed.
  65. If close_fds is true, all file descriptors except 0, 1 and 2 will be
  66. closed before the child process is executed.
  67. if shell is true, the specified command will be executed through the
  68. shell.
  69. If cwd is not None, the current directory will be changed to cwd
  70. before the child is executed.
  71. If env is not None, it defines the environment variables for the new
  72. process.
  73. If universal_newlines is true, the file objects stdout and stderr are
  74. opened as a text files, but lines may be terminated by any of 'n',
  75. the Unix end-of-line convention, 'r', the Macintosh convention or
  76. 'rn', the Windows convention.  All of these external representations
  77. are seen as 'n' by the Python program.  Note: This feature is only
  78. available if Python is built with universal newline support (the
  79. default).  Also, the newlines attribute of the file objects stdout,
  80. stdin and stderr are not updated by the communicate() method.
  81. The startupinfo and creationflags, if given, will be passed to the
  82. underlying CreateProcess() function.  They can specify things such as
  83. appearance of the main window and priority for the new process.
  84. (Windows only)
  85. This module also defines two shortcut functions:
  86. call(*popenargs, **kwargs):
  87.     Run command with arguments.  Wait for command to complete, then
  88.     return the returncode attribute.
  89.     The arguments are the same as for the Popen constructor.  Example:
  90.     retcode = call(["ls", "-l"])
  91. check_call(*popenargs, **kwargs):
  92.     Run command with arguments.  Wait for command to complete.  If the
  93.     exit code was zero then return, otherwise raise
  94.     CalledProcessError.  The CalledProcessError object will have the
  95.     return code in the returncode attribute.
  96.     The arguments are the same as for the Popen constructor.  Example:
  97.     check_call(["ls", "-l"])
  98. Exceptions
  99. ----------
  100. Exceptions raised in the child process, before the new program has
  101. started to execute, will be re-raised in the parent.  Additionally,
  102. the exception object will have one extra attribute called
  103. 'child_traceback', which is a string containing traceback information
  104. from the childs point of view.
  105. The most common exception raised is OSError.  This occurs, for
  106. example, when trying to execute a non-existent file.  Applications
  107. should prepare for OSErrors.
  108. A ValueError will be raised if Popen is called with invalid arguments.
  109. check_call() will raise CalledProcessError, if the called process
  110. returns a non-zero return code.
  111. Security
  112. --------
  113. Unlike some other popen functions, this implementation will never call
  114. /bin/sh implicitly.  This means that all characters, including shell
  115. metacharacters, can safely be passed to child processes.
  116. Popen objects
  117. =============
  118. Instances of the Popen class have the following methods:
  119. poll()
  120.     Check if child process has terminated.  Returns returncode
  121.     attribute.
  122. wait()
  123.     Wait for child process to terminate.  Returns returncode attribute.
  124. communicate(input=None)
  125.     Interact with process: Send data to stdin.  Read data from stdout
  126.     and stderr, until end-of-file is reached.  Wait for process to
  127.     terminate.  The optional stdin argument should be a string to be
  128.     sent to the child process, or None, if no data should be sent to
  129.     the child.
  130.     communicate() returns a tuple (stdout, stderr).
  131.     Note: The data read is buffered in memory, so do not use this
  132.     method if the data size is large or unlimited.
  133. The following attributes are also available:
  134. stdin
  135.     If the stdin argument is PIPE, this attribute is a file object
  136.     that provides input to the child process.  Otherwise, it is None.
  137. stdout
  138.     If the stdout argument is PIPE, this attribute is a file object
  139.     that provides output from the child process.  Otherwise, it is
  140.     None.
  141. stderr
  142.     If the stderr argument is PIPE, this attribute is file object that
  143.     provides error output from the child process.  Otherwise, it is
  144.     None.
  145. pid
  146.     The process ID of the child process.
  147. returncode
  148.     The child return code.  A None value indicates that the process
  149.     hasn't terminated yet.  A negative value -N indicates that the
  150.     child was terminated by signal N (UNIX only).
  151. Replacing older functions with the subprocess module
  152. ====================================================
  153. In this section, "a ==> b" means that b can be used as a replacement
  154. for a.
  155. Note: All functions in this section fail (more or less) silently if
  156. the executed program cannot be found; this module raises an OSError
  157. exception.
  158. In the following examples, we assume that the subprocess module is
  159. imported with "from subprocess import *".
  160. Replacing /bin/sh shell backquote
  161. ---------------------------------
  162. output=`mycmd myarg`
  163. ==>
  164. output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
  165. Replacing shell pipe line
  166. -------------------------
  167. output=`dmesg | grep hda`
  168. ==>
  169. p1 = Popen(["dmesg"], stdout=PIPE)
  170. p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
  171. output = p2.communicate()[0]
  172. Replacing os.system()
  173. ---------------------
  174. sts = os.system("mycmd" + " myarg")
  175. ==>
  176. p = Popen("mycmd" + " myarg", shell=True)
  177. pid, sts = os.waitpid(p.pid, 0)
  178. Note:
  179. * Calling the program through the shell is usually not required.
  180. * It's easier to look at the returncode attribute than the
  181.   exitstatus.
  182. A more real-world example would look like this:
  183. try:
  184.     retcode = call("mycmd" + " myarg", shell=True)
  185.     if retcode < 0:
  186.         print >>sys.stderr, "Child was terminated by signal", -retcode
  187.     else:
  188.         print >>sys.stderr, "Child returned", retcode
  189. except OSError, e:
  190.     print >>sys.stderr, "Execution failed:", e
  191. Replacing os.spawn*
  192. -------------------
  193. P_NOWAIT example:
  194. pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
  195. ==>
  196. pid = Popen(["/bin/mycmd", "myarg"]).pid
  197. P_WAIT example:
  198. retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
  199. ==>
  200. retcode = call(["/bin/mycmd", "myarg"])
  201. Vector example:
  202. os.spawnvp(os.P_NOWAIT, path, args)
  203. ==>
  204. Popen([path] + args[1:])
  205. Environment example:
  206. os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
  207. ==>
  208. Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
  209. Replacing os.popen*
  210. -------------------
  211. pipe = os.popen(cmd, mode='r', bufsize)
  212. ==>
  213. pipe = Popen(cmd, shell=True, bufsize=bufsize, stdout=PIPE).stdout
  214. pipe = os.popen(cmd, mode='w', bufsize)
  215. ==>
  216. pipe = Popen(cmd, shell=True, bufsize=bufsize, stdin=PIPE).stdin
  217. (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize)
  218. ==>
  219. p = Popen(cmd, shell=True, bufsize=bufsize,
  220.           stdin=PIPE, stdout=PIPE, close_fds=True)
  221. (child_stdin, child_stdout) = (p.stdin, p.stdout)
  222. (child_stdin,
  223.  child_stdout,
  224.  child_stderr) = os.popen3(cmd, mode, bufsize)
  225. ==>
  226. p = Popen(cmd, shell=True, bufsize=bufsize,
  227.           stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
  228. (child_stdin,
  229.  child_stdout,
  230.  child_stderr) = (p.stdin, p.stdout, p.stderr)
  231. (child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize)
  232. ==>
  233. p = Popen(cmd, shell=True, bufsize=bufsize,
  234.           stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
  235. (child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout)
  236. Replacing popen2.*
  237. ------------------
  238. Note: If the cmd argument to popen2 functions is a string, the command
  239. is executed through /bin/sh.  If it is a list, the command is directly
  240. executed.
  241. (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)
  242. ==>
  243. p = Popen(["somestring"], shell=True, bufsize=bufsize
  244.           stdin=PIPE, stdout=PIPE, close_fds=True)
  245. (child_stdout, child_stdin) = (p.stdout, p.stdin)
  246. (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode)
  247. ==>
  248. p = Popen(["mycmd", "myarg"], bufsize=bufsize,
  249.           stdin=PIPE, stdout=PIPE, close_fds=True)
  250. (child_stdout, child_stdin) = (p.stdout, p.stdin)
  251. The popen2.Popen3 and popen3.Popen4 basically works as subprocess.Popen,
  252. except that:
  253. * subprocess.Popen raises an exception if the execution fails
  254. * the capturestderr argument is replaced with the stderr argument.
  255. * stdin=PIPE and stdout=PIPE must be specified.
  256. * popen2 closes all filedescriptors by default, but you have to specify
  257.   close_fds=True with subprocess.Popen.
  258. """
  259. import sys
  260. mswindows = (sys.platform == "win32")
  261. import os
  262. import string
  263. import types
  264. import traceback
  265. # Exception classes used by this module.
  266. class CalledProcessError(Exception):
  267.     """This exception is raised when a process run by check_call() returns
  268.     a non-zero exit status.  The exit status will be stored in the
  269.     returncode attribute."""
  270.     def __init__(self, returncode, cmd):
  271.         self.returncode = returncode
  272.         self.cmd = cmd
  273.     def __str__(self):
  274.         return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
  275. if mswindows:
  276.     try:
  277.         import threading
  278.     except ImportError:
  279.         # SCons:  the threading module is only used by the communicate()
  280.         # method, which we don't actually use, so don't worry if we
  281.         # can't import it.
  282.         pass
  283.     import msvcrt
  284.     if 0: # <-- change this to use pywin32 instead of the _subprocess driver
  285.         import pywintypes
  286.         from win32api import GetStdHandle, STD_INPUT_HANDLE, 
  287.                              STD_OUTPUT_HANDLE, STD_ERROR_HANDLE
  288.         from win32api import GetCurrentProcess, DuplicateHandle, 
  289.                              GetModuleFileName, GetVersion
  290.         from win32con import DUPLICATE_SAME_ACCESS, SW_HIDE
  291.         from win32pipe import CreatePipe
  292.         from win32process import CreateProcess, STARTUPINFO, 
  293.                                  GetExitCodeProcess, STARTF_USESTDHANDLES, 
  294.                                  STARTF_USESHOWWINDOW, CREATE_NEW_CONSOLE
  295.         from win32event import WaitForSingleObject, INFINITE, WAIT_OBJECT_0
  296.     else:
  297.         from _subprocess import *
  298.         class STARTUPINFO:
  299.             dwFlags = 0
  300.             hStdInput = None
  301.             hStdOutput = None
  302.             hStdError = None
  303.             wShowWindow = 0
  304.         class pywintypes:
  305.             error = IOError
  306. else:
  307.     import select
  308.     import errno
  309.     import fcntl
  310.     import pickle
  311.     try:
  312.         fcntl.F_GETFD
  313.     except AttributeError:
  314.         fcntl.F_GETFD = 1
  315.     try:
  316.         fcntl.F_SETFD
  317.     except AttributeError:
  318.         fcntl.F_SETFD = 2
  319. __all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "CalledProcessError"]
  320. try:
  321.     MAXFD = os.sysconf("SC_OPEN_MAX")
  322. except KeyboardInterrupt:
  323.     raise       # SCons:  don't swallow keyboard interrupts
  324. except:
  325.     MAXFD = 256
  326. # True/False does not exist on 2.2.0
  327. try:
  328.     False
  329. except NameError:
  330.     False = 0
  331.     True = 1
  332. try:
  333.     isinstance(1, int)
  334. except TypeError:
  335.     def is_int(obj):
  336.         return type(obj) == type(1)
  337.     def is_int_or_long(obj):
  338.         return type(obj) in (type(1), type(1L))
  339. else:
  340.     def is_int(obj):
  341.         return isinstance(obj, int)
  342.     def is_int_or_long(obj):
  343.         return isinstance(obj, (int, long))
  344. try:
  345.     types.StringTypes
  346. except AttributeError:
  347.     try:
  348.         types.StringTypes = (types.StringType, types.UnicodeType)
  349.     except AttributeError:
  350.         types.StringTypes = (types.StringType,)
  351.     def is_string(obj):
  352.         return type(obj) in types.StringTypes
  353. else:
  354.     def is_string(obj):
  355.         return isinstance(obj, types.StringTypes)
  356. _active = []
  357. def _cleanup():
  358.     for inst in _active[:]:
  359.         if inst.poll(_deadstate=sys.maxint) >= 0:
  360.             try:
  361.                 _active.remove(inst)
  362.             except ValueError:
  363.                 # This can happen if two threads create a new Popen instance.
  364.                 # It's harmless that it was already removed, so ignore.
  365.                 pass
  366. PIPE = -1
  367. STDOUT = -2
  368. def call(*popenargs, **kwargs):
  369.     """Run command with arguments.  Wait for command to complete, then
  370.     return the returncode attribute.
  371.     The arguments are the same as for the Popen constructor.  Example:
  372.     retcode = call(["ls", "-l"])
  373.     """
  374.     return apply(Popen, popenargs, kwargs).wait()
  375. def check_call(*popenargs, **kwargs):
  376.     """Run command with arguments.  Wait for command to complete.  If
  377.     the exit code was zero then return, otherwise raise
  378.     CalledProcessError.  The CalledProcessError object will have the
  379.     return code in the returncode attribute.
  380.     The arguments are the same as for the Popen constructor.  Example:
  381.     check_call(["ls", "-l"])
  382.     """
  383.     retcode = apply(call, popenargs, kwargs)
  384.     cmd = kwargs.get("args")
  385.     if cmd is None:
  386.         cmd = popenargs[0]
  387.     if retcode:
  388.         raise CalledProcessError(retcode, cmd)
  389.     return retcode
  390. def list2cmdline(seq):
  391.     """
  392.     Translate a sequence of arguments into a command line
  393.     string, using the same rules as the MS C runtime:
  394.     1) Arguments are delimited by white space, which is either a
  395.        space or a tab.
  396.     2) A string surrounded by double quotation marks is
  397.        interpreted as a single argument, regardless of white space
  398.        contained within.  A quoted string can be embedded in an
  399.        argument.
  400.     3) A double quotation mark preceded by a backslash is
  401.        interpreted as a literal double quotation mark.
  402.     4) Backslashes are interpreted literally, unless they
  403.        immediately precede a double quotation mark.
  404.     5) If backslashes immediately precede a double quotation mark,
  405.        every pair of backslashes is interpreted as a literal
  406.        backslash.  If the number of backslashes is odd, the last
  407.        backslash escapes the next double quotation mark as
  408.        described in rule 3.
  409.     """
  410.     # See
  411.     # http://msdn.microsoft.com/library/en-us/vccelng/htm/progs_12.asp
  412.     result = []
  413.     needquote = False
  414.     for arg in seq:
  415.         bs_buf = []
  416.         # Add a space to separate this argument from the others
  417.         if result:
  418.             result.append(' ')
  419.         needquote = (" " in arg) or ("t" in arg)
  420.         if needquote:
  421.             result.append('"')
  422.         for c in arg:
  423.             if c == '\':
  424.                 # Don't know if we need to double yet.
  425.                 bs_buf.append(c)
  426.             elif c == '"':
  427.                 # Double backspaces.
  428.                 result.append('\' * len(bs_buf)*2)
  429.                 bs_buf = []
  430.                 result.append('\"')
  431.             else:
  432.                 # Normal char
  433.                 if bs_buf:
  434.                     result.extend(bs_buf)
  435.                     bs_buf = []
  436.                 result.append(c)
  437.         # Add remaining backspaces, if any.
  438.         if bs_buf:
  439.             result.extend(bs_buf)
  440.         if needquote:
  441.             result.extend(bs_buf)
  442.             result.append('"')
  443.     return string.join(result, '')
  444. try:
  445.     object
  446. except NameError:
  447.     class object:
  448.         pass
  449. class Popen(object):
  450.     def __init__(self, args, bufsize=0, executable=None,
  451.                  stdin=None, stdout=None, stderr=None,
  452.                  preexec_fn=None, close_fds=False, shell=False,
  453.                  cwd=None, env=None, universal_newlines=False,
  454.                  startupinfo=None, creationflags=0):
  455.         """Create new Popen instance."""
  456.         _cleanup()
  457.         self._child_created = False
  458.         if not is_int_or_long(bufsize):
  459.             raise TypeError("bufsize must be an integer")
  460.         if mswindows:
  461.             if preexec_fn is not None:
  462.                 raise ValueError("preexec_fn is not supported on Windows "
  463.                                  "platforms")
  464.             if close_fds:
  465.                 raise ValueError("close_fds is not supported on Windows "
  466.                                  "platforms")
  467.         else:
  468.             # POSIX
  469.             if startupinfo is not None:
  470.                 raise ValueError("startupinfo is only supported on Windows "
  471.                                  "platforms")
  472.             if creationflags != 0:
  473.                 raise ValueError("creationflags is only supported on Windows "
  474.                                  "platforms")
  475.         self.stdin = None
  476.         self.stdout = None
  477.         self.stderr = None
  478.         self.pid = None
  479.         self.returncode = None
  480.         self.universal_newlines = universal_newlines
  481.         # Input and output objects. The general principle is like
  482.         # this:
  483.         #
  484.         # Parent                   Child
  485.         # ------                   -----
  486.         # p2cwrite   ---stdin--->  p2cread
  487.         # c2pread    <--stdout---  c2pwrite
  488.         # errread    <--stderr---  errwrite
  489.         #
  490.         # On POSIX, the child objects are file descriptors.  On
  491.         # Windows, these are Windows file handles.  The parent objects
  492.         # are file descriptors on both platforms.  The parent objects
  493.         # are None when not using PIPEs. The child objects are None
  494.         # when not redirecting.
  495.         (p2cread, p2cwrite,
  496.          c2pread, c2pwrite,
  497.          errread, errwrite) = self._get_handles(stdin, stdout, stderr)
  498.         self._execute_child(args, executable, preexec_fn, close_fds,
  499.                             cwd, env, universal_newlines,
  500.                             startupinfo, creationflags, shell,
  501.                             p2cread, p2cwrite,
  502.                             c2pread, c2pwrite,
  503.                             errread, errwrite)
  504.         if p2cwrite:
  505.             self.stdin = os.fdopen(p2cwrite, 'wb', bufsize)
  506.         if c2pread:
  507.             if universal_newlines:
  508.                 self.stdout = os.fdopen(c2pread, 'rU', bufsize)
  509.             else:
  510.                 self.stdout = os.fdopen(c2pread, 'rb', bufsize)
  511.         if errread:
  512.             if universal_newlines:
  513.                 self.stderr = os.fdopen(errread, 'rU', bufsize)
  514.             else:
  515.                 self.stderr = os.fdopen(errread, 'rb', bufsize)
  516.     def _translate_newlines(self, data):
  517.         data = data.replace("rn", "n")
  518.         data = data.replace("r", "n")
  519.         return data
  520.     def __del__(self):
  521.         if not self._child_created:
  522.             # We didn't get to successfully create a child process.
  523.             return
  524.         # In case the child hasn't been waited on, check if it's done.
  525.         self.poll(_deadstate=sys.maxint)
  526.         if self.returncode is None and _active is not None:
  527.             # Child is still running, keep us alive until we can wait on it.
  528.             _active.append(self)
  529.     def communicate(self, input=None):
  530.         """Interact with process: Send data to stdin.  Read data from
  531.         stdout and stderr, until end-of-file is reached.  Wait for
  532.         process to terminate.  The optional input argument should be a
  533.         string to be sent to the child process, or None, if no data
  534.         should be sent to the child.
  535.         communicate() returns a tuple (stdout, stderr)."""
  536.         # Optimization: If we are only using one pipe, or no pipe at
  537.         # all, using select() or threads is unnecessary.
  538.         if [self.stdin, self.stdout, self.stderr].count(None) >= 2:
  539.             stdout = None
  540.             stderr = None
  541.             if self.stdin:
  542.                 if input:
  543.                     self.stdin.write(input)
  544.                 self.stdin.close()
  545.             elif self.stdout:
  546.                 stdout = self.stdout.read()
  547.             elif self.stderr:
  548.                 stderr = self.stderr.read()
  549.             self.wait()
  550.             return (stdout, stderr)
  551.         return self._communicate(input)
  552.     if mswindows:
  553.         #
  554.         # Windows methods
  555.         #
  556.         def _get_handles(self, stdin, stdout, stderr):
  557.             """Construct and return tupel with IO objects:
  558.             p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
  559.             """
  560.             if stdin is None and stdout is None and stderr is None:
  561.                 return (None, None, None, None, None, None)
  562.             p2cread, p2cwrite = None, None
  563.             c2pread, c2pwrite = None, None
  564.             errread, errwrite = None, None
  565.             if stdin is None:
  566.                 p2cread = GetStdHandle(STD_INPUT_HANDLE)
  567.             elif stdin == PIPE:
  568.                 p2cread, p2cwrite = CreatePipe(None, 0)
  569.                 # Detach and turn into fd
  570.                 p2cwrite = p2cwrite.Detach()
  571.                 p2cwrite = msvcrt.open_osfhandle(p2cwrite, 0)
  572.             elif is_int(stdin):
  573.                 p2cread = msvcrt.get_osfhandle(stdin)
  574.             else:
  575.                 # Assuming file-like object
  576.                 p2cread = msvcrt.get_osfhandle(stdin.fileno())
  577.             p2cread = self._make_inheritable(p2cread)
  578.             if stdout is None:
  579.                 c2pwrite = GetStdHandle(STD_OUTPUT_HANDLE)
  580.             elif stdout == PIPE:
  581.                 c2pread, c2pwrite = CreatePipe(None, 0)
  582.                 # Detach and turn into fd
  583.                 c2pread = c2pread.Detach()
  584.                 c2pread = msvcrt.open_osfhandle(c2pread, 0)
  585.             elif is_int(stdout):
  586.                 c2pwrite = msvcrt.get_osfhandle(stdout)
  587.             else:
  588.                 # Assuming file-like object
  589.                 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
  590.             c2pwrite = self._make_inheritable(c2pwrite)
  591.             if stderr is None:
  592.                 errwrite = GetStdHandle(STD_ERROR_HANDLE)
  593.             elif stderr == PIPE:
  594.                 errread, errwrite = CreatePipe(None, 0)
  595.                 # Detach and turn into fd
  596.                 errread = errread.Detach()
  597.                 errread = msvcrt.open_osfhandle(errread, 0)
  598.             elif stderr == STDOUT:
  599.                 errwrite = c2pwrite
  600.             elif is_int(stderr):
  601.                 errwrite = msvcrt.get_osfhandle(stderr)
  602.             else:
  603.                 # Assuming file-like object
  604.                 errwrite = msvcrt.get_osfhandle(stderr.fileno())
  605.             errwrite = self._make_inheritable(errwrite)
  606.             return (p2cread, p2cwrite,
  607.                     c2pread, c2pwrite,
  608.                     errread, errwrite)
  609.         def _make_inheritable(self, handle):
  610.             """Return a duplicate of handle, which is inheritable"""
  611.             return DuplicateHandle(GetCurrentProcess(), handle,
  612.                                    GetCurrentProcess(), 0, 1,
  613.                                    DUPLICATE_SAME_ACCESS)
  614.         def _find_w9xpopen(self):
  615.             """Find and return absolut path to w9xpopen.exe"""
  616.             w9xpopen = os.path.join(os.path.dirname(GetModuleFileName(0)),
  617.                                     "w9xpopen.exe")
  618.             if not os.path.exists(w9xpopen):
  619.                 # Eeek - file-not-found - possibly an embedding
  620.                 # situation - see if we can locate it in sys.exec_prefix
  621.                 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
  622.                                         "w9xpopen.exe")
  623.                 if not os.path.exists(w9xpopen):
  624.                     raise RuntimeError("Cannot locate w9xpopen.exe, which is "
  625.                                        "needed for Popen to work with your "
  626.                                        "shell or platform.")
  627.             return w9xpopen
  628.         def _execute_child(self, args, executable, preexec_fn, close_fds,
  629.                            cwd, env, universal_newlines,
  630.                            startupinfo, creationflags, shell,
  631.                            p2cread, p2cwrite,
  632.                            c2pread, c2pwrite,
  633.                            errread, errwrite):
  634.             """Execute program (MS Windows version)"""
  635.             if not isinstance(args, types.StringTypes):
  636.                 args = list2cmdline(args)
  637.             # Process startup details
  638.             if startupinfo is None:
  639.                 startupinfo = STARTUPINFO()
  640.             if None not in (p2cread, c2pwrite, errwrite):
  641.                 startupinfo.dwFlags = startupinfo.dwFlags | STARTF_USESTDHANDLES
  642.                 startupinfo.hStdInput = p2cread
  643.                 startupinfo.hStdOutput = c2pwrite
  644.                 startupinfo.hStdError = errwrite
  645.             if shell:
  646.                 startupinfo.dwFlags = startupinfo.dwFlags | STARTF_USESHOWWINDOW
  647.                 startupinfo.wShowWindow = SW_HIDE
  648.                 comspec = os.environ.get("COMSPEC", "cmd.exe")
  649.                 args = comspec + " /c " + args
  650.                 if (GetVersion() >= 0x80000000L or
  651.                         os.path.basename(comspec).lower() == "command.com"):
  652.                     # Win9x, or using command.com on NT. We need to
  653.                     # use the w9xpopen intermediate program. For more
  654.                     # information, see KB Q150956
  655.                     # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
  656.                     w9xpopen = self._find_w9xpopen()
  657.                     args = '"%s" %s' % (w9xpopen, args)
  658.                     # Not passing CREATE_NEW_CONSOLE has been known to
  659.                     # cause random failures on win9x.  Specifically a
  660.                     # dialog: "Your program accessed mem currently in
  661.                     # use at xxx" and a hopeful warning about the
  662.                     # stability of your system.  Cost is Ctrl+C wont
  663.                     # kill children.
  664.                     creationflags = creationflags | CREATE_NEW_CONSOLE
  665.             # Start the process
  666.             try:
  667.                 hp, ht, pid, tid = CreateProcess(executable, args,
  668.                                          # no special security
  669.                                          None, None,
  670.                                          # must inherit handles to pass std
  671.                                          # handles
  672.                                          1,
  673.                                          creationflags,
  674.                                          env,
  675.                                          cwd,
  676.                                          startupinfo)
  677.             except pywintypes.error, e:
  678.                 # Translate pywintypes.error to WindowsError, which is
  679.                 # a subclass of OSError.  FIXME: We should really
  680.                 # translate errno using _sys_errlist (or simliar), but
  681.                 # how can this be done from Python?
  682.                 raise apply(WindowsError, e.args)
  683.             # Retain the process handle, but close the thread handle
  684.             self._child_created = True
  685.             self._handle = hp
  686.             self.pid = pid
  687.             ht.Close()
  688.             # Child is launched. Close the parent's copy of those pipe
  689.             # handles that only the child should have open.  You need
  690.             # to make sure that no handles to the write end of the
  691.             # output pipe are maintained in this process or else the
  692.             # pipe will not close when the child process exits and the
  693.             # ReadFile will hang.
  694.             if p2cread is not None:
  695.                 p2cread.Close()
  696.             if c2pwrite is not None:
  697.                 c2pwrite.Close()
  698.             if errwrite is not None:
  699.                 errwrite.Close()
  700.         def poll(self, _deadstate=None):
  701.             """Check if child process has terminated.  Returns returncode
  702.             attribute."""
  703.             if self.returncode is None:
  704.                 if WaitForSingleObject(self._handle, 0) == WAIT_OBJECT_0:
  705.                     self.returncode = GetExitCodeProcess(self._handle)
  706.             return self.returncode
  707.         def wait(self):
  708.             """Wait for child process to terminate.  Returns returncode
  709.             attribute."""
  710.             if self.returncode is None:
  711.                 obj = WaitForSingleObject(self._handle, INFINITE)
  712.                 self.returncode = GetExitCodeProcess(self._handle)
  713.             return self.returncode
  714.         def _readerthread(self, fh, buffer):
  715.             buffer.append(fh.read())
  716.         def _communicate(self, input):
  717.             stdout = None # Return
  718.             stderr = None # Return
  719.             if self.stdout:
  720.                 stdout = []
  721.                 stdout_thread = threading.Thread(target=self._readerthread,
  722.                                                  args=(self.stdout, stdout))
  723.                 stdout_thread.setDaemon(True)
  724.                 stdout_thread.start()
  725.             if self.stderr:
  726.                 stderr = []
  727.                 stderr_thread = threading.Thread(target=self._readerthread,
  728.                                                  args=(self.stderr, stderr))
  729.                 stderr_thread.setDaemon(True)
  730.                 stderr_thread.start()
  731.             if self.stdin:
  732.                 if input is not None:
  733.                     self.stdin.write(input)
  734.                 self.stdin.close()
  735.             if self.stdout:
  736.                 stdout_thread.join()
  737.             if self.stderr:
  738.                 stderr_thread.join()
  739.             # All data exchanged.  Translate lists into strings.
  740.             if stdout is not None:
  741.                 stdout = stdout[0]
  742.             if stderr is not None:
  743.                 stderr = stderr[0]
  744.             # Translate newlines, if requested.  We cannot let the file
  745.             # object do the translation: It is based on stdio, which is
  746.             # impossible to combine with select (unless forcing no
  747.             # buffering).
  748.             if self.universal_newlines and hasattr(file, 'newlines'):
  749.                 if stdout:
  750.                     stdout = self._translate_newlines(stdout)
  751.                 if stderr:
  752.                     stderr = self._translate_newlines(stderr)
  753.             self.wait()
  754.             return (stdout, stderr)
  755.     else:
  756.         #
  757.         # POSIX methods
  758.         #
  759.         def _get_handles(self, stdin, stdout, stderr):
  760.             """Construct and return tupel with IO objects:
  761.             p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
  762.             """
  763.             p2cread, p2cwrite = None, None
  764.             c2pread, c2pwrite = None, None
  765.             errread, errwrite = None, None
  766.             if stdin is None:
  767.                 pass
  768.             elif stdin == PIPE:
  769.                 p2cread, p2cwrite = os.pipe()
  770.             elif is_int(stdin):
  771.                 p2cread = stdin
  772.             else:
  773.                 # Assuming file-like object
  774.                 p2cread = stdin.fileno()
  775.             if stdout is None:
  776.                 pass
  777.             elif stdout == PIPE:
  778.                 c2pread, c2pwrite = os.pipe()
  779.             elif is_int(stdout):
  780.                 c2pwrite = stdout
  781.             else:
  782.                 # Assuming file-like object
  783.                 c2pwrite = stdout.fileno()
  784.             if stderr is None:
  785.                 pass
  786.             elif stderr == PIPE:
  787.                 errread, errwrite = os.pipe()
  788.             elif stderr == STDOUT:
  789.                 errwrite = c2pwrite
  790.             elif is_int(stderr):
  791.                 errwrite = stderr
  792.             else:
  793.                 # Assuming file-like object
  794.                 errwrite = stderr.fileno()
  795.             return (p2cread, p2cwrite,
  796.                     c2pread, c2pwrite,
  797.                     errread, errwrite)
  798.         def _set_cloexec_flag(self, fd):
  799.             try:
  800.                 cloexec_flag = fcntl.FD_CLOEXEC
  801.             except AttributeError:
  802.                 cloexec_flag = 1
  803.             old = fcntl.fcntl(fd, fcntl.F_GETFD)
  804.             fcntl.fcntl(fd, fcntl.F_SETFD, old | cloexec_flag)
  805.         def _close_fds(self, but):
  806.             for i in xrange(3, MAXFD):
  807.                 if i == but:
  808.                     continue
  809.                 try:
  810.                     os.close(i)
  811.                 except KeyboardInterrupt:
  812.                     raise       # SCons:  don't swallow keyboard interrupts
  813.                 except:
  814.                     pass
  815.         def _execute_child(self, args, executable, preexec_fn, close_fds,
  816.                            cwd, env, universal_newlines,
  817.                            startupinfo, creationflags, shell,
  818.                            p2cread, p2cwrite,
  819.                            c2pread, c2pwrite,
  820.                            errread, errwrite):
  821.             """Execute program (POSIX version)"""
  822.             if is_string(args):
  823.                 args = [args]
  824.             if shell:
  825.                 args = ["/bin/sh", "-c"] + args
  826.             if executable is None:
  827.                 executable = args[0]
  828.             # For transferring possible exec failure from child to parent
  829.             # The first char specifies the exception type: 0 means
  830.             # OSError, 1 means some other error.
  831.             errpipe_read, errpipe_write = os.pipe()
  832.             self._set_cloexec_flag(errpipe_write)
  833.             self.pid = os.fork()
  834.             self._child_created = True
  835.             if self.pid == 0:
  836.                 # Child
  837.                 try:
  838.                     # Close parent's pipe ends
  839.                     if p2cwrite:
  840.                         os.close(p2cwrite)
  841.                     if c2pread:
  842.                         os.close(c2pread)
  843.                     if errread:
  844.                         os.close(errread)
  845.                     os.close(errpipe_read)
  846.                     # Dup fds for child
  847.                     if p2cread:
  848.                         os.dup2(p2cread, 0)
  849.                     if c2pwrite:
  850.                         os.dup2(c2pwrite, 1)
  851.                     if errwrite:
  852.                         os.dup2(errwrite, 2)
  853.                     # Close pipe fds.  Make sure we don't close the same
  854.                     # fd more than once, or standard fds.
  855.                     try:
  856.                         set
  857.                     except NameError:
  858.                         # Fall-back for earlier Python versions, so epydoc
  859.                         # can use this module directly to execute things.
  860.                         if p2cread:
  861.                             os.close(p2cread)
  862.                         if c2pwrite and c2pwrite not in (p2cread,):
  863.                             os.close(c2pwrite)
  864.                         if errwrite and errwrite not in (p2cread, c2pwrite):
  865.                             os.close(errwrite)
  866.                     else:
  867.                         for fd in set((p2cread, c2pwrite, errwrite))-set((0,1,2)):
  868.                             if fd: os.close(fd)
  869.                     # Close all other fds, if asked for
  870.                     if close_fds:
  871.                         self._close_fds(but=errpipe_write)
  872.                     if cwd is not None:
  873.                         os.chdir(cwd)
  874.                     if preexec_fn:
  875.                         apply(preexec_fn)
  876.                     if env is None:
  877.                         os.execvp(executable, args)
  878.                     else:
  879.                         os.execvpe(executable, args, env)
  880.                 except KeyboardInterrupt:
  881.                     raise       # SCons:  don't swallow keyboard interrupts
  882.                 except:
  883.                     exc_type, exc_value, tb = sys.exc_info()
  884.                     # Save the traceback and attach it to the exception object
  885.                     exc_lines = traceback.format_exception(exc_type,
  886.                                                            exc_value,
  887.                                                            tb)
  888.                     exc_value.child_traceback = string.join(exc_lines, '')
  889.                     os.write(errpipe_write, pickle.dumps(exc_value))
  890.                 # This exitcode won't be reported to applications, so it
  891.                 # really doesn't matter what we return.
  892.                 os._exit(255)
  893.             # Parent
  894.             os.close(errpipe_write)
  895.             if p2cread and p2cwrite:
  896.                 os.close(p2cread)
  897.             if c2pwrite and c2pread:
  898.                 os.close(c2pwrite)
  899.             if errwrite and errread:
  900.                 os.close(errwrite)
  901.             # Wait for exec to fail or succeed; possibly raising exception
  902.             data = os.read(errpipe_read, 1048576) # Exceptions limited to 1 MB
  903.             os.close(errpipe_read)
  904.             if data != "":
  905.                 os.waitpid(self.pid, 0)
  906.                 child_exception = pickle.loads(data)
  907.                 raise child_exception
  908.         def _handle_exitstatus(self, sts):
  909.             if os.WIFSIGNALED(sts):
  910.                 self.returncode = -os.WTERMSIG(sts)
  911.             elif os.WIFEXITED(sts):
  912.                 self.returncode = os.WEXITSTATUS(sts)
  913.             else:
  914.                 # Should never happen
  915.                 raise RuntimeError("Unknown child exit status!")
  916.         def poll(self, _deadstate=None):
  917.             """Check if child process has terminated.  Returns returncode
  918.             attribute."""
  919.             if self.returncode is None:
  920.                 try:
  921.                     pid, sts = os.waitpid(self.pid, os.WNOHANG)
  922.                     if pid == self.pid:
  923.                         self._handle_exitstatus(sts)
  924.                 except os.error:
  925.                     if _deadstate is not None:
  926.                         self.returncode = _deadstate
  927.             return self.returncode
  928.         def wait(self):
  929.             """Wait for child process to terminate.  Returns returncode
  930.             attribute."""
  931.             if self.returncode is None:
  932.                 pid, sts = os.waitpid(self.pid, 0)
  933.                 self._handle_exitstatus(sts)
  934.             return self.returncode
  935.         def _communicate(self, input):
  936.             read_set = []
  937.             write_set = []
  938.             stdout = None # Return
  939.             stderr = None # Return
  940.             if self.stdin:
  941.                 # Flush stdio buffer.  This might block, if the user has
  942.                 # been writing to .stdin in an uncontrolled fashion.
  943.                 self.stdin.flush()
  944.                 if input:
  945.                     write_set.append(self.stdin)
  946.                 else:
  947.                     self.stdin.close()
  948.             if self.stdout:
  949.                 read_set.append(self.stdout)
  950.                 stdout = []
  951.             if self.stderr:
  952.                 read_set.append(self.stderr)
  953.                 stderr = []
  954.             input_offset = 0
  955.             while read_set or write_set:
  956.                 rlist, wlist, xlist = select.select(read_set, write_set, [])
  957.                 if self.stdin in wlist:
  958.                     # When select has indicated that the file is writable,
  959.                     # we can write up to PIPE_BUF bytes without risk
  960.                     # blocking.  POSIX defines PIPE_BUF >= 512
  961.                     bytes_written = os.write(self.stdin.fileno(), buffer(input, input_offset, 512))
  962.                     input_offset = input_offset + bytes_written
  963.                     if input_offset >= len(input):
  964.                         self.stdin.close()
  965.                         write_set.remove(self.stdin)
  966.                 if self.stdout in rlist:
  967.                     data = os.read(self.stdout.fileno(), 1024)
  968.                     if data == "":
  969.                         self.stdout.close()
  970.                         read_set.remove(self.stdout)
  971.                     stdout.append(data)
  972.                 if self.stderr in rlist:
  973.                     data = os.read(self.stderr.fileno(), 1024)
  974.                     if data == "":
  975.                         self.stderr.close()
  976.                         read_set.remove(self.stderr)
  977.                     stderr.append(data)
  978.             # All data exchanged.  Translate lists into strings.
  979.             if stdout is not None:
  980.                 stdout = string.join(stdout, '')
  981.             if stderr is not None:
  982.                 stderr = string.join(stderr, '')
  983.             # Translate newlines, if requested.  We cannot let the file
  984.             # object do the translation: It is based on stdio, which is
  985.             # impossible to combine with select (unless forcing no
  986.             # buffering).
  987.             if self.universal_newlines and hasattr(file, 'newlines'):
  988.                 if stdout:
  989.                     stdout = self._translate_newlines(stdout)
  990.                 if stderr:
  991.                     stderr = self._translate_newlines(stderr)
  992.             self.wait()
  993.             return (stdout, stderr)
  994. def _demo_posix():
  995.     #
  996.     # Example 1: Simple redirection: Get process list
  997.     #
  998.     plist = Popen(["ps"], stdout=PIPE).communicate()[0]
  999.     print "Process list:"
  1000.     print plist
  1001.     #
  1002.     # Example 2: Change uid before executing child
  1003.     #
  1004.     if os.getuid() == 0:
  1005.         p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
  1006.         p.wait()
  1007.     #
  1008.     # Example 3: Connecting several subprocesses
  1009.     #
  1010.     print "Looking for 'hda'..."
  1011.     p1 = Popen(["dmesg"], stdout=PIPE)
  1012.     p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
  1013.     print repr(p2.communicate()[0])
  1014.     #
  1015.     # Example 4: Catch execution error
  1016.     #
  1017.     print
  1018.     print "Trying a weird file..."
  1019.     try:
  1020.         print Popen(["/this/path/does/not/exist"]).communicate()
  1021.     except OSError, e:
  1022.         if e.errno == errno.ENOENT:
  1023.             print "The file didn't exist.  I thought so..."
  1024.             print "Child traceback:"
  1025.             print e.child_traceback
  1026.         else:
  1027.             print "Error", e.errno
  1028.     else:
  1029.         sys.stderr.write( "Gosh.  No error.n" )
  1030. def _demo_windows():
  1031.     #
  1032.     # Example 1: Connecting several subprocesses
  1033.     #
  1034.     print "Looking for 'PROMPT' in set output..."
  1035.     p1 = Popen("set", stdout=PIPE, shell=True)
  1036.     p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
  1037.     print repr(p2.communicate()[0])
  1038.     #
  1039.     # Example 2: Simple execution of program
  1040.     #
  1041.     print "Executing calc..."
  1042.     p = Popen("calc")
  1043.     p.wait()
  1044. if __name__ == "__main__":
  1045.     if mswindows:
  1046.         _demo_windows()
  1047.     else:
  1048.         _demo_posix()