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