Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`subprocess` --- Subprocess management |
| 2 | =========================================== |
| 3 | |
| 4 | .. module:: subprocess |
| 5 | :synopsis: Subprocess management. |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 6 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 7 | .. moduleauthor:: Peter Åstrand <astrand@lysator.liu.se> |
| 8 | .. sectionauthor:: Peter Åstrand <astrand@lysator.liu.se> |
| 9 | |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 10 | **Source code:** :source:`Lib/subprocess.py` |
| 11 | |
| 12 | -------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 13 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | The :mod:`subprocess` module allows you to spawn new processes, connect to their |
| 15 | input/output/error pipes, and obtain their return codes. This module intends to |
Benjamin Peterson | 5eea8a7 | 2014-03-12 21:41:35 -0500 | [diff] [blame] | 16 | replace several older modules and functions:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 17 | |
| 18 | os.system |
| 19 | os.spawn* |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 20 | |
| 21 | Information about how the :mod:`subprocess` module can be used to replace these |
| 22 | modules and functions can be found in the following sections. |
| 23 | |
Benjamin Peterson | 4118174 | 2008-07-02 20:22:54 +0000 | [diff] [blame] | 24 | .. seealso:: |
| 25 | |
| 26 | :pep:`324` -- PEP proposing the subprocess module |
| 27 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 28 | |
Ezio Melotti | 402f75d | 2012-11-08 10:07:10 +0200 | [diff] [blame] | 29 | Using the :mod:`subprocess` Module |
| 30 | ---------------------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 31 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 32 | The recommended approach to invoking subprocesses is to use the :func:`run` |
Benjamin Peterson | ef9ffcb | 2015-04-14 22:12:14 -0400 | [diff] [blame] | 33 | function for all use cases it can handle. For more advanced use cases, the |
| 34 | underlying :class:`Popen` interface can be used directly. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 35 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 36 | The :func:`run` function was added in Python 3.5; if you need to retain |
| 37 | compatibility with older versions, see the :ref:`call-function-trio` section. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 38 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 39 | |
| 40 | .. function:: run(args, *, stdin=None, input=None, stdout=None, stderr=None,\ |
Andriy Maletsky | 22d131a | 2018-08-09 23:01:54 +0300 | [diff] [blame] | 41 | capture_output=False, shell=False, cwd=None, timeout=None, \ |
Jakub Stasiak | 7432f09 | 2018-11-12 04:40:42 +0100 | [diff] [blame] | 42 | check=False, encoding=None, errors=None, text=None, env=None, \ |
| 43 | universal_newlines=None) |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 44 | |
| 45 | Run the command described by *args*. Wait for command to complete, then |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 46 | return a :class:`CompletedProcess` instance. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 47 | |
| 48 | The arguments shown above are merely the most common ones, described below |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 49 | in :ref:`frequently-used-arguments` (hence the use of keyword-only notation |
| 50 | in the abbreviated signature). The full function signature is largely the |
Bo Bayles | ce0f33d | 2018-01-30 00:40:39 -0600 | [diff] [blame] | 51 | same as that of the :class:`Popen` constructor - most of the arguments to |
| 52 | this function are passed through to that interface. (*timeout*, *input*, |
| 53 | *check*, and *capture_output* are not.) |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 54 | |
Bo Bayles | ce0f33d | 2018-01-30 00:40:39 -0600 | [diff] [blame] | 55 | If *capture_output* is true, stdout and stderr will be captured. |
| 56 | When used, the internal :class:`Popen` object is automatically created with |
| 57 | ``stdout=PIPE`` and ``stderr=PIPE``. The *stdout* and *stderr* arguments may |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 58 | not be supplied at the same time as *capture_output*. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 59 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 60 | The *timeout* argument is passed to :meth:`Popen.communicate`. If the timeout |
| 61 | expires, the child process will be killed and waited for. The |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 62 | :exc:`TimeoutExpired` exception will be re-raised after the child process |
| 63 | has terminated. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 64 | |
Serhiy Storchaka | fcd9f22 | 2013-04-22 20:20:54 +0300 | [diff] [blame] | 65 | The *input* argument is passed to :meth:`Popen.communicate` and thus to the |
| 66 | subprocess's stdin. If used it must be a byte sequence, or a string if |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 67 | *encoding* or *errors* is specified or *text* is true. When |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 68 | used, the internal :class:`Popen` object is automatically created with |
| 69 | ``stdin=PIPE``, and the *stdin* argument may not be used as well. |
Serhiy Storchaka | fcd9f22 | 2013-04-22 20:20:54 +0300 | [diff] [blame] | 70 | |
Serhiy Storchaka | 4adf01c | 2016-10-19 18:30:05 +0300 | [diff] [blame] | 71 | If *check* is true, and the process exits with a non-zero exit code, a |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 72 | :exc:`CalledProcessError` exception will be raised. Attributes of that |
| 73 | exception hold the arguments, the exit code, and stdout and stderr if they |
| 74 | were captured. |
| 75 | |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 76 | If *encoding* or *errors* are specified, or *text* is true, |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 77 | file objects for stdin, stdout and stderr are opened in text mode using the |
| 78 | specified *encoding* and *errors* or the :class:`io.TextIOWrapper` default. |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 79 | The *universal_newlines* argument is equivalent to *text* and is provided |
| 80 | for backwards compatibility. By default, file objects are opened in binary mode. |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 81 | |
Tobias Kunze | af1ec97 | 2018-06-05 13:41:42 +0200 | [diff] [blame] | 82 | If *env* is not ``None``, it must be a mapping that defines the environment |
| 83 | variables for the new process; these are used instead of the default |
| 84 | behavior of inheriting the current process' environment. It is passed directly |
| 85 | to :class:`Popen`. |
| 86 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 87 | Examples:: |
| 88 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 89 | >>> subprocess.run(["ls", "-l"]) # doesn't capture output |
| 90 | CompletedProcess(args=['ls', '-l'], returncode=0) |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 91 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 92 | >>> subprocess.run("exit 1", shell=True, check=True) |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 93 | Traceback (most recent call last): |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 94 | ... |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 95 | subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1 |
| 96 | |
Bo Bayles | ce0f33d | 2018-01-30 00:40:39 -0600 | [diff] [blame] | 97 | >>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True) |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 98 | CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0, |
Bo Bayles | ce0f33d | 2018-01-30 00:40:39 -0600 | [diff] [blame] | 99 | stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'') |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 100 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 101 | .. versionadded:: 3.5 |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 102 | |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 103 | .. versionchanged:: 3.6 |
| 104 | |
| 105 | Added *encoding* and *errors* parameters |
| 106 | |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 107 | .. versionchanged:: 3.7 |
| 108 | |
Bo Bayles | ce0f33d | 2018-01-30 00:40:39 -0600 | [diff] [blame] | 109 | Added the *text* parameter, as a more understandable alias of *universal_newlines*. |
| 110 | Added the *capture_output* parameter. |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 111 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 112 | .. class:: CompletedProcess |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 113 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 114 | The return value from :func:`run`, representing a process that has finished. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 115 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 116 | .. attribute:: args |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 117 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 118 | The arguments used to launch the process. This may be a list or a string. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 119 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 120 | .. attribute:: returncode |
Serhiy Storchaka | fcd9f22 | 2013-04-22 20:20:54 +0300 | [diff] [blame] | 121 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 122 | Exit status of the child process. Typically, an exit status of 0 indicates |
| 123 | that it ran successfully. |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 124 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 125 | A negative value ``-N`` indicates that the child was terminated by signal |
| 126 | ``N`` (POSIX only). |
| 127 | |
| 128 | .. attribute:: stdout |
| 129 | |
| 130 | Captured stdout from the child process. A bytes sequence, or a string if |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 131 | :func:`run` was called with an encoding, errors, or text=True. |
| 132 | ``None`` if stdout was not captured. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 133 | |
| 134 | If you ran the process with ``stderr=subprocess.STDOUT``, stdout and |
| 135 | stderr will be combined in this attribute, and :attr:`stderr` will be |
Serhiy Storchaka | ecf41da | 2016-10-19 16:29:26 +0300 | [diff] [blame] | 136 | ``None``. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 137 | |
| 138 | .. attribute:: stderr |
| 139 | |
| 140 | Captured stderr from the child process. A bytes sequence, or a string if |
andyclegg | 7fed7bd | 2017-10-23 03:01:19 +0100 | [diff] [blame] | 141 | :func:`run` was called with an encoding, errors, or text=True. |
| 142 | ``None`` if stderr was not captured. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 143 | |
| 144 | .. method:: check_returncode() |
| 145 | |
| 146 | If :attr:`returncode` is non-zero, raise a :exc:`CalledProcessError`. |
| 147 | |
| 148 | .. versionadded:: 3.5 |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 149 | |
| 150 | .. data:: DEVNULL |
| 151 | |
| 152 | Special value that can be used as the *stdin*, *stdout* or *stderr* argument |
| 153 | to :class:`Popen` and indicates that the special file :data:`os.devnull` |
| 154 | will be used. |
| 155 | |
| 156 | .. versionadded:: 3.3 |
| 157 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 158 | |
| 159 | .. data:: PIPE |
| 160 | |
| 161 | Special value that can be used as the *stdin*, *stdout* or *stderr* argument |
| 162 | to :class:`Popen` and indicates that a pipe to the standard stream should be |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 163 | opened. Most useful with :meth:`Popen.communicate`. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 164 | |
| 165 | |
| 166 | .. data:: STDOUT |
| 167 | |
| 168 | Special value that can be used as the *stderr* argument to :class:`Popen` and |
| 169 | indicates that standard error should go into the same handle as standard |
| 170 | output. |
| 171 | |
| 172 | |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 173 | .. exception:: SubprocessError |
| 174 | |
| 175 | Base class for all other exceptions from this module. |
| 176 | |
| 177 | .. versionadded:: 3.3 |
| 178 | |
| 179 | |
| 180 | .. exception:: TimeoutExpired |
| 181 | |
| 182 | Subclass of :exc:`SubprocessError`, raised when a timeout expires |
| 183 | while waiting for a child process. |
| 184 | |
| 185 | .. attribute:: cmd |
| 186 | |
| 187 | Command that was used to spawn the child process. |
| 188 | |
| 189 | .. attribute:: timeout |
| 190 | |
| 191 | Timeout in seconds. |
| 192 | |
| 193 | .. attribute:: output |
| 194 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 195 | Output of the child process if it was captured by :func:`run` or |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 196 | :func:`check_output`. Otherwise, ``None``. |
| 197 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 198 | .. attribute:: stdout |
| 199 | |
| 200 | Alias for output, for symmetry with :attr:`stderr`. |
| 201 | |
| 202 | .. attribute:: stderr |
| 203 | |
| 204 | Stderr output of the child process if it was captured by :func:`run`. |
| 205 | Otherwise, ``None``. |
| 206 | |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 207 | .. versionadded:: 3.3 |
| 208 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 209 | .. versionchanged:: 3.5 |
| 210 | *stdout* and *stderr* attributes added |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 211 | |
| 212 | .. exception:: CalledProcessError |
| 213 | |
| 214 | Subclass of :exc:`SubprocessError`, raised when a process run by |
| 215 | :func:`check_call` or :func:`check_output` returns a non-zero exit status. |
| 216 | |
| 217 | .. attribute:: returncode |
| 218 | |
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) | 583a1d6 | 2016-06-03 00:31:21 +0000 | [diff] [blame] | 219 | Exit status of the child process. If the process exited due to a |
| 220 | signal, this will be the negative signal number. |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 221 | |
| 222 | .. attribute:: cmd |
| 223 | |
| 224 | Command that was used to spawn the child process. |
| 225 | |
| 226 | .. attribute:: output |
| 227 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 228 | Output of the child process if it was captured by :func:`run` or |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 229 | :func:`check_output`. Otherwise, ``None``. |
| 230 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 231 | .. attribute:: stdout |
| 232 | |
| 233 | Alias for output, for symmetry with :attr:`stderr`. |
| 234 | |
| 235 | .. attribute:: stderr |
| 236 | |
| 237 | Stderr output of the child process if it was captured by :func:`run`. |
| 238 | Otherwise, ``None``. |
| 239 | |
| 240 | .. versionchanged:: 3.5 |
| 241 | *stdout* and *stderr* attributes added |
Andrew Svetlov | b4a09ab | 2012-08-09 15:11:45 +0300 | [diff] [blame] | 242 | |
| 243 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 244 | .. _frequently-used-arguments: |
| 245 | |
| 246 | Frequently Used Arguments |
| 247 | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 248 | |
| 249 | To support a wide variety of use cases, the :class:`Popen` constructor (and |
| 250 | the convenience functions) accept a large number of optional arguments. For |
| 251 | most typical use cases, many of these arguments can be safely left at their |
| 252 | default values. The arguments that are most commonly needed are: |
| 253 | |
| 254 | *args* is required for all calls and should be a string, or a sequence of |
| 255 | program arguments. Providing a sequence of arguments is generally |
| 256 | preferred, as it allows the module to take care of any required escaping |
| 257 | and quoting of arguments (e.g. to permit spaces in file names). If passing |
| 258 | a single string, either *shell* must be :const:`True` (see below) or else |
| 259 | the string must simply name the program to be executed without specifying |
| 260 | any arguments. |
| 261 | |
| 262 | *stdin*, *stdout* and *stderr* specify the executed program's standard input, |
| 263 | standard output and standard error file handles, respectively. Valid values |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 264 | are :data:`PIPE`, :data:`DEVNULL`, an existing file descriptor (a positive |
| 265 | integer), an existing file object, and ``None``. :data:`PIPE` indicates |
| 266 | that a new pipe to the child should be created. :data:`DEVNULL` indicates |
| 267 | that the special file :data:`os.devnull` will be used. With the default |
| 268 | settings of ``None``, no redirection will occur; the child's file handles |
| 269 | will be inherited from the parent. Additionally, *stderr* can be |
| 270 | :data:`STDOUT`, which indicates that the stderr data from the child |
| 271 | process should be captured into the same file handle as for *stdout*. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 272 | |
R David Murray | 1b00f25 | 2012-08-15 10:43:58 -0400 | [diff] [blame] | 273 | .. index:: |
| 274 | single: universal newlines; subprocess module |
| 275 | |
Pablo Galindo | e14c010 | 2018-02-11 20:58:23 +0000 | [diff] [blame] | 276 | If *encoding* or *errors* are specified, or *text* (also known as |
| 277 | *universal_newlines*) is true, |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 278 | the file objects *stdin*, *stdout* and *stderr* will be opened in text |
| 279 | mode using the *encoding* and *errors* specified in the call or the |
| 280 | defaults for :class:`io.TextIOWrapper`. |
Ronald Oussoren | 385521c | 2013-07-07 09:26:45 +0200 | [diff] [blame] | 281 | |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 282 | For *stdin*, line ending characters ``'\n'`` in the input will be converted |
| 283 | to the default line separator :data:`os.linesep`. For *stdout* and *stderr*, |
| 284 | all line endings in the output will be converted to ``'\n'``. For more |
| 285 | information see the documentation of the :class:`io.TextIOWrapper` class |
| 286 | when the *newline* argument to its constructor is ``None``. |
| 287 | |
| 288 | If text mode is not used, *stdin*, *stdout* and *stderr* will be opened as |
| 289 | binary streams. No encoding or line ending conversion is performed. |
| 290 | |
| 291 | .. versionadded:: 3.6 |
| 292 | Added *encoding* and *errors* parameters. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 293 | |
Pablo Galindo | e14c010 | 2018-02-11 20:58:23 +0000 | [diff] [blame] | 294 | .. versionadded:: 3.7 |
| 295 | Added the *text* parameter as an alias for *universal_newlines*. |
| 296 | |
Andrew Svetlov | 50be452 | 2012-08-13 22:09:04 +0300 | [diff] [blame] | 297 | .. note:: |
| 298 | |
Gregory P. Smith | 1f8a40b | 2013-03-20 18:32:03 -0700 | [diff] [blame] | 299 | The newlines attribute of the file objects :attr:`Popen.stdin`, |
| 300 | :attr:`Popen.stdout` and :attr:`Popen.stderr` are not updated by |
| 301 | the :meth:`Popen.communicate` method. |
Andrew Svetlov | 50be452 | 2012-08-13 22:09:04 +0300 | [diff] [blame] | 302 | |
| 303 | If *shell* is ``True``, the specified command will be executed through |
Ezio Melotti | 186d523 | 2012-09-15 08:34:08 +0300 | [diff] [blame] | 304 | the shell. This can be useful if you are using Python primarily for the |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 305 | enhanced control flow it offers over most system shells and still want |
Ezio Melotti | 186d523 | 2012-09-15 08:34:08 +0300 | [diff] [blame] | 306 | convenient access to other shell features such as shell pipes, filename |
| 307 | wildcards, environment variable expansion, and expansion of ``~`` to a |
| 308 | user's home directory. However, note that Python itself offers |
| 309 | implementations of many shell-like features (in particular, :mod:`glob`, |
| 310 | :mod:`fnmatch`, :func:`os.walk`, :func:`os.path.expandvars`, |
| 311 | :func:`os.path.expanduser`, and :mod:`shutil`). |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 312 | |
Andrew Svetlov | 4805fa8 | 2012-08-13 22:11:14 +0300 | [diff] [blame] | 313 | .. versionchanged:: 3.3 |
| 314 | When *universal_newlines* is ``True``, the class uses the encoding |
| 315 | :func:`locale.getpreferredencoding(False) <locale.getpreferredencoding>` |
| 316 | instead of ``locale.getpreferredencoding()``. See the |
| 317 | :class:`io.TextIOWrapper` class for more information on this change. |
| 318 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 319 | .. note:: |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 320 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 321 | Read the `Security Considerations`_ section before using ``shell=True``. |
Andrew Svetlov | c2415eb | 2012-10-28 11:42:26 +0200 | [diff] [blame] | 322 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 323 | These options, along with all of the other options, are described in more |
| 324 | detail in the :class:`Popen` constructor documentation. |
| 325 | |
| 326 | |
Sandro Tosi | 1526ad1 | 2011-12-25 11:27:37 +0100 | [diff] [blame] | 327 | Popen Constructor |
Sandro Tosi | 3e6c814 | 2011-12-25 17:14:11 +0100 | [diff] [blame] | 328 | ^^^^^^^^^^^^^^^^^ |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 329 | |
| 330 | The underlying process creation and management in this module is handled by |
| 331 | the :class:`Popen` class. It offers a lot of flexibility so that developers |
| 332 | are able to handle the less common cases not covered by the convenience |
| 333 | functions. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 334 | |
| 335 | |
Gregory P. Smith | a1ed539 | 2013-03-23 11:44:25 -0700 | [diff] [blame] | 336 | .. class:: Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, \ |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 337 | stderr=None, preexec_fn=None, close_fds=True, shell=False, \ |
Jakub Stasiak | 7432f09 | 2018-11-12 04:40:42 +0100 | [diff] [blame] | 338 | cwd=None, env=None, universal_newlines=None, \ |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 339 | startupinfo=None, creationflags=0, restore_signals=True, \ |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 340 | start_new_session=False, pass_fds=(), *, \ |
Pablo Galindo | e14c010 | 2018-02-11 20:58:23 +0000 | [diff] [blame] | 341 | encoding=None, errors=None, text=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 342 | |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 343 | Execute a child program in a new process. On POSIX, the class uses |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 344 | :meth:`os.execvp`-like behavior to execute the child program. On Windows, |
| 345 | the class uses the Windows ``CreateProcess()`` function. The arguments to |
| 346 | :class:`Popen` are as follows. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 347 | |
Serhiy Storchaka | be50a7b | 2018-02-28 01:03:46 +0200 | [diff] [blame] | 348 | *args* should be a sequence of program arguments or else a single string. |
| 349 | By default, the program to execute is the first item in *args* if *args* is |
| 350 | a sequence. If *args* is a string, the interpretation is |
| 351 | platform-dependent and described below. See the *shell* and *executable* |
| 352 | arguments for additional differences from the default behavior. Unless |
| 353 | otherwise stated, it is recommended to pass *args* as a sequence. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 354 | |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 355 | On POSIX, if *args* is a string, the string is interpreted as the name or |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 356 | path of the program to execute. However, this can only be done if not |
| 357 | passing arguments to the program. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 358 | |
R. David Murray | 5973e4d | 2010-02-04 16:41:57 +0000 | [diff] [blame] | 359 | .. note:: |
| 360 | |
| 361 | :meth:`shlex.split` can be useful when determining the correct |
| 362 | tokenization for *args*, especially in complex cases:: |
| 363 | |
| 364 | >>> import shlex, subprocess |
R. David Murray | 73bc75b | 2010-02-05 16:25:12 +0000 | [diff] [blame] | 365 | >>> command_line = input() |
R. David Murray | 5973e4d | 2010-02-04 16:41:57 +0000 | [diff] [blame] | 366 | /bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'" |
| 367 | >>> args = shlex.split(command_line) |
| 368 | >>> print(args) |
| 369 | ['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"] |
| 370 | >>> p = subprocess.Popen(args) # Success! |
| 371 | |
| 372 | Note in particular that options (such as *-input*) and arguments (such |
| 373 | as *eggs.txt*) that are separated by whitespace in the shell go in separate |
| 374 | list elements, while arguments that need quoting or backslash escaping when |
| 375 | used in the shell (such as filenames containing spaces or the *echo* command |
| 376 | shown above) are single list elements. |
| 377 | |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 378 | On Windows, if *args* is a sequence, it will be converted to a string in a |
| 379 | manner described in :ref:`converting-argument-sequence`. This is because |
| 380 | the underlying ``CreateProcess()`` operates on strings. |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 381 | |
Serhiy Storchaka | a97cd2e | 2016-10-19 16:43:42 +0300 | [diff] [blame] | 382 | The *shell* argument (which defaults to ``False``) specifies whether to use |
| 383 | the shell as the program to execute. If *shell* is ``True``, it is |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 384 | recommended to pass *args* as a string rather than as a sequence. |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 385 | |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 386 | On POSIX with ``shell=True``, the shell defaults to :file:`/bin/sh`. If |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 387 | *args* is a string, the string specifies the command |
| 388 | to execute through the shell. This means that the string must be |
R. David Murray | 5973e4d | 2010-02-04 16:41:57 +0000 | [diff] [blame] | 389 | formatted exactly as it would be when typed at the shell prompt. This |
| 390 | includes, for example, quoting or backslash escaping filenames with spaces in |
| 391 | them. If *args* is a sequence, the first item specifies the command string, and |
| 392 | any additional items will be treated as additional arguments to the shell |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 393 | itself. That is to say, :class:`Popen` does the equivalent of:: |
R. David Murray | 5973e4d | 2010-02-04 16:41:57 +0000 | [diff] [blame] | 394 | |
| 395 | Popen(['/bin/sh', '-c', args[0], args[1], ...]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 396 | |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 397 | On Windows with ``shell=True``, the :envvar:`COMSPEC` environment variable |
| 398 | specifies the default shell. The only time you need to specify |
| 399 | ``shell=True`` on Windows is when the command you wish to execute is built |
| 400 | into the shell (e.g. :command:`dir` or :command:`copy`). You do not need |
| 401 | ``shell=True`` to run a batch file or console-based executable. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 402 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 403 | .. note:: |
Chris Jerdonek | cc32a68 | 2012-10-10 22:52:22 -0700 | [diff] [blame] | 404 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 405 | Read the `Security Considerations`_ section before using ``shell=True``. |
Chris Jerdonek | cc32a68 | 2012-10-10 22:52:22 -0700 | [diff] [blame] | 406 | |
Antoine Pitrou | afe8d06 | 2014-09-21 21:10:56 +0200 | [diff] [blame] | 407 | *bufsize* will be supplied as the corresponding argument to the |
| 408 | :func:`open` function when creating the stdin/stdout/stderr pipe |
| 409 | file objects: |
| 410 | |
| 411 | - :const:`0` means unbuffered (read and write are one |
| 412 | system call and can return short) |
| 413 | - :const:`1` means line buffered |
| 414 | (only usable if ``universal_newlines=True`` i.e., in a text mode) |
| 415 | - any other positive value means use a buffer of approximately that |
| 416 | size |
| 417 | - negative bufsize (the default) means the system default of |
| 418 | io.DEFAULT_BUFFER_SIZE will be used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 419 | |
Georg Brandl | 37b70bb | 2013-11-25 08:48:37 +0100 | [diff] [blame] | 420 | .. versionchanged:: 3.3.1 |
Gregory P. Smith | a1ed539 | 2013-03-23 11:44:25 -0700 | [diff] [blame] | 421 | *bufsize* now defaults to -1 to enable buffering by default to match the |
Georg Brandl | 37b70bb | 2013-11-25 08:48:37 +0100 | [diff] [blame] | 422 | behavior that most code expects. In versions prior to Python 3.2.4 and |
| 423 | 3.3.1 it incorrectly defaulted to :const:`0` which was unbuffered |
| 424 | and allowed short reads. This was unintentional and did not match the |
| 425 | behavior of Python 2 as most code expected. |
Antoine Pitrou | 4b87620 | 2010-06-02 17:10:49 +0000 | [diff] [blame] | 426 | |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 427 | The *executable* argument specifies a replacement program to execute. It |
| 428 | is very seldom needed. When ``shell=False``, *executable* replaces the |
Chris Jerdonek | 4a4a02b | 2012-10-10 17:46:18 -0700 | [diff] [blame] | 429 | program to execute specified by *args*. However, the original *args* is |
| 430 | still passed to the program. Most programs treat the program specified |
| 431 | by *args* as the command name, which can then be different from the program |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 432 | actually executed. On POSIX, the *args* name |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 433 | becomes the display name for the executable in utilities such as |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 434 | :program:`ps`. If ``shell=True``, on POSIX the *executable* argument |
Chris Jerdonek | 470ee39 | 2012-10-08 23:06:57 -0700 | [diff] [blame] | 435 | specifies a replacement shell for the default :file:`/bin/sh`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 436 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 437 | *stdin*, *stdout* and *stderr* specify the executed program's standard input, |
Georg Brandl | af265f4 | 2008-12-07 15:06:20 +0000 | [diff] [blame] | 438 | standard output and standard error file handles, respectively. Valid values |
Ross Lagerwall | ba102ec | 2011-03-16 18:40:25 +0200 | [diff] [blame] | 439 | are :data:`PIPE`, :data:`DEVNULL`, an existing file descriptor (a positive |
| 440 | integer), an existing :term:`file object`, and ``None``. :data:`PIPE` |
| 441 | indicates that a new pipe to the child should be created. :data:`DEVNULL` |
Nick Coghlan | 217f05b | 2011-11-08 22:11:21 +1000 | [diff] [blame] | 442 | indicates that the special file :data:`os.devnull` will be used. With the |
| 443 | default settings of ``None``, no redirection will occur; the child's file |
| 444 | handles will be inherited from the parent. Additionally, *stderr* can be |
| 445 | :data:`STDOUT`, which indicates that the stderr data from the applications |
| 446 | should be captured into the same file handle as for stdout. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 447 | |
| 448 | If *preexec_fn* is set to a callable object, this object will be called in the |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 449 | child process just before the child is executed. |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 450 | (POSIX only) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 451 | |
| 452 | .. warning:: |
| 453 | |
| 454 | The *preexec_fn* parameter is not safe to use in the presence of threads |
| 455 | in your application. The child process could deadlock before exec is |
| 456 | called. |
| 457 | If you must use it, keep it trivial! Minimize the number of libraries |
| 458 | you call into. |
| 459 | |
| 460 | .. note:: |
| 461 | |
| 462 | If you need to modify the environment for the child use the *env* |
| 463 | parameter rather than doing it in a *preexec_fn*. |
| 464 | The *start_new_session* parameter can take the place of a previously |
| 465 | common use of *preexec_fn* to call os.setsid() in the child. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 466 | |
| 467 | If *close_fds* is true, all file descriptors except :const:`0`, :const:`1` and |
Gregory P. Smith | dfb6e54 | 2018-03-25 10:27:59 -0700 | [diff] [blame] | 468 | :const:`2` will be closed before the child process is executed. Otherwise |
| 469 | when *close_fds* is false, file descriptors obey their inheritable flag |
| 470 | as described in :ref:`fd_inheritance`. |
| 471 | |
Gregory P. Smith | d23047b | 2010-12-04 09:10:44 +0000 | [diff] [blame] | 472 | On Windows, if *close_fds* is true then no handles will be inherited by the |
Segev Finer | b2a6083 | 2017-12-18 11:28:19 +0200 | [diff] [blame] | 473 | child process unless explicitly passed in the ``handle_list`` element of |
| 474 | :attr:`STARTUPINFO.lpAttributeList`, or by standard handle redirection. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 475 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 476 | .. versionchanged:: 3.2 |
| 477 | The default for *close_fds* was changed from :const:`False` to |
| 478 | what is described above. |
| 479 | |
Segev Finer | b2a6083 | 2017-12-18 11:28:19 +0200 | [diff] [blame] | 480 | .. versionchanged:: 3.7 |
| 481 | On Windows the default for *close_fds* was changed from :const:`False` to |
| 482 | :const:`True` when redirecting the standard handles. It's now possible to |
| 483 | set *close_fds* to :const:`True` when redirecting the standard handles. |
| 484 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 485 | *pass_fds* is an optional sequence of file descriptors to keep open |
| 486 | between the parent and child. Providing any *pass_fds* forces |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 487 | *close_fds* to be :const:`True`. (POSIX only) |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 488 | |
Sergey Fedoseev | f120288 | 2018-07-06 05:01:16 +0500 | [diff] [blame] | 489 | .. versionchanged:: 3.2 |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 490 | The *pass_fds* parameter was added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 491 | |
Chris Jerdonek | ec3ea94 | 2012-09-30 00:10:28 -0700 | [diff] [blame] | 492 | If *cwd* is not ``None``, the function changes the working directory to |
Sayan Chowdhury | d5c11f7 | 2017-02-26 22:36:10 +0530 | [diff] [blame] | 493 | *cwd* before executing the child. *cwd* can be a :class:`str` and |
| 494 | :term:`path-like <path-like object>` object. In particular, the function |
| 495 | looks for *executable* (or for the first item in *args*) relative to *cwd* |
| 496 | if the executable path is a relative path. |
| 497 | |
| 498 | .. versionchanged:: 3.6 |
| 499 | *cwd* parameter accepts a :term:`path-like object`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 500 | |
Serhiy Storchaka | fbc1c26 | 2013-11-29 12:17:13 +0200 | [diff] [blame] | 501 | If *restore_signals* is true (the default) all signals that Python has set to |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 502 | SIG_IGN are restored to SIG_DFL in the child process before the exec. |
| 503 | Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals. |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 504 | (POSIX only) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 505 | |
| 506 | .. versionchanged:: 3.2 |
| 507 | *restore_signals* was added. |
| 508 | |
Serhiy Storchaka | fbc1c26 | 2013-11-29 12:17:13 +0200 | [diff] [blame] | 509 | If *start_new_session* is true the setsid() system call will be made in the |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 510 | child process prior to the execution of the subprocess. (POSIX only) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 511 | |
| 512 | .. versionchanged:: 3.2 |
| 513 | *start_new_session* was added. |
| 514 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 515 | If *env* is not ``None``, it must be a mapping that defines the environment |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 516 | variables for the new process; these are used instead of the default |
| 517 | behavior of inheriting the current process' environment. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 518 | |
R. David Murray | 1055e89 | 2009-04-16 18:15:32 +0000 | [diff] [blame] | 519 | .. note:: |
R. David Murray | f4ac149 | 2009-04-15 22:35:15 +0000 | [diff] [blame] | 520 | |
Georg Brandl | 2708f3a | 2009-12-20 14:38:23 +0000 | [diff] [blame] | 521 | If specified, *env* must provide any variables required for the program to |
| 522 | execute. On Windows, in order to run a `side-by-side assembly`_ the |
| 523 | specified *env* **must** include a valid :envvar:`SystemRoot`. |
R. David Murray | f4ac149 | 2009-04-15 22:35:15 +0000 | [diff] [blame] | 524 | |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 525 | .. _side-by-side assembly: https://en.wikipedia.org/wiki/Side-by-Side_Assembly |
R. David Murray | 1055e89 | 2009-04-16 18:15:32 +0000 | [diff] [blame] | 526 | |
Pablo Galindo | e14c010 | 2018-02-11 20:58:23 +0000 | [diff] [blame] | 527 | If *encoding* or *errors* are specified, or *text* is true, the file objects |
| 528 | *stdin*, *stdout* and *stderr* are opened in text mode with the specified |
| 529 | encoding and *errors*, as described above in :ref:`frequently-used-arguments`. |
| 530 | The *universal_newlines* argument is equivalent to *text* and is provided |
| 531 | for backwards compatibility. By default, file objects are opened in binary mode. |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 532 | |
| 533 | .. versionadded:: 3.6 |
| 534 | *encoding* and *errors* were added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 535 | |
Pablo Galindo | e14c010 | 2018-02-11 20:58:23 +0000 | [diff] [blame] | 536 | .. versionadded:: 3.7 |
| 537 | *text* was added as a more readable alias for *universal_newlines*. |
| 538 | |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 539 | If given, *startupinfo* will be a :class:`STARTUPINFO` object, which is |
| 540 | passed to the underlying ``CreateProcess`` function. |
James | b5d9e08 | 2017-11-08 14:18:59 +0000 | [diff] [blame] | 541 | *creationflags*, if given, can be one or more of the following flags: |
| 542 | |
| 543 | * :data:`CREATE_NEW_CONSOLE` |
| 544 | * :data:`CREATE_NEW_PROCESS_GROUP` |
| 545 | * :data:`ABOVE_NORMAL_PRIORITY_CLASS` |
| 546 | * :data:`BELOW_NORMAL_PRIORITY_CLASS` |
| 547 | * :data:`HIGH_PRIORITY_CLASS` |
| 548 | * :data:`IDLE_PRIORITY_CLASS` |
| 549 | * :data:`NORMAL_PRIORITY_CLASS` |
| 550 | * :data:`REALTIME_PRIORITY_CLASS` |
| 551 | * :data:`CREATE_NO_WINDOW` |
| 552 | * :data:`DETACHED_PROCESS` |
| 553 | * :data:`CREATE_DEFAULT_ERROR_MODE` |
| 554 | * :data:`CREATE_BREAKAWAY_FROM_JOB` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 555 | |
Gregory P. Smith | 6b65745 | 2011-05-11 21:42:08 -0700 | [diff] [blame] | 556 | Popen objects are supported as context managers via the :keyword:`with` statement: |
| 557 | on exit, standard file descriptors are closed, and the process is waited for. |
Brian Curtin | 79cdb66 | 2010-12-03 02:46:02 +0000 | [diff] [blame] | 558 | :: |
| 559 | |
| 560 | with Popen(["ifconfig"], stdout=PIPE) as proc: |
| 561 | log.write(proc.stdout.read()) |
| 562 | |
| 563 | .. versionchanged:: 3.2 |
| 564 | Added context manager support. |
| 565 | |
Victor Stinner | 5a48e21 | 2016-05-20 12:11:15 +0200 | [diff] [blame] | 566 | .. versionchanged:: 3.6 |
| 567 | Popen destructor now emits a :exc:`ResourceWarning` warning if the child |
| 568 | process is still running. |
| 569 | |
Victor Stinner | d7befad | 2019-04-25 14:30:16 +0200 | [diff] [blame^] | 570 | .. versionchanged:: 3.8 |
| 571 | Popen can use :func:`os.posix_spawn` in some cases for better |
| 572 | performance. On Windows Subsystem for Linux and QEMU User Emulation, |
| 573 | Popen constructor using :func:`os.posix_spawn` no longer raise an |
| 574 | exception on errors like missing program, but the child process fails |
| 575 | with a non-zero :attr:`~Popen.returncode`. |
| 576 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 577 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 578 | Exceptions |
| 579 | ^^^^^^^^^^ |
| 580 | |
| 581 | Exceptions raised in the child process, before the new program has started to |
Harmandeep Singh | 47a2fce | 2019-01-04 01:23:56 +0530 | [diff] [blame] | 582 | execute, will be re-raised in the parent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 583 | |
| 584 | The most common exception raised is :exc:`OSError`. This occurs, for example, |
| 585 | when trying to execute a non-existent file. Applications should prepare for |
| 586 | :exc:`OSError` exceptions. |
| 587 | |
| 588 | A :exc:`ValueError` will be raised if :class:`Popen` is called with invalid |
| 589 | arguments. |
| 590 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 591 | :func:`check_call` and :func:`check_output` will raise |
| 592 | :exc:`CalledProcessError` if the called process returns a non-zero return |
| 593 | code. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 594 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 595 | All of the functions and methods that accept a *timeout* parameter, such as |
| 596 | :func:`call` and :meth:`Popen.communicate` will raise :exc:`TimeoutExpired` if |
| 597 | the timeout expires before the process exits. |
| 598 | |
Ronald Oussoren | c157790 | 2011-03-16 10:03:10 -0400 | [diff] [blame] | 599 | Exceptions defined in this module all inherit from :exc:`SubprocessError`. |
Gregory P. Smith | 54d412e | 2011-03-14 14:08:43 -0400 | [diff] [blame] | 600 | |
| 601 | .. versionadded:: 3.3 |
| 602 | The :exc:`SubprocessError` base class was added. |
| 603 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 604 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 605 | Security Considerations |
| 606 | ----------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 607 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 608 | Unlike some other popen functions, this implementation will never |
| 609 | implicitly call a system shell. This means that all characters, |
| 610 | including shell metacharacters, can safely be passed to child processes. |
| 611 | If the shell is invoked explicitly, via ``shell=True``, it is the application's |
| 612 | responsibility to ensure that all whitespace and metacharacters are |
| 613 | quoted appropriately to avoid |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 614 | `shell injection <https://en.wikipedia.org/wiki/Shell_injection#Shell_injection>`_ |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 615 | vulnerabilities. |
| 616 | |
| 617 | When using ``shell=True``, the :func:`shlex.quote` function can be |
| 618 | used to properly escape whitespace and shell metacharacters in strings |
| 619 | that are going to be used to construct shell commands. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 620 | |
| 621 | |
| 622 | Popen Objects |
| 623 | ------------- |
| 624 | |
| 625 | Instances of the :class:`Popen` class have the following methods: |
| 626 | |
| 627 | |
| 628 | .. method:: Popen.poll() |
| 629 | |
Serhiy Storchaka | 9e0ae53 | 2013-08-24 00:23:38 +0300 | [diff] [blame] | 630 | Check if child process has terminated. Set and return |
Ivan Chernoff | 006617f | 2017-08-29 17:46:24 +0300 | [diff] [blame] | 631 | :attr:`~Popen.returncode` attribute. Otherwise, returns ``None``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 632 | |
| 633 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 634 | .. method:: Popen.wait(timeout=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 635 | |
Serhiy Storchaka | 9e0ae53 | 2013-08-24 00:23:38 +0300 | [diff] [blame] | 636 | Wait for child process to terminate. Set and return |
| 637 | :attr:`~Popen.returncode` attribute. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 638 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 639 | If the process does not terminate after *timeout* seconds, raise a |
| 640 | :exc:`TimeoutExpired` exception. It is safe to catch this exception and |
| 641 | retry the wait. |
| 642 | |
Victor Stinner | 0717124 | 2014-02-24 13:18:47 +0100 | [diff] [blame] | 643 | .. note:: |
| 644 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 645 | This will deadlock when using ``stdout=PIPE`` or ``stderr=PIPE`` |
| 646 | and the child process generates enough output to a pipe such that |
| 647 | it blocks waiting for the OS pipe buffer to accept more data. |
| 648 | Use :meth:`Popen.communicate` when using pipes to avoid that. |
| 649 | |
| 650 | .. note:: |
| 651 | |
Victor Stinner | 0717124 | 2014-02-24 13:18:47 +0100 | [diff] [blame] | 652 | The function is implemented using a busy loop (non-blocking call and |
| 653 | short sleeps). Use the :mod:`asyncio` module for an asynchronous wait: |
| 654 | see :class:`asyncio.create_subprocess_exec`. |
| 655 | |
Reid Kleckner | 28f1303 | 2011-03-14 12:36:53 -0400 | [diff] [blame] | 656 | .. versionchanged:: 3.3 |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 657 | *timeout* was added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 658 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 659 | .. method:: Popen.communicate(input=None, timeout=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 660 | |
| 661 | Interact with process: Send data to stdin. Read data from stdout and stderr, |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 662 | until end-of-file is reached. Wait for process to terminate. The optional |
Gregory P. Smith | a454ef6 | 2011-05-22 22:29:49 -0700 | [diff] [blame] | 663 | *input* argument should be data to be sent to the child process, or |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 664 | ``None``, if no data should be sent to the child. If streams were opened in |
| 665 | text mode, *input* must be a string. Otherwise, it must be bytes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 666 | |
Victor Stinner | 3989205 | 2014-10-14 00:52:07 +0200 | [diff] [blame] | 667 | :meth:`communicate` returns a tuple ``(stdout_data, stderr_data)``. |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 668 | The data will be strings if streams were opened in text mode; otherwise, |
| 669 | bytes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 670 | |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 671 | Note that if you want to send data to the process's stdin, you need to create |
| 672 | the Popen object with ``stdin=PIPE``. Similarly, to get anything other than |
| 673 | ``None`` in the result tuple, you need to give ``stdout=PIPE`` and/or |
| 674 | ``stderr=PIPE`` too. |
| 675 | |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 676 | If the process does not terminate after *timeout* seconds, a |
| 677 | :exc:`TimeoutExpired` exception will be raised. Catching this exception and |
| 678 | retrying communication will not lose any output. |
| 679 | |
| 680 | The child process is not killed if the timeout expires, so in order to |
| 681 | cleanup properly a well-behaved application should kill the child process and |
| 682 | finish communication:: |
| 683 | |
| 684 | proc = subprocess.Popen(...) |
| 685 | try: |
| 686 | outs, errs = proc.communicate(timeout=15) |
| 687 | except TimeoutExpired: |
| 688 | proc.kill() |
| 689 | outs, errs = proc.communicate() |
| 690 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 691 | .. note:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 692 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 693 | The data read is buffered in memory, so do not use this method if the data |
| 694 | size is large or unlimited. |
| 695 | |
Reid Kleckner | 28f1303 | 2011-03-14 12:36:53 -0400 | [diff] [blame] | 696 | .. versionchanged:: 3.3 |
Reid Kleckner | 31aa7dd | 2011-03-14 12:02:10 -0400 | [diff] [blame] | 697 | *timeout* was added. |
| 698 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 699 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 700 | .. method:: Popen.send_signal(signal) |
| 701 | |
| 702 | Sends the signal *signal* to the child. |
| 703 | |
| 704 | .. note:: |
| 705 | |
Brian Curtin | eb24d74 | 2010-04-12 17:16:38 +0000 | [diff] [blame] | 706 | On Windows, SIGTERM is an alias for :meth:`terminate`. CTRL_C_EVENT and |
Senthil Kumaran | 916bd38 | 2010-10-15 12:55:19 +0000 | [diff] [blame] | 707 | CTRL_BREAK_EVENT can be sent to processes started with a *creationflags* |
Brian Curtin | eb24d74 | 2010-04-12 17:16:38 +0000 | [diff] [blame] | 708 | parameter which includes `CREATE_NEW_PROCESS_GROUP`. |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 709 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 710 | |
| 711 | .. method:: Popen.terminate() |
| 712 | |
| 713 | Stop the child. On Posix OSs the method sends SIGTERM to the |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 714 | child. On Windows the Win32 API function :c:func:`TerminateProcess` is called |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 715 | to stop the child. |
| 716 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 717 | |
| 718 | .. method:: Popen.kill() |
| 719 | |
| 720 | Kills the child. On Posix OSs the function sends SIGKILL to the child. |
| 721 | On Windows :meth:`kill` is an alias for :meth:`terminate`. |
| 722 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 723 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 724 | The following attributes are also available: |
| 725 | |
Gregory P. Smith | 024c5ee | 2014-04-29 11:33:23 -0700 | [diff] [blame] | 726 | .. attribute:: Popen.args |
| 727 | |
| 728 | The *args* argument as it was passed to :class:`Popen` -- a |
| 729 | sequence of program arguments or else a single string. |
| 730 | |
| 731 | .. versionadded:: 3.3 |
Georg Brandl | 734e268 | 2008-08-12 08:18:18 +0000 | [diff] [blame] | 732 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 733 | .. attribute:: Popen.stdin |
| 734 | |
Benjamin Peterson | 3d8814e | 2014-01-18 00:45:56 -0500 | [diff] [blame] | 735 | If the *stdin* argument was :data:`PIPE`, this attribute is a writeable |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 736 | stream object as returned by :func:`open`. If the *encoding* or *errors* |
| 737 | arguments were specified or the *universal_newlines* argument was ``True``, |
| 738 | the stream is a text stream, otherwise it is a byte stream. If the *stdin* |
| 739 | argument was not :data:`PIPE`, this attribute is ``None``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 740 | |
| 741 | |
| 742 | .. attribute:: Popen.stdout |
| 743 | |
Benjamin Peterson | 3d8814e | 2014-01-18 00:45:56 -0500 | [diff] [blame] | 744 | If the *stdout* argument was :data:`PIPE`, this attribute is a readable |
| 745 | stream object as returned by :func:`open`. Reading from the stream provides |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 746 | output from the child process. If the *encoding* or *errors* arguments were |
| 747 | specified or the *universal_newlines* argument was ``True``, the stream is a |
| 748 | text stream, otherwise it is a byte stream. If the *stdout* argument was not |
| 749 | :data:`PIPE`, this attribute is ``None``. |
Benjamin Peterson | af69fe2 | 2014-01-18 00:49:04 -0500 | [diff] [blame] | 750 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 751 | |
| 752 | .. attribute:: Popen.stderr |
| 753 | |
Benjamin Peterson | 3d8814e | 2014-01-18 00:45:56 -0500 | [diff] [blame] | 754 | If the *stderr* argument was :data:`PIPE`, this attribute is a readable |
| 755 | stream object as returned by :func:`open`. Reading from the stream provides |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 756 | error output from the child process. If the *encoding* or *errors* arguments |
| 757 | were specified or the *universal_newlines* argument was ``True``, the stream |
| 758 | is a text stream, otherwise it is a byte stream. If the *stderr* argument was |
| 759 | not :data:`PIPE`, this attribute is ``None``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 760 | |
Gregory P. Smith | 6436cba | 2014-05-11 13:26:21 -0700 | [diff] [blame] | 761 | .. warning:: |
| 762 | |
| 763 | Use :meth:`~Popen.communicate` rather than :attr:`.stdin.write <Popen.stdin>`, |
| 764 | :attr:`.stdout.read <Popen.stdout>` or :attr:`.stderr.read <Popen.stderr>` to avoid |
| 765 | deadlocks due to any of the other OS pipe buffers filling up and blocking the |
| 766 | child process. |
| 767 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 768 | |
| 769 | .. attribute:: Popen.pid |
| 770 | |
| 771 | The process ID of the child process. |
| 772 | |
Georg Brandl | 58bfdca | 2010-03-21 09:50:49 +0000 | [diff] [blame] | 773 | Note that if you set the *shell* argument to ``True``, this is the process ID |
| 774 | of the spawned shell. |
| 775 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 776 | |
| 777 | .. attribute:: Popen.returncode |
| 778 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 779 | The child return code, set by :meth:`poll` and :meth:`wait` (and indirectly |
| 780 | by :meth:`communicate`). A ``None`` value indicates that the process |
| 781 | hasn't terminated yet. |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 782 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 783 | A negative value ``-N`` indicates that the child was terminated by signal |
Gregory P. Smith | 8e0aa05 | 2014-05-11 13:28:35 -0700 | [diff] [blame] | 784 | ``N`` (POSIX only). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 785 | |
| 786 | |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 787 | Windows Popen Helpers |
| 788 | --------------------- |
| 789 | |
| 790 | The :class:`STARTUPINFO` class and following constants are only available |
| 791 | on Windows. |
| 792 | |
Berker Peksag | f518474 | 2017-03-01 12:51:55 +0300 | [diff] [blame] | 793 | .. class:: STARTUPINFO(*, dwFlags=0, hStdInput=None, hStdOutput=None, \ |
Segev Finer | b2a6083 | 2017-12-18 11:28:19 +0200 | [diff] [blame] | 794 | hStdError=None, wShowWindow=0, lpAttributeList=None) |
Brian Curtin | 73365dd | 2011-04-29 22:18:33 -0500 | [diff] [blame] | 795 | |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 796 | Partial support of the Windows |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 797 | `STARTUPINFO <https://msdn.microsoft.com/en-us/library/ms686331(v=vs.85).aspx>`__ |
Berker Peksag | f518474 | 2017-03-01 12:51:55 +0300 | [diff] [blame] | 798 | structure is used for :class:`Popen` creation. The following attributes can |
| 799 | be set by passing them as keyword-only arguments. |
| 800 | |
| 801 | .. versionchanged:: 3.7 |
| 802 | Keyword-only argument support was added. |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 803 | |
| 804 | .. attribute:: dwFlags |
| 805 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 806 | A bit field that determines whether certain :class:`STARTUPINFO` |
| 807 | attributes are used when the process creates a window. :: |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 808 | |
| 809 | si = subprocess.STARTUPINFO() |
| 810 | si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW |
| 811 | |
| 812 | .. attribute:: hStdInput |
| 813 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 814 | If :attr:`dwFlags` specifies :data:`STARTF_USESTDHANDLES`, this attribute |
| 815 | is the standard input handle for the process. If |
| 816 | :data:`STARTF_USESTDHANDLES` is not specified, the default for standard |
| 817 | input is the keyboard buffer. |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 818 | |
| 819 | .. attribute:: hStdOutput |
| 820 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 821 | If :attr:`dwFlags` specifies :data:`STARTF_USESTDHANDLES`, this attribute |
| 822 | is the standard output handle for the process. Otherwise, this attribute |
| 823 | is ignored and the default for standard output is the console window's |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 824 | buffer. |
| 825 | |
| 826 | .. attribute:: hStdError |
| 827 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 828 | If :attr:`dwFlags` specifies :data:`STARTF_USESTDHANDLES`, this attribute |
| 829 | is the standard error handle for the process. Otherwise, this attribute is |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 830 | ignored and the default for standard error is the console window's buffer. |
| 831 | |
| 832 | .. attribute:: wShowWindow |
| 833 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 834 | If :attr:`dwFlags` specifies :data:`STARTF_USESHOWWINDOW`, this attribute |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 835 | can be any of the values that can be specified in the ``nCmdShow`` |
| 836 | parameter for the |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 837 | `ShowWindow <https://msdn.microsoft.com/en-us/library/ms633548(v=vs.85).aspx>`__ |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 838 | function, except for ``SW_SHOWDEFAULT``. Otherwise, this attribute is |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 839 | ignored. |
Brian Curtin | 73365dd | 2011-04-29 22:18:33 -0500 | [diff] [blame] | 840 | |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 841 | :data:`SW_HIDE` is provided for this attribute. It is used when |
| 842 | :class:`Popen` is called with ``shell=True``. |
| 843 | |
Segev Finer | b2a6083 | 2017-12-18 11:28:19 +0200 | [diff] [blame] | 844 | .. attribute:: lpAttributeList |
| 845 | |
| 846 | A dictionary of additional attributes for process creation as given in |
| 847 | ``STARTUPINFOEX``, see |
| 848 | `UpdateProcThreadAttribute <https://msdn.microsoft.com/en-us/library/windows/desktop/ms686880(v=vs.85).aspx>`__. |
| 849 | |
| 850 | Supported attributes: |
| 851 | |
| 852 | **handle_list** |
| 853 | Sequence of handles that will be inherited. *close_fds* must be true if |
| 854 | non-empty. |
| 855 | |
| 856 | The handles must be temporarily made inheritable by |
| 857 | :func:`os.set_handle_inheritable` when passed to the :class:`Popen` |
| 858 | constructor, else :class:`OSError` will be raised with Windows error |
| 859 | ``ERROR_INVALID_PARAMETER`` (87). |
| 860 | |
| 861 | .. warning:: |
| 862 | |
| 863 | In a multithreaded process, use caution to avoid leaking handles |
| 864 | that are marked inheritable when combining this feature with |
| 865 | concurrent calls to other process creation functions that inherit |
| 866 | all handles such as :func:`os.system`. This also applies to |
| 867 | standard handle redirection, which temporarily creates inheritable |
| 868 | handles. |
| 869 | |
| 870 | .. versionadded:: 3.7 |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 871 | |
James | b5d9e08 | 2017-11-08 14:18:59 +0000 | [diff] [blame] | 872 | Windows Constants |
| 873 | ^^^^^^^^^^^^^^^^^ |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 874 | |
| 875 | The :mod:`subprocess` module exposes the following constants. |
| 876 | |
| 877 | .. data:: STD_INPUT_HANDLE |
| 878 | |
| 879 | The standard input device. Initially, this is the console input buffer, |
| 880 | ``CONIN$``. |
| 881 | |
| 882 | .. data:: STD_OUTPUT_HANDLE |
| 883 | |
| 884 | The standard output device. Initially, this is the active console screen |
| 885 | buffer, ``CONOUT$``. |
| 886 | |
| 887 | .. data:: STD_ERROR_HANDLE |
| 888 | |
| 889 | The standard error device. Initially, this is the active console screen |
| 890 | buffer, ``CONOUT$``. |
| 891 | |
| 892 | .. data:: SW_HIDE |
| 893 | |
| 894 | Hides the window. Another window will be activated. |
| 895 | |
| 896 | .. data:: STARTF_USESTDHANDLES |
| 897 | |
| 898 | Specifies that the :attr:`STARTUPINFO.hStdInput`, |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 899 | :attr:`STARTUPINFO.hStdOutput`, and :attr:`STARTUPINFO.hStdError` attributes |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 900 | contain additional information. |
| 901 | |
| 902 | .. data:: STARTF_USESHOWWINDOW |
| 903 | |
Senthil Kumaran | a6bac95 | 2011-07-04 11:28:30 -0700 | [diff] [blame] | 904 | Specifies that the :attr:`STARTUPINFO.wShowWindow` attribute contains |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 905 | additional information. |
| 906 | |
| 907 | .. data:: CREATE_NEW_CONSOLE |
| 908 | |
| 909 | The new process has a new console, instead of inheriting its parent's |
| 910 | console (the default). |
Brian Curtin | 73365dd | 2011-04-29 22:18:33 -0500 | [diff] [blame] | 911 | |
Brian Curtin | 3040193 | 2011-04-29 22:20:57 -0500 | [diff] [blame] | 912 | .. data:: CREATE_NEW_PROCESS_GROUP |
| 913 | |
| 914 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 915 | group will be created. This flag is necessary for using :func:`os.kill` |
| 916 | on the subprocess. |
| 917 | |
| 918 | This flag is ignored if :data:`CREATE_NEW_CONSOLE` is specified. |
| 919 | |
James | b5d9e08 | 2017-11-08 14:18:59 +0000 | [diff] [blame] | 920 | .. data:: ABOVE_NORMAL_PRIORITY_CLASS |
| 921 | |
| 922 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 923 | will have an above average priority. |
| 924 | |
| 925 | .. versionadded:: 3.7 |
| 926 | |
| 927 | .. data:: BELOW_NORMAL_PRIORITY_CLASS |
| 928 | |
| 929 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 930 | will have a below average priority. |
| 931 | |
| 932 | .. versionadded:: 3.7 |
| 933 | |
| 934 | .. data:: HIGH_PRIORITY_CLASS |
| 935 | |
| 936 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 937 | will have a high priority. |
| 938 | |
| 939 | .. versionadded:: 3.7 |
| 940 | |
| 941 | .. data:: IDLE_PRIORITY_CLASS |
| 942 | |
| 943 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 944 | will have an idle (lowest) priority. |
| 945 | |
| 946 | .. versionadded:: 3.7 |
| 947 | |
| 948 | .. data:: NORMAL_PRIORITY_CLASS |
| 949 | |
| 950 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 951 | will have an normal priority. (default) |
| 952 | |
| 953 | .. versionadded:: 3.7 |
| 954 | |
| 955 | .. data:: REALTIME_PRIORITY_CLASS |
| 956 | |
| 957 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 958 | will have realtime priority. |
| 959 | You should almost never use REALTIME_PRIORITY_CLASS, because this interrupts |
| 960 | system threads that manage mouse input, keyboard input, and background disk |
| 961 | flushing. This class can be appropriate for applications that "talk" directly |
| 962 | to hardware or that perform brief tasks that should have limited interruptions. |
| 963 | |
| 964 | .. versionadded:: 3.7 |
| 965 | |
| 966 | .. data:: CREATE_NO_WINDOW |
| 967 | |
| 968 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
Jules Lasne (jlasne) | 7e9ce4c | 2019-03-04 19:12:04 +0100 | [diff] [blame] | 969 | will not create a window. |
James | b5d9e08 | 2017-11-08 14:18:59 +0000 | [diff] [blame] | 970 | |
| 971 | .. versionadded:: 3.7 |
| 972 | |
| 973 | .. data:: DETACHED_PROCESS |
| 974 | |
| 975 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 976 | will not inherit its parent's console. |
| 977 | This value cannot be used with CREATE_NEW_CONSOLE. |
| 978 | |
| 979 | .. versionadded:: 3.7 |
| 980 | |
| 981 | .. data:: CREATE_DEFAULT_ERROR_MODE |
| 982 | |
| 983 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 984 | does not inherit the error mode of the calling process. Instead, the new |
| 985 | process gets the default error mode. |
| 986 | This feature is particularly useful for multithreaded shell applications |
| 987 | that run with hard errors disabled. |
| 988 | |
| 989 | .. versionadded:: 3.7 |
| 990 | |
| 991 | .. data:: CREATE_BREAKAWAY_FROM_JOB |
| 992 | |
| 993 | A :class:`Popen` ``creationflags`` parameter to specify that a new process |
| 994 | is not associated with the job. |
| 995 | |
| 996 | .. versionadded:: 3.7 |
| 997 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 998 | .. _call-function-trio: |
| 999 | |
| 1000 | Older high-level API |
| 1001 | -------------------- |
| 1002 | |
| 1003 | Prior to Python 3.5, these three functions comprised the high level API to |
| 1004 | subprocess. You can now use :func:`run` in many cases, but lots of existing code |
| 1005 | calls these functions. |
| 1006 | |
Alex Gaynor | 368cf1d | 2017-05-25 22:28:17 -0400 | [diff] [blame] | 1007 | .. function:: call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None) |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1008 | |
| 1009 | Run the command described by *args*. Wait for command to complete, then |
Berker Peksag | bf1d4b6 | 2015-07-25 14:27:07 +0300 | [diff] [blame] | 1010 | return the :attr:`~Popen.returncode` attribute. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1011 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1012 | Code needing to capture stdout or stderr should use :func:`run` instead: |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1013 | |
| 1014 | run(...).returncode |
| 1015 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1016 | To suppress stdout or stderr, supply a value of :data:`DEVNULL`. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1017 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1018 | The arguments shown above are merely some common ones. |
| 1019 | The full function signature is the |
Berker Peksag | bf1d4b6 | 2015-07-25 14:27:07 +0300 | [diff] [blame] | 1020 | same as that of the :class:`Popen` constructor - this function passes all |
| 1021 | supplied arguments other than *timeout* directly through to that interface. |
| 1022 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1023 | .. note:: |
| 1024 | |
| 1025 | Do not use ``stdout=PIPE`` or ``stderr=PIPE`` with this |
| 1026 | function. The child process will block if it generates enough |
| 1027 | output to a pipe to fill up the OS pipe buffer as the pipes are |
| 1028 | not being read from. |
| 1029 | |
| 1030 | .. versionchanged:: 3.3 |
| 1031 | *timeout* was added. |
| 1032 | |
Alex Gaynor | 368cf1d | 2017-05-25 22:28:17 -0400 | [diff] [blame] | 1033 | .. function:: check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None) |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1034 | |
| 1035 | Run command with arguments. Wait for command to complete. If the return |
| 1036 | code was zero then return, otherwise raise :exc:`CalledProcessError`. The |
| 1037 | :exc:`CalledProcessError` object will have the return code in the |
| 1038 | :attr:`~CalledProcessError.returncode` attribute. |
| 1039 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1040 | Code needing to capture stdout or stderr should use :func:`run` instead: |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1041 | |
| 1042 | run(..., check=True) |
| 1043 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1044 | To suppress stdout or stderr, supply a value of :data:`DEVNULL`. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1045 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1046 | The arguments shown above are merely some common ones. |
| 1047 | The full function signature is the |
Berker Peksag | bf1d4b6 | 2015-07-25 14:27:07 +0300 | [diff] [blame] | 1048 | same as that of the :class:`Popen` constructor - this function passes all |
| 1049 | supplied arguments other than *timeout* directly through to that interface. |
| 1050 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1051 | .. note:: |
| 1052 | |
| 1053 | Do not use ``stdout=PIPE`` or ``stderr=PIPE`` with this |
| 1054 | function. The child process will block if it generates enough |
| 1055 | output to a pipe to fill up the OS pipe buffer as the pipes are |
| 1056 | not being read from. |
| 1057 | |
| 1058 | .. versionchanged:: 3.3 |
| 1059 | *timeout* was added. |
| 1060 | |
| 1061 | |
Steve Dower | 050acae | 2016-09-06 20:16:17 -0700 | [diff] [blame] | 1062 | .. function:: check_output(args, *, stdin=None, stderr=None, shell=False, \ |
Alex Gaynor | 368cf1d | 2017-05-25 22:28:17 -0400 | [diff] [blame] | 1063 | cwd=None, encoding=None, errors=None, \ |
Jakub Stasiak | 7432f09 | 2018-11-12 04:40:42 +0100 | [diff] [blame] | 1064 | universal_newlines=None, timeout=None, text=None) |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1065 | |
| 1066 | Run command with arguments and return its output. |
| 1067 | |
| 1068 | If the return code was non-zero it raises a :exc:`CalledProcessError`. The |
| 1069 | :exc:`CalledProcessError` object will have the return code in the |
| 1070 | :attr:`~CalledProcessError.returncode` attribute and any output in the |
| 1071 | :attr:`~CalledProcessError.output` attribute. |
| 1072 | |
| 1073 | This is equivalent to:: |
| 1074 | |
| 1075 | run(..., check=True, stdout=PIPE).stdout |
| 1076 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1077 | The arguments shown above are merely some common ones. |
Berker Peksag | bf1d4b6 | 2015-07-25 14:27:07 +0300 | [diff] [blame] | 1078 | The full function signature is largely the same as that of :func:`run` - |
| 1079 | most arguments are passed directly through to that interface. |
| 1080 | However, explicitly passing ``input=None`` to inherit the parent's |
| 1081 | standard input file handle is not supported. |
| 1082 | |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1083 | By default, this function will return the data as encoded bytes. The actual |
| 1084 | encoding of the output data may depend on the command being invoked, so the |
| 1085 | decoding to text will often need to be handled at the application level. |
| 1086 | |
Gregory P. Smith | 7a2e84c | 2019-03-23 00:40:28 -0700 | [diff] [blame] | 1087 | This behaviour may be overridden by setting *text*, *encoding*, *errors*, |
| 1088 | or *universal_newlines* to ``True`` as described in |
| 1089 | :ref:`frequently-used-arguments` and :func:`run`. |
Gregory P. Smith | 6e73000 | 2015-04-14 16:14:25 -0700 | [diff] [blame] | 1090 | |
| 1091 | To also capture standard error in the result, use |
| 1092 | ``stderr=subprocess.STDOUT``:: |
| 1093 | |
| 1094 | >>> subprocess.check_output( |
| 1095 | ... "ls non_existent_file; exit 0", |
| 1096 | ... stderr=subprocess.STDOUT, |
| 1097 | ... shell=True) |
| 1098 | 'ls: non_existent_file: No such file or directory\n' |
| 1099 | |
| 1100 | .. versionadded:: 3.1 |
| 1101 | |
| 1102 | .. versionchanged:: 3.3 |
| 1103 | *timeout* was added. |
| 1104 | |
| 1105 | .. versionchanged:: 3.4 |
Berker Peksag | bf1d4b6 | 2015-07-25 14:27:07 +0300 | [diff] [blame] | 1106 | Support for the *input* keyword argument was added. |
Brian Curtin | e6242d7 | 2011-04-29 22:17:51 -0500 | [diff] [blame] | 1107 | |
Brice Gros | fc1ce81 | 2018-02-07 01:46:29 +0100 | [diff] [blame] | 1108 | .. versionchanged:: 3.6 |
| 1109 | *encoding* and *errors* were added. See :func:`run` for details. |
| 1110 | |
Jakub Stasiak | 7432f09 | 2018-11-12 04:40:42 +0100 | [diff] [blame] | 1111 | .. versionadded:: 3.7 |
| 1112 | *text* was added as a more readable alias for *universal_newlines*. |
| 1113 | |
| 1114 | |
Benjamin Peterson | dcf97b9 | 2008-07-02 17:30:14 +0000 | [diff] [blame] | 1115 | .. _subprocess-replacements: |
| 1116 | |
Ezio Melotti | 402f75d | 2012-11-08 10:07:10 +0200 | [diff] [blame] | 1117 | Replacing Older Functions with the :mod:`subprocess` Module |
| 1118 | ----------------------------------------------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1119 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1120 | In this section, "a becomes b" means that b can be used as a replacement for a. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1121 | |
| 1122 | .. note:: |
| 1123 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1124 | All "a" functions in this section fail (more or less) silently if the |
| 1125 | executed program cannot be found; the "b" replacements raise :exc:`OSError` |
| 1126 | instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1127 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1128 | In addition, the replacements using :func:`check_output` will fail with a |
| 1129 | :exc:`CalledProcessError` if the requested operation produces a non-zero |
Serhiy Storchaka | 9e0ae53 | 2013-08-24 00:23:38 +0300 | [diff] [blame] | 1130 | return code. The output is still available as the |
| 1131 | :attr:`~CalledProcessError.output` attribute of the raised exception. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1132 | |
| 1133 | In the following examples, we assume that the relevant functions have already |
Ezio Melotti | 402f75d | 2012-11-08 10:07:10 +0200 | [diff] [blame] | 1134 | been imported from the :mod:`subprocess` module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1135 | |
| 1136 | |
| 1137 | Replacing /bin/sh shell backquote |
| 1138 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1139 | |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1140 | .. code-block:: bash |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1141 | |
| 1142 | output=`mycmd myarg` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1143 | |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1144 | becomes:: |
| 1145 | |
| 1146 | output = check_output(["mycmd", "myarg"]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1147 | |
Benjamin Peterson | f10a79a | 2008-10-11 00:49:57 +0000 | [diff] [blame] | 1148 | Replacing shell pipeline |
| 1149 | ^^^^^^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1150 | |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1151 | .. code-block:: bash |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1152 | |
| 1153 | output=`dmesg | grep hda` |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1154 | |
| 1155 | becomes:: |
| 1156 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1157 | p1 = Popen(["dmesg"], stdout=PIPE) |
| 1158 | p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE) |
Gregory P. Smith | e09d2f1 | 2011-02-05 21:47:25 +0000 | [diff] [blame] | 1159 | p1.stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1160 | output = p2.communicate()[0] |
| 1161 | |
Gregory P. Smith | e09d2f1 | 2011-02-05 21:47:25 +0000 | [diff] [blame] | 1162 | The p1.stdout.close() call after starting the p2 is important in order for p1 |
| 1163 | to receive a SIGPIPE if p2 exits before p1. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1164 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1165 | Alternatively, for trusted input, the shell's own pipeline support may still |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1166 | be used directly: |
| 1167 | |
| 1168 | .. code-block:: bash |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1169 | |
| 1170 | output=`dmesg | grep hda` |
Martin Panter | 1050d2d | 2016-07-26 11:18:21 +0200 | [diff] [blame] | 1171 | |
| 1172 | becomes:: |
| 1173 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1174 | output=check_output("dmesg | grep hda", shell=True) |
| 1175 | |
| 1176 | |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1177 | Replacing :func:`os.system` |
| 1178 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1179 | |
| 1180 | :: |
| 1181 | |
| 1182 | sts = os.system("mycmd" + " myarg") |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1183 | # becomes |
| 1184 | sts = call("mycmd" + " myarg", shell=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1185 | |
| 1186 | Notes: |
| 1187 | |
| 1188 | * Calling the program through the shell is usually not required. |
| 1189 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1190 | A more realistic example would look like this:: |
| 1191 | |
| 1192 | try: |
| 1193 | retcode = call("mycmd" + " myarg", shell=True) |
| 1194 | if retcode < 0: |
Collin Winter | c79461b | 2007-09-01 23:34:30 +0000 | [diff] [blame] | 1195 | print("Child was terminated by signal", -retcode, file=sys.stderr) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1196 | else: |
Collin Winter | c79461b | 2007-09-01 23:34:30 +0000 | [diff] [blame] | 1197 | print("Child returned", retcode, file=sys.stderr) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1198 | except OSError as e: |
Collin Winter | c79461b | 2007-09-01 23:34:30 +0000 | [diff] [blame] | 1199 | print("Execution failed:", e, file=sys.stderr) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1200 | |
| 1201 | |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1202 | Replacing the :func:`os.spawn <os.spawnl>` family |
| 1203 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1204 | |
| 1205 | P_NOWAIT example:: |
| 1206 | |
| 1207 | pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg") |
| 1208 | ==> |
| 1209 | pid = Popen(["/bin/mycmd", "myarg"]).pid |
| 1210 | |
| 1211 | P_WAIT example:: |
| 1212 | |
| 1213 | retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg") |
| 1214 | ==> |
| 1215 | retcode = call(["/bin/mycmd", "myarg"]) |
| 1216 | |
| 1217 | Vector example:: |
| 1218 | |
| 1219 | os.spawnvp(os.P_NOWAIT, path, args) |
| 1220 | ==> |
| 1221 | Popen([path] + args[1:]) |
| 1222 | |
| 1223 | Environment example:: |
| 1224 | |
| 1225 | os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env) |
| 1226 | ==> |
| 1227 | Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"}) |
| 1228 | |
| 1229 | |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1230 | |
| 1231 | Replacing :func:`os.popen`, :func:`os.popen2`, :func:`os.popen3` |
| 1232 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1233 | |
| 1234 | :: |
| 1235 | |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1236 | (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1237 | ==> |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1238 | p = Popen(cmd, shell=True, bufsize=bufsize, |
| 1239 | stdin=PIPE, stdout=PIPE, close_fds=True) |
| 1240 | (child_stdin, child_stdout) = (p.stdin, p.stdout) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1241 | |
| 1242 | :: |
| 1243 | |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1244 | (child_stdin, |
| 1245 | child_stdout, |
| 1246 | child_stderr) = os.popen3(cmd, mode, bufsize) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1247 | ==> |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1248 | p = Popen(cmd, shell=True, bufsize=bufsize, |
| 1249 | stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True) |
| 1250 | (child_stdin, |
| 1251 | child_stdout, |
| 1252 | child_stderr) = (p.stdin, p.stdout, p.stderr) |
| 1253 | |
| 1254 | :: |
| 1255 | |
| 1256 | (child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize) |
| 1257 | ==> |
| 1258 | p = Popen(cmd, shell=True, bufsize=bufsize, |
| 1259 | stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True) |
| 1260 | (child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout) |
| 1261 | |
| 1262 | Return code handling translates as follows:: |
| 1263 | |
| 1264 | pipe = os.popen(cmd, 'w') |
| 1265 | ... |
| 1266 | rc = pipe.close() |
Stefan Krah | fc9e08d | 2010-07-14 10:16:11 +0000 | [diff] [blame] | 1267 | if rc is not None and rc >> 8: |
Ezio Melotti | 985e24d | 2009-09-13 07:54:02 +0000 | [diff] [blame] | 1268 | print("There were some errors") |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1269 | ==> |
R David Murray | 17227a7 | 2015-09-04 10:01:19 -0400 | [diff] [blame] | 1270 | process = Popen(cmd, stdin=PIPE) |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1271 | ... |
| 1272 | process.stdin.close() |
| 1273 | if process.wait() != 0: |
Ezio Melotti | 985e24d | 2009-09-13 07:54:02 +0000 | [diff] [blame] | 1274 | print("There were some errors") |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1275 | |
| 1276 | |
| 1277 | Replacing functions from the :mod:`popen2` module |
| 1278 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1279 | |
| 1280 | .. note:: |
| 1281 | |
| 1282 | If the cmd argument to popen2 functions is a string, the command is executed |
| 1283 | through /bin/sh. If it is a list, the command is directly executed. |
| 1284 | |
| 1285 | :: |
| 1286 | |
| 1287 | (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode) |
| 1288 | ==> |
R David Murray | ae9d193 | 2014-05-14 10:09:52 -0400 | [diff] [blame] | 1289 | p = Popen("somestring", shell=True, bufsize=bufsize, |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1290 | stdin=PIPE, stdout=PIPE, close_fds=True) |
| 1291 | (child_stdout, child_stdin) = (p.stdout, p.stdin) |
| 1292 | |
| 1293 | :: |
| 1294 | |
| 1295 | (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode) |
| 1296 | ==> |
| 1297 | p = Popen(["mycmd", "myarg"], bufsize=bufsize, |
| 1298 | stdin=PIPE, stdout=PIPE, close_fds=True) |
| 1299 | (child_stdout, child_stdin) = (p.stdout, p.stdin) |
| 1300 | |
| 1301 | :class:`popen2.Popen3` and :class:`popen2.Popen4` basically work as |
| 1302 | :class:`subprocess.Popen`, except that: |
| 1303 | |
| 1304 | * :class:`Popen` raises an exception if the execution fails. |
| 1305 | |
Jules Lasne (jlasne) | 7e9ce4c | 2019-03-04 19:12:04 +0100 | [diff] [blame] | 1306 | * The *capturestderr* argument is replaced with the *stderr* argument. |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 1307 | |
| 1308 | * ``stdin=PIPE`` and ``stdout=PIPE`` must be specified. |
| 1309 | |
| 1310 | * popen2 closes all file descriptors by default, but you have to specify |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 1311 | ``close_fds=True`` with :class:`Popen` to guarantee this behavior on |
| 1312 | all platforms or past Python versions. |
Eli Bendersky | 046a764 | 2011-04-15 07:23:26 +0300 | [diff] [blame] | 1313 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1314 | |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1315 | Legacy Shell Invocation Functions |
Nick Coghlan | 32e4a58 | 2011-11-08 21:50:58 +1000 | [diff] [blame] | 1316 | --------------------------------- |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1317 | |
| 1318 | This module also provides the following legacy functions from the 2.x |
| 1319 | ``commands`` module. These operations implicitly invoke the system shell and |
| 1320 | none of the guarantees described above regarding security and exception |
| 1321 | handling consistency are valid for these functions. |
| 1322 | |
| 1323 | .. function:: getstatusoutput(cmd) |
| 1324 | |
Gregory P. Smith | 738b7d9 | 2017-09-06 17:39:23 -0700 | [diff] [blame] | 1325 | Return ``(exitcode, output)`` of executing *cmd* in a shell. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1326 | |
Tim Golden | 6079814 | 2013-11-05 12:57:25 +0000 | [diff] [blame] | 1327 | Execute the string *cmd* in a shell with :meth:`Popen.check_output` and |
Gregory P. Smith | 738b7d9 | 2017-09-06 17:39:23 -0700 | [diff] [blame] | 1328 | return a 2-tuple ``(exitcode, output)``. The locale encoding is used; |
Tim Golden | 6079814 | 2013-11-05 12:57:25 +0000 | [diff] [blame] | 1329 | see the notes on :ref:`frequently-used-arguments` for more details. |
Tim Golden | 3a2abb5 | 2013-11-03 18:24:50 +0000 | [diff] [blame] | 1330 | |
| 1331 | A trailing newline is stripped from the output. |
Gregory P. Smith | 738b7d9 | 2017-09-06 17:39:23 -0700 | [diff] [blame] | 1332 | The exit code for the command can be interpreted as the return code |
| 1333 | of subprocess. Example:: |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1334 | |
| 1335 | >>> subprocess.getstatusoutput('ls /bin/ls') |
| 1336 | (0, '/bin/ls') |
| 1337 | >>> subprocess.getstatusoutput('cat /bin/junk') |
Gregory P. Smith | 738b7d9 | 2017-09-06 17:39:23 -0700 | [diff] [blame] | 1338 | (1, 'cat: /bin/junk: No such file or directory') |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1339 | >>> subprocess.getstatusoutput('/bin/junk') |
Gregory P. Smith | 738b7d9 | 2017-09-06 17:39:23 -0700 | [diff] [blame] | 1340 | (127, 'sh: /bin/junk: not found') |
| 1341 | >>> subprocess.getstatusoutput('/bin/kill $$') |
| 1342 | (-15, '') |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1343 | |
Cheryl Sabella | 2d6097d | 2018-10-12 10:55:20 -0400 | [diff] [blame] | 1344 | .. availability:: POSIX & Windows. |
R David Murray | 95b696a | 2014-03-07 20:04:17 -0500 | [diff] [blame] | 1345 | |
| 1346 | .. versionchanged:: 3.3.4 |
Gregory P. Smith | 738b7d9 | 2017-09-06 17:39:23 -0700 | [diff] [blame] | 1347 | Windows support was added. |
| 1348 | |
| 1349 | The function now returns (exitcode, output) instead of (status, output) |
Xiang Zhang | 7d16172 | 2018-09-22 04:18:20 +0800 | [diff] [blame] | 1350 | as it did in Python 3.3.3 and earlier. exitcode has the same value as |
| 1351 | :attr:`~Popen.returncode`. |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1352 | |
| 1353 | |
| 1354 | .. function:: getoutput(cmd) |
| 1355 | |
| 1356 | Return output (stdout and stderr) of executing *cmd* in a shell. |
| 1357 | |
Xiang Zhang | 7d16172 | 2018-09-22 04:18:20 +0800 | [diff] [blame] | 1358 | Like :func:`getstatusoutput`, except the exit code is ignored and the return |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1359 | value is a string containing the command's output. Example:: |
| 1360 | |
| 1361 | >>> subprocess.getoutput('ls /bin/ls') |
| 1362 | '/bin/ls' |
| 1363 | |
Cheryl Sabella | 2d6097d | 2018-10-12 10:55:20 -0400 | [diff] [blame] | 1364 | .. availability:: POSIX & Windows. |
R David Murray | 95b696a | 2014-03-07 20:04:17 -0500 | [diff] [blame] | 1365 | |
| 1366 | .. versionchanged:: 3.3.4 |
| 1367 | Windows support added |
Nick Coghlan | c29248f | 2011-11-08 20:49:23 +1000 | [diff] [blame] | 1368 | |
Nick Coghlan | 32e4a58 | 2011-11-08 21:50:58 +1000 | [diff] [blame] | 1369 | |
Eli Bendersky | 046a764 | 2011-04-15 07:23:26 +0300 | [diff] [blame] | 1370 | Notes |
| 1371 | ----- |
| 1372 | |
| 1373 | .. _converting-argument-sequence: |
| 1374 | |
| 1375 | Converting an argument sequence to a string on Windows |
| 1376 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1377 | |
| 1378 | On Windows, an *args* sequence is converted to a string that can be parsed |
| 1379 | using the following rules (which correspond to the rules used by the MS C |
| 1380 | runtime): |
| 1381 | |
| 1382 | 1. Arguments are delimited by white space, which is either a |
| 1383 | space or a tab. |
| 1384 | |
| 1385 | 2. A string surrounded by double quotation marks is |
| 1386 | interpreted as a single argument, regardless of white space |
| 1387 | contained within. A quoted string can be embedded in an |
| 1388 | argument. |
| 1389 | |
| 1390 | 3. A double quotation mark preceded by a backslash is |
| 1391 | interpreted as a literal double quotation mark. |
| 1392 | |
| 1393 | 4. Backslashes are interpreted literally, unless they |
| 1394 | immediately precede a double quotation mark. |
| 1395 | |
| 1396 | 5. If backslashes immediately precede a double quotation mark, |
| 1397 | every pair of backslashes is interpreted as a literal |
| 1398 | backslash. If the number of backslashes is odd, the last |
| 1399 | backslash escapes the next double quotation mark as |
| 1400 | described in rule 3. |
| 1401 | |
Eli Bendersky | d211231 | 2011-04-15 07:26:28 +0300 | [diff] [blame] | 1402 | |
Éric Araujo | 9bce311 | 2011-07-27 18:29:31 +0200 | [diff] [blame] | 1403 | .. seealso:: |
| 1404 | |
| 1405 | :mod:`shlex` |
| 1406 | Module which provides function to parse and escape command lines. |