cpython-lru_cache-weakref: Lib/subprocess.py annotate

annotate Lib/subprocess.py @ 38664:7619216bbc19 2.4

Bug #1502728: Correctly link against librt library on HP-UX. (backport from rev. 46743)

author	Georg Brandl <georg@python.org>
date	Thu, 08 Jun 2006 12:54:16 +0000
parents	913e5e84fade
children	d84224320f82

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

Mercurial > cpython-lru_cache-weakref

annotate Lib/subprocess.py @ 38664:7619216bbc19 2.4