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

annotate Lib/subprocess.py @ 65035:87f4b32905df 2.7

Cosmetic fix to use print function.

author	Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp>
date	Fri, 01 Oct 2010 10:48:47 +0000
parents	e4de2176f98e
children	072ee3f743c2

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 #
34624 5fde17b35472 Made the module compatible with Python 2.2 again. Peter Astrand <astrand@lysator.liu.se> parents: 34587 diff changeset	5 # This module should remain compatible with Python 2.2, see PEP 291.
5fde17b35472 Made the module compatible with Python 2.2 again. Peter Astrand <astrand@lysator.liu.se> parents: 34587 diff changeset	6 #
35633 45aaa436b945 Changed license header: Now simply referring to PSF. This closes bug Peter Astrand <astrand@lysator.liu.se> parents: 34818 diff changeset	7 # Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	8 #
34587 e9ec2ce340fd Added copyright notice: Peter Astrand <astrand@lysator.liu.se> parents: 34575 diff changeset	9 # Licensed to PSF under a Contributor Agreement.
35633 45aaa436b945 Changed license header: Now simply referring to PSF. This closes bug Peter Astrand <astrand@lysator.liu.se> parents: 34818 diff changeset	10 # See http://www.python.org/2.4/license for licensing details.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	11
33776 c5d951a0e0c3 Fix docstring formatting of escape sequences. Raymond Hettinger <python@rcn.com> parents: 33770 diff changeset	12 r"""subprocess - Subprocesses with accessible I/O streams
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	13
33770 c6aac03474c5 return codes are available on all platforms, not just on Unix Fredrik Lundh <fredrik@pythonware.com> parents: 33751 diff changeset	14 This module allows you to spawn processes, connect to their
c6aac03474c5 return codes are available on all platforms, not just on Unix Fredrik Lundh <fredrik@pythonware.com> parents: 33751 diff changeset	15 input/output/error pipes, and obtain their return codes. This module
c6aac03474c5 return codes are available on all platforms, not just on Unix Fredrik Lundh <fredrik@pythonware.com> parents: 33751 diff changeset	16 intends to replace several other, older modules and functions, like:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	17
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	18 os.system
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	19 os.spawn*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	20 os.popen*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	21 popen2.*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	22 commands.*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	23
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	24 Information about how the subprocess module can be used to replace these
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	25 modules and functions can be found below.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	26
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	27
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	28
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	29 Using the subprocess module
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	30 ===========================
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	31 This module defines one class called Popen:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	32
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	33 class Popen(args, bufsize=0, executable=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	34 stdin=None, stdout=None, stderr=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	35 preexec_fn=None, close_fds=False, shell=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	36 cwd=None, env=None, universal_newlines=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	37 startupinfo=None, creationflags=0):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	38
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	39
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	40 Arguments are:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	41
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	42 args should be a string, or a sequence of program arguments. The
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	43 program to execute is normally the first item in the args sequence or
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	44 string, but can be explicitly set by using the executable argument.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	45
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	46 On UNIX, with shell=False (default): In this case, the Popen class
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	47 uses os.execvp() to execute the child program. args should normally
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	48 be a sequence. A string will be treated as a sequence with the string
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	49 as the only item (the program to execute).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	50
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	51 On UNIX, with shell=True: If args is a string, it specifies the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	52 command string to execute through the shell. If args is a sequence,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	53 the first item specifies the command string, and any additional items
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	54 will be treated as additional shell arguments.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	55
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	56 On Windows: the Popen class uses CreateProcess() to execute the child
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	57 program, which operates on strings. If args is a sequence, it will be
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	58 converted to a string using the list2cmdline method. Please note that
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	59 not all MS Windows applications interpret the command line the same
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	60 way: The list2cmdline is designed for applications using the same
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	61 rules as the MS C runtime.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	62
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	63 bufsize, if given, has the same meaning as the corresponding argument
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	64 to the built-in open() function: 0 means unbuffered, 1 means line
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	65 buffered, any other positive value means use a buffer of
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	66 (approximately) that size. A negative bufsize means to use the system
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	67 default, which usually means fully buffered. The default value for
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	68 bufsize is 0 (unbuffered).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	69
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	70 stdin, stdout and stderr specify the executed programs' standard
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	71 input, standard output and standard error file handles, respectively.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	72 Valid values are PIPE, an existing file descriptor (a positive
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	73 integer), an existing file object, and None. PIPE indicates that a
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	74 new pipe to the child should be created. With None, no redirection
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	75 will occur; the child's file handles will be inherited from the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	76 parent. Additionally, stderr can be STDOUT, which indicates that the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	77 stderr data from the applications should be captured into the same
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	78 file handle as for stdout.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	79
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	80 If preexec_fn is set to a callable object, this object will be called
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	81 in the child process just before the child is executed.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	82
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	83 If close_fds is true, all file descriptors except 0, 1 and 2 will be
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	84 closed before the child process is executed.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	85
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	86 if shell is true, the specified command will be executed through the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	87 shell.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	88
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	89 If cwd is not None, the current directory will be changed to cwd
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	90 before the child is executed.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	91
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	92 If env is not None, it defines the environment variables for the new
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	93 process.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	94
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	95 If universal_newlines is true, the file objects stdout and stderr are
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	96 opened as a text files, but lines may be terminated by any of '\n',
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	97 the Unix end-of-line convention, '\r', the Macintosh convention or
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	98 '\r\n', the Windows convention. All of these external representations
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	99 are seen as '\n' by the Python program. Note: This feature is only
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	100 available if Python is built with universal newline support (the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	101 default). Also, the newlines attribute of the file objects stdout,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	102 stdin and stderr are not updated by the communicate() method.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	103
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	104 The startupinfo and creationflags, if given, will be passed to the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	105 underlying CreateProcess() function. They can specify things such as
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	106 appearance of the main window and priority for the new process.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	107 (Windows only)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	108
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	109
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	110 This module also defines some shortcut functions:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	111
34111 73b09c2b788b Changed signature of call function to avoid confusion: this 'args' is not the same as the one to the Popen constructor Peter Astrand <astrand@lysator.liu.se> parents: 34052 diff changeset	112 call(popenargs, *kwargs):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	113 Run command with arguments. Wait for command to complete, then
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	114 return the returncode attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	115
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	116 The arguments are the same as for the Popen constructor. Example:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	117
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	118 retcode = call(["ls", "-l"])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	119
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	120 check_call(popenargs, *kwargs):
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	121 Run command with arguments. Wait for command to complete. If the
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	122 exit code was zero then return, otherwise raise
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	123 CalledProcessError. The CalledProcessError object will have the
39084 9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	124 return code in the returncode attribute.
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	125
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	126 The arguments are the same as for the Popen constructor. Example:
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	127
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	128 check_call(["ls", "-l"])
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	129
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	130 check_output(popenargs, *kwargs):
57816 d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	131 Run command with arguments and return its output as a byte string.
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	132
57816 d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	133 If the exit code was non-zero it raises a CalledProcessError. The
d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	134 CalledProcessError object will have the return code in the returncode
d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	135 attribute and output in the output attribute.
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	136
57816 d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	137 The arguments are the same as for the Popen constructor. Example:
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	138
57959 fe0459dc9889 #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. Georg Brandl <georg@python.org> parents: 57816 diff changeset	139 output = check_output(["ls", "-l", "/dev/null"])
fe0459dc9889 #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. Georg Brandl <georg@python.org> parents: 57816 diff changeset	140
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	141
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	142 Exceptions
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	143 ----------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	144 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	145 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	146 the exception object will have one extra attribute called
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	147 'child_traceback', which is a string containing traceback information
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	148 from the childs point of view.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	149
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	150 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	151 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	152 should prepare for OSErrors.
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 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	155
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	156 check_call() and check_output() will raise CalledProcessError, if the
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	157 called process returns a non-zero return code.
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	158
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	159
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	160 Security
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	161 --------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	162 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	163 /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	164 metacharacters, can safely be passed to child processes.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	165
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	166
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	167 Popen objects
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	168 =============
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	169 Instances of the Popen class have the following methods:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	170
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	171 poll()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	172 Check if child process has terminated. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	173 attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	174
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	175 wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	176 Wait for child process to terminate. Returns returncode attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	177
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	178 communicate(input=None)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	179 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	180 and stderr, until end-of-file is reached. Wait for process to
40532 a3222075f5c6 SF bug #1623890, fix argument name in docstring Neal Norwitz <nnorwitz@gmail.com> parents: 40244 diff changeset	181 terminate. The optional input argument should be a string to be
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	182 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	183 the child.
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	184
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	185 communicate() returns a tuple (stdout, stderr).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	186
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	187 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	188 method if the data size is large or unlimited.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	189
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	190 The following attributes are also available:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	191
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	192 stdin
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	193 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	194 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	195
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	196 stdout
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	197 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	198 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	199 None.
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 stderr
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	202 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	203 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	204 None.
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 pid
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	207 The process ID of the child process.
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 returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	210 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	211 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	212 child was terminated by signal N (UNIX only).
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	213
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	214
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	215 Replacing older functions with the subprocess module
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	216 ====================================================
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	217 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	218 for a.
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 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	221 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	222 exception.
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 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	225 imported with "from subprocess import *".
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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	228 Replacing /bin/sh shell backquote
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	229 ---------------------------------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	230 output=`mycmd myarg`
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	231 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	232 output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	233
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	234
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	235 Replacing shell pipe line
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	236 -------------------------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	237 output=`dmesg \| grep hda`
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	238 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	239 p1 = Popen(["dmesg"], stdout=PIPE)
34050 fd1be494c31b Corrected example for replacing shell pipeline. Fixes bug 1073790. Peter Astrand <astrand@lysator.liu.se> parents: 33929 diff changeset	240 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	241 output = p2.communicate()[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
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	244 Replacing os.system()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	245 ---------------------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	246 sts = os.system("mycmd" + " myarg")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	247 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	248 p = Popen("mycmd" + " myarg", shell=True)
39041 8cc9784130a0 Fix doco. Backport candidate. Neal Norwitz <nnorwitz@gmail.com> parents: 38917 diff changeset	249 pid, sts = os.waitpid(p.pid, 0)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	250
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	251 Note:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	252
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	253 * 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	254
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	255 * 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	256 exitstatus.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	257
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	258 A more real-world example would look like this:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	259
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	260 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	261 retcode = call("mycmd" + " myarg", shell=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	262 if retcode < 0:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	263 print >>sys.stderr, "Child was terminated by signal", -retcode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	264 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	265 print >>sys.stderr, "Child returned", retcode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	266 except OSError, e:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	267 print >>sys.stderr, "Execution failed:", e
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	268
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 Replacing os.spawn*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	271 -------------------
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	272 P_NOWAIT example:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	273
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	274 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	275 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	276 pid = Popen(["/bin/mycmd", "myarg"]).pid
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	277
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	278
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	279 P_WAIT example:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	280
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	281 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	282 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	283 retcode = call(["/bin/mycmd", "myarg"])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	284
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	285
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	286 Vector example:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	287
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	288 os.spawnvp(os.P_NOWAIT, path, args)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	289 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	290 Popen([path] + args[1:])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	291
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	292
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	293 Environment example:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	294
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	295 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	296 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	297 Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	298
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	299
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	300 Replacing os.popen*
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	301 -------------------
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	302 pipe = os.popen("cmd", mode='r', bufsize)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	303 ==>
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	304 pipe = Popen("cmd", shell=True, bufsize=bufsize, stdout=PIPE).stdout
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	305
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	306 pipe = os.popen("cmd", mode='w', bufsize)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	307 ==>
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	308 pipe = Popen("cmd", shell=True, bufsize=bufsize, stdin=PIPE).stdin
33723 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
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	311 (child_stdin, child_stdout) = os.popen2("cmd", mode, bufsize)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	312 ==>
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	313 p = Popen("cmd", shell=True, bufsize=bufsize,
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	314 stdin=PIPE, stdout=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	315 (child_stdin, child_stdout) = (p.stdin, p.stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	316
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	317
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	318 (child_stdin,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	319 child_stdout,
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	320 child_stderr) = os.popen3("cmd", mode, bufsize)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	321 ==>
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	322 p = Popen("cmd", shell=True, bufsize=bufsize,
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	323 stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	324 (child_stdin,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	325 child_stdout,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	326 child_stderr) = (p.stdin, p.stdout, p.stderr)
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
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	329 (child_stdin, child_stdout_and_stderr) = os.popen4("cmd", mode,
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	330 bufsize)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	331 ==>
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	332 p = Popen("cmd", shell=True, bufsize=bufsize,
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	333 stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	334 (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	335
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	336 On Unix, os.popen2, os.popen3 and os.popen4 also accept a sequence as
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	337 the command to execute, in which case arguments will be passed
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	338 directly to the program without shell intervention. This usage can be
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	339 replaced as follows:
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	340
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	341 (child_stdin, child_stdout) = os.popen2(["/bin/ls", "-l"], mode,
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	342 bufsize)
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	343 ==>
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	344 p = Popen(["/bin/ls", "-l"], bufsize=bufsize, stdin=PIPE, stdout=PIPE)
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	345 (child_stdin, child_stdout) = (p.stdin, p.stdout)
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	346
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	347 Return code handling translates as follows:
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	348
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	349 pipe = os.popen("cmd", 'w')
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	350 ...
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	351 rc = pipe.close()
59462 6671932bd8b8 Fix syntax: "rc != None" -> "rc is not None" Florent Xicluna <florent.xicluna@gmail.com> parents: 59206 diff changeset	352 if rc is not None and rc % 256:
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	353 print "There were some errors"
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	354 ==>
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	355 process = Popen("cmd", 'w', shell=True, stdin=PIPE)
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	356 ...
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	357 process.stdin.close()
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	358 if process.wait() != 0:
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	359 print "There were some errors"
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	360
33723 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 Replacing popen2.*
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	363 ------------------
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	364 (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)
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 p = Popen(["somestring"], shell=True, bufsize=bufsize
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	367 stdin=PIPE, stdout=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	368 (child_stdout, child_stdin) = (p.stdout, p.stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	369
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	370 On Unix, popen2 also accepts a sequence as the command to execute, in
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	371 which case arguments will be passed directly to the program without
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	372 shell intervention. This usage can be replaced as follows:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	373
56294 1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	374 (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize,
1ea03f86e081 #5329: fix os.popen* regression from 2.5: don't execute commands as a sequence Philip Jenvey <pjenvey@underboss.org> parents: 55275 diff changeset	375 mode)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	376 ==>
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	377 p = Popen(["mycmd", "myarg"], bufsize=bufsize,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	378 stdin=PIPE, stdout=PIPE, close_fds=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	379 (child_stdout, child_stdin) = (p.stdout, p.stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	380
41687 8edd746291fe Fix typo in docstring (the module is popen2, not 3). Neal Norwitz <nnorwitz@gmail.com> parents: 41503 diff changeset	381 The popen2.Popen3 and popen2.Popen4 basically works as subprocess.Popen,
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	382 except that:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	383
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	384 * subprocess.Popen raises an exception if the execution fails
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	385 * the capturestderr argument is replaced with the stderr argument.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	386 * stdin=PIPE and stdout=PIPE must be specified.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	387 * 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	388 close_fds=True with subprocess.Popen.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	389 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	390
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	391 import sys
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	392 mswindows = (sys.platform == "win32")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	393
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	394 import os
34624 5fde17b35472 Made the module compatible with Python 2.2 again. Peter Astrand <astrand@lysator.liu.se> parents: 34587 diff changeset	395 import types
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	396 import traceback
44792 b4d03a92bddf Fixes issue1336 - a race condition could occur when forking if the gc Gregory P. Smith <greg@mad-scientist.com> parents: 44790 diff changeset	397 import gc
46479 e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	398 import signal
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	399
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	400 # Exception classes used by this module.
39084 9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	401 class CalledProcessError(Exception):
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	402 """This exception is raised when a process run by check_call() or
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	403 check_output() returns a non-zero exit status.
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	404 The exit status will be stored in the returncode attribute;
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	405 check_output() will also store the output in the output attribute.
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	406 """
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	407 def __init__(self, returncode, cmd, output=None):
39084 9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	408 self.returncode = returncode
9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	409 self.cmd = cmd
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	410 self.output = output
39084 9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	411 def __str__(self):
9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	412 return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode)
39117 acff1c34cca3 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 39084 diff changeset	413
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	414
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	415 if mswindows:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	416 import threading
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	417 import msvcrt
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	418 import _subprocess
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	419 class STARTUPINFO:
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	420 dwFlags = 0
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	421 hStdInput = None
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	422 hStdOutput = None
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	423 hStdError = None
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	424 wShowWindow = 0
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	425 class pywintypes:
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	426 error = IOError
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	427 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	428 import select
55092 9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	429 _has_poll = hasattr(select, 'poll')
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	430 import errno
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	431 import fcntl
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	432 import pickle
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	433
55178 5609352fea12 #6416: Fix compilation of the select module on Windows, as well as test_subprocess: Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55092 diff changeset	434 # When select or poll has indicated that the file is writable,
5609352fea12 #6416: Fix compilation of the select module on Windows, as well as test_subprocess: Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55092 diff changeset	435 # we can write up to _PIPE_BUF bytes without risk of blocking.
5609352fea12 #6416: Fix compilation of the select module on Windows, as well as test_subprocess: Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55092 diff changeset	436 # POSIX defines PIPE_BUF as >= 512.
5609352fea12 #6416: Fix compilation of the select module on Windows, as well as test_subprocess: Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55092 diff changeset	437 _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
5609352fea12 #6416: Fix compilation of the select module on Windows, as well as test_subprocess: Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55092 diff changeset	438
5609352fea12 #6416: Fix compilation of the select module on Windows, as well as test_subprocess: Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55092 diff changeset	439
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	440 __all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call",
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	441 "check_output", "CalledProcessError"]
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	442
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	443 if mswindows:
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	444 from _subprocess import CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	445 __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP"])
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	446 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	447 MAXFD = os.sysconf("SC_OPEN_MAX")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	448 except:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	449 MAXFD = 256
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	450
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	451 _active = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	452
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	453 def _cleanup():
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	454 for inst in _active[:]:
57959 fe0459dc9889 #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. Georg Brandl <georg@python.org> parents: 57816 diff changeset	455 res = inst._internal_poll(_deadstate=sys.maxint)
fe0459dc9889 #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. Georg Brandl <georg@python.org> parents: 57816 diff changeset	456 if res is not None and res >= 0:
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	457 try:
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	458 _active.remove(inst)
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	459 except ValueError:
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	460 # This can happen if two threads create a new Popen instance.
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	461 # It's harmless that it was already removed, so ignore.
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	462 pass
33723 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 PIPE = -1
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	465 STDOUT = -2
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	466
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	467
59206 6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	468 def _eintr_retry_call(func, *args):
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	469 while True:
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	470 try:
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	471 return func(*args)
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	472 except OSError, e:
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	473 if e.errno == errno.EINTR:
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	474 continue
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	475 raise
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	476
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	477
34111 73b09c2b788b Changed signature of call function to avoid confusion: this 'args' is not the same as the one to the Popen constructor Peter Astrand <astrand@lysator.liu.se> parents: 34052 diff changeset	478 def call(popenargs, *kwargs):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	479 """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	480 return the returncode attribute.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	481
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	482 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	483
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	484 retcode = call(["ls", "-l"])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	485 """
34111 73b09c2b788b Changed signature of call function to avoid confusion: this 'args' is not the same as the one to the Popen constructor Peter Astrand <astrand@lysator.liu.se> parents: 34052 diff changeset	486 return Popen(popenargs, *kwargs).wait()
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	487
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	488
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	489 def check_call(popenargs, *kwargs):
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	490 """Run command with arguments. Wait for command to complete. If
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	491 the exit code was zero then return, otherwise raise
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	492 CalledProcessError. The CalledProcessError object will have the
39084 9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	493 return code in the returncode attribute.
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	494
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	495 The arguments are the same as for the Popen constructor. Example:
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	496
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	497 check_call(["ls", "-l"])
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	498 """
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	499 retcode = call(popenargs, *kwargs)
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	500 if retcode:
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	501 cmd = kwargs.get("args")
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	502 if cmd is None:
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	503 cmd = popenargs[0]
39084 9f2c3de74856 Bug #1223937: CalledProcessError.errno -> CalledProcessError.returncode. Peter Astrand <astrand@lysator.liu.se> parents: 39041 diff changeset	504 raise CalledProcessError(retcode, cmd)
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	505 return 0
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	506
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	507
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	508 def check_output(popenargs, *kwargs):
57816 d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	509 r"""Run command with arguments and return its output as a byte string.
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	510
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	511 If the exit code was non-zero it raises a CalledProcessError. The
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	512 CalledProcessError object will have the return code in the returncode
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	513 attribute and output in the output attribute.
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	514
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	515 The arguments are the same as for the Popen constructor. Example:
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	516
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	517 >>> check_output(["ls", "-l", "/dev/null"])
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	518 'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	519
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	520 The stdout argument is not allowed as it is used internally.
57959 fe0459dc9889 #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. Georg Brandl <georg@python.org> parents: 57816 diff changeset	521 To capture standard error in the result, use stderr=STDOUT.
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	522
49984 589cde614b5b rename the new check_call_output to check_output. its less ugly. Gregory P. Smith <greg@mad-scientist.com> parents: 49977 diff changeset	523 >>> check_output(["/bin/sh", "-c",
57816 d890c8ffad02 #7381: subprocess documentation and library docstring consistency fixes. Georg Brandl <georg@python.org> parents: 57153 diff changeset	524 ... "ls -l non_existent_file ; exit 0"],
57959 fe0459dc9889 #7381: consistency update, and backport avoiding ``None >= 0`` check from py3k. Georg Brandl <georg@python.org> parents: 57816 diff changeset	525 ... stderr=STDOUT)
51775 af9b6c43804e Issue #5341: Fix a variety of spelling errors. Mark Dickinson <dickinsm@gmail.com> parents: 51636 diff changeset	526 'ls: non_existent_file: No such file or directory\n'
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	527 """
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	528 if 'stdout' in kwargs:
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	529 raise ValueError('stdout argument not allowed, it will be overridden.')
54792 37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	530 process = Popen(stdout=PIPE, popenargs, *kwargs)
49977 4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	531 output, unused_err = process.communicate()
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	532 retcode = process.poll()
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	533 if retcode:
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	534 cmd = kwargs.get("args")
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	535 if cmd is None:
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	536 cmd = popenargs[0]
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	537 raise CalledProcessError(retcode, cmd, output=output)
4790b31d9257 Adds a subprocess.check_call_output() function to return the output from a Gregory P. Smith <greg@mad-scientist.com> parents: 48194 diff changeset	538 return output
34302 998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	539
998fb1e1c8e9 New subprocess utility function: check_call. Closes #1071764. Peter Astrand <astrand@lysator.liu.se> parents: 34111 diff changeset	540
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	541 def list2cmdline(seq):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	542 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	543 Translate a sequence of arguments into a command line
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	544 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	545
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	546 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	547 space or a tab.
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 2) A string surrounded by double quotation marks is
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	550 interpreted as a single argument, regardless of white space
62401 da558461d9a9 Revert r60115 Jean-Paul Calderone <exarkun@divmod.com> parents: 61582 diff changeset	551 contained within. A quoted string can be embedded in an
da558461d9a9 Revert r60115 Jean-Paul Calderone <exarkun@divmod.com> parents: 61582 diff changeset	552 argument.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	553
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	554 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	555 interpreted as a literal double quotation mark.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	556
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	557 4) Backslashes are interpreted literally, unless they
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	558 immediately precede a double quotation mark.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	559
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	560 5) If backslashes immediately precede a double quotation mark,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	561 every pair of backslashes is interpreted as a literal
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	562 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	563 backslash escapes the next double quotation mark as
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	564 described in rule 3.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	565 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	566
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	567 # See
57153 c76d5fbeb691 Issue 7294: Fixed URL in a comment. Eric Smith <eric@trueblade.com> parents: 56294 diff changeset	568 # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
c76d5fbeb691 Issue 7294: Fixed URL in a comment. Eric Smith <eric@trueblade.com> parents: 56294 diff changeset	569 # or search http://msdn.microsoft.com for
c76d5fbeb691 Issue 7294: Fixed URL in a comment. Eric Smith <eric@trueblade.com> parents: 56294 diff changeset	570 # "Parsing C++ Command-Line Arguments"
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	571 result = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	572 needquote = False
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	573 for arg in seq:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	574 bs_buf = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	575
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	576 # 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	577 if result:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	578 result.append(' ')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	579
62401 da558461d9a9 Revert r60115 Jean-Paul Calderone <exarkun@divmod.com> parents: 61582 diff changeset	580 needquote = (" " in arg) or ("\t" in arg) or not arg
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	581 if needquote:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	582 result.append('"')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	583
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	584 for c in arg:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	585 if c == '\\':
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	586 # 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	587 bs_buf.append(c)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	588 elif c == '"':
44790 210323e2a927 fix comment typos, use not arg instead of arg == "", add test coverage Gregory P. Smith <greg@mad-scientist.com> parents: 44785 diff changeset	589 # Double backslashes.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	590 result.append('\\' * len(bs_buf)*2)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	591 bs_buf = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	592 result.append('\\"')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	593 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	594 # Normal char
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	595 if bs_buf:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	596 result.extend(bs_buf)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	597 bs_buf = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	598 result.append(c)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	599
44790 210323e2a927 fix comment typos, use not arg instead of arg == "", add test coverage Gregory P. Smith <greg@mad-scientist.com> parents: 44785 diff changeset	600 # Add remaining backslashes, if any.
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	601 if bs_buf:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	602 result.extend(bs_buf)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	603
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	604 if needquote:
34675 8f0456425715 Corrected bug in list2cmdline wrt backslashes. Fixes #1083306. Peter Astrand <astrand@lysator.liu.se> parents: 34672 diff changeset	605 result.extend(bs_buf)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	606 result.append('"')
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	607
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	608 return ''.join(result)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	609
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	610
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	611 class Popen(object):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	612 def __init__(self, args, bufsize=0, executable=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	613 stdin=None, stdout=None, stderr=None,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	614 preexec_fn=None, close_fds=False, shell=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	615 cwd=None, env=None, universal_newlines=False,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	616 startupinfo=None, creationflags=0):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	617 """Create new Popen instance."""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	618 _cleanup()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	619
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	620 self._child_created = False
34052 79d2ae0a62ef Raise TypeError if bufsize argument is not an integer. Patch 1071755, slightly modified. Peter Astrand <astrand@lysator.liu.se> parents: 34050 diff changeset	621 if not isinstance(bufsize, (int, long)):
79d2ae0a62ef Raise TypeError if bufsize argument is not an integer. Patch 1071755, slightly modified. Peter Astrand <astrand@lysator.liu.se> parents: 34050 diff changeset	622 raise TypeError("bufsize must be an integer")
79d2ae0a62ef Raise TypeError if bufsize argument is not an integer. Patch 1071755, slightly modified. Peter Astrand <astrand@lysator.liu.se> parents: 34050 diff changeset	623
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	624 if mswindows:
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	625 if preexec_fn is not None:
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	626 raise ValueError("preexec_fn is not supported on Windows "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	627 "platforms")
41886 ec3b8e94a355 Applied patch 1669481, slightly modified: Support close_fds on Win32 Peter Astrand <astrand@lysator.liu.se> parents: 41689 diff changeset	628 if close_fds and (stdin is not None or stdout is not None or
ec3b8e94a355 Applied patch 1669481, slightly modified: Support close_fds on Win32 Peter Astrand <astrand@lysator.liu.se> parents: 41689 diff changeset	629 stderr is not None):
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	630 raise ValueError("close_fds is not supported on Windows "
41886 ec3b8e94a355 Applied patch 1669481, slightly modified: Support close_fds on Win32 Peter Astrand <astrand@lysator.liu.se> parents: 41689 diff changeset	631 "platforms if you redirect stdin/stdout/stderr")
33723 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 # POSIX
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	634 if startupinfo is not None:
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	635 raise ValueError("startupinfo is only supported on Windows "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	636 "platforms")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	637 if creationflags != 0:
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	638 raise ValueError("creationflags is only supported on Windows "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	639 "platforms")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	640
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	641 self.stdin = None
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	642 self.stdout = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	643 self.stderr = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	644 self.pid = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	645 self.returncode = None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	646 self.universal_newlines = universal_newlines
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 # Input and output objects. The general principle is like
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	649 # this:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	650 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	651 # Parent Child
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	652 # ------ -----
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	653 # p2cwrite ---stdin---> p2cread
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	654 # c2pread <--stdout--- c2pwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	655 # errread <--stderr--- errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	656 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	657 # On POSIX, the child objects are file descriptors. On
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	658 # Windows, these are Windows file handles. The parent objects
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	659 # are file descriptors on both platforms. The parent objects
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	660 # 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	661 # when not redirecting.
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	662
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	663 (p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	664 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	665 errread, errwrite) = self._get_handles(stdin, stdout, stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	666
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	667 self._execute_child(args, executable, preexec_fn, close_fds,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	668 cwd, env, universal_newlines,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	669 startupinfo, creationflags, shell,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	670 p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	671 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	672 errread, errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	673
40746 d3e88631f92b Applied patch 1124861.3.patch to solve bug #1124861: Automatically create pipes on Windows, if GetStdHandle fails. Will backport. Peter Astrand <astrand@lysator.liu.se> parents: 40740 diff changeset	674 if mswindows:
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	675 if p2cwrite is not None:
80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	676 p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	677 if c2pread is not None:
80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	678 c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	679 if errread is not None:
80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	680 errread = msvcrt.open_osfhandle(errread.Detach(), 0)
40746 d3e88631f92b Applied patch 1124861.3.patch to solve bug #1124861: Automatically create pipes on Windows, if GetStdHandle fails. Will backport. Peter Astrand <astrand@lysator.liu.se> parents: 40740 diff changeset	681
40740 ad8cdfb69872 We had several if statements checking the value of a fd. This is unsafe, since valid fds might be zero. We should check for not None instead. Peter Astrand <astrand@lysator.liu.se> parents: 40732 diff changeset	682 if p2cwrite is not None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	683 self.stdin = os.fdopen(p2cwrite, 'wb', bufsize)
40740 ad8cdfb69872 We had several if statements checking the value of a fd. This is unsafe, since valid fds might be zero. We should check for not None instead. Peter Astrand <astrand@lysator.liu.se> parents: 40732 diff changeset	684 if c2pread is not None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	685 if universal_newlines:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	686 self.stdout = os.fdopen(c2pread, 'rU', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	687 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	688 self.stdout = os.fdopen(c2pread, 'rb', bufsize)
40740 ad8cdfb69872 We had several if statements checking the value of a fd. This is unsafe, since valid fds might be zero. We should check for not None instead. Peter Astrand <astrand@lysator.liu.se> parents: 40732 diff changeset	689 if errread is not None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	690 if universal_newlines:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	691 self.stderr = os.fdopen(errread, 'rU', bufsize)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	692 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	693 self.stderr = os.fdopen(errread, 'rb', bufsize)
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	694
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	695
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	696 def _translate_newlines(self, data):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	697 data = data.replace("\r\n", "\n")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	698 data = data.replace("\r", "\n")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	699 return data
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	700
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	701
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	702 def __del__(self, _maxint=sys.maxint, _active=_active):
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	703 if not self._child_created:
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	704 # We didn't get to successfully create a child process.
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	705 return
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	706 # In case the child hasn't been waited on, check if it's done.
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	707 self._internal_poll(_deadstate=_maxint)
39122 8fe6786f5144 Guard for _active being None in __del__ method. Georg Brandl <georg@python.org> parents: 39117 diff changeset	708 if self.returncode is None and _active is not None:
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	709 # Child is still running, keep us alive until we can wait on it.
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	710 _active.append(self)
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	711
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	712
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	713 def communicate(self, input=None):
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	714 """Interact with process: Send data to stdin. Read data from
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	715 stdout and stderr, until end-of-file is reached. Wait for
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	716 process to terminate. The optional input argument should be a
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	717 string to be sent to the child process, or None, if no data
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	718 should be sent to the child.
34818 4eaab38566c9 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 34675 diff changeset	719
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	720 communicate() returns a tuple (stdout, stderr)."""
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	721
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	722 # Optimization: If we are only using one pipe, or no pipe at
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	723 # all, using select() or threads is unnecessary.
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	724 if [self.stdin, self.stdout, self.stderr].count(None) >= 2:
34818 4eaab38566c9 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 34675 diff changeset	725 stdout = None
4eaab38566c9 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 34675 diff changeset	726 stderr = None
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	727 if self.stdin:
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	728 if input:
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	729 self.stdin.write(input)
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	730 self.stdin.close()
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	731 elif self.stdout:
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	732 stdout = self.stdout.read()
47338 273e8de34603 Fixes issue2791: subprocess.Popen.communicate leaked a file descripton until Gregory P. Smith <greg@mad-scientist.com> parents: 46479 diff changeset	733 self.stdout.close()
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	734 elif self.stderr:
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	735 stderr = self.stderr.read()
47338 273e8de34603 Fixes issue2791: subprocess.Popen.communicate leaked a file descripton until Gregory P. Smith <greg@mad-scientist.com> parents: 46479 diff changeset	736 self.stderr.close()
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	737 self.wait()
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	738 return (stdout, stderr)
34818 4eaab38566c9 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 34675 diff changeset	739
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	740 return self._communicate(input)
085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	741
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	742
48154 288ca1c72888 - Issue #1857: subprocess.Popen.poll gained an additional _deadstate keyword Gregory P. Smith <greg@mad-scientist.com> parents: 47899 diff changeset	743 def poll(self):
288ca1c72888 - Issue #1857: subprocess.Popen.poll gained an additional _deadstate keyword Gregory P. Smith <greg@mad-scientist.com> parents: 47899 diff changeset	744 return self._internal_poll()
288ca1c72888 - Issue #1857: subprocess.Popen.poll gained an additional _deadstate keyword Gregory P. Smith <greg@mad-scientist.com> parents: 47899 diff changeset	745
288ca1c72888 - Issue #1857: subprocess.Popen.poll gained an additional _deadstate keyword Gregory P. Smith <greg@mad-scientist.com> parents: 47899 diff changeset	746
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	747 if mswindows:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	748 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	749 # Windows methods
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 def _get_handles(self, stdin, stdout, stderr):
55192 14cd19feaf20 #6447: typo in subprocess docstring Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55178 diff changeset	752 """Construct and return tuple with IO objects:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	753 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	754 """
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	755 if stdin is None and stdout is None and stderr is None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	756 return (None, None, None, None, None, None)
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	757
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	758 p2cread, p2cwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	759 c2pread, c2pwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	760 errread, errwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	761
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	762 if stdin is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	763 p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	764 if p2cread is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	765 p2cread, _ = _subprocess.CreatePipe(None, 0)
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	766 elif stdin == PIPE:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	767 p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	768 elif isinstance(stdin, int):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	769 p2cread = msvcrt.get_osfhandle(stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	770 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	771 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	772 p2cread = msvcrt.get_osfhandle(stdin.fileno())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	773 p2cread = self._make_inheritable(p2cread)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	774
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	775 if stdout is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	776 c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	777 if c2pwrite is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	778 _, c2pwrite = _subprocess.CreatePipe(None, 0)
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	779 elif stdout == PIPE:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	780 c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	781 elif isinstance(stdout, int):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	782 c2pwrite = msvcrt.get_osfhandle(stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	783 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	784 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	785 c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	786 c2pwrite = self._make_inheritable(c2pwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	787
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	788 if stderr is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	789 errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	790 if errwrite is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	791 _, errwrite = _subprocess.CreatePipe(None, 0)
51977 80233df24f8c Issue #5179: Fixed subprocess handle leak on failure on windows. Hirokazu Yamamoto <ocean-city@m2.ccsnet.ne.jp> parents: 51775 diff changeset	792 elif stderr == PIPE:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	793 errread, errwrite = _subprocess.CreatePipe(None, 0)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	794 elif stderr == STDOUT:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	795 errwrite = c2pwrite
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	796 elif isinstance(stderr, int):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	797 errwrite = msvcrt.get_osfhandle(stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	798 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	799 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	800 errwrite = msvcrt.get_osfhandle(stderr.fileno())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	801 errwrite = self._make_inheritable(errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	802
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	803 return (p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	804 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	805 errread, errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	806
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	807
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	808 def _make_inheritable(self, handle):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	809 """Return a duplicate of handle, which is inheritable"""
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	810 return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	811 handle, _subprocess.GetCurrentProcess(), 0, 1,
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	812 _subprocess.DUPLICATE_SAME_ACCESS)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	813
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	814
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	815 def _find_w9xpopen(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	816 """Find and return absolut path to w9xpopen.exe"""
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	817 w9xpopen = os.path.join(
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	818 os.path.dirname(_subprocess.GetModuleFileName(0)),
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	819 "w9xpopen.exe")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	820 if not os.path.exists(w9xpopen):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	821 # Eeek - file-not-found - possibly an embedding
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	822 # 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	823 w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	824 "w9xpopen.exe")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	825 if not os.path.exists(w9xpopen):
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	826 raise RuntimeError("Cannot locate w9xpopen.exe, which is "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	827 "needed for Popen to work with your "
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	828 "shell or platform.")
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	829 return w9xpopen
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	830
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	831
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	832 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	833 cwd, env, universal_newlines,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	834 startupinfo, creationflags, shell,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	835 p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	836 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	837 errread, errwrite):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	838 """Execute program (MS Windows version)"""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	839
34624 5fde17b35472 Made the module compatible with Python 2.2 again. Peter Astrand <astrand@lysator.liu.se> parents: 34587 diff changeset	840 if not isinstance(args, types.StringTypes):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	841 args = list2cmdline(args)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	842
33929 66223a9ebe48 When using shell=True on Windows, don't display a shell window by default. Fixes #1057061. Peter Astrand <astrand@lysator.liu.se> parents: 33776 diff changeset	843 # Process startup details
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	844 if startupinfo is None:
38589 7d31d031f8e1 Bug #1500293: fix memory leaks in _subprocess module. Georg Brandl <georg@python.org> parents: 38078 diff changeset	845 startupinfo = STARTUPINFO()
7d31d031f8e1 Bug #1500293: fix memory leaks in _subprocess module. Georg Brandl <georg@python.org> parents: 38078 diff changeset	846 if None not in (p2cread, c2pwrite, errwrite):
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	847 startupinfo.dwFlags \|= _subprocess.STARTF_USESTDHANDLES
33929 66223a9ebe48 When using shell=True on Windows, don't display a shell window by default. Fixes #1057061. Peter Astrand <astrand@lysator.liu.se> parents: 33776 diff changeset	848 startupinfo.hStdInput = p2cread
66223a9ebe48 When using shell=True on Windows, don't display a shell window by default. Fixes #1057061. Peter Astrand <astrand@lysator.liu.se> parents: 33776 diff changeset	849 startupinfo.hStdOutput = c2pwrite
66223a9ebe48 When using shell=True on Windows, don't display a shell window by default. Fixes #1057061. Peter Astrand <astrand@lysator.liu.se> parents: 33776 diff changeset	850 startupinfo.hStdError = errwrite
66223a9ebe48 When using shell=True on Windows, don't display a shell window by default. Fixes #1057061. Peter Astrand <astrand@lysator.liu.se> parents: 33776 diff changeset	851
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	852 if shell:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	853 startupinfo.dwFlags \|= _subprocess.STARTF_USESHOWWINDOW
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	854 startupinfo.wShowWindow = _subprocess.SW_HIDE
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	855 comspec = os.environ.get("COMSPEC", "cmd.exe")
63931 ab2d94931b0c #2304: fix incorporating Eric Smith's .format suggestion and tested on Ubuntu as well as Windows Tim Golden <mail@timgolden.me.uk> parents: 63842 diff changeset	856 args = '{} /c "{}"'.format (comspec, args)
ab2d94931b0c #2304: fix incorporating Eric Smith's .format suggestion and tested on Ubuntu as well as Windows Tim Golden <mail@timgolden.me.uk> parents: 63842 diff changeset	857 if (_subprocess.GetVersion() >= 0x80000000 or
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	858 os.path.basename(comspec).lower() == "command.com"):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	859 # 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	860 # use the w9xpopen intermediate program. For more
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	861 # information, see KB Q150956
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	862 # (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	863 w9xpopen = self._find_w9xpopen()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	864 args = '"%s" %s' % (w9xpopen, args)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	865 # Not passing CREATE_NEW_CONSOLE has been known to
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	866 # cause random failures on win9x. Specifically a
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	867 # dialog: "Your program accessed mem currently in
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	868 # use at xxx" and a hopeful warning about the
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	869 # stability of your system. Cost is Ctrl+C wont
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	870 # kill children.
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	871 creationflags \|= _subprocess.CREATE_NEW_CONSOLE
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	872
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	873 # Start the process
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	874 try:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	875 hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	876 # no special security
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	877 None, None,
41886 ec3b8e94a355 Applied patch 1669481, slightly modified: Support close_fds on Win32 Peter Astrand <astrand@lysator.liu.se> parents: 41689 diff changeset	878 int(not close_fds),
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	879 creationflags,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	880 env,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	881 cwd,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	882 startupinfo)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	883 except pywintypes.error, e:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	884 # Translate pywintypes.error to WindowsError, which is
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	885 # a subclass of OSError. FIXME: We should really
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	886 # translate errno using _sys_errlist (or simliar), but
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	887 # how can this be done from Python?
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	888 raise WindowsError(*e.args)
63814 a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	889 finally:
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	890 # Child is launched. Close the parent's copy of those pipe
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	891 # handles that only the child should have open. You need
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	892 # to make sure that no handles to the write end of the
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	893 # output pipe are maintained in this process or else the
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	894 # pipe will not close when the child process exits and the
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	895 # ReadFile will hang.
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	896 if p2cread is not None:
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	897 p2cread.Close()
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	898 if c2pwrite is not None:
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	899 c2pwrite.Close()
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	900 if errwrite is not None:
a0bdcdd0f086 Issue #3210: Revert C module changes and apply patch from Hirokazu Yamamoto instead Tim Golden <mail@timgolden.me.uk> parents: 63096 diff changeset	901 errwrite.Close()
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	902
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	903 # Retain the process handle, but close the thread handle
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	904 self._child_created = True
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	905 self._handle = hp
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	906 self.pid = pid
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	907 ht.Close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	908
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	909 def _internal_poll(self, _deadstate=None,
61582 e6bfe93b65bb Fix regression introduced by r81154 (Issue #5099, subprocess destructor) Victor Stinner <victor.stinner@haypocalc.com> parents: 61564 diff changeset	910 _WaitForSingleObject=_subprocess.WaitForSingleObject,
e6bfe93b65bb Fix regression introduced by r81154 (Issue #5099, subprocess destructor) Victor Stinner <victor.stinner@haypocalc.com> parents: 61564 diff changeset	911 _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
e6bfe93b65bb Fix regression introduced by r81154 (Issue #5099, subprocess destructor) Victor Stinner <victor.stinner@haypocalc.com> parents: 61564 diff changeset	912 _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	913 """Check if child process has terminated. Returns returncode
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	914 attribute.
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	915
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	916 This method is called by __del__, so it can only refer to objects
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	917 in its local scope.
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	918
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	919 """
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	920 if self.returncode is None:
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	921 if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	922 self.returncode = _GetExitCodeProcess(self._handle)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	923 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	924
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	925
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	926 def wait(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	927 """Wait for child process to terminate. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	928 attribute."""
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	929 if self.returncode is None:
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	930 _subprocess.WaitForSingleObject(self._handle,
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	931 _subprocess.INFINITE)
3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	932 self.returncode = _subprocess.GetExitCodeProcess(self._handle)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	933 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	934
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	935
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	936 def _readerthread(self, fh, buffer):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	937 buffer.append(fh.read())
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	938
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	939
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	940 def _communicate(self, input):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	941 stdout = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	942 stderr = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	943
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	944 if self.stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	945 stdout = []
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	946 stdout_thread = threading.Thread(target=self._readerthread,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	947 args=(self.stdout, stdout))
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	948 stdout_thread.setDaemon(True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	949 stdout_thread.start()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	950 if self.stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	951 stderr = []
33735 1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	952 stderr_thread = threading.Thread(target=self._readerthread,
1383c4692af7 Folded long lines. Tim Peters <tim.peters@gmail.com> parents: 33731 diff changeset	953 args=(self.stderr, stderr))
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	954 stderr_thread.setDaemon(True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	955 stderr_thread.start()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	956
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	957 if self.stdin:
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	958 if input is not None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	959 self.stdin.write(input)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	960 self.stdin.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	961
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	962 if self.stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	963 stdout_thread.join()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	964 if self.stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	965 stderr_thread.join()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	966
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	967 # All data exchanged. Translate lists into strings.
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	968 if stdout is not None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	969 stdout = stdout[0]
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	970 if stderr is not None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	971 stderr = stderr[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	972
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	973 # Translate newlines, if requested. We cannot let the file
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	974 # 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	975 # impossible to combine with select (unless forcing no
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	976 # buffering).
38078 b1cbc605bec9 Try to fix breakage caused by patch #1479181, r45850 Neal Norwitz <nnorwitz@gmail.com> parents: 37563 diff changeset	977 if self.universal_newlines and hasattr(file, 'newlines'):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	978 if stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	979 stdout = self._translate_newlines(stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	980 if stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	981 stderr = self._translate_newlines(stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	982
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	983 self.wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	984 return (stdout, stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	985
46479 e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	986 def send_signal(self, sig):
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	987 """Send a signal to the process
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	988 """
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	989 if sig == signal.SIGTERM:
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	990 self.terminate()
60197 0ab89e8bdedc Implement #1220212. Add os.kill support for Windows. Brian Curtin <brian.curtin@gmail.com> parents: 59462 diff changeset	991 elif sig == signal.CTRL_C_EVENT:
0ab89e8bdedc Implement #1220212. Add os.kill support for Windows. Brian Curtin <brian.curtin@gmail.com> parents: 59462 diff changeset	992 os.kill(self.pid, signal.CTRL_C_EVENT)
0ab89e8bdedc Implement #1220212. Add os.kill support for Windows. Brian Curtin <brian.curtin@gmail.com> parents: 59462 diff changeset	993 elif sig == signal.CTRL_BREAK_EVENT:
0ab89e8bdedc Implement #1220212. Add os.kill support for Windows. Brian Curtin <brian.curtin@gmail.com> parents: 59462 diff changeset	994 os.kill(self.pid, signal.CTRL_BREAK_EVENT)
46479 e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	995 else:
64519 e4de2176f98e Merged revisions 84582 via svnmerge from Brian Curtin <brian.curtin@gmail.com> parents: 64494 diff changeset	996 raise ValueError("Unsupported signal: {}".format(sig))
46479 e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	997
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	998 def terminate(self):
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	999 """Terminates the process
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1000 """
60920 3b8341d05216 Fix #7838. Add docstrings and privatize _subprocess implementation details. Brian Curtin <brian.curtin@gmail.com> parents: 60197 diff changeset	1001 _subprocess.TerminateProcess(self._handle, 1)
46479 e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1002
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1003 kill = terminate
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1004
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1005 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1006 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1007 # POSIX methods
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1008 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1009 def _get_handles(self, stdin, stdout, stderr):
55192 14cd19feaf20 #6447: typo in subprocess docstring Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 55178 diff changeset	1010 """Construct and return tuple with IO objects:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1011 p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1012 """
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1013 p2cread, p2cwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1014 c2pread, c2pwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1015 errread, errwrite = None, None
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1016
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1017 if stdin is None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1018 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1019 elif stdin == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1020 p2cread, p2cwrite = os.pipe()
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1021 elif isinstance(stdin, int):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1022 p2cread = stdin
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1023 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1024 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1025 p2cread = stdin.fileno()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1026
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1027 if stdout is None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1028 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1029 elif stdout == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1030 c2pread, c2pwrite = os.pipe()
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1031 elif isinstance(stdout, int):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1032 c2pwrite = stdout
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1033 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1034 # Assuming file-like object
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	1035 c2pwrite = stdout.fileno()
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1036
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1037 if stderr is None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1038 pass
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1039 elif stderr == PIPE:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1040 errread, errwrite = os.pipe()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1041 elif stderr == STDOUT:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1042 errwrite = c2pwrite
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1043 elif isinstance(stderr, int):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1044 errwrite = stderr
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1045 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1046 # Assuming file-like object
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1047 errwrite = stderr.fileno()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1048
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1049 return (p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1050 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1051 errread, errwrite)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1052
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1053
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1054 def _set_cloexec_flag(self, fd):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1055 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1056 cloexec_flag = fcntl.FD_CLOEXEC
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1057 except AttributeError:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1058 cloexec_flag = 1
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1059
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1060 old = fcntl.fcntl(fd, fcntl.F_GETFD)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1061 fcntl.fcntl(fd, fcntl.F_SETFD, old \| cloexec_flag)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1062
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1063
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1064 def _close_fds(self, but):
54792 37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1065 if hasattr(os, 'closerange'):
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1066 os.closerange(3, but)
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1067 os.closerange(but + 1, MAXFD)
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1068 else:
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1069 for i in xrange(3, MAXFD):
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1070 if i == but:
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1071 continue
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1072 try:
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1073 os.close(i)
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1074 except:
37223ef4d470 #6189: The subprocess.py module should be kept compatible with python 2.2 Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 51977 diff changeset	1075 pass
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	1076
53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	1077
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1078 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	1079 cwd, env, universal_newlines,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1080 startupinfo, creationflags, shell,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1081 p2cread, p2cwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1082 c2pread, c2pwrite,
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1083 errread, errwrite):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1084 """Execute program (POSIX version)"""
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1085
34624 5fde17b35472 Made the module compatible with Python 2.2 again. Peter Astrand <astrand@lysator.liu.se> parents: 34587 diff changeset	1086 if isinstance(args, types.StringTypes):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1087 args = [args]
40244 a72d970c384b Bug #1357915: allow all sequence types for shell arguments in Georg Brandl <georg@python.org> parents: 39793 diff changeset	1088 else:
a72d970c384b Bug #1357915: allow all sequence types for shell arguments in Georg Brandl <georg@python.org> parents: 39793 diff changeset	1089 args = list(args)
33723 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 if shell:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1092 args = ["/bin/sh", "-c"] + args
63096 354546846c29 Issue #9265: Incorrect name passed as arg[0] when shell=True Stefan Krah <stefan@bytereef.org> parents: 62401 diff changeset	1093 if executable:
354546846c29 Issue #9265: Incorrect name passed as arg[0] when shell=True Stefan Krah <stefan@bytereef.org> parents: 62401 diff changeset	1094 args[0] = executable
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1095
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1096 if executable is None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1097 executable = args[0]
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 # For transferring possible exec failure from child to parent
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1100 # The first char specifies the exception type: 0 means
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1101 # OSError, 1 means some other error.
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1102 errpipe_read, errpipe_write = os.pipe()
44792 b4d03a92bddf Fixes issue1336 - a race condition could occur when forking if the gc Gregory P. Smith <greg@mad-scientist.com> parents: 44790 diff changeset	1103 try:
44798 5e66030f1a67 Undo an unnecessary else: and indentation that r60104 added. Gregory P. Smith <greg@mad-scientist.com> parents: 44792 diff changeset	1104 try:
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1105 self._set_cloexec_flag(errpipe_write)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1106
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1107 gc_was_enabled = gc.isenabled()
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1108 # Disable gc to avoid bug where gc -> file_dealloc ->
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1109 # write to stderr -> hang. http://bugs.python.org/issue1336
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1110 gc.disable()
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1111 try:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1112 self.pid = os.fork()
55275 7f1547f66ccf Revert r74028. Georg Brandl <georg@python.org> parents: 55274 diff changeset	1113 except:
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1114 if gc_was_enabled:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1115 gc.enable()
55275 7f1547f66ccf Revert r74028. Georg Brandl <georg@python.org> parents: 55274 diff changeset	1116 raise
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1117 self._child_created = True
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1118 if self.pid == 0:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1119 # Child
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1120 try:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1121 # Close parent's pipe ends
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1122 if p2cwrite is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1123 os.close(p2cwrite)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1124 if c2pread is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1125 os.close(c2pread)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1126 if errread is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1127 os.close(errread)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1128 os.close(errpipe_read)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1129
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1130 # Dup fds for child
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1131 if p2cread is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1132 os.dup2(p2cread, 0)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1133 if c2pwrite is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1134 os.dup2(c2pwrite, 1)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1135 if errwrite is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1136 os.dup2(errwrite, 2)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1137
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1138 # Close pipe fds. Make sure we don't close the same
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1139 # fd more than once, or standard fds.
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1140 if p2cread is not None and p2cread not in (0,):
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1141 os.close(p2cread)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1142 if c2pwrite is not None and c2pwrite not in (p2cread, 1):
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1143 os.close(c2pwrite)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1144 if errwrite is not None and errwrite not in (p2cread, c2pwrite, 2):
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1145 os.close(errwrite)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1146
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1147 # Close all other fds, if asked for
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1148 if close_fds:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1149 self._close_fds(but=errpipe_write)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1150
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1151 if cwd is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1152 os.chdir(cwd)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1153
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1154 if preexec_fn:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1155 preexec_fn()
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1156
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1157 if env is None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1158 os.execvp(executable, args)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1159 else:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1160 os.execvpe(executable, args, env)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1161
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1162 except:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1163 exc_type, exc_value, tb = sys.exc_info()
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1164 # Save the traceback and attach it to the exception object
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1165 exc_lines = traceback.format_exception(exc_type,
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1166 exc_value,
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1167 tb)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1168 exc_value.child_traceback = ''.join(exc_lines)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1169 os.write(errpipe_write, pickle.dumps(exc_value))
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1170
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1171 # This exitcode won't be reported to applications, so it
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1172 # really doesn't matter what we return.
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1173 os._exit(255)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1174
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1175 # Parent
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1176 if gc_was_enabled:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1177 gc.enable()
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1178 finally:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1179 # be sure the FD is closed no matter what
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1180 os.close(errpipe_write)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1181
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1182 if p2cread is not None and p2cwrite is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1183 os.close(p2cread)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1184 if c2pwrite is not None and c2pread is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1185 os.close(c2pwrite)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1186 if errwrite is not None and errread is not None:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1187 os.close(errwrite)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1188
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1189 # Wait for exec to fail or succeed; possibly raising exception
59206 6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	1190 # Exception limited to 1M
6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	1191 data = _eintr_retry_call(os.read, errpipe_read, 1048576)
54795 dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1192 finally:
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1193 # be sure the FD is closed no matter what
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1194 os.close(errpipe_read)
dcc962b4d8ff Issue #6274. Fixed a potential FD leak in subprocess.py. Facundo Batista <facundobatista@gmail.com> parents: 54792 diff changeset	1195
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1196 if data != "":
59206 6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	1197 _eintr_retry_call(os.waitpid, self.pid, 0)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1198 child_exception = pickle.loads(data)
51636 556990bb4f0a #5179: don't leak PIPE fds when child execution fails. Georg Brandl <georg@python.org> parents: 49984 diff changeset	1199 for fd in (p2cwrite, c2pread, errread):
556990bb4f0a #5179: don't leak PIPE fds when child execution fails. Georg Brandl <georg@python.org> parents: 49984 diff changeset	1200 if fd is not None:
556990bb4f0a #5179: don't leak PIPE fds when child execution fails. Georg Brandl <georg@python.org> parents: 49984 diff changeset	1201 os.close(fd)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1202 raise child_exception
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1203
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1204
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1205 def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1206 _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1207 _WEXITSTATUS=os.WEXITSTATUS):
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1208 # This method is called (indirectly) by __del__, so it cannot
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1209 # refer to anything outside of its local scope."""
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1210 if _WIFSIGNALED(sts):
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1211 self.returncode = -_WTERMSIG(sts)
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1212 elif _WIFEXITED(sts):
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1213 self.returncode = _WEXITSTATUS(sts)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1214 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1215 # Should never happen
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1216 raise RuntimeError("Unknown child exit status!")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1217
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1218
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1219 def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1220 _WNOHANG=os.WNOHANG, _os_error=os.error):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1221 """Check if child process has terminated. Returns returncode
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1222 attribute.
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1223
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1224 This method is called by __del__, so it cannot reference anything
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1225 outside of the local scope (nor can any methods it calls).
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1226
ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1227 """
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1228 if self.returncode is None:
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1229 try:
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1230 pid, sts = _waitpid(self.pid, _WNOHANG)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1231 if pid == self.pid:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1232 self._handle_exitstatus(sts)
61564 ca496bfacd1b subprocess.Popen.__del__ referenced global objects, which is a no-no thanks to Brett Cannon <bcannon@gmail.com> parents: 60977 diff changeset	1233 except _os_error:
37563 42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	1234 if _deadstate is not None:
42023f5b7d6d Patch #1467770: Add Popen objects to _active only in __del__. Martin v. Löwis <martin@v.loewis.de> parents: 35633 diff changeset	1235 self.returncode = _deadstate
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1236 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1237
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1238
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1239 def wait(self):
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1240 """Wait for child process to terminate. Returns returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1241 attribute."""
34575 4545a154fac1 Patch from Leandro Lucarella: replaced: Peter Astrand <astrand@lysator.liu.se> parents: 34551 diff changeset	1242 if self.returncode is None:
59206 6e664bcc958d Issue #1068268: The subprocess module now handles EINTR in internal Gregory P. Smith <greg@mad-scientist.com> parents: 58761 diff changeset	1243 pid, sts = _eintr_retry_call(os.waitpid, self.pid, 0)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1244 self._handle_exitstatus(sts)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1245 return self.returncode
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1246
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1247
34672 085bc27f92b7 Optimization for communicate(): If only one of stdin/stdout/stderr is Peter Astrand <astrand@lysator.liu.se> parents: 34624 diff changeset	1248 def _communicate(self, input):
55092 9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1249 if self.stdin:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1250 # Flush stdio buffer. This might block, if the user has
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1251 # been writing to .stdin in an uncontrolled fashion.
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1252 self.stdin.flush()
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1253 if not input:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1254 self.stdin.close()
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1255
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1256 if _has_poll:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1257 stdout, stderr = self._communicate_with_poll(input)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1258 else:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1259 stdout, stderr = self._communicate_with_select(input)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1260
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1261 # All data exchanged. Translate lists into strings.
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1262 if stdout is not None:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1263 stdout = ''.join(stdout)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1264 if stderr is not None:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1265 stderr = ''.join(stderr)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1266
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1267 # Translate newlines, if requested. We cannot let the file
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1268 # object do the translation: It is based on stdio, which is
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1269 # impossible to combine with select (unless forcing no
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1270 # buffering).
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1271 if self.universal_newlines and hasattr(file, 'newlines'):
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1272 if stdout:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1273 stdout = self._translate_newlines(stdout)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1274 if stderr:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1275 stderr = self._translate_newlines(stderr)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1276
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1277 self.wait()
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1278 return (stdout, stderr)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1279
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1280
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1281 def _communicate_with_poll(self, input):
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1282 stdout = None # Return
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1283 stderr = None # Return
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1284 fd2file = {}
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1285 fd2output = {}
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1286
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1287 poller = select.poll()
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1288 def register_and_append(file_obj, eventmask):
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1289 poller.register(file_obj.fileno(), eventmask)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1290 fd2file[file_obj.fileno()] = file_obj
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1291
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1292 def close_unregister_and_remove(fd):
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1293 poller.unregister(fd)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1294 fd2file[fd].close()
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1295 fd2file.pop(fd)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1296
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1297 if self.stdin and input:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1298 register_and_append(self.stdin, select.POLLOUT)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1299
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1300 select_POLLIN_POLLPRI = select.POLLIN \| select.POLLPRI
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1301 if self.stdout:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1302 register_and_append(self.stdout, select_POLLIN_POLLPRI)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1303 fd2output[self.stdout.fileno()] = stdout = []
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1304 if self.stderr:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1305 register_and_append(self.stderr, select_POLLIN_POLLPRI)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1306 fd2output[self.stderr.fileno()] = stderr = []
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1307
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1308 input_offset = 0
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1309 while fd2file:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1310 try:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1311 ready = poller.poll()
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1312 except select.error, e:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1313 if e.args[0] == errno.EINTR:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1314 continue
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1315 raise
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1316
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1317 for fd, mode in ready:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1318 if mode & select.POLLOUT:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1319 chunk = input[input_offset : input_offset + _PIPE_BUF]
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1320 input_offset += os.write(fd, chunk)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1321 if input_offset >= len(input):
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1322 close_unregister_and_remove(fd)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1323 elif mode & select_POLLIN_POLLPRI:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1324 data = os.read(fd, 4096)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1325 if not data:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1326 close_unregister_and_remove(fd)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1327 fd2output[fd].append(data)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1328 else:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1329 # Ignore hang up or errors.
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1330 close_unregister_and_remove(fd)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1331
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1332 return (stdout, stderr)
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1333
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1334
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1335 def _communicate_with_select(self, input):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1336 read_set = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1337 write_set = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1338 stdout = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1339 stderr = None # Return
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1340
55092 9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1341 if self.stdin and input:
9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1342 write_set.append(self.stdin)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1343 if self.stdout:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1344 read_set.append(self.stdout)
33731 53c468d0955b Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 33727 diff changeset	1345 stdout = []
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1346 if self.stderr:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1347 read_set.append(self.stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1348 stderr = []
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1349
40568 99093b527c01 Avoid O(N*2) bottleneck in _communicate_(). Fixes #1598181. Peter Astrand <astrand@lysator.liu.se>* parents: 40566 diff changeset	1350 input_offset = 0
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1351 while read_set or write_set:
47899 c3193b7156bb - Issue #2113: Fix error in subprocess.Popen if the select system call is Gregory P. Smith <greg@mad-scientist.com> parents: 47338 diff changeset	1352 try:
c3193b7156bb - Issue #2113: Fix error in subprocess.Popen if the select system call is Gregory P. Smith <greg@mad-scientist.com> parents: 47338 diff changeset	1353 rlist, wlist, xlist = select.select(read_set, write_set, [])
c3193b7156bb - Issue #2113: Fix error in subprocess.Popen if the select system call is Gregory P. Smith <greg@mad-scientist.com> parents: 47338 diff changeset	1354 except select.error, e:
c3193b7156bb - Issue #2113: Fix error in subprocess.Popen if the select system call is Gregory P. Smith <greg@mad-scientist.com> parents: 47338 diff changeset	1355 if e.args[0] == errno.EINTR:
c3193b7156bb - Issue #2113: Fix error in subprocess.Popen if the select system call is Gregory P. Smith <greg@mad-scientist.com> parents: 47338 diff changeset	1356 continue
c3193b7156bb - Issue #2113: Fix error in subprocess.Popen if the select system call is Gregory P. Smith <greg@mad-scientist.com> parents: 47338 diff changeset	1357 raise
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1358
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1359 if self.stdin in wlist:
55092 9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1360 chunk = input[input_offset : input_offset + _PIPE_BUF]
48194 6416e6044a30 Remove warnings generated for the suprocess module when run under -3. Required Brett Cannon <bcannon@gmail.com> parents: 48154 diff changeset	1361 bytes_written = os.write(self.stdin.fileno(), chunk)
40732 5dae0d7f683a Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 40619 diff changeset	1362 input_offset += bytes_written
40568 99093b527c01 Avoid O(N*2) bottleneck in _communicate_(). Fixes #1598181. Peter Astrand <astrand@lysator.liu.se>* parents: 40566 diff changeset	1363 if input_offset >= len(input):
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1364 self.stdin.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1365 write_set.remove(self.stdin)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1366
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1367 if self.stdout in rlist:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1368 data = os.read(self.stdout.fileno(), 1024)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1369 if data == "":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1370 self.stdout.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1371 read_set.remove(self.stdout)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1372 stdout.append(data)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1373
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1374 if self.stderr in rlist:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1375 data = os.read(self.stderr.fileno(), 1024)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1376 if data == "":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1377 self.stderr.close()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1378 read_set.remove(self.stderr)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1379 stderr.append(data)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1380
55092 9808e38fde72 Use select.poll() in subprocess, when available, rather than select() so that Gregory P. Smith <greg@mad-scientist.com> parents: 54795 diff changeset	1381 return (stdout, stderr)
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1382
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1383
46479 e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1384 def send_signal(self, sig):
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1385 """Send a signal to the process
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1386 """
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1387 os.kill(self.pid, sig)
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1388
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1389 def terminate(self):
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1390 """Terminate the process with SIGTERM
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1391 """
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1392 self.send_signal(signal.SIGTERM)
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1393
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1394 def kill(self):
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1395 """Kill the process with SIGKILL
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1396 """
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1397 self.send_signal(signal.SIGKILL)
e16593da4898 Added kill, terminate and send_signal to subprocess.Popen Christian Heimes <christian@cheimes.de> parents: 44801 diff changeset	1398
33723 76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1399
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1400 def _demo_posix():
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1401 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1402 # Example 1: Simple redirection: Get process list
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1403 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1404 plist = Popen(["ps"], stdout=PIPE).communicate()[0]
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1405 print "Process list:"
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1406 print plist
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1407
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1408 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1409 # Example 2: Change uid before executing child
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1410 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1411 if os.getuid() == 0:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1412 p = Popen(["id"], preexec_fn=lambda: os.setuid(100))
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1413 p.wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1414
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1415 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1416 # Example 3: Connecting several subprocesses
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1417 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1418 print "Looking for 'hda'..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1419 p1 = Popen(["dmesg"], stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1420 p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1421 print repr(p2.communicate()[0])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1422
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1423 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1424 # Example 4: Catch execution error
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1425 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1426 print
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1427 print "Trying a weird file..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1428 try:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1429 print Popen(["/this/path/does/not/exist"]).communicate()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1430 except OSError, e:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1431 if e.errno == errno.ENOENT:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1432 print "The file didn't exist. I thought so..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1433 print "Child traceback:"
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1434 print e.child_traceback
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1435 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1436 print "Error", e.errno
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1437 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1438 print >>sys.stderr, "Gosh. No error."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1439
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1440
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1441 def _demo_windows():
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1442 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1443 # Example 1: Connecting several subprocesses
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1444 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1445 print "Looking for 'PROMPT' in set output..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1446 p1 = Popen("set", stdout=PIPE, shell=True)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1447 p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE)
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1448 print repr(p2.communicate()[0])
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1449
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1450 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1451 # Example 2: Simple execution of program
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1452 #
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1453 print "Executing calc..."
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1454 p = Popen("calc")
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1455 p.wait()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1456
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1457
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1458 if __name__ == "__main__":
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1459 if mswindows:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1460 _demo_windows()
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1461 else:
76641824cf05 Added Peter Astrand's subprocess module. Fredrik Lundh <fredrik@pythonware.com> parents: diff changeset	1462 _demo_posix()

Mercurial > cpython-lru_cache-weakref

annotate Lib/subprocess.py @ 65035:87f4b32905df 2.7