Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1 | # subprocess - Subprocesses with accessible I/O streams |
| 2 | # |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 3 | # For more information about this module, see PEP 324. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 4 | # |
Peter Astrand | 3a708df | 2005-09-23 17:37:29 +0000 | [diff] [blame] | 5 | # Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se> |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 6 | # |
Peter Astrand | 69bf13f | 2005-02-14 08:56:32 +0000 | [diff] [blame] | 7 | # Licensed to PSF under a Contributor Agreement. |
Peter Astrand | 3a708df | 2005-09-23 17:37:29 +0000 | [diff] [blame] | 8 | # See http://www.python.org/2.4/license for licensing details. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 9 | |
Raymond Hettinger | 837dd93 | 2004-10-17 16:36:53 +0000 | [diff] [blame] | 10 | r"""subprocess - Subprocesses with accessible I/O streams |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 11 | |
Fredrik Lundh | 15aaacc | 2004-10-17 14:47:05 +0000 | [diff] [blame] | 12 | This module allows you to spawn processes, connect to their |
| 13 | input/output/error pipes, and obtain their return codes. This module |
| 14 | intends to replace several other, older modules and functions, like: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 15 | |
| 16 | os.system |
| 17 | os.spawn* |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 18 | |
| 19 | Information about how the subprocess module can be used to replace these |
| 20 | modules and functions can be found below. |
| 21 | |
| 22 | |
| 23 | |
| 24 | Using the subprocess module |
| 25 | =========================== |
| 26 | This module defines one class called Popen: |
| 27 | |
| 28 | class Popen(args, bufsize=0, executable=None, |
| 29 | stdin=None, stdout=None, stderr=None, |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 30 | preexec_fn=None, close_fds=True, shell=False, |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 31 | cwd=None, env=None, universal_newlines=False, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 32 | startupinfo=None, creationflags=0, |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 33 | restore_signals=True, start_new_session=False, pass_fds=()): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 34 | |
| 35 | |
| 36 | Arguments are: |
| 37 | |
| 38 | args should be a string, or a sequence of program arguments. The |
| 39 | program to execute is normally the first item in the args sequence or |
| 40 | string, but can be explicitly set by using the executable argument. |
| 41 | |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 42 | On POSIX, with shell=False (default): In this case, the Popen class |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 43 | uses os.execvp() to execute the child program. args should normally |
| 44 | be a sequence. A string will be treated as a sequence with the string |
| 45 | as the only item (the program to execute). |
| 46 | |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 47 | On POSIX, with shell=True: If args is a string, it specifies the |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 48 | command string to execute through the shell. If args is a sequence, |
| 49 | the first item specifies the command string, and any additional items |
| 50 | will be treated as additional shell arguments. |
| 51 | |
| 52 | On Windows: the Popen class uses CreateProcess() to execute the child |
| 53 | program, which operates on strings. If args is a sequence, it will be |
| 54 | converted to a string using the list2cmdline method. Please note that |
| 55 | not all MS Windows applications interpret the command line the same |
| 56 | way: The list2cmdline is designed for applications using the same |
| 57 | rules as the MS C runtime. |
| 58 | |
| 59 | bufsize, if given, has the same meaning as the corresponding argument |
| 60 | to the built-in open() function: 0 means unbuffered, 1 means line |
| 61 | buffered, any other positive value means use a buffer of |
| 62 | (approximately) that size. A negative bufsize means to use the system |
| 63 | default, which usually means fully buffered. The default value for |
| 64 | bufsize is 0 (unbuffered). |
| 65 | |
| 66 | stdin, stdout and stderr specify the executed programs' standard |
| 67 | input, standard output and standard error file handles, respectively. |
| 68 | Valid values are PIPE, an existing file descriptor (a positive |
| 69 | integer), an existing file object, and None. PIPE indicates that a |
| 70 | new pipe to the child should be created. With None, no redirection |
| 71 | will occur; the child's file handles will be inherited from the |
| 72 | parent. Additionally, stderr can be STDOUT, which indicates that the |
| 73 | stderr data from the applications should be captured into the same |
| 74 | file handle as for stdout. |
| 75 | |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 76 | On POSIX, if preexec_fn is set to a callable object, this object will be |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 77 | called in the child process just before the child is executed. The use |
| 78 | of preexec_fn is not thread safe, using it in the presence of threads |
| 79 | could lead to a deadlock in the child process before the new executable |
| 80 | is executed. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 81 | |
| 82 | If close_fds is true, all file descriptors except 0, 1 and 2 will be |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 83 | closed before the child process is executed. The default for close_fds |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 84 | varies by platform: Always true on POSIX. True when stdin/stdout/stderr |
| 85 | are None on Windows, false otherwise. |
| 86 | |
| 87 | pass_fds is an optional sequence of file descriptors to keep open between the |
| 88 | parent and child. Providing any pass_fds implicitly sets close_fds to true. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 89 | |
| 90 | if shell is true, the specified command will be executed through the |
| 91 | shell. |
| 92 | |
| 93 | If cwd is not None, the current directory will be changed to cwd |
| 94 | before the child is executed. |
| 95 | |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 96 | On POSIX, if restore_signals is True all signals that Python sets to |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 97 | SIG_IGN are restored to SIG_DFL in the child process before the exec. |
| 98 | Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. This |
| 99 | parameter does nothing on Windows. |
| 100 | |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 101 | On POSIX, if start_new_session is True, the setsid() system call will be made |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 102 | in the child process prior to executing the command. |
| 103 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 104 | If env is not None, it defines the environment variables for the new |
| 105 | process. |
| 106 | |
| 107 | If universal_newlines is true, the file objects stdout and stderr are |
| 108 | opened as a text files, but lines may be terminated by any of '\n', |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 109 | the Unix end-of-line convention, '\r', the old Macintosh convention or |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 110 | '\r\n', the Windows convention. All of these external representations |
| 111 | are seen as '\n' by the Python program. Note: This feature is only |
| 112 | available if Python is built with universal newline support (the |
| 113 | default). Also, the newlines attribute of the file objects stdout, |
| 114 | stdin and stderr are not updated by the communicate() method. |
| 115 | |
| 116 | The startupinfo and creationflags, if given, will be passed to the |
| 117 | underlying CreateProcess() function. They can specify things such as |
| 118 | appearance of the main window and priority for the new process. |
| 119 | (Windows only) |
| 120 | |
| 121 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 122 | This module also defines some shortcut functions: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 123 | |
Peter Astrand | 5f5e141 | 2004-12-05 20:15:36 +0000 | [diff] [blame] | 124 | call(*popenargs, **kwargs): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 125 | Run command with arguments. Wait for command to complete, then |
| 126 | return the returncode attribute. |
| 127 | |
| 128 | The arguments are the same as for the Popen constructor. Example: |
| 129 | |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 130 | >>> retcode = subprocess.call(["ls", "-l"]) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 131 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 132 | check_call(*popenargs, **kwargs): |
| 133 | Run command with arguments. Wait for command to complete. If the |
| 134 | exit code was zero then return, otherwise raise |
| 135 | CalledProcessError. The CalledProcessError object will have the |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 136 | return code in the returncode attribute. |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 137 | |
| 138 | The arguments are the same as for the Popen constructor. Example: |
| 139 | |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 140 | >>> subprocess.check_call(["ls", "-l"]) |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 141 | 0 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 142 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 143 | getstatusoutput(cmd): |
| 144 | Return (status, output) of executing cmd in a shell. |
| 145 | |
| 146 | Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple |
| 147 | (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the |
| 148 | returned output will contain output or error messages. A trailing newline |
| 149 | is stripped from the output. The exit status for the command can be |
| 150 | interpreted according to the rules for the C function wait(). Example: |
| 151 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 152 | >>> subprocess.getstatusoutput('ls /bin/ls') |
| 153 | (0, '/bin/ls') |
| 154 | >>> subprocess.getstatusoutput('cat /bin/junk') |
| 155 | (256, 'cat: /bin/junk: No such file or directory') |
| 156 | >>> subprocess.getstatusoutput('/bin/junk') |
| 157 | (256, 'sh: /bin/junk: not found') |
| 158 | |
| 159 | getoutput(cmd): |
| 160 | Return output (stdout or stderr) of executing cmd in a shell. |
| 161 | |
| 162 | Like getstatusoutput(), except the exit status is ignored and the return |
| 163 | value is a string containing the command's output. Example: |
| 164 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 165 | >>> subprocess.getoutput('ls /bin/ls') |
| 166 | '/bin/ls' |
| 167 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 168 | check_output(*popenargs, **kwargs): |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 169 | Run command with arguments and return its output as a byte string. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 170 | |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 171 | If the exit code was non-zero it raises a CalledProcessError. The |
| 172 | CalledProcessError object will have the return code in the returncode |
| 173 | attribute and output in the output attribute. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 174 | |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 175 | The arguments are the same as for the Popen constructor. Example: |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 176 | |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 177 | >>> output = subprocess.check_output(["ls", "-l", "/dev/null"]) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 178 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 179 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 180 | Exceptions |
| 181 | ---------- |
| 182 | Exceptions raised in the child process, before the new program has |
| 183 | started to execute, will be re-raised in the parent. Additionally, |
| 184 | the exception object will have one extra attribute called |
| 185 | 'child_traceback', which is a string containing traceback information |
| 186 | from the childs point of view. |
| 187 | |
| 188 | The most common exception raised is OSError. This occurs, for |
| 189 | example, when trying to execute a non-existent file. Applications |
| 190 | should prepare for OSErrors. |
| 191 | |
| 192 | A ValueError will be raised if Popen is called with invalid arguments. |
| 193 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 194 | check_call() and check_output() will raise CalledProcessError, if the |
| 195 | called process returns a non-zero return code. |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 196 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 197 | |
| 198 | Security |
| 199 | -------- |
| 200 | Unlike some other popen functions, this implementation will never call |
| 201 | /bin/sh implicitly. This means that all characters, including shell |
| 202 | metacharacters, can safely be passed to child processes. |
| 203 | |
| 204 | |
| 205 | Popen objects |
| 206 | ============= |
| 207 | Instances of the Popen class have the following methods: |
| 208 | |
| 209 | poll() |
| 210 | Check if child process has terminated. Returns returncode |
| 211 | attribute. |
| 212 | |
| 213 | wait() |
| 214 | Wait for child process to terminate. Returns returncode attribute. |
| 215 | |
| 216 | communicate(input=None) |
| 217 | Interact with process: Send data to stdin. Read data from stdout |
| 218 | and stderr, until end-of-file is reached. Wait for process to |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 219 | terminate. The optional input argument should be a string to be |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 220 | sent to the child process, or None, if no data should be sent to |
| 221 | the child. |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 222 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 223 | communicate() returns a tuple (stdout, stderr). |
| 224 | |
| 225 | Note: The data read is buffered in memory, so do not use this |
| 226 | method if the data size is large or unlimited. |
| 227 | |
| 228 | The following attributes are also available: |
| 229 | |
| 230 | stdin |
| 231 | If the stdin argument is PIPE, this attribute is a file object |
| 232 | that provides input to the child process. Otherwise, it is None. |
| 233 | |
| 234 | stdout |
| 235 | If the stdout argument is PIPE, this attribute is a file object |
| 236 | that provides output from the child process. Otherwise, it is |
| 237 | None. |
| 238 | |
| 239 | stderr |
| 240 | If the stderr argument is PIPE, this attribute is file object that |
| 241 | provides error output from the child process. Otherwise, it is |
| 242 | None. |
| 243 | |
| 244 | pid |
| 245 | The process ID of the child process. |
| 246 | |
| 247 | returncode |
| 248 | The child return code. A None value indicates that the process |
| 249 | hasn't terminated yet. A negative value -N indicates that the |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 250 | child was terminated by signal N (POSIX only). |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 251 | |
| 252 | |
| 253 | Replacing older functions with the subprocess module |
| 254 | ==================================================== |
| 255 | In this section, "a ==> b" means that b can be used as a replacement |
| 256 | for a. |
| 257 | |
| 258 | Note: All functions in this section fail (more or less) silently if |
| 259 | the executed program cannot be found; this module raises an OSError |
| 260 | exception. |
| 261 | |
| 262 | In the following examples, we assume that the subprocess module is |
| 263 | imported with "from subprocess import *". |
| 264 | |
| 265 | |
| 266 | Replacing /bin/sh shell backquote |
| 267 | --------------------------------- |
| 268 | output=`mycmd myarg` |
| 269 | ==> |
| 270 | output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0] |
| 271 | |
| 272 | |
| 273 | Replacing shell pipe line |
| 274 | ------------------------- |
| 275 | output=`dmesg | grep hda` |
| 276 | ==> |
| 277 | p1 = Popen(["dmesg"], stdout=PIPE) |
Peter Astrand | 6fdf3cb | 2004-11-30 18:06:42 +0000 | [diff] [blame] | 278 | p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 279 | output = p2.communicate()[0] |
| 280 | |
| 281 | |
| 282 | Replacing os.system() |
| 283 | --------------------- |
| 284 | sts = os.system("mycmd" + " myarg") |
| 285 | ==> |
| 286 | p = Popen("mycmd" + " myarg", shell=True) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 287 | pid, sts = os.waitpid(p.pid, 0) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 288 | |
| 289 | Note: |
| 290 | |
| 291 | * Calling the program through the shell is usually not required. |
| 292 | |
| 293 | * It's easier to look at the returncode attribute than the |
| 294 | exitstatus. |
| 295 | |
| 296 | A more real-world example would look like this: |
| 297 | |
| 298 | try: |
| 299 | retcode = call("mycmd" + " myarg", shell=True) |
| 300 | if retcode < 0: |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 301 | print("Child was terminated by signal", -retcode, file=sys.stderr) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 302 | else: |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 303 | print("Child returned", retcode, file=sys.stderr) |
| 304 | except OSError as e: |
| 305 | print("Execution failed:", e, file=sys.stderr) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 306 | |
| 307 | |
| 308 | Replacing os.spawn* |
| 309 | ------------------- |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 310 | P_NOWAIT example: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 311 | |
| 312 | pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg") |
| 313 | ==> |
| 314 | pid = Popen(["/bin/mycmd", "myarg"]).pid |
| 315 | |
| 316 | |
| 317 | P_WAIT example: |
| 318 | |
| 319 | retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg") |
| 320 | ==> |
| 321 | retcode = call(["/bin/mycmd", "myarg"]) |
| 322 | |
| 323 | |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 324 | Vector example: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 325 | |
| 326 | os.spawnvp(os.P_NOWAIT, path, args) |
| 327 | ==> |
| 328 | Popen([path] + args[1:]) |
| 329 | |
| 330 | |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 331 | Environment example: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 332 | |
| 333 | os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env) |
| 334 | ==> |
| 335 | Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"}) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 336 | """ |
| 337 | |
| 338 | import sys |
| 339 | mswindows = (sys.platform == "win32") |
| 340 | |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 341 | import io |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 342 | import os |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 343 | import traceback |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 344 | import gc |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 345 | import signal |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 346 | import builtins |
Gregory P. Smith | d23047b | 2010-12-04 09:10:44 +0000 | [diff] [blame] | 347 | import warnings |
Ross Lagerwall | 4f61b02 | 2011-04-05 15:34:00 +0200 | [diff] [blame] | 348 | import errno |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 349 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 350 | # Exception classes used by this module. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 351 | class CalledProcessError(Exception): |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 352 | """This exception is raised when a process run by check_call() or |
| 353 | check_output() returns a non-zero exit status. |
| 354 | The exit status will be stored in the returncode attribute; |
| 355 | check_output() will also store the output in the output attribute. |
| 356 | """ |
| 357 | def __init__(self, returncode, cmd, output=None): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 358 | self.returncode = returncode |
| 359 | self.cmd = cmd |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 360 | self.output = output |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 361 | def __str__(self): |
| 362 | return "Command '%s' returned non-zero exit status %d" % (self.cmd, self.returncode) |
| 363 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 364 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 365 | if mswindows: |
| 366 | import threading |
| 367 | import msvcrt |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 368 | import _subprocess |
| 369 | class STARTUPINFO: |
| 370 | dwFlags = 0 |
| 371 | hStdInput = None |
| 372 | hStdOutput = None |
| 373 | hStdError = None |
| 374 | wShowWindow = 0 |
| 375 | class pywintypes: |
| 376 | error = IOError |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 377 | else: |
| 378 | import select |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 379 | _has_poll = hasattr(select, 'poll') |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 380 | import fcntl |
| 381 | import pickle |
| 382 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 383 | try: |
| 384 | import _posixsubprocess |
| 385 | except ImportError: |
| 386 | _posixsubprocess = None |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 387 | warnings.warn("The _posixsubprocess module is not being used. " |
| 388 | "Child process reliability may suffer if your " |
| 389 | "program uses threads.", RuntimeWarning) |
| 390 | |
Amaury Forgeot d'Arc | ace3102 | 2009-07-09 22:44:11 +0000 | [diff] [blame] | 391 | # When select or poll has indicated that the file is writable, |
| 392 | # we can write up to _PIPE_BUF bytes without risk of blocking. |
| 393 | # POSIX defines PIPE_BUF as >= 512. |
| 394 | _PIPE_BUF = getattr(select, 'PIPE_BUF', 512) |
| 395 | |
Antoine Pitrou | c9c83ba | 2011-01-03 18:23:55 +0000 | [diff] [blame] | 396 | _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1) |
| 397 | |
| 398 | def _set_cloexec(fd, cloexec): |
| 399 | old = fcntl.fcntl(fd, fcntl.F_GETFD) |
| 400 | if cloexec: |
| 401 | fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC) |
| 402 | else: |
| 403 | fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC) |
| 404 | |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 405 | if _posixsubprocess: |
| 406 | _create_pipe = _posixsubprocess.cloexec_pipe |
| 407 | else: |
| 408 | def _create_pipe(): |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 409 | fds = os.pipe() |
Antoine Pitrou | c9c83ba | 2011-01-03 18:23:55 +0000 | [diff] [blame] | 410 | _set_cloexec(fds[0], True) |
| 411 | _set_cloexec(fds[1], True) |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 412 | return fds |
Amaury Forgeot d'Arc | ace3102 | 2009-07-09 22:44:11 +0000 | [diff] [blame] | 413 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 414 | __all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call", "getstatusoutput", |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 415 | "getoutput", "check_output", "CalledProcessError"] |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 416 | |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 417 | if mswindows: |
Brian Curtin | 08fd8d9 | 2011-04-29 16:11:30 -0500 | [diff] [blame] | 418 | from _subprocess import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP, |
Brian Curtin | 8b8e7f4 | 2011-04-29 15:48:13 -0500 | [diff] [blame] | 419 | STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, |
| 420 | STD_ERROR_HANDLE, SW_HIDE, |
| 421 | STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW) |
Gregory P. Smith | 0ef3e39 | 2011-05-11 22:20:11 -0700 | [diff] [blame] | 422 | |
Brian Curtin | 08fd8d9 | 2011-04-29 16:11:30 -0500 | [diff] [blame] | 423 | __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP", |
Brian Curtin | 8b8e7f4 | 2011-04-29 15:48:13 -0500 | [diff] [blame] | 424 | "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE", |
| 425 | "STD_ERROR_HANDLE", "SW_HIDE", |
| 426 | "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"]) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 427 | try: |
| 428 | MAXFD = os.sysconf("SC_OPEN_MAX") |
| 429 | except: |
| 430 | MAXFD = 256 |
| 431 | |
Charles-François Natali | 134a8ba | 2011-08-18 18:49:39 +0200 | [diff] [blame] | 432 | # This lists holds Popen instances for which the underlying process had not |
| 433 | # exited at the time its __del__ method got called: those processes are wait()ed |
| 434 | # for synchronously from _cleanup() when a new Popen object is created, to avoid |
| 435 | # zombie processes. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 436 | _active = [] |
| 437 | |
| 438 | def _cleanup(): |
| 439 | for inst in _active[:]: |
Georg Brandl | 6aa2d1f | 2008-08-12 08:35:52 +0000 | [diff] [blame] | 440 | res = inst._internal_poll(_deadstate=sys.maxsize) |
Charles-François Natali | 134a8ba | 2011-08-18 18:49:39 +0200 | [diff] [blame] | 441 | if res is not None: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 442 | try: |
| 443 | _active.remove(inst) |
| 444 | except ValueError: |
| 445 | # This can happen if two threads create a new Popen instance. |
| 446 | # It's harmless that it was already removed, so ignore. |
| 447 | pass |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 448 | |
| 449 | PIPE = -1 |
| 450 | STDOUT = -2 |
| 451 | |
| 452 | |
Gregory P. Smith | a59c59f | 2010-03-01 00:17:40 +0000 | [diff] [blame] | 453 | def _eintr_retry_call(func, *args): |
| 454 | while True: |
| 455 | try: |
| 456 | return func(*args) |
Victor Stinner | 2cfb6f3 | 2011-07-05 14:00:56 +0200 | [diff] [blame] | 457 | except (OSError, IOError) as e: |
Gregory P. Smith | a59c59f | 2010-03-01 00:17:40 +0000 | [diff] [blame] | 458 | if e.errno == errno.EINTR: |
| 459 | continue |
| 460 | raise |
| 461 | |
| 462 | |
Peter Astrand | 5f5e141 | 2004-12-05 20:15:36 +0000 | [diff] [blame] | 463 | def call(*popenargs, **kwargs): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 464 | """Run command with arguments. Wait for command to complete, then |
| 465 | return the returncode attribute. |
| 466 | |
| 467 | The arguments are the same as for the Popen constructor. Example: |
| 468 | |
| 469 | retcode = call(["ls", "-l"]) |
| 470 | """ |
Peter Astrand | 5f5e141 | 2004-12-05 20:15:36 +0000 | [diff] [blame] | 471 | return Popen(*popenargs, **kwargs).wait() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 472 | |
| 473 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 474 | def check_call(*popenargs, **kwargs): |
| 475 | """Run command with arguments. Wait for command to complete. If |
| 476 | the exit code was zero then return, otherwise raise |
| 477 | CalledProcessError. The CalledProcessError object will have the |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 478 | return code in the returncode attribute. |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 479 | |
| 480 | The arguments are the same as for the Popen constructor. Example: |
| 481 | |
| 482 | check_call(["ls", "-l"]) |
| 483 | """ |
| 484 | retcode = call(*popenargs, **kwargs) |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 485 | if retcode: |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 486 | cmd = kwargs.get("args") |
| 487 | if cmd is None: |
| 488 | cmd = popenargs[0] |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 489 | raise CalledProcessError(retcode, cmd) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 490 | return 0 |
| 491 | |
| 492 | |
| 493 | def check_output(*popenargs, **kwargs): |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 494 | r"""Run command with arguments and return its output as a byte string. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 495 | |
| 496 | If the exit code was non-zero it raises a CalledProcessError. The |
| 497 | CalledProcessError object will have the return code in the returncode |
| 498 | attribute and output in the output attribute. |
| 499 | |
| 500 | The arguments are the same as for the Popen constructor. Example: |
| 501 | |
| 502 | >>> check_output(["ls", "-l", "/dev/null"]) |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 503 | b'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n' |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 504 | |
| 505 | The stdout argument is not allowed as it is used internally. |
Georg Brandl | 127d470 | 2009-12-28 08:10:38 +0000 | [diff] [blame] | 506 | To capture standard error in the result, use stderr=STDOUT. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 507 | |
| 508 | >>> check_output(["/bin/sh", "-c", |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 509 | ... "ls -l non_existent_file ; exit 0"], |
Georg Brandl | 127d470 | 2009-12-28 08:10:38 +0000 | [diff] [blame] | 510 | ... stderr=STDOUT) |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 511 | b'ls: non_existent_file: No such file or directory\n' |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 512 | """ |
| 513 | if 'stdout' in kwargs: |
| 514 | raise ValueError('stdout argument not allowed, it will be overridden.') |
| 515 | process = Popen(*popenargs, stdout=PIPE, **kwargs) |
| 516 | output, unused_err = process.communicate() |
| 517 | retcode = process.poll() |
| 518 | if retcode: |
| 519 | cmd = kwargs.get("args") |
| 520 | if cmd is None: |
| 521 | cmd = popenargs[0] |
| 522 | raise CalledProcessError(retcode, cmd, output=output) |
| 523 | return output |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 524 | |
| 525 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 526 | def list2cmdline(seq): |
| 527 | """ |
| 528 | Translate a sequence of arguments into a command line |
| 529 | string, using the same rules as the MS C runtime: |
| 530 | |
| 531 | 1) Arguments are delimited by white space, which is either a |
| 532 | space or a tab. |
| 533 | |
| 534 | 2) A string surrounded by double quotation marks is |
| 535 | interpreted as a single argument, regardless of white space |
Jean-Paul Calderone | 1ddd407 | 2010-06-18 20:03:54 +0000 | [diff] [blame] | 536 | contained within. A quoted string can be embedded in an |
| 537 | argument. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 538 | |
| 539 | 3) A double quotation mark preceded by a backslash is |
| 540 | interpreted as a literal double quotation mark. |
| 541 | |
| 542 | 4) Backslashes are interpreted literally, unless they |
| 543 | immediately precede a double quotation mark. |
| 544 | |
| 545 | 5) If backslashes immediately precede a double quotation mark, |
| 546 | every pair of backslashes is interpreted as a literal |
| 547 | backslash. If the number of backslashes is odd, the last |
| 548 | backslash escapes the next double quotation mark as |
| 549 | described in rule 3. |
| 550 | """ |
| 551 | |
| 552 | # See |
Eric Smith | 3c573af | 2009-11-09 15:23:15 +0000 | [diff] [blame] | 553 | # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx |
| 554 | # or search http://msdn.microsoft.com for |
| 555 | # "Parsing C++ Command-Line Arguments" |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 556 | result = [] |
| 557 | needquote = False |
| 558 | for arg in seq: |
| 559 | bs_buf = [] |
| 560 | |
| 561 | # Add a space to separate this argument from the others |
| 562 | if result: |
| 563 | result.append(' ') |
| 564 | |
Jean-Paul Calderone | 1ddd407 | 2010-06-18 20:03:54 +0000 | [diff] [blame] | 565 | needquote = (" " in arg) or ("\t" in arg) or not arg |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 566 | if needquote: |
| 567 | result.append('"') |
| 568 | |
| 569 | for c in arg: |
| 570 | if c == '\\': |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 571 | # Don't know if we need to double yet. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 572 | bs_buf.append(c) |
| 573 | elif c == '"': |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 574 | # Double backslashes. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 575 | result.append('\\' * len(bs_buf)*2) |
| 576 | bs_buf = [] |
| 577 | result.append('\\"') |
| 578 | else: |
| 579 | # Normal char |
| 580 | if bs_buf: |
| 581 | result.extend(bs_buf) |
| 582 | bs_buf = [] |
| 583 | result.append(c) |
| 584 | |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 585 | # Add remaining backslashes, if any. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 586 | if bs_buf: |
| 587 | result.extend(bs_buf) |
| 588 | |
| 589 | if needquote: |
Peter Astrand | 7e78ade | 2005-03-03 21:10:23 +0000 | [diff] [blame] | 590 | result.extend(bs_buf) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 591 | result.append('"') |
| 592 | |
| 593 | return ''.join(result) |
| 594 | |
| 595 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 596 | # Various tools for executing commands and looking at their output and status. |
| 597 | # |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 598 | # NB This only works (and is only relevant) for POSIX. |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 599 | |
| 600 | def getstatusoutput(cmd): |
| 601 | """Return (status, output) of executing cmd in a shell. |
| 602 | |
| 603 | Execute the string 'cmd' in a shell with os.popen() and return a 2-tuple |
| 604 | (status, output). cmd is actually run as '{ cmd ; } 2>&1', so that the |
| 605 | returned output will contain output or error messages. A trailing newline |
| 606 | is stripped from the output. The exit status for the command can be |
| 607 | interpreted according to the rules for the C function wait(). Example: |
| 608 | |
| 609 | >>> import subprocess |
| 610 | >>> subprocess.getstatusoutput('ls /bin/ls') |
| 611 | (0, '/bin/ls') |
| 612 | >>> subprocess.getstatusoutput('cat /bin/junk') |
| 613 | (256, 'cat: /bin/junk: No such file or directory') |
| 614 | >>> subprocess.getstatusoutput('/bin/junk') |
| 615 | (256, 'sh: /bin/junk: not found') |
| 616 | """ |
| 617 | pipe = os.popen('{ ' + cmd + '; } 2>&1', 'r') |
| 618 | text = pipe.read() |
| 619 | sts = pipe.close() |
| 620 | if sts is None: sts = 0 |
| 621 | if text[-1:] == '\n': text = text[:-1] |
| 622 | return sts, text |
| 623 | |
| 624 | |
| 625 | def getoutput(cmd): |
| 626 | """Return output (stdout or stderr) of executing cmd in a shell. |
| 627 | |
| 628 | Like getstatusoutput(), except the exit status is ignored and the return |
| 629 | value is a string containing the command's output. Example: |
| 630 | |
| 631 | >>> import subprocess |
| 632 | >>> subprocess.getoutput('ls /bin/ls') |
| 633 | '/bin/ls' |
| 634 | """ |
| 635 | return getstatusoutput(cmd)[1] |
| 636 | |
| 637 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 638 | _PLATFORM_DEFAULT_CLOSE_FDS = object() |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 639 | |
| 640 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 641 | class Popen(object): |
| 642 | def __init__(self, args, bufsize=0, executable=None, |
| 643 | stdin=None, stdout=None, stderr=None, |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 644 | preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS, |
| 645 | shell=False, cwd=None, env=None, universal_newlines=False, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 646 | startupinfo=None, creationflags=0, |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 647 | restore_signals=True, start_new_session=False, |
| 648 | pass_fds=()): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 649 | """Create new Popen instance.""" |
| 650 | _cleanup() |
| 651 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 652 | self._child_created = False |
Guido van Rossum | 46a05a7 | 2007-06-07 21:56:45 +0000 | [diff] [blame] | 653 | if bufsize is None: |
| 654 | bufsize = 0 # Restore default |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 655 | if not isinstance(bufsize, int): |
Peter Astrand | 738131d | 2004-11-30 21:04:45 +0000 | [diff] [blame] | 656 | raise TypeError("bufsize must be an integer") |
| 657 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 658 | if mswindows: |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 659 | if preexec_fn is not None: |
| 660 | raise ValueError("preexec_fn is not supported on Windows " |
| 661 | "platforms") |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 662 | any_stdio_set = (stdin is not None or stdout is not None or |
| 663 | stderr is not None) |
| 664 | if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS: |
| 665 | if any_stdio_set: |
| 666 | close_fds = False |
| 667 | else: |
| 668 | close_fds = True |
| 669 | elif close_fds and any_stdio_set: |
| 670 | raise ValueError( |
| 671 | "close_fds is not supported on Windows platforms" |
| 672 | " if you redirect stdin/stdout/stderr") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 673 | else: |
| 674 | # POSIX |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 675 | if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS: |
| 676 | close_fds = True |
| 677 | if pass_fds and not close_fds: |
| 678 | warnings.warn("pass_fds overriding close_fds.", RuntimeWarning) |
| 679 | close_fds = True |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 680 | if startupinfo is not None: |
| 681 | raise ValueError("startupinfo is only supported on Windows " |
| 682 | "platforms") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 683 | if creationflags != 0: |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 684 | raise ValueError("creationflags is only supported on Windows " |
| 685 | "platforms") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 686 | |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 687 | self.stdin = None |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 688 | self.stdout = None |
| 689 | self.stderr = None |
| 690 | self.pid = None |
| 691 | self.returncode = None |
| 692 | self.universal_newlines = universal_newlines |
| 693 | |
| 694 | # Input and output objects. The general principle is like |
| 695 | # this: |
| 696 | # |
| 697 | # Parent Child |
| 698 | # ------ ----- |
| 699 | # p2cwrite ---stdin---> p2cread |
| 700 | # c2pread <--stdout--- c2pwrite |
| 701 | # errread <--stderr--- errwrite |
| 702 | # |
| 703 | # On POSIX, the child objects are file descriptors. On |
| 704 | # Windows, these are Windows file handles. The parent objects |
| 705 | # are file descriptors on both platforms. The parent objects |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 706 | # are -1 when not using PIPEs. The child objects are -1 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 707 | # when not redirecting. |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 708 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 709 | (p2cread, p2cwrite, |
| 710 | c2pread, c2pwrite, |
| 711 | errread, errwrite) = self._get_handles(stdin, stdout, stderr) |
| 712 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 713 | # We wrap OS handles *before* launching the child, otherwise a |
| 714 | # quickly terminating child could make our fds unwrappable |
| 715 | # (see #8458). |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 716 | |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 717 | if mswindows: |
Florent Xicluna | 3b8bfef | 2010-03-14 12:31:06 +0000 | [diff] [blame] | 718 | if p2cwrite != -1: |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 719 | p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0) |
Florent Xicluna | 3b8bfef | 2010-03-14 12:31:06 +0000 | [diff] [blame] | 720 | if c2pread != -1: |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 721 | c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0) |
Florent Xicluna | 3b8bfef | 2010-03-14 12:31:06 +0000 | [diff] [blame] | 722 | if errread != -1: |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 723 | errread = msvcrt.open_osfhandle(errread.Detach(), 0) |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 724 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 725 | if p2cwrite != -1: |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 726 | self.stdin = io.open(p2cwrite, 'wb', bufsize) |
| 727 | if self.universal_newlines: |
Antoine Pitrou | ab85ff3 | 2011-07-23 22:03:45 +0200 | [diff] [blame] | 728 | self.stdin = io.TextIOWrapper(self.stdin, write_through=True) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 729 | if c2pread != -1: |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 730 | self.stdout = io.open(c2pread, 'rb', bufsize) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 731 | if universal_newlines: |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 732 | self.stdout = io.TextIOWrapper(self.stdout) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 733 | if errread != -1: |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 734 | self.stderr = io.open(errread, 'rb', bufsize) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 735 | if universal_newlines: |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 736 | self.stderr = io.TextIOWrapper(self.stderr) |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 737 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 738 | try: |
| 739 | self._execute_child(args, executable, preexec_fn, close_fds, |
| 740 | pass_fds, cwd, env, universal_newlines, |
| 741 | startupinfo, creationflags, shell, |
| 742 | p2cread, p2cwrite, |
| 743 | c2pread, c2pwrite, |
| 744 | errread, errwrite, |
| 745 | restore_signals, start_new_session) |
| 746 | except: |
Gregory P. Smith | 3d8e776 | 2012-11-10 22:32:22 -0800 | [diff] [blame] | 747 | # Cleanup if the child failed starting. |
| 748 | for f in filter(None, (self.stdin, self.stdout, self.stderr)): |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 749 | try: |
| 750 | f.close() |
| 751 | except EnvironmentError: |
Gregory P. Smith | 3d8e776 | 2012-11-10 22:32:22 -0800 | [diff] [blame] | 752 | pass # Ignore EBADF or other errors. |
| 753 | |
| 754 | # Make sure the child pipes are closed as well. |
| 755 | to_close = [] |
| 756 | if stdin == PIPE: |
| 757 | to_close.append(p2cread) |
| 758 | if stdout == PIPE: |
| 759 | to_close.append(c2pwrite) |
| 760 | if stderr == PIPE: |
| 761 | to_close.append(errwrite) |
| 762 | for fd in to_close: |
| 763 | try: |
| 764 | os.close(fd) |
| 765 | except EnvironmentError: |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 766 | pass |
Gregory P. Smith | 3d8e776 | 2012-11-10 22:32:22 -0800 | [diff] [blame] | 767 | |
Antoine Pitrou | c998232 | 2011-01-04 19:07:07 +0000 | [diff] [blame] | 768 | raise |
| 769 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 770 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 771 | def _translate_newlines(self, data, encoding): |
Andrew Svetlov | 8286071 | 2012-08-19 22:13:41 +0300 | [diff] [blame] | 772 | data = data.decode(encoding) |
| 773 | return data.replace("\r\n", "\n").replace("\r", "\n") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 774 | |
Brian Curtin | 79cdb66 | 2010-12-03 02:46:02 +0000 | [diff] [blame] | 775 | def __enter__(self): |
| 776 | return self |
| 777 | |
| 778 | def __exit__(self, type, value, traceback): |
| 779 | if self.stdout: |
| 780 | self.stdout.close() |
| 781 | if self.stderr: |
| 782 | self.stderr.close() |
| 783 | if self.stdin: |
| 784 | self.stdin.close() |
Gregory P. Smith | c9557af | 2011-05-11 22:18:23 -0700 | [diff] [blame] | 785 | # Wait for the process to terminate, to avoid zombies. |
| 786 | self.wait() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 787 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 788 | def __del__(self, _maxsize=sys.maxsize, _active=_active): |
Victor Stinner | 87b9bc3 | 2011-06-01 00:57:47 +0200 | [diff] [blame] | 789 | # If __init__ hasn't had a chance to execute (e.g. if it |
| 790 | # was passed an undeclared keyword argument), we don't |
| 791 | # have a _child_created attribute at all. |
| 792 | if not getattr(self, '_child_created', False): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 793 | # We didn't get to successfully create a child process. |
| 794 | return |
| 795 | # In case the child hasn't been waited on, check if it's done. |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 796 | self._internal_poll(_deadstate=_maxsize) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 797 | if self.returncode is None and _active is not None: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 798 | # Child is still running, keep us alive until we can wait on it. |
| 799 | _active.append(self) |
| 800 | |
| 801 | |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 802 | def communicate(self, input=None): |
| 803 | """Interact with process: Send data to stdin. Read data from |
| 804 | stdout and stderr, until end-of-file is reached. Wait for |
| 805 | process to terminate. The optional input argument should be a |
| 806 | string to be sent to the child process, or None, if no data |
| 807 | should be sent to the child. |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 808 | |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 809 | communicate() returns a tuple (stdout, stderr).""" |
| 810 | |
| 811 | # Optimization: If we are only using one pipe, or no pipe at |
| 812 | # all, using select() or threads is unnecessary. |
| 813 | if [self.stdin, self.stdout, self.stderr].count(None) >= 2: |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 814 | stdout = None |
| 815 | stderr = None |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 816 | if self.stdin: |
| 817 | if input: |
Ross Lagerwall | 4f61b02 | 2011-04-05 15:34:00 +0200 | [diff] [blame] | 818 | try: |
| 819 | self.stdin.write(input) |
| 820 | except IOError as e: |
| 821 | if e.errno != errno.EPIPE and e.errno != errno.EINVAL: |
| 822 | raise |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 823 | self.stdin.close() |
| 824 | elif self.stdout: |
Victor Stinner | 2cfb6f3 | 2011-07-05 14:00:56 +0200 | [diff] [blame] | 825 | stdout = _eintr_retry_call(self.stdout.read) |
Georg Brandl | f08a9dd | 2008-06-10 16:57:31 +0000 | [diff] [blame] | 826 | self.stdout.close() |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 827 | elif self.stderr: |
Victor Stinner | 2cfb6f3 | 2011-07-05 14:00:56 +0200 | [diff] [blame] | 828 | stderr = _eintr_retry_call(self.stderr.read) |
Georg Brandl | f08a9dd | 2008-06-10 16:57:31 +0000 | [diff] [blame] | 829 | self.stderr.close() |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 830 | self.wait() |
| 831 | return (stdout, stderr) |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 832 | |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 833 | return self._communicate(input) |
| 834 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 835 | |
Georg Brandl | 6aa2d1f | 2008-08-12 08:35:52 +0000 | [diff] [blame] | 836 | def poll(self): |
| 837 | return self._internal_poll() |
| 838 | |
| 839 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 840 | if mswindows: |
| 841 | # |
| 842 | # Windows methods |
| 843 | # |
| 844 | def _get_handles(self, stdin, stdout, stderr): |
Alexandre Vassalotti | 711ed4a | 2009-07-17 10:42:05 +0000 | [diff] [blame] | 845 | """Construct and return tuple with IO objects: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 846 | p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite |
| 847 | """ |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 848 | if stdin is None and stdout is None and stderr is None: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 849 | return (-1, -1, -1, -1, -1, -1) |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 850 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 851 | p2cread, p2cwrite = -1, -1 |
| 852 | c2pread, c2pwrite = -1, -1 |
| 853 | errread, errwrite = -1, -1 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 854 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 855 | if stdin is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 856 | p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 857 | if p2cread is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 858 | p2cread, _ = _subprocess.CreatePipe(None, 0) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 859 | elif stdin == PIPE: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 860 | p2cread, p2cwrite = _subprocess.CreatePipe(None, 0) |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 861 | elif isinstance(stdin, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 862 | p2cread = msvcrt.get_osfhandle(stdin) |
| 863 | else: |
| 864 | # Assuming file-like object |
| 865 | p2cread = msvcrt.get_osfhandle(stdin.fileno()) |
| 866 | p2cread = self._make_inheritable(p2cread) |
| 867 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 868 | if stdout is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 869 | c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 870 | if c2pwrite is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 871 | _, c2pwrite = _subprocess.CreatePipe(None, 0) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 872 | elif stdout == PIPE: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 873 | c2pread, c2pwrite = _subprocess.CreatePipe(None, 0) |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 874 | elif isinstance(stdout, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 875 | c2pwrite = msvcrt.get_osfhandle(stdout) |
| 876 | else: |
| 877 | # Assuming file-like object |
| 878 | c2pwrite = msvcrt.get_osfhandle(stdout.fileno()) |
| 879 | c2pwrite = self._make_inheritable(c2pwrite) |
| 880 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 881 | if stderr is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 882 | errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 883 | if errwrite is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 884 | _, errwrite = _subprocess.CreatePipe(None, 0) |
Hirokazu Yamamoto | 0c98817 | 2009-03-03 22:41:26 +0000 | [diff] [blame] | 885 | elif stderr == PIPE: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 886 | errread, errwrite = _subprocess.CreatePipe(None, 0) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 887 | elif stderr == STDOUT: |
| 888 | errwrite = c2pwrite |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 889 | elif isinstance(stderr, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 890 | errwrite = msvcrt.get_osfhandle(stderr) |
| 891 | else: |
| 892 | # Assuming file-like object |
| 893 | errwrite = msvcrt.get_osfhandle(stderr.fileno()) |
| 894 | errwrite = self._make_inheritable(errwrite) |
| 895 | |
| 896 | return (p2cread, p2cwrite, |
| 897 | c2pread, c2pwrite, |
| 898 | errread, errwrite) |
| 899 | |
| 900 | |
| 901 | def _make_inheritable(self, handle): |
| 902 | """Return a duplicate of handle, which is inheritable""" |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 903 | return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(), |
| 904 | handle, _subprocess.GetCurrentProcess(), 0, 1, |
| 905 | _subprocess.DUPLICATE_SAME_ACCESS) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 906 | |
| 907 | |
| 908 | def _find_w9xpopen(self): |
| 909 | """Find and return absolut path to w9xpopen.exe""" |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 910 | w9xpopen = os.path.join( |
| 911 | os.path.dirname(_subprocess.GetModuleFileName(0)), |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 912 | "w9xpopen.exe") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 913 | if not os.path.exists(w9xpopen): |
| 914 | # Eeek - file-not-found - possibly an embedding |
| 915 | # situation - see if we can locate it in sys.exec_prefix |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 916 | w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix), |
| 917 | "w9xpopen.exe") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 918 | if not os.path.exists(w9xpopen): |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 919 | raise RuntimeError("Cannot locate w9xpopen.exe, which is " |
| 920 | "needed for Popen to work with your " |
| 921 | "shell or platform.") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 922 | return w9xpopen |
| 923 | |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 924 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 925 | def _execute_child(self, args, executable, preexec_fn, close_fds, |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 926 | pass_fds, cwd, env, universal_newlines, |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 927 | startupinfo, creationflags, shell, |
| 928 | p2cread, p2cwrite, |
| 929 | c2pread, c2pwrite, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 930 | errread, errwrite, |
| 931 | unused_restore_signals, unused_start_new_session): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 932 | """Execute program (MS Windows version)""" |
| 933 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 934 | assert not pass_fds, "pass_fds not supported on Windows." |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 935 | |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 936 | if not isinstance(args, str): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 937 | args = list2cmdline(args) |
| 938 | |
Peter Astrand | c1d6536 | 2004-11-07 14:30:34 +0000 | [diff] [blame] | 939 | # Process startup details |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 940 | if startupinfo is None: |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 941 | startupinfo = STARTUPINFO() |
Victor Stinner | b369358 | 2010-05-21 20:13:12 +0000 | [diff] [blame] | 942 | if -1 not in (p2cread, c2pwrite, errwrite): |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 943 | startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES |
Peter Astrand | c1d6536 | 2004-11-07 14:30:34 +0000 | [diff] [blame] | 944 | startupinfo.hStdInput = p2cread |
| 945 | startupinfo.hStdOutput = c2pwrite |
| 946 | startupinfo.hStdError = errwrite |
| 947 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 948 | if shell: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 949 | startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW |
| 950 | startupinfo.wShowWindow = _subprocess.SW_HIDE |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 951 | comspec = os.environ.get("COMSPEC", "cmd.exe") |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 952 | args = '{} /c "{}"'.format (comspec, args) |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 953 | if (_subprocess.GetVersion() >= 0x80000000 or |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 954 | os.path.basename(comspec).lower() == "command.com"): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 955 | # Win9x, or using command.com on NT. We need to |
| 956 | # use the w9xpopen intermediate program. For more |
| 957 | # information, see KB Q150956 |
| 958 | # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp) |
| 959 | w9xpopen = self._find_w9xpopen() |
| 960 | args = '"%s" %s' % (w9xpopen, args) |
| 961 | # Not passing CREATE_NEW_CONSOLE has been known to |
| 962 | # cause random failures on win9x. Specifically a |
| 963 | # dialog: "Your program accessed mem currently in |
| 964 | # use at xxx" and a hopeful warning about the |
Mark Dickinson | 934896d | 2009-02-21 20:59:32 +0000 | [diff] [blame] | 965 | # stability of your system. Cost is Ctrl+C won't |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 966 | # kill children. |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 967 | creationflags |= _subprocess.CREATE_NEW_CONSOLE |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 968 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 969 | # Start the process |
| 970 | try: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 971 | hp, ht, pid, tid = _subprocess.CreateProcess(executable, args, |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 972 | # no special security |
| 973 | None, None, |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 974 | int(not close_fds), |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 975 | creationflags, |
| 976 | env, |
| 977 | cwd, |
| 978 | startupinfo) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 979 | except pywintypes.error as e: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 980 | # Translate pywintypes.error to WindowsError, which is |
| 981 | # a subclass of OSError. FIXME: We should really |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 982 | # translate errno using _sys_errlist (or similar), but |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 983 | # how can this be done from Python? |
| 984 | raise WindowsError(*e.args) |
Tim Golden | ad537f2 | 2010-08-08 11:18:16 +0000 | [diff] [blame] | 985 | finally: |
| 986 | # Child is launched. Close the parent's copy of those pipe |
| 987 | # handles that only the child should have open. You need |
| 988 | # to make sure that no handles to the write end of the |
| 989 | # output pipe are maintained in this process or else the |
| 990 | # pipe will not close when the child process exits and the |
| 991 | # ReadFile will hang. |
| 992 | if p2cread != -1: |
| 993 | p2cread.Close() |
| 994 | if c2pwrite != -1: |
| 995 | c2pwrite.Close() |
| 996 | if errwrite != -1: |
| 997 | errwrite.Close() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 998 | |
| 999 | # Retain the process handle, but close the thread handle |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1000 | self._child_created = True |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1001 | self._handle = hp |
| 1002 | self.pid = pid |
| 1003 | ht.Close() |
| 1004 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1005 | def _internal_poll(self, _deadstate=None, |
Victor Stinner | c807a61 | 2010-05-14 21:53:45 +0000 | [diff] [blame] | 1006 | _WaitForSingleObject=_subprocess.WaitForSingleObject, |
| 1007 | _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0, |
| 1008 | _GetExitCodeProcess=_subprocess.GetExitCodeProcess): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1009 | """Check if child process has terminated. Returns returncode |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1010 | attribute. |
| 1011 | |
| 1012 | This method is called by __del__, so it can only refer to objects |
| 1013 | in its local scope. |
| 1014 | |
| 1015 | """ |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1016 | if self.returncode is None: |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1017 | if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0: |
| 1018 | self.returncode = _GetExitCodeProcess(self._handle) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1019 | return self.returncode |
| 1020 | |
| 1021 | |
| 1022 | def wait(self): |
| 1023 | """Wait for child process to terminate. Returns returncode |
| 1024 | attribute.""" |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1025 | if self.returncode is None: |
Brian Curtin | 1ce6b58 | 2010-04-24 16:19:22 +0000 | [diff] [blame] | 1026 | _subprocess.WaitForSingleObject(self._handle, |
| 1027 | _subprocess.INFINITE) |
| 1028 | self.returncode = _subprocess.GetExitCodeProcess(self._handle) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1029 | return self.returncode |
| 1030 | |
| 1031 | |
| 1032 | def _readerthread(self, fh, buffer): |
| 1033 | buffer.append(fh.read()) |
Victor Stinner | 667d4b5 | 2010-12-25 22:40:32 +0000 | [diff] [blame] | 1034 | fh.close() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1035 | |
| 1036 | |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 1037 | def _communicate(self, input): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1038 | stdout = None # Return |
| 1039 | stderr = None # Return |
| 1040 | |
| 1041 | if self.stdout: |
| 1042 | stdout = [] |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 1043 | stdout_thread = threading.Thread(target=self._readerthread, |
| 1044 | args=(self.stdout, stdout)) |
Benjamin Peterson | 632e036 | 2008-08-18 19:08:51 +0000 | [diff] [blame] | 1045 | stdout_thread.daemon = True |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1046 | stdout_thread.start() |
| 1047 | if self.stderr: |
| 1048 | stderr = [] |
Tim Peters | e8374a5 | 2004-10-13 03:15:00 +0000 | [diff] [blame] | 1049 | stderr_thread = threading.Thread(target=self._readerthread, |
| 1050 | args=(self.stderr, stderr)) |
Benjamin Peterson | 632e036 | 2008-08-18 19:08:51 +0000 | [diff] [blame] | 1051 | stderr_thread.daemon = True |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1052 | stderr_thread.start() |
| 1053 | |
| 1054 | if self.stdin: |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1055 | if input is not None: |
Ross Lagerwall | 4f61b02 | 2011-04-05 15:34:00 +0200 | [diff] [blame] | 1056 | try: |
| 1057 | self.stdin.write(input) |
| 1058 | except IOError as e: |
| 1059 | if e.errno != errno.EPIPE: |
| 1060 | raise |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1061 | self.stdin.close() |
| 1062 | |
| 1063 | if self.stdout: |
| 1064 | stdout_thread.join() |
| 1065 | if self.stderr: |
| 1066 | stderr_thread.join() |
| 1067 | |
| 1068 | # All data exchanged. Translate lists into strings. |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1069 | if stdout is not None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1070 | stdout = stdout[0] |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1071 | if stderr is not None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1072 | stderr = stderr[0] |
| 1073 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1074 | self.wait() |
| 1075 | return (stdout, stderr) |
| 1076 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1077 | def send_signal(self, sig): |
| 1078 | """Send a signal to the process |
| 1079 | """ |
| 1080 | if sig == signal.SIGTERM: |
| 1081 | self.terminate() |
Brian Curtin | eb24d74 | 2010-04-12 17:16:38 +0000 | [diff] [blame] | 1082 | elif sig == signal.CTRL_C_EVENT: |
| 1083 | os.kill(self.pid, signal.CTRL_C_EVENT) |
| 1084 | elif sig == signal.CTRL_BREAK_EVENT: |
| 1085 | os.kill(self.pid, signal.CTRL_BREAK_EVENT) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1086 | else: |
Brian Curtin | 1965136 | 2010-09-07 13:24:38 +0000 | [diff] [blame] | 1087 | raise ValueError("Unsupported signal: {}".format(sig)) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1088 | |
| 1089 | def terminate(self): |
| 1090 | """Terminates the process |
| 1091 | """ |
Antoine Pitrou | 1f9a835 | 2012-03-11 19:29:12 +0100 | [diff] [blame] | 1092 | try: |
| 1093 | _subprocess.TerminateProcess(self._handle, 1) |
| 1094 | except OSError as e: |
| 1095 | # ERROR_ACCESS_DENIED (winerror 5) is received when the |
| 1096 | # process already died. |
| 1097 | if e.winerror != 5: |
| 1098 | raise |
| 1099 | rc = _subprocess.GetExitCodeProcess(self._handle) |
| 1100 | if rc == _subprocess.STILL_ACTIVE: |
| 1101 | raise |
| 1102 | self.returncode = rc |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1103 | |
| 1104 | kill = terminate |
| 1105 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1106 | else: |
| 1107 | # |
| 1108 | # POSIX methods |
| 1109 | # |
| 1110 | def _get_handles(self, stdin, stdout, stderr): |
Alexandre Vassalotti | 711ed4a | 2009-07-17 10:42:05 +0000 | [diff] [blame] | 1111 | """Construct and return tuple with IO objects: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1112 | p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite |
| 1113 | """ |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1114 | p2cread, p2cwrite = -1, -1 |
| 1115 | c2pread, c2pwrite = -1, -1 |
| 1116 | errread, errwrite = -1, -1 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1117 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1118 | if stdin is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1119 | pass |
| 1120 | elif stdin == PIPE: |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 1121 | p2cread, p2cwrite = _create_pipe() |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1122 | elif isinstance(stdin, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1123 | p2cread = stdin |
| 1124 | else: |
| 1125 | # Assuming file-like object |
| 1126 | p2cread = stdin.fileno() |
| 1127 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1128 | if stdout is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1129 | pass |
| 1130 | elif stdout == PIPE: |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 1131 | c2pread, c2pwrite = _create_pipe() |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1132 | elif isinstance(stdout, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1133 | c2pwrite = stdout |
| 1134 | else: |
| 1135 | # Assuming file-like object |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 1136 | c2pwrite = stdout.fileno() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1137 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1138 | if stderr is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1139 | pass |
| 1140 | elif stderr == PIPE: |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 1141 | errread, errwrite = _create_pipe() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1142 | elif stderr == STDOUT: |
| 1143 | errwrite = c2pwrite |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1144 | elif isinstance(stderr, int): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1145 | errwrite = stderr |
| 1146 | else: |
| 1147 | # Assuming file-like object |
| 1148 | errwrite = stderr.fileno() |
| 1149 | |
| 1150 | return (p2cread, p2cwrite, |
| 1151 | c2pread, c2pwrite, |
| 1152 | errread, errwrite) |
| 1153 | |
| 1154 | |
Antoine Pitrou | 47f14ba | 2011-01-03 23:42:01 +0000 | [diff] [blame] | 1155 | def _close_fds(self, fds_to_keep): |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 1156 | start_fd = 3 |
Antoine Pitrou | 47f14ba | 2011-01-03 23:42:01 +0000 | [diff] [blame] | 1157 | for fd in sorted(fds_to_keep): |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 1158 | if fd >= start_fd: |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 1159 | os.closerange(start_fd, fd) |
| 1160 | start_fd = fd + 1 |
| 1161 | if start_fd <= MAXFD: |
| 1162 | os.closerange(start_fd, MAXFD) |
| 1163 | |
| 1164 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1165 | def _execute_child(self, args, executable, preexec_fn, close_fds, |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 1166 | pass_fds, cwd, env, universal_newlines, |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1167 | startupinfo, creationflags, shell, |
| 1168 | p2cread, p2cwrite, |
| 1169 | c2pread, c2pwrite, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1170 | errread, errwrite, |
| 1171 | restore_signals, start_new_session): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1172 | """Execute program (POSIX version)""" |
| 1173 | |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 1174 | if isinstance(args, str): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1175 | args = [args] |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 1176 | else: |
| 1177 | args = list(args) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1178 | |
| 1179 | if shell: |
| 1180 | args = ["/bin/sh", "-c"] + args |
Stefan Krah | 9542cc6 | 2010-07-19 14:20:53 +0000 | [diff] [blame] | 1181 | if executable: |
| 1182 | args[0] = executable |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1183 | |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1184 | if executable is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1185 | executable = args[0] |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1186 | orig_executable = executable |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1187 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1188 | # For transferring possible exec failure from child to parent. |
| 1189 | # Data format: "exception name:hex errno:description" |
| 1190 | # Pickle is not used; it is complex and involves memory allocation. |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 1191 | errpipe_read, errpipe_write = _create_pipe() |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 1192 | try: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1193 | try: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1194 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1195 | if _posixsubprocess: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1196 | # We must avoid complex work that could involve |
| 1197 | # malloc or free in the child process to avoid |
| 1198 | # potential deadlocks, thus we do all this here. |
| 1199 | # and pass it to fork_exec() |
| 1200 | |
Victor Stinner | f1512a2 | 2011-06-21 17:18:38 +0200 | [diff] [blame] | 1201 | if env is not None: |
Victor Stinner | 449c466 | 2010-05-08 11:10:09 +0000 | [diff] [blame] | 1202 | env_list = [os.fsencode(k) + b'=' + os.fsencode(v) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1203 | for k, v in env.items()] |
| 1204 | else: |
| 1205 | env_list = None # Use execv instead of execve. |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 1206 | executable = os.fsencode(executable) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1207 | if os.path.dirname(executable): |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 1208 | executable_list = (executable,) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1209 | else: |
| 1210 | # This matches the behavior of os._execvpe(). |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 1211 | executable_list = tuple( |
| 1212 | os.path.join(os.fsencode(dir), executable) |
| 1213 | for dir in os.get_exec_path(env)) |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 1214 | fds_to_keep = set(pass_fds) |
| 1215 | fds_to_keep.add(errpipe_write) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1216 | self.pid = _posixsubprocess.fork_exec( |
| 1217 | args, executable_list, |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 1218 | close_fds, sorted(fds_to_keep), cwd, env_list, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1219 | p2cread, p2cwrite, c2pread, c2pwrite, |
| 1220 | errread, errwrite, |
| 1221 | errpipe_read, errpipe_write, |
| 1222 | restore_signals, start_new_session, preexec_fn) |
Charles-François Natali | 134a8ba | 2011-08-18 18:49:39 +0200 | [diff] [blame] | 1223 | self._child_created = True |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1224 | else: |
| 1225 | # Pure Python implementation: It is not thread safe. |
| 1226 | # This implementation may deadlock in the child if your |
| 1227 | # parent process has any other threads running. |
| 1228 | |
| 1229 | gc_was_enabled = gc.isenabled() |
| 1230 | # Disable gc to avoid bug where gc -> file_dealloc -> |
| 1231 | # write to stderr -> hang. See issue1336 |
| 1232 | gc.disable() |
| 1233 | try: |
| 1234 | self.pid = os.fork() |
| 1235 | except: |
| 1236 | if gc_was_enabled: |
| 1237 | gc.enable() |
| 1238 | raise |
| 1239 | self._child_created = True |
| 1240 | if self.pid == 0: |
| 1241 | # Child |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1242 | reached_preexec = False |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1243 | try: |
| 1244 | # Close parent's pipe ends |
| 1245 | if p2cwrite != -1: |
| 1246 | os.close(p2cwrite) |
| 1247 | if c2pread != -1: |
| 1248 | os.close(c2pread) |
| 1249 | if errread != -1: |
| 1250 | os.close(errread) |
| 1251 | os.close(errpipe_read) |
| 1252 | |
Ross Lagerwall | d98646e | 2011-07-27 07:16:31 +0200 | [diff] [blame] | 1253 | # When duping fds, if there arises a situation |
| 1254 | # where one of the fds is either 0, 1 or 2, it |
| 1255 | # is possible that it is overwritten (#12607). |
| 1256 | if c2pwrite == 0: |
| 1257 | c2pwrite = os.dup(c2pwrite) |
| 1258 | if errwrite == 0 or errwrite == 1: |
| 1259 | errwrite = os.dup(errwrite) |
| 1260 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1261 | # Dup fds for child |
Antoine Pitrou | c9c83ba | 2011-01-03 18:23:55 +0000 | [diff] [blame] | 1262 | def _dup2(a, b): |
| 1263 | # dup2() removes the CLOEXEC flag but |
| 1264 | # we must do it ourselves if dup2() |
| 1265 | # would be a no-op (issue #10806). |
| 1266 | if a == b: |
| 1267 | _set_cloexec(a, False) |
| 1268 | elif a != -1: |
| 1269 | os.dup2(a, b) |
| 1270 | _dup2(p2cread, 0) |
| 1271 | _dup2(c2pwrite, 1) |
| 1272 | _dup2(errwrite, 2) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1273 | |
| 1274 | # Close pipe fds. Make sure we don't close the |
| 1275 | # same fd more than once, or standard fds. |
Antoine Pitrou | c9c83ba | 2011-01-03 18:23:55 +0000 | [diff] [blame] | 1276 | closed = set() |
| 1277 | for fd in [p2cread, c2pwrite, errwrite]: |
| 1278 | if fd > 2 and fd not in closed: |
| 1279 | os.close(fd) |
| 1280 | closed.add(fd) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1281 | |
| 1282 | # Close all other fds, if asked for |
| 1283 | if close_fds: |
Antoine Pitrou | 47f14ba | 2011-01-03 23:42:01 +0000 | [diff] [blame] | 1284 | fds_to_keep = set(pass_fds) |
| 1285 | fds_to_keep.add(errpipe_write) |
| 1286 | self._close_fds(fds_to_keep) |
Gregory P. Smith | d4cc7bf | 2010-12-04 11:22:11 +0000 | [diff] [blame] | 1287 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1288 | |
| 1289 | if cwd is not None: |
| 1290 | os.chdir(cwd) |
| 1291 | |
| 1292 | # This is a copy of Python/pythonrun.c |
| 1293 | # _Py_RestoreSignals(). If that were exposed |
| 1294 | # as a sys._py_restoresignals func it would be |
| 1295 | # better.. but this pure python implementation |
| 1296 | # isn't likely to be used much anymore. |
| 1297 | if restore_signals: |
| 1298 | signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ') |
| 1299 | for sig in signals: |
| 1300 | if hasattr(signal, sig): |
| 1301 | signal.signal(getattr(signal, sig), |
| 1302 | signal.SIG_DFL) |
| 1303 | |
| 1304 | if start_new_session and hasattr(os, 'setsid'): |
| 1305 | os.setsid() |
| 1306 | |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1307 | reached_preexec = True |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1308 | if preexec_fn: |
| 1309 | preexec_fn() |
| 1310 | |
| 1311 | if env is None: |
| 1312 | os.execvp(executable, args) |
| 1313 | else: |
| 1314 | os.execvpe(executable, args, env) |
| 1315 | |
| 1316 | except: |
| 1317 | try: |
| 1318 | exc_type, exc_value = sys.exc_info()[:2] |
| 1319 | if isinstance(exc_value, OSError): |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1320 | errno_num = exc_value.errno |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1321 | else: |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1322 | errno_num = 0 |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1323 | if not reached_preexec: |
| 1324 | exc_value = "noexec" |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1325 | message = '%s:%x:%s' % (exc_type.__name__, |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1326 | errno_num, exc_value) |
Victor Stinner | 4d07804 | 2010-04-23 19:28:32 +0000 | [diff] [blame] | 1327 | message = message.encode(errors="surrogatepass") |
| 1328 | os.write(errpipe_write, message) |
| 1329 | except Exception: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1330 | # We MUST not allow anything odd happening |
| 1331 | # above to prevent us from exiting below. |
| 1332 | pass |
| 1333 | |
| 1334 | # This exitcode won't be reported to applications |
| 1335 | # so it really doesn't matter what we return. |
| 1336 | os._exit(255) |
| 1337 | |
| 1338 | # Parent |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1339 | if gc_was_enabled: |
| 1340 | gc.enable() |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1341 | finally: |
| 1342 | # be sure the FD is closed no matter what |
| 1343 | os.close(errpipe_write) |
| 1344 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1345 | if p2cread != -1 and p2cwrite != -1: |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1346 | os.close(p2cread) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1347 | if c2pwrite != -1 and c2pread != -1: |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1348 | os.close(c2pwrite) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1349 | if errwrite != -1 and errread != -1: |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1350 | os.close(errwrite) |
| 1351 | |
| 1352 | # Wait for exec to fail or succeed; possibly raising an |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1353 | # exception (limited in size) |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1354 | errpipe_data = bytearray() |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1355 | while True: |
| 1356 | part = _eintr_retry_call(os.read, errpipe_read, 50000) |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1357 | errpipe_data += part |
| 1358 | if not part or len(errpipe_data) > 50000: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1359 | break |
Facundo Batista | 10706e2 | 2009-06-19 20:34:30 +0000 | [diff] [blame] | 1360 | finally: |
| 1361 | # be sure the FD is closed no matter what |
| 1362 | os.close(errpipe_read) |
| 1363 | |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1364 | if errpipe_data: |
Gregory P. Smith | e85db2b | 2010-12-14 14:38:00 +0000 | [diff] [blame] | 1365 | try: |
| 1366 | _eintr_retry_call(os.waitpid, self.pid, 0) |
| 1367 | except OSError as e: |
| 1368 | if e.errno != errno.ECHILD: |
| 1369 | raise |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1370 | try: |
Gregory P. Smith | f44c9da | 2012-11-10 23:33:17 -0800 | [diff] [blame] | 1371 | exception_name, hex_errno, err_msg = ( |
| 1372 | errpipe_data.split(b':', 2)) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1373 | except ValueError: |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1374 | exception_name = b'RuntimeError' |
| 1375 | hex_errno = b'0' |
Gregory P. Smith | 3aee222 | 2012-11-11 00:04:13 -0800 | [diff] [blame] | 1376 | err_msg = (b'Bad exception data from child: ' + |
| 1377 | repr(errpipe_data)) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1378 | child_exception_type = getattr( |
| 1379 | builtins, exception_name.decode('ascii'), |
| 1380 | RuntimeError) |
Victor Stinner | 4d07804 | 2010-04-23 19:28:32 +0000 | [diff] [blame] | 1381 | err_msg = err_msg.decode(errors="surrogatepass") |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1382 | if issubclass(child_exception_type, OSError) and hex_errno: |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1383 | errno_num = int(hex_errno, 16) |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1384 | child_exec_never_called = (err_msg == "noexec") |
| 1385 | if child_exec_never_called: |
| 1386 | err_msg = "" |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1387 | if errno_num != 0: |
| 1388 | err_msg = os.strerror(errno_num) |
| 1389 | if errno_num == errno.ENOENT: |
Gregory P. Smith | 5591b02 | 2012-10-10 03:34:47 -0700 | [diff] [blame] | 1390 | if child_exec_never_called: |
| 1391 | # The error must be from chdir(cwd). |
| 1392 | err_msg += ': ' + repr(cwd) |
| 1393 | else: |
| 1394 | err_msg += ': ' + repr(orig_executable) |
Benjamin Peterson | b8bc439 | 2010-11-20 18:24:54 +0000 | [diff] [blame] | 1395 | raise child_exception_type(errno_num, err_msg) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1396 | raise child_exception_type(err_msg) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1397 | |
| 1398 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1399 | def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED, |
| 1400 | _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED, |
| 1401 | _WEXITSTATUS=os.WEXITSTATUS): |
| 1402 | # This method is called (indirectly) by __del__, so it cannot |
| 1403 | # refer to anything outside of its local scope.""" |
| 1404 | if _WIFSIGNALED(sts): |
| 1405 | self.returncode = -_WTERMSIG(sts) |
| 1406 | elif _WIFEXITED(sts): |
| 1407 | self.returncode = _WEXITSTATUS(sts) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1408 | else: |
| 1409 | # Should never happen |
| 1410 | raise RuntimeError("Unknown child exit status!") |
| 1411 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1412 | |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1413 | def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid, |
| 1414 | _WNOHANG=os.WNOHANG, _os_error=os.error): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1415 | """Check if child process has terminated. Returns returncode |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1416 | attribute. |
| 1417 | |
| 1418 | This method is called by __del__, so it cannot reference anything |
| 1419 | outside of the local scope (nor can any methods it calls). |
| 1420 | |
| 1421 | """ |
Peter Astrand | d38ddf4 | 2005-02-10 08:32:50 +0000 | [diff] [blame] | 1422 | if self.returncode is None: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1423 | try: |
Brett Cannon | 84df1e6 | 2010-05-14 00:33:40 +0000 | [diff] [blame] | 1424 | pid, sts = _waitpid(self.pid, _WNOHANG) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1425 | if pid == self.pid: |
| 1426 | self._handle_exitstatus(sts) |
Gregory P. Smith | 3905171 | 2012-09-29 11:40:38 -0700 | [diff] [blame] | 1427 | except _os_error as e: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1428 | if _deadstate is not None: |
| 1429 | self.returncode = _deadstate |
Gregory P. Smith | 3905171 | 2012-09-29 11:40:38 -0700 | [diff] [blame] | 1430 | elif e.errno == errno.ECHILD: |
| 1431 | # This happens if SIGCLD is set to be ignored or |
| 1432 | # waiting for child processes has otherwise been |
| 1433 | # disabled for our process. This child is dead, we |
| 1434 | # can't get the status. |
| 1435 | # http://bugs.python.org/issue15756 |
| 1436 | self.returncode = 0 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1437 | return self.returncode |
| 1438 | |
| 1439 | |
| 1440 | def wait(self): |
| 1441 | """Wait for child process to terminate. Returns returncode |
| 1442 | attribute.""" |
Gregory P. Smith | 2ec8233 | 2012-11-10 20:52:29 -0800 | [diff] [blame] | 1443 | while self.returncode is None: |
Gregory P. Smith | e85db2b | 2010-12-14 14:38:00 +0000 | [diff] [blame] | 1444 | try: |
| 1445 | pid, sts = _eintr_retry_call(os.waitpid, self.pid, 0) |
| 1446 | except OSError as e: |
| 1447 | if e.errno != errno.ECHILD: |
| 1448 | raise |
| 1449 | # This happens if SIGCLD is set to be ignored or waiting |
| 1450 | # for child processes has otherwise been disabled for our |
| 1451 | # process. This child is dead, we can't get the status. |
Gregory P. Smith | 2ec8233 | 2012-11-10 20:52:29 -0800 | [diff] [blame] | 1452 | pid = self.pid |
Gregory P. Smith | e85db2b | 2010-12-14 14:38:00 +0000 | [diff] [blame] | 1453 | sts = 0 |
Gregory P. Smith | 2ec8233 | 2012-11-10 20:52:29 -0800 | [diff] [blame] | 1454 | # Check the pid and loop as waitpid has been known to return |
| 1455 | # 0 even without WNOHANG in odd situations. issue14396. |
| 1456 | if pid == self.pid: |
| 1457 | self._handle_exitstatus(sts) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1458 | return self.returncode |
| 1459 | |
| 1460 | |
Peter Astrand | 23109f0 | 2005-03-03 20:28:59 +0000 | [diff] [blame] | 1461 | def _communicate(self, input): |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1462 | if self.stdin: |
| 1463 | # Flush stdio buffer. This might block, if the user has |
| 1464 | # been writing to .stdin in an uncontrolled fashion. |
| 1465 | self.stdin.flush() |
| 1466 | if not input: |
| 1467 | self.stdin.close() |
| 1468 | |
| 1469 | if _has_poll: |
| 1470 | stdout, stderr = self._communicate_with_poll(input) |
| 1471 | else: |
| 1472 | stdout, stderr = self._communicate_with_select(input) |
| 1473 | |
| 1474 | # All data exchanged. Translate lists into strings. |
| 1475 | if stdout is not None: |
| 1476 | stdout = b''.join(stdout) |
| 1477 | if stderr is not None: |
| 1478 | stderr = b''.join(stderr) |
| 1479 | |
| 1480 | # Translate newlines, if requested. |
| 1481 | # This also turns bytes into strings. |
| 1482 | if self.universal_newlines: |
| 1483 | if stdout is not None: |
| 1484 | stdout = self._translate_newlines(stdout, |
| 1485 | self.stdout.encoding) |
| 1486 | if stderr is not None: |
| 1487 | stderr = self._translate_newlines(stderr, |
| 1488 | self.stderr.encoding) |
| 1489 | |
| 1490 | self.wait() |
| 1491 | return (stdout, stderr) |
| 1492 | |
| 1493 | |
| 1494 | def _communicate_with_poll(self, input): |
| 1495 | stdout = None # Return |
| 1496 | stderr = None # Return |
| 1497 | fd2file = {} |
| 1498 | fd2output = {} |
| 1499 | |
| 1500 | poller = select.poll() |
| 1501 | def register_and_append(file_obj, eventmask): |
| 1502 | poller.register(file_obj.fileno(), eventmask) |
| 1503 | fd2file[file_obj.fileno()] = file_obj |
| 1504 | |
| 1505 | def close_unregister_and_remove(fd): |
| 1506 | poller.unregister(fd) |
| 1507 | fd2file[fd].close() |
| 1508 | fd2file.pop(fd) |
| 1509 | |
| 1510 | if self.stdin and input: |
| 1511 | register_and_append(self.stdin, select.POLLOUT) |
| 1512 | |
| 1513 | select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI |
| 1514 | if self.stdout: |
| 1515 | register_and_append(self.stdout, select_POLLIN_POLLPRI) |
| 1516 | fd2output[self.stdout.fileno()] = stdout = [] |
| 1517 | if self.stderr: |
| 1518 | register_and_append(self.stderr, select_POLLIN_POLLPRI) |
| 1519 | fd2output[self.stderr.fileno()] = stderr = [] |
| 1520 | |
| 1521 | input_offset = 0 |
| 1522 | while fd2file: |
| 1523 | try: |
| 1524 | ready = poller.poll() |
| 1525 | except select.error as e: |
| 1526 | if e.args[0] == errno.EINTR: |
| 1527 | continue |
| 1528 | raise |
| 1529 | |
| 1530 | # XXX Rewrite these to use non-blocking I/O on the |
| 1531 | # file objects; they are no longer using C stdio! |
| 1532 | |
| 1533 | for fd, mode in ready: |
| 1534 | if mode & select.POLLOUT: |
| 1535 | chunk = input[input_offset : input_offset + _PIPE_BUF] |
Ross Lagerwall | 4f61b02 | 2011-04-05 15:34:00 +0200 | [diff] [blame] | 1536 | try: |
| 1537 | input_offset += os.write(fd, chunk) |
| 1538 | except OSError as e: |
| 1539 | if e.errno == errno.EPIPE: |
| 1540 | close_unregister_and_remove(fd) |
| 1541 | else: |
| 1542 | raise |
| 1543 | else: |
| 1544 | if input_offset >= len(input): |
| 1545 | close_unregister_and_remove(fd) |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1546 | elif mode & select_POLLIN_POLLPRI: |
| 1547 | data = os.read(fd, 4096) |
| 1548 | if not data: |
| 1549 | close_unregister_and_remove(fd) |
| 1550 | fd2output[fd].append(data) |
| 1551 | else: |
| 1552 | # Ignore hang up or errors. |
| 1553 | close_unregister_and_remove(fd) |
| 1554 | |
| 1555 | return (stdout, stderr) |
| 1556 | |
| 1557 | |
| 1558 | def _communicate_with_select(self, input): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1559 | read_set = [] |
| 1560 | write_set = [] |
| 1561 | stdout = None # Return |
| 1562 | stderr = None # Return |
| 1563 | |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1564 | if self.stdin and input: |
| 1565 | write_set.append(self.stdin) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1566 | if self.stdout: |
| 1567 | read_set.append(self.stdout) |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 1568 | stdout = [] |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1569 | if self.stderr: |
| 1570 | read_set.append(self.stderr) |
| 1571 | stderr = [] |
| 1572 | |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 1573 | input_offset = 0 |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1574 | while read_set or write_set: |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 1575 | try: |
| 1576 | rlist, wlist, xlist = select.select(read_set, write_set, []) |
| 1577 | except select.error as e: |
| 1578 | if e.args[0] == errno.EINTR: |
| 1579 | continue |
| 1580 | raise |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1581 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1582 | # XXX Rewrite these to use non-blocking I/O on the |
| 1583 | # file objects; they are no longer using C stdio! |
| 1584 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1585 | if self.stdin in wlist: |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1586 | chunk = input[input_offset : input_offset + _PIPE_BUF] |
Ross Lagerwall | 4f61b02 | 2011-04-05 15:34:00 +0200 | [diff] [blame] | 1587 | try: |
| 1588 | bytes_written = os.write(self.stdin.fileno(), chunk) |
| 1589 | except OSError as e: |
| 1590 | if e.errno == errno.EPIPE: |
| 1591 | self.stdin.close() |
| 1592 | write_set.remove(self.stdin) |
| 1593 | else: |
| 1594 | raise |
| 1595 | else: |
| 1596 | input_offset += bytes_written |
| 1597 | if input_offset >= len(input): |
| 1598 | self.stdin.close() |
| 1599 | write_set.remove(self.stdin) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1600 | |
| 1601 | if self.stdout in rlist: |
| 1602 | data = os.read(self.stdout.fileno(), 1024) |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 1603 | if not data: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1604 | self.stdout.close() |
| 1605 | read_set.remove(self.stdout) |
| 1606 | stdout.append(data) |
| 1607 | |
| 1608 | if self.stderr in rlist: |
| 1609 | data = os.read(self.stderr.fileno(), 1024) |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 1610 | if not data: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1611 | self.stderr.close() |
| 1612 | read_set.remove(self.stderr) |
| 1613 | stderr.append(data) |
| 1614 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1615 | return (stdout, stderr) |
| 1616 | |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1617 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1618 | def send_signal(self, sig): |
| 1619 | """Send a signal to the process |
| 1620 | """ |
| 1621 | os.kill(self.pid, sig) |
| 1622 | |
| 1623 | def terminate(self): |
| 1624 | """Terminate the process with SIGTERM |
| 1625 | """ |
| 1626 | self.send_signal(signal.SIGTERM) |
| 1627 | |
| 1628 | def kill(self): |
| 1629 | """Kill the process with SIGKILL |
| 1630 | """ |
| 1631 | self.send_signal(signal.SIGKILL) |
| 1632 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1633 | |
| 1634 | def _demo_posix(): |
| 1635 | # |
| 1636 | # Example 1: Simple redirection: Get process list |
| 1637 | # |
| 1638 | plist = Popen(["ps"], stdout=PIPE).communicate()[0] |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1639 | print("Process list:") |
| 1640 | print(plist) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1641 | |
| 1642 | # |
| 1643 | # Example 2: Change uid before executing child |
| 1644 | # |
| 1645 | if os.getuid() == 0: |
| 1646 | p = Popen(["id"], preexec_fn=lambda: os.setuid(100)) |
| 1647 | p.wait() |
| 1648 | |
| 1649 | # |
| 1650 | # Example 3: Connecting several subprocesses |
| 1651 | # |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1652 | print("Looking for 'hda'...") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1653 | p1 = Popen(["dmesg"], stdout=PIPE) |
| 1654 | p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1655 | print(repr(p2.communicate()[0])) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1656 | |
| 1657 | # |
| 1658 | # Example 4: Catch execution error |
| 1659 | # |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1660 | print() |
| 1661 | print("Trying a weird file...") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1662 | try: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1663 | print(Popen(["/this/path/does/not/exist"]).communicate()) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 1664 | except OSError as e: |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1665 | if e.errno == errno.ENOENT: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1666 | print("The file didn't exist. I thought so...") |
| 1667 | print("Child traceback:") |
| 1668 | print(e.child_traceback) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1669 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1670 | print("Error", e.errno) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1671 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1672 | print("Gosh. No error.", file=sys.stderr) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1673 | |
| 1674 | |
| 1675 | def _demo_windows(): |
| 1676 | # |
| 1677 | # Example 1: Connecting several subprocesses |
| 1678 | # |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1679 | print("Looking for 'PROMPT' in set output...") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1680 | p1 = Popen("set", stdout=PIPE, shell=True) |
| 1681 | p2 = Popen('find "PROMPT"', stdin=p1.stdout, stdout=PIPE) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1682 | print(repr(p2.communicate()[0])) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1683 | |
| 1684 | # |
| 1685 | # Example 2: Simple execution of program |
| 1686 | # |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1687 | print("Executing calc...") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1688 | p = Popen("calc") |
| 1689 | p.wait() |
| 1690 | |
| 1691 | |
| 1692 | if __name__ == "__main__": |
| 1693 | if mswindows: |
| 1694 | _demo_windows() |
| 1695 | else: |
| 1696 | _demo_posix() |