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