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

annotate Lib/subprocess.py @ 33845:032f342efcd2 legacy-trunk

Very few little improvements.

author	Facundo Batista <facundobatista@gmail.com>
date	Tue, 26 Oct 2004 23:38:46 +0000
parents	c5d951a0e0c3
children	66223a9ebe48

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 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	5 # Copyright (c) 2003-2004 by Peter Astrand <astrand@lysator.liu.se>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	6 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	7 # By obtaining, using, and/or copying this software and/or its
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	8 # associated documentation, you agree that you have read, understood,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	9 # and will comply with the following terms and conditions:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	10 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	11 # Permission to use, copy, modify, and distribute this software and
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	12 # its associated documentation for any purpose and without fee is
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	13 # hereby granted, provided that the above copyright notice appears in
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	14 # all copies, and that both that copyright notice and this permission
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	15 # notice appear in supporting documentation, and that the name of the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	16 # author not be used in advertising or publicity pertaining to
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	17 # distribution of the software without specific, written prior
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	18 # permission.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	19 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	20 # THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	21 # INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	22 # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	23 # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	24 # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	25 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	26 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	27
33776 c5d951a0e0c3 Fix docstring formatting of escape sequences. Raymond Hettinger <python@rcn.com> parents: 33770 diff changeset	28 r"""subprocess - Subprocesses with accessible I/O streams
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	29
33770 c6aac03474c5 return codes are available on all platforms, not just on Unix Fredrik Lundh <fredrik@pythonware.com> parents: 33751 diff changeset	30 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	31 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	32 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	33
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	34 os.system
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	35 os.spawn*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	36 os.popen*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	37 popen2.*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	38 commands.*
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 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	41 modules and functions can be found below.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	42
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	43
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	44
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	45 Using the subprocess module
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	46 ===========================
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	47 This module defines one class called Popen:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	48
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	49 class Popen(args, bufsize=0, executable=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	50 stdin=None, stdout=None, stderr=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	51 preexec_fn=None, close_fds=False, shell=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	52 cwd=None, env=None, universal_newlines=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	53 startupinfo=None, creationflags=0):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	54
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 Arguments are:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	57
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	58 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	59 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	60 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	61
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	62 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	63 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	64 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	65 as the only item (the program to execute).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	66
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	67 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	68 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	69 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	70 will be treated as additional shell arguments.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	71
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	72 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	73 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	74 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	75 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	76 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	77 rules as the MS C runtime.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	78
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	79 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	80 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	81 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	82 (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	83 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	84 bufsize is 0 (unbuffered).
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 stdin, stdout and stderr specify the executed programs' standard
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	87 input, standard output and standard error file handles, respectively.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	88 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	89 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	90 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	91 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	92 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	93 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	94 file handle as for stdout.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	95
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	96 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	97 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	98
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	99 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	100 closed before the child process is executed.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	101
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	102 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	103 shell.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	104
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	105 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	106 before the child is executed.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	107
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	108 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	109 process.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	110
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	111 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	112 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	113 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	114 '\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	115 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	116 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	117 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	118 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	119
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	120 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	121 underlying CreateProcess() function. They can specify things such as
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	122 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	123 (Windows only)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	124
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	125
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	126 This module also defines two shortcut functions:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	127
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	128 call(args, *kwargs):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	129 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	130 return the returncode attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	131
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	132 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	133
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	134 retcode = call(["ls", "-l"])
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	137 Exceptions
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	138 ----------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	139 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	140 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	141 the exception object will have one extra attribute called
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	142 'child_traceback', which is a string containing traceback information
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	143 from the childs point of view.
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 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	146 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	147 should prepare for OSErrors.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	148
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	149 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	150
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	151
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	152 Security
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 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	155 /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	156 metacharacters, can safely be passed to child processes.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	157
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	158
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	159 Popen objects
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	160 =============
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	161 Instances of the Popen class have the following methods:
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 poll()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	164 Check if child process has terminated. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	165 attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	166
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	167 wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	168 Wait for child process to terminate. Returns returncode attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	169
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	170 communicate(input=None)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	171 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	172 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	173 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	174 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	175 the child.
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	176
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	177 communicate() returns a tuple (stdout, stderr).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	178
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	179 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	180 method if the data size is large or unlimited.
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 The following attributes are also available:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	183
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	184 stdin
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	185 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	186 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	187
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	188 stdout
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	189 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	190 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	191 None.
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 stderr
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	194 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	195 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	196 None.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	197
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	198 pid
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	199 The process ID of the child process.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	200
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	201 returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	202 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	203 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	204 child was terminated by signal N (UNIX only).
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	207 Replacing older functions with the subprocess module
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	208 ====================================================
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	209 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	210 for a.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	211
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	212 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	213 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	214 exception.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	215
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	216 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	217 imported with "from subprocess import *".
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 /bin/sh shell backquote
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 output=`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 output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	225
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 Replacing shell pipe line
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 output=`dmesg \| grep hda`
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 p1 = Popen(["dmesg"], stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	232 p2 = Popen(["grep", "hda"], stdin=p1.stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	233 output = p2.communicate()[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	234
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 Replacing os.system()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	237 ---------------------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	238 sts = os.system("mycmd" + " myarg")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	239 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	240 p = Popen("mycmd" + " myarg", shell=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	241 sts = os.waitpid(p.pid, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	242
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	243 Note:
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 * 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	246
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	247 * 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	248 exitstatus.
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 A more real-world example would look like this:
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 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	253 retcode = call("mycmd" + " myarg", shell=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	254 if retcode < 0:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	255 print >>sys.stderr, "Child was terminated by signal", -retcode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	256 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	257 print >>sys.stderr, "Child returned", retcode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	258 except OSError, e:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	259 print >>sys.stderr, "Execution failed:", e
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	262 Replacing os.spawn*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	263 -------------------
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	264 P_NOWAIT example:
33723 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 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	267 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	268 pid = Popen(["/bin/mycmd", "myarg"]).pid
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	269
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 P_WAIT example:
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 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	274 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	275 retcode = call(["/bin/mycmd", "myarg"])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	276
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	277
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	278 Vector example:
33723 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 os.spawnvp(os.P_NOWAIT, path, args)
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 Popen([path] + args[1:])
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
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	285 Environment example:
33723 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 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	288 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	289 Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	290
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	291
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	292 Replacing os.popen*
33723 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 pipe = os.popen(cmd, mode='r', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	295 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	296 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	297
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	298 pipe = os.popen(cmd, mode='w', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	299 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	300 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	301
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	302
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	303 (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize)
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 p = Popen(cmd, shell=True, bufsize=bufsize,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	306 stdin=PIPE, stdout=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	307 (child_stdin, child_stdout) = (p.stdin, p.stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	308
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	309
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	310 (child_stdin,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	311 child_stdout,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	312 child_stderr) = os.popen3(cmd, mode, bufsize)
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 p = Popen(cmd, shell=True, bufsize=bufsize,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	315 stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	316 (child_stdin,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	317 child_stdout,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	318 child_stderr) = (p.stdin, p.stdout, p.stderr)
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	321 (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	322 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	323 p = Popen(cmd, shell=True, bufsize=bufsize,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	324 stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	325 (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	326
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	327
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	328 Replacing popen2.*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	329 ------------------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	330 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	331 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	332 executed.
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 (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	335 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	336 p = Popen(["somestring"], shell=True, bufsize=bufsize
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	337 stdin=PIPE, stdout=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	338 (child_stdout, child_stdin) = (p.stdout, p.stdin)
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 (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	342 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	343 p = Popen(["mycmd", "myarg"], bufsize=bufsize,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	344 stdin=PIPE, stdout=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	345 (child_stdout, child_stdin) = (p.stdout, p.stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	346
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	347 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	348 except that:
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 * subprocess.Popen raises an exception if the execution fails
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	351 * the capturestderr argument is replaced with the stderr argument.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	352 * stdin=PIPE and stdout=PIPE must be specified.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	353 * 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	354 close_fds=True with subprocess.Popen.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	355
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	356
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	357 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	358
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	359 import sys
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	360 mswindows = (sys.platform == "win32")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	361
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	362 import os
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	363 import types
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	364 import traceback
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	365
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	366 if mswindows:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	367 import threading
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	368 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	369 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	370 import pywintypes
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	371 from win32api import GetStdHandle, STD_INPUT_HANDLE, \
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	372 STD_OUTPUT_HANDLE, STD_ERROR_HANDLE
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	373 from win32api import GetCurrentProcess, DuplicateHandle, \
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	374 GetModuleFileName, GetVersion
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	375 from win32con import DUPLICATE_SAME_ACCESS
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	376 from win32pipe import CreatePipe
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	377 from win32process import CreateProcess, STARTUPINFO, \
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	378 GetExitCodeProcess, STARTF_USESTDHANDLES, \
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	379 CREATE_NEW_CONSOLE
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	380 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	381 else:
aa2d6060495a Replace dynamic try/except with "if 0", to keep py2exe happy. If you Fredrik Lundh <fredrik@pythonware.com> parents: 33735 diff changeset	382 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	383 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	384 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	385 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	386 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	387 hStdError = None
aa2d6060495a Replace dynamic try/except with "if 0", to keep py2exe happy. If you Fredrik Lundh <fredrik@pythonware.com> parents: 33735 diff changeset	388 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	389 error = IOError
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	390 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	391 import select
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	392 import errno
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	393 import fcntl
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	394 import pickle
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	395
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	396 __all__ = ["Popen", "PIPE", "STDOUT", "call"]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	397
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	398 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	399 MAXFD = os.sysconf("SC_OPEN_MAX")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	400 except:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	401 MAXFD = 256
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	402
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	403 # True/False does not exist on 2.2.0
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	404 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	405 False
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	406 except NameError:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	407 False = 0
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	408 True = 1
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	409
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	410 _active = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	411
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	412 def _cleanup():
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	413 for inst in _active[:]:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	414 inst.poll()
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 PIPE = -1
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	417 STDOUT = -2
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	418
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	419
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	420 def call(args, *kwargs):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	421 """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	422 return the returncode attribute.
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 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	425
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	426 retcode = call(["ls", "-l"])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	427 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	428 return Popen(args, *kwargs).wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	429
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	430
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	431 def list2cmdline(seq):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	432 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	433 Translate a sequence of arguments into a command line
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	434 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	435
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	436 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	437 space or a tab.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	438
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	439 2) A string surrounded by double quotation marks is
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	440 interpreted as a single argument, regardless of white space
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	441 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	442 argument.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	443
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	444 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	445 interpreted as a literal double quotation mark.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	446
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	447 4) Backslashes are interpreted literally, unless they
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	448 immediately precede a double quotation mark.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	449
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	450 5) If backslashes immediately precede a double quotation mark,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	451 every pair of backslashes is interpreted as a literal
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	452 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	453 backslash escapes the next double quotation mark as
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	454 described in rule 3.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	455 """
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 # See
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	458 # 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	459 result = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	460 needquote = False
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	461 for arg in seq:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	462 bs_buf = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	463
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	464 # 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	465 if result:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	466 result.append(' ')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	467
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	468 needquote = (" " in arg) or ("\t" in arg)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	469 if needquote:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	470 result.append('"')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	471
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	472 for c in arg:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	473 if c == '\\':
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	474 # 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	475 bs_buf.append(c)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	476 elif c == '"':
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	477 # Double backspaces.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	478 result.append('\\' * len(bs_buf)*2)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	479 bs_buf = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	480 result.append('\\"')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	481 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	482 # Normal char
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	483 if bs_buf:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	484 result.extend(bs_buf)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	485 bs_buf = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	486 result.append(c)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	487
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	488 # Add remaining backspaces, if any.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	489 if bs_buf:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	490 result.extend(bs_buf)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	491
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	492 if needquote:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	493 result.append('"')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	494
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	495 return ''.join(result)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	496
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	497
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	498 class Popen(object):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	499 def __init__(self, args, bufsize=0, executable=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	500 stdin=None, stdout=None, stderr=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	501 preexec_fn=None, close_fds=False, shell=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	502 cwd=None, env=None, universal_newlines=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	503 startupinfo=None, creationflags=0):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	504 """Create new Popen instance."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	505 _cleanup()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	506
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	507 if mswindows:
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	508 if preexec_fn is not None:
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	509 raise ValueError("preexec_fn is not 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 if close_fds:
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	512 raise ValueError("close_fds is not supported on Windows "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	513 "platforms")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	514 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	515 # POSIX
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	516 if startupinfo is not None:
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	517 raise ValueError("startupinfo is only supported on Windows "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	518 "platforms")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	519 if creationflags != 0:
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	520 raise ValueError("creationflags is only supported on Windows "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	521 "platforms")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	522
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	523 self.stdin = None
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	524 self.stdout = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	525 self.stderr = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	526 self.pid = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	527 self.returncode = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	528 self.universal_newlines = universal_newlines
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	529
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	530 # Input and output objects. The general principle is like
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	531 # this:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	532 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	533 # Parent Child
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	534 # ------ -----
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	535 # p2cwrite ---stdin---> p2cread
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	536 # c2pread <--stdout--- c2pwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	537 # errread <--stderr--- errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	538 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	539 # On POSIX, the child objects are file descriptors. On
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	540 # Windows, these are Windows file handles. The parent objects
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	541 # are file descriptors on both platforms. The parent objects
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	542 # 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	543 # when not redirecting.
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	544
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	545 (p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	546 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	547 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	548
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	549 self._execute_child(args, executable, preexec_fn, close_fds,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	550 cwd, env, universal_newlines,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	551 startupinfo, creationflags, shell,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	552 p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	553 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	554 errread, errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	555
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	556 if p2cwrite:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	557 self.stdin = os.fdopen(p2cwrite, 'wb', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	558 if c2pread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	559 if universal_newlines:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	560 self.stdout = os.fdopen(c2pread, 'rU', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	561 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	562 self.stdout = os.fdopen(c2pread, 'rb', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	563 if errread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	564 if universal_newlines:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	565 self.stderr = os.fdopen(errread, 'rU', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	566 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	567 self.stderr = os.fdopen(errread, 'rb', bufsize)
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	568
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	569 _active.append(self)
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	572 def _translate_newlines(self, data):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	573 data = data.replace("\r\n", "\n")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	574 data = data.replace("\r", "\n")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	575 return data
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	576
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	577
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	578 if mswindows:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	579 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	580 # Windows methods
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 def _get_handles(self, stdin, stdout, stderr):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	583 """Construct and return tupel with IO objects:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	584 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	585 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	586 if stdin == None and stdout == None and stderr == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	587 return (None, None, None, None, None, None)
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	588
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	589 p2cread, p2cwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	590 c2pread, c2pwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	591 errread, errwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	592
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	593 if stdin == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	594 p2cread = GetStdHandle(STD_INPUT_HANDLE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	595 elif stdin == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	596 p2cread, p2cwrite = CreatePipe(None, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	597 # Detach and turn into fd
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	598 p2cwrite = p2cwrite.Detach()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	599 p2cwrite = msvcrt.open_osfhandle(p2cwrite, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	600 elif type(stdin) == types.IntType:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	601 p2cread = msvcrt.get_osfhandle(stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	602 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	603 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	604 p2cread = msvcrt.get_osfhandle(stdin.fileno())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	605 p2cread = self._make_inheritable(p2cread)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	606
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	607 if stdout == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	608 c2pwrite = GetStdHandle(STD_OUTPUT_HANDLE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	609 elif stdout == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	610 c2pread, c2pwrite = CreatePipe(None, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	611 # Detach and turn into fd
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	612 c2pread = c2pread.Detach()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	613 c2pread = msvcrt.open_osfhandle(c2pread, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	614 elif type(stdout) == types.IntType:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	615 c2pwrite = msvcrt.get_osfhandle(stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	616 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	617 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	618 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	619 c2pwrite = self._make_inheritable(c2pwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	620
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	621 if stderr == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	622 errwrite = GetStdHandle(STD_ERROR_HANDLE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	623 elif stderr == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	624 errread, errwrite = CreatePipe(None, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	625 # Detach and turn into fd
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	626 errread = errread.Detach()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	627 errread = msvcrt.open_osfhandle(errread, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	628 elif stderr == STDOUT:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	629 errwrite = c2pwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	630 elif type(stderr) == types.IntType:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	631 errwrite = msvcrt.get_osfhandle(stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	632 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	633 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	634 errwrite = msvcrt.get_osfhandle(stderr.fileno())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	635 errwrite = self._make_inheritable(errwrite)
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 return (p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	638 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	639 errread, errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	640
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	641
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	642 def _make_inheritable(self, handle):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	643 """Return a duplicate of handle, which is inheritable"""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	644 return DuplicateHandle(GetCurrentProcess(), handle,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	645 GetCurrentProcess(), 0, 1,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	646 DUPLICATE_SAME_ACCESS)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	647
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	648
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	649 def _find_w9xpopen(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	650 """Find and return absolut path to w9xpopen.exe"""
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	651 w9xpopen = os.path.join(os.path.dirname(GetModuleFileName(0)),
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	652 "w9xpopen.exe")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	653 if not os.path.exists(w9xpopen):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	654 # Eeek - file-not-found - possibly an embedding
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	655 # 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	656 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	657 "w9xpopen.exe")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	658 if not os.path.exists(w9xpopen):
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	659 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	660 "needed for Popen to work with your "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	661 "shell or platform.")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	662 return w9xpopen
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	663
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	664
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	665 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	666 cwd, env, universal_newlines,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	667 startupinfo, creationflags, shell,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	668 p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	669 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	670 errread, errwrite):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	671 """Execute program (MS Windows version)"""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	672
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	673 if not isinstance(args, types.StringTypes):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	674 args = list2cmdline(args)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	675
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	676 if shell:
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 # Process startup details
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	696 if startupinfo == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	697 startupinfo = STARTUPINFO()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	698 if not None in (p2cread, c2pwrite, errwrite):
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	699 startupinfo.dwFlags \|= STARTF_USESTDHANDLES
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	700 startupinfo.hStdInput = p2cread
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	701 startupinfo.hStdOutput = c2pwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	702 startupinfo.hStdError = errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	703
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	704 # Start the process
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	705 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	706 hp, ht, pid, tid = CreateProcess(executable, args,
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	707 # no special security
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	708 None, None,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	709 # must inherit handles to pass std
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	710 # handles
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	711 1,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	712 creationflags,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	713 env,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	714 cwd,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	715 startupinfo)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	716 except pywintypes.error, e:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	717 # Translate pywintypes.error to WindowsError, which is
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	718 # a subclass of OSError. FIXME: We should really
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	719 # translate errno using _sys_errlist (or simliar), but
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	720 # how can this be done from Python?
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	721 raise WindowsError(*e.args)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	722
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	723 # Retain the process handle, but close the thread handle
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	724 self._handle = hp
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	725 self.pid = pid
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	726 ht.Close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	727
33727 0236b6530c46 Typo fix Andrew M. Kuchling <amk@amk.ca> parents: 33723 diff changeset	728 # 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	729 # 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	730 # 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	731 # 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	732 # 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	733 # ReadFile will hang.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	734 if p2cread != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	735 p2cread.Close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	736 if c2pwrite != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	737 c2pwrite.Close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	738 if errwrite != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	739 errwrite.Close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	740
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	741
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	742 def poll(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	743 """Check if child process has terminated. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	744 attribute."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	745 if self.returncode == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	746 if WaitForSingleObject(self._handle, 0) == WAIT_OBJECT_0:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	747 self.returncode = GetExitCodeProcess(self._handle)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	748 _active.remove(self)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	749 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	750
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 def wait(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	753 """Wait for child process to terminate. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	754 attribute."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	755 if self.returncode == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	756 obj = WaitForSingleObject(self._handle, INFINITE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	757 self.returncode = GetExitCodeProcess(self._handle)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	758 _active.remove(self)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	759 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	760
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	761
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	762 def _readerthread(self, fh, buffer):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	763 buffer.append(fh.read())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	764
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	765
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	766 def communicate(self, input=None):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	767 """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	768 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	769 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	770 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	771 should be sent to the child.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	772
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	773 communicate() returns a tuple (stdout, stderr)."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	774 stdout = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	775 stderr = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	776
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	777 if self.stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	778 stdout = []
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	779 stdout_thread = threading.Thread(target=self._readerthread,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	780 args=(self.stdout, stdout))
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	781 stdout_thread.setDaemon(True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	782 stdout_thread.start()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	783 if self.stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	784 stderr = []
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	785 stderr_thread = threading.Thread(target=self._readerthread,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	786 args=(self.stderr, stderr))
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	787 stderr_thread.setDaemon(True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	788 stderr_thread.start()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	789
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	790 if self.stdin:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	791 if input != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	792 self.stdin.write(input)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	793 self.stdin.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	794
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	795 if self.stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	796 stdout_thread.join()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	797 if self.stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	798 stderr_thread.join()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	799
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	800 # All data exchanged. Translate lists into strings.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	801 if stdout != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	802 stdout = stdout[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	803 if stderr != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	804 stderr = stderr[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	805
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	806 # Translate newlines, if requested. We cannot let the file
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	807 # 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	808 # impossible to combine with select (unless forcing no
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	809 # buffering).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	810 if self.universal_newlines and hasattr(open, 'newlines'):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	811 if stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	812 stdout = self._translate_newlines(stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	813 if stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	814 stderr = self._translate_newlines(stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	815
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	816 self.wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	817 return (stdout, stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	818
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	819 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	820 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	821 # POSIX methods
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	822 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	823 def _get_handles(self, stdin, stdout, stderr):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	824 """Construct and return tupel with IO objects:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	825 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	826 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	827 p2cread, p2cwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	828 c2pread, c2pwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	829 errread, errwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	830
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	831 if stdin == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	832 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	833 elif stdin == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	834 p2cread, p2cwrite = os.pipe()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	835 elif type(stdin) == types.IntType:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	836 p2cread = stdin
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	837 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	838 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	839 p2cread = stdin.fileno()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	840
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	841 if stdout == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	842 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	843 elif stdout == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	844 c2pread, c2pwrite = os.pipe()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	845 elif type(stdout) == types.IntType:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	846 c2pwrite = stdout
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	847 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	848 # Assuming file-like object
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	849 c2pwrite = stdout.fileno()
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	850
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	851 if stderr == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	852 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	853 elif stderr == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	854 errread, errwrite = os.pipe()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	855 elif stderr == STDOUT:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	856 errwrite = c2pwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	857 elif type(stderr) == types.IntType:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	858 errwrite = stderr
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	859 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	860 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	861 errwrite = stderr.fileno()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	862
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	863 return (p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	864 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	865 errread, errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	866
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 def _set_cloexec_flag(self, fd):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	869 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	870 cloexec_flag = fcntl.FD_CLOEXEC
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	871 except AttributeError:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	872 cloexec_flag = 1
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	873
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	874 old = fcntl.fcntl(fd, fcntl.F_GETFD)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	875 fcntl.fcntl(fd, fcntl.F_SETFD, old \| cloexec_flag)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	876
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	877
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	878 def _close_fds(self, but):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	879 for i in range(3, MAXFD):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	880 if i == but:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	881 continue
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	882 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	883 os.close(i)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	884 except:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	885 pass
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	886
53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	887
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	888 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	889 cwd, env, universal_newlines,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	890 startupinfo, creationflags, shell,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	891 p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	892 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	893 errread, errwrite):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	894 """Execute program (POSIX version)"""
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 if isinstance(args, types.StringTypes):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	897 args = [args]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	898
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	899 if shell:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	900 args = ["/bin/sh", "-c"] + args
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 if executable == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	903 executable = args[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	904
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	905 # For transferring possible exec failure from child to parent
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	906 # The first char specifies the exception type: 0 means
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	907 # OSError, 1 means some other error.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	908 errpipe_read, errpipe_write = os.pipe()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	909 self._set_cloexec_flag(errpipe_write)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	910
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	911 self.pid = os.fork()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	912 if self.pid == 0:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	913 # Child
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	914 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	915 # Close parent's pipe ends
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	916 if p2cwrite:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	917 os.close(p2cwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	918 if c2pread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	919 os.close(c2pread)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	920 if errread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	921 os.close(errread)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	922 os.close(errpipe_read)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	923
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	924 # Dup fds for child
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.dup2(p2cread, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	927 if c2pwrite:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	928 os.dup2(c2pwrite, 1)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	929 if errwrite:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	930 os.dup2(errwrite, 2)
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 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	933 # fd more than once.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	934 if p2cread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	935 os.close(p2cread)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	936 if c2pwrite and c2pwrite not in (p2cread,):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	937 os.close(c2pwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	938 if errwrite and errwrite not in (p2cread, c2pwrite):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	939 os.close(errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	940
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	941 # Close all other fds, if asked for
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	942 if close_fds:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	943 self._close_fds(but=errpipe_write)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	944
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	945 if cwd != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	946 os.chdir(cwd)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	947
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	948 if preexec_fn:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	949 apply(preexec_fn)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	950
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	951 if env == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	952 os.execvp(executable, args)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	953 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	954 os.execvpe(executable, args, env)
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 except:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	957 exc_type, exc_value, tb = sys.exc_info()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	958 # 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	959 exc_lines = traceback.format_exception(exc_type,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	960 exc_value,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	961 tb)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	962 exc_value.child_traceback = ''.join(exc_lines)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	963 os.write(errpipe_write, pickle.dumps(exc_value))
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	964
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	965 # 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	966 # really doesn't matter what we return.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	967 os._exit(255)
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 # Parent
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	970 os.close(errpipe_write)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	971 if p2cread and p2cwrite:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	972 os.close(p2cread)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	973 if c2pwrite and c2pread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	974 os.close(c2pwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	975 if errwrite and errread:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	976 os.close(errwrite)
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 # 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	979 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	980 os.close(errpipe_read)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	981 if data != "":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	982 child_exception = pickle.loads(data)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	983 raise child_exception
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	984
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	985
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	986 def _handle_exitstatus(self, sts):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	987 if os.WIFSIGNALED(sts):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	988 self.returncode = -os.WTERMSIG(sts)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	989 elif os.WIFEXITED(sts):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	990 self.returncode = os.WEXITSTATUS(sts)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	991 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	992 # Should never happen
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	993 raise RuntimeError("Unknown child exit status!")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	994
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	995 _active.remove(self)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	996
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	997
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	998 def poll(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	999 """Check if child process has terminated. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1000 attribute."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1001 if self.returncode == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1002 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1003 pid, sts = os.waitpid(self.pid, os.WNOHANG)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1004 if pid == self.pid:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1005 self._handle_exitstatus(sts)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1006 except os.error:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1007 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1008 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1009
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 def wait(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1012 """Wait for child process to terminate. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1013 attribute."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1014 if self.returncode == None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1015 pid, sts = os.waitpid(self.pid, 0)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1016 self._handle_exitstatus(sts)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1017 return self.returncode
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1020 def communicate(self, input=None):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1021 """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	1022 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	1023 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	1024 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	1025 should be sent to the child.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1026
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1027 communicate() returns a tuple (stdout, stderr)."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1028 read_set = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1029 write_set = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1030 stdout = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1031 stderr = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1032
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1033 if self.stdin:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1034 # 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	1035 # been writing to .stdin in an uncontrolled fashion.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1036 self.stdin.flush()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1037 if input:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1038 write_set.append(self.stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1039 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1040 self.stdin.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1041 if self.stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1042 read_set.append(self.stdout)
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	1043 stdout = []
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1044 if self.stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1045 read_set.append(self.stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1046 stderr = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1047
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1048 while read_set or write_set:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1049 rlist, wlist, xlist = select.select(read_set, write_set, [])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1050
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1051 if self.stdin in wlist:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1052 # When select has indicated that the file is writable,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1053 # 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	1054 # blocking. POSIX defines PIPE_BUF >= 512
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1055 bytes_written = os.write(self.stdin.fileno(), input[:512])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1056 input = input[bytes_written:]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1057 if not input:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1058 self.stdin.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1059 write_set.remove(self.stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1060
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1061 if self.stdout in rlist:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1062 data = os.read(self.stdout.fileno(), 1024)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1063 if data == "":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1064 self.stdout.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1065 read_set.remove(self.stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1066 stdout.append(data)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1067
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1068 if self.stderr in rlist:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1069 data = os.read(self.stderr.fileno(), 1024)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1070 if data == "":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1071 self.stderr.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1072 read_set.remove(self.stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1073 stderr.append(data)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1074
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1075 # All data exchanged. Translate lists into strings.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1076 if stdout != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1077 stdout = ''.join(stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1078 if stderr != None:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1079 stderr = ''.join(stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1080
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1081 # Translate newlines, if requested. We cannot let the file
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1082 # 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	1083 # impossible to combine with select (unless forcing no
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1084 # buffering).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1085 if self.universal_newlines and hasattr(open, 'newlines'):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1086 if stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1087 stdout = self._translate_newlines(stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1088 if stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1089 stderr = self._translate_newlines(stderr)
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 self.wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1092 return (stdout, stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1093
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 def _demo_posix():
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1096 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1097 # Example 1: Simple redirection: Get process list
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1098 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1099 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1100 print "Process list:"
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1101 print plist
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 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1104 # Example 2: Change uid before executing child
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1105 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1106 if os.getuid() == 0:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1107 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1108 p.wait()
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 3: Connecting several subprocesses
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 "Looking for 'hda'..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1114 p1 = Popen(["dmesg"], stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1115 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1116 print repr(p2.communicate()[0])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1117
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1118 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1119 # Example 4: Catch execution error
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1120 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1121 print
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1122 print "Trying a weird file..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1123 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1124 print Popen(["/this/path/does/not/exist"]).communicate()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1125 except OSError, e:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1126 if e.errno == errno.ENOENT:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1127 print "The file didn't exist. I thought so..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1128 print "Child traceback:"
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1129 print e.child_traceback
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1130 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1131 print "Error", e.errno
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1132 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1133 print >>sys.stderr, "Gosh. No error."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1134
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1135
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1136 def _demo_windows():
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 1: Connecting several subprocesses
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 "Looking for 'PROMPT' in set output..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1141 p1 = Popen("set", stdout=PIPE, shell=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1142 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1143 print repr(p2.communicate()[0])
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 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1146 # Example 2: Simple execution of program
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1147 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1148 print "Executing calc..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1149 p = Popen("calc")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1150 p.wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1151
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1152
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1153 if __name__ == "__main__":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1154 if mswindows:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1155 _demo_windows()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1156 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1157 _demo_posix()

Mercurial > cpython-lru_cache-weakref

annotate Lib/subprocess.py @ 33845:032f342efcd2 legacy-trunk