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