Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`shutil` --- High-level file operations |
| 2 | ============================================ |
| 3 | |
| 4 | .. module:: shutil |
| 5 | :synopsis: High-level file operations, including copying. |
| 6 | .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 7 | .. partly based on the docstrings |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 8 | |
| 9 | .. index:: |
| 10 | single: file; copying |
| 11 | single: copying files |
| 12 | |
Raymond Hettinger | 1048094 | 2011-01-10 03:26:08 +0000 | [diff] [blame] | 13 | **Source code:** :source:`Lib/shutil.py` |
| 14 | |
Raymond Hettinger | 4f707fd | 2011-01-10 19:54:11 +0000 | [diff] [blame] | 15 | -------------- |
| 16 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 17 | The :mod:`shutil` module offers a number of high-level operations on files and |
| 18 | collections of files. In particular, functions are provided which support file |
Guido van Rossum | 2cc30da | 2007-11-02 23:46:40 +0000 | [diff] [blame] | 19 | copying and removal. For operations on individual files, see also the |
| 20 | :mod:`os` module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 21 | |
Guido van Rossum | da27fd2 | 2007-08-17 00:24:54 +0000 | [diff] [blame] | 22 | .. warning:: |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 23 | |
Senthil Kumaran | 7f728c1 | 2012-02-13 23:30:47 +0800 | [diff] [blame] | 24 | Even the higher-level file copying functions (:func:`shutil.copy`, |
| 25 | :func:`shutil.copy2`) cannot copy all file metadata. |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 26 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 27 | On POSIX platforms, this means that file owner and group are lost as well |
Georg Brandl | c575c90 | 2008-09-13 17:46:05 +0000 | [diff] [blame] | 28 | as ACLs. On Mac OS, the resource fork and other metadata are not used. |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 29 | This means that resources will be lost and file type and creator codes will |
| 30 | not be correct. On Windows, file owners, ACLs and alternate data streams |
| 31 | are not copied. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 32 | |
Éric Araujo | 6e6cb8e | 2010-11-16 19:13:50 +0000 | [diff] [blame] | 33 | |
Éric Araujo | f2fbb9c | 2012-01-16 16:55:55 +0100 | [diff] [blame] | 34 | .. _file-operations: |
| 35 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 36 | Directory and files operations |
| 37 | ------------------------------ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 38 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 39 | .. function:: copyfileobj(fsrc, fdst[, length]) |
| 40 | |
| 41 | Copy the contents of the file-like object *fsrc* to the file-like object *fdst*. |
| 42 | The integer *length*, if given, is the buffer size. In particular, a negative |
| 43 | *length* value means to copy the data without looping over the source data in |
| 44 | chunks; by default the data is read in chunks to avoid uncontrolled memory |
| 45 | consumption. Note that if the current file position of the *fsrc* object is not |
| 46 | 0, only the contents from the current file position to the end of the file will |
| 47 | be copied. |
| 48 | |
| 49 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 50 | .. function:: copyfile(src, dst, *, follow_symlinks=True) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 51 | |
Senthil Kumaran | 7f728c1 | 2012-02-13 23:30:47 +0800 | [diff] [blame] | 52 | Copy the contents (no metadata) of the file named *src* to a file named |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 53 | *dst* and return *dst*. *src* and *dst* are path names given as strings. |
| 54 | *dst* must be the complete target file name; look at :func:`shutil.copy` |
| 55 | for a copy that accepts a target directory path. If *src* and *dst* |
Hynek Schlawack | 4865376 | 2012-10-07 12:49:58 +0200 | [diff] [blame] | 56 | specify the same file, :exc:`SameFileError` is raised. |
Senthil Kumaran | 1fd6482 | 2012-02-13 23:35:44 +0800 | [diff] [blame] | 57 | |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 58 | The destination location must be writable; otherwise, an :exc:`OSError` |
| 59 | exception will be raised. If *dst* already exists, it will be replaced. |
| 60 | Special files such as character or block devices and pipes cannot be |
| 61 | copied with this function. |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 62 | |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 63 | If *follow_symlinks* is false and *src* is a symbolic link, |
| 64 | a new symbolic link will be created instead of copying the |
| 65 | file *src* points to. |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 66 | |
Antoine Pitrou | 62ab10a0 | 2011-10-12 20:10:51 +0200 | [diff] [blame] | 67 | .. versionchanged:: 3.3 |
| 68 | :exc:`IOError` used to be raised instead of :exc:`OSError`. |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 69 | Added *follow_symlinks* argument. |
| 70 | Now returns *dst*. |
Antoine Pitrou | 62ab10a0 | 2011-10-12 20:10:51 +0200 | [diff] [blame] | 71 | |
Hynek Schlawack | 4865376 | 2012-10-07 12:49:58 +0200 | [diff] [blame] | 72 | .. versionchanged:: 3.4 |
Hynek Schlawack | 27ddb57 | 2012-10-28 13:59:27 +0100 | [diff] [blame] | 73 | Raise :exc:`SameFileError` instead of :exc:`Error`. Since the former is |
| 74 | a subclass of the latter, this change is backward compatible. |
Hynek Schlawack | 4865376 | 2012-10-07 12:49:58 +0200 | [diff] [blame] | 75 | |
| 76 | |
| 77 | .. exception:: SameFileError |
| 78 | |
| 79 | This exception is raised if source and destination in :func:`copyfile` |
| 80 | are the same file. |
| 81 | |
| 82 | .. versionadded:: 3.4 |
| 83 | |
| 84 | |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 85 | .. function:: copymode(src, dst, *, follow_symlinks=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 86 | |
| 87 | Copy the permission bits from *src* to *dst*. The file contents, owner, and |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 88 | group are unaffected. *src* and *dst* are path names given as strings. |
| 89 | If *follow_symlinks* is false, and both *src* and *dst* are symbolic links, |
| 90 | :func:`copymode` will attempt to modify the mode of *dst* itself (rather |
| 91 | than the file it points to). This functionality is not available on every |
| 92 | platform; please see :func:`copystat` for more information. If |
| 93 | :func:`copymode` cannot modify symbolic links on the local platform, and it |
| 94 | is asked to do so, it will do nothing and return. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 95 | |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 96 | .. versionchanged:: 3.3 |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 97 | Added *follow_symlinks* argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 98 | |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 99 | .. function:: copystat(src, dst, *, follow_symlinks=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 100 | |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 101 | Copy the permission bits, last access time, last modification time, and |
| 102 | flags from *src* to *dst*. On Linux, :func:`copystat` also copies the |
| 103 | "extended attributes" where possible. The file contents, owner, and |
| 104 | group are unaffected. *src* and *dst* are path names given as strings. |
| 105 | |
| 106 | If *follow_symlinks* is false, and *src* and *dst* both |
| 107 | refer to symbolic links, :func:`copystat` will operate on |
| 108 | the symbolic links themselves rather than the files the |
| 109 | symbolic links refer to--reading the information from the |
| 110 | *src* symbolic link, and writing the information to the |
| 111 | *dst* symbolic link. |
| 112 | |
| 113 | .. note:: |
| 114 | |
| 115 | Not all platforms provide the ability to examine and |
| 116 | modify symbolic links. Python itself can tell you what |
| 117 | functionality is locally available. |
| 118 | |
| 119 | * If ``os.chmod in os.supports_follow_symlinks`` is |
| 120 | ``True``, :func:`copystat` can modify the permission |
| 121 | bits of a symbolic link. |
| 122 | |
| 123 | * If ``os.utime in os.supports_follow_symlinks`` is |
| 124 | ``True``, :func:`copystat` can modify the last access |
| 125 | and modification times of a symbolic link. |
| 126 | |
| 127 | * If ``os.chflags in os.supports_follow_symlinks`` is |
| 128 | ``True``, :func:`copystat` can modify the flags of |
| 129 | a symbolic link. (``os.chflags`` is not available on |
| 130 | all platforms.) |
| 131 | |
| 132 | On platforms where some or all of this functionality |
| 133 | is unavailable, when asked to modify a symbolic link, |
| 134 | :func:`copystat` will copy everything it can. |
| 135 | :func:`copystat` never returns failure. |
| 136 | |
| 137 | Please see :data:`os.supports_follow_symlinks` |
| 138 | for more information. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 139 | |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 140 | .. versionchanged:: 3.3 |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 141 | Added *follow_symlinks* argument and support for Linux extended attributes. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 142 | |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 143 | .. function:: copy(src, dst, *, follow_symlinks=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 144 | |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 145 | Copies the file *src* to the file or directory *dst*. *src* and *dst* |
| 146 | should be strings. If *dst* specifies a directory, the file will be |
| 147 | copied into *dst* using the base filename from *src*. Returns the |
| 148 | path to the newly created file. |
| 149 | |
| 150 | If *follow_symlinks* is false, and *src* is a symbolic link, |
| 151 | *dst* will be created as a symbolic link. If *follow_symlinks* |
| 152 | is true and *src* is a symbolic link, *dst* will be a copy of |
| 153 | the file *src* refers to. |
| 154 | |
| 155 | :func:`copy` copies the file data and the file's permission |
| 156 | mode (see :func:`os.chmod`). Other metadata, like the |
| 157 | file's creation and modification times, is not preserved. |
| 158 | To preserve all file metadata from the original, use |
| 159 | :func:`~shutil.copy2` instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 160 | |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 161 | .. versionchanged:: 3.3 |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 162 | Added *follow_symlinks* argument. |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 163 | Now returns path to the newly created file. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 164 | |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 165 | .. function:: copy2(src, dst, *, follow_symlinks=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 166 | |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 167 | Identical to :func:`~shutil.copy` except that :func:`copy2` |
| 168 | also attempts to preserve all file metadata. |
| 169 | |
| 170 | When *follow_symlinks* is false, and *src* is a symbolic |
| 171 | link, :func:`copy2` attempts to copy all metadata from the |
| 172 | *src* symbolic link to the newly-created *dst* symbolic link. |
| 173 | However, this functionality is not available on all platforms. |
| 174 | On platforms where some or all of this functionality is |
| 175 | unavailable, :func:`copy2` will preserve all the metadata |
| 176 | it can; :func:`copy2` never returns failure. |
| 177 | |
| 178 | :func:`copy2` uses :func:`copystat` to copy the file metadata. |
| 179 | Please see :func:`copystat` for more information |
| 180 | about platform support for modifying symbolic link metadata. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 181 | |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 182 | .. versionchanged:: 3.3 |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 183 | Added *follow_symlinks* argument, try to copy extended |
| 184 | file system attributes too (currently Linux only). |
Larry Hastings | 60eba57 | 2012-09-21 10:12:14 -0700 | [diff] [blame] | 185 | Now returns path to the newly created file. |
Brian Curtin | 066dacf | 2012-06-19 10:03:05 -0500 | [diff] [blame] | 186 | |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 187 | .. function:: ignore_patterns(\*patterns) |
| 188 | |
| 189 | This factory function creates a function that can be used as a callable for |
| 190 | :func:`copytree`\'s *ignore* argument, ignoring files and directories that |
| 191 | match one of the glob-style *patterns* provided. See the example below. |
| 192 | |
| 193 | |
Ezio Melotti | cb999a3 | 2010-04-20 11:26:51 +0000 | [diff] [blame] | 194 | .. function:: copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 195 | |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 196 | Recursively copy an entire directory tree rooted at *src*, returning the |
| 197 | destination directory. The destination |
Senthil Kumaran | 7f728c1 | 2012-02-13 23:30:47 +0800 | [diff] [blame] | 198 | directory, named by *dst*, must not already exist; it will be created as |
| 199 | well as missing parent directories. Permissions and times of directories |
| 200 | are copied with :func:`copystat`, individual files are copied using |
| 201 | :func:`shutil.copy2`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 202 | |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 203 | If *symlinks* is true, symbolic links in the source tree are represented as |
Antoine Pitrou | 78091e6 | 2011-12-29 18:54:15 +0100 | [diff] [blame] | 204 | symbolic links in the new tree and the metadata of the original links will |
| 205 | be copied as far as the platform allows; if false or omitted, the contents |
| 206 | and metadata of the linked files are copied to the new tree. |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 207 | |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 208 | When *symlinks* is false, if the file pointed by the symlink doesn't |
| 209 | exist, a exception will be added in the list of errors raised in |
| 210 | a :exc:`Error` exception at the end of the copy process. |
| 211 | You can set the optional *ignore_dangling_symlinks* flag to true if you |
Tarek Ziadé | 8c26c7d | 2010-04-23 13:03:50 +0000 | [diff] [blame] | 212 | want to silence this exception. Notice that this option has no effect |
| 213 | on platforms that don't support :func:`os.symlink`. |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 214 | |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 215 | If *ignore* is given, it must be a callable that will receive as its |
| 216 | arguments the directory being visited by :func:`copytree`, and a list of its |
| 217 | contents, as returned by :func:`os.listdir`. Since :func:`copytree` is |
| 218 | called recursively, the *ignore* callable will be called once for each |
| 219 | directory that is copied. The callable must return a sequence of directory |
| 220 | and file names relative to the current directory (i.e. a subset of the items |
| 221 | in its second argument); these names will then be ignored in the copy |
| 222 | process. :func:`ignore_patterns` can be used to create such a callable that |
| 223 | ignores names based on glob-style patterns. |
| 224 | |
| 225 | If exception(s) occur, an :exc:`Error` is raised with a list of reasons. |
| 226 | |
Senthil Kumaran | 7f728c1 | 2012-02-13 23:30:47 +0800 | [diff] [blame] | 227 | If *copy_function* is given, it must be a callable that will be used to copy |
| 228 | each file. It will be called with the source path and the destination path |
| 229 | as arguments. By default, :func:`shutil.copy2` is used, but any function |
Senthil Kumaran | 1fd6482 | 2012-02-13 23:35:44 +0800 | [diff] [blame] | 230 | that supports the same signature (like :func:`shutil.copy`) can be used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 231 | |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 232 | .. versionchanged:: 3.3 |
| 233 | Copy metadata when *symlinks* is false. |
| 234 | Now returns *dst*. |
| 235 | |
Tarek Ziadé | 5340db3 | 2010-04-19 22:30:51 +0000 | [diff] [blame] | 236 | .. versionchanged:: 3.2 |
| 237 | Added the *copy_function* argument to be able to provide a custom copy |
| 238 | function. |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 239 | Added the *ignore_dangling_symlinks* argument to silent dangling symlinks |
| 240 | errors when *symlinks* is false. |
| 241 | |
Georg Brandl | 96acb73 | 2012-06-24 17:39:05 +0200 | [diff] [blame] | 242 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 243 | .. function:: rmtree(path, ignore_errors=False, onerror=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 244 | |
| 245 | .. index:: single: directory; deleting |
| 246 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 247 | Delete an entire directory tree; *path* must point to a directory (but not a |
| 248 | symbolic link to a directory). If *ignore_errors* is true, errors resulting |
| 249 | from failed removals will be ignored; if false or omitted, such errors are |
| 250 | handled by calling a handler specified by *onerror* or, if that is omitted, |
| 251 | they raise an exception. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 252 | |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 253 | .. note:: |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 254 | |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 255 | On platforms that support the necessary fd-based functions a symlink |
Georg Brandl | 96acb73 | 2012-06-24 17:39:05 +0200 | [diff] [blame] | 256 | attack resistant version of :func:`rmtree` is used by default. On other |
| 257 | platforms, the :func:`rmtree` implementation is susceptible to a symlink |
| 258 | attack: given proper timing and circumstances, attackers can manipulate |
| 259 | symlinks on the filesystem to delete files they wouldn't be able to access |
| 260 | otherwise. Applications can use the :data:`rmtree.avoids_symlink_attacks` |
| 261 | function attribute to determine which case applies. |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 262 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 263 | If *onerror* is provided, it must be a callable that accepts three |
Hynek Schlawack | 67be92b | 2012-06-23 17:58:42 +0200 | [diff] [blame] | 264 | parameters: *function*, *path*, and *excinfo*. |
| 265 | |
| 266 | The first parameter, *function*, is the function which raised the exception; |
| 267 | it depends on the platform and implementation. The second parameter, |
| 268 | *path*, will be the path name passed to *function*. The third parameter, |
| 269 | *excinfo*, will be the exception information returned by |
| 270 | :func:`sys.exc_info`. Exceptions raised by *onerror* will not be caught. |
| 271 | |
| 272 | .. versionchanged:: 3.3 |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 273 | Added a symlink attack resistant version that is used automatically |
| 274 | if platform supports fd-based functions. |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 275 | |
Éric Araujo | 544e13d | 2012-06-24 13:53:48 -0400 | [diff] [blame] | 276 | .. attribute:: rmtree.avoids_symlink_attacks |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 277 | |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 278 | Indicates whether the current platform and implementation provides a |
Georg Brandl | 96acb73 | 2012-06-24 17:39:05 +0200 | [diff] [blame] | 279 | symlink attack resistant version of :func:`rmtree`. Currently this is |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 280 | only true for platforms supporting fd-based directory access functions. |
Hynek Schlawack | 2100b42 | 2012-06-23 20:28:32 +0200 | [diff] [blame] | 281 | |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 282 | .. versionadded:: 3.3 |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 283 | |
Georg Brandl | 96acb73 | 2012-06-24 17:39:05 +0200 | [diff] [blame] | 284 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 285 | .. function:: move(src, dst) |
| 286 | |
Brian Curtin | 0d0a1de | 2012-06-18 18:41:07 -0500 | [diff] [blame] | 287 | Recursively move a file or directory (*src*) to another location (*dst*) |
| 288 | and return the destination. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 289 | |
Benjamin Peterson | 218144a | 2015-03-22 10:11:54 -0400 | [diff] [blame] | 290 | If the destination is an existing directory, then *src* is moved inside that |
| 291 | directory. If the destination already exists but is not a directory, it may |
| 292 | be overwritten depending on :func:`os.rename` semantics. |
Éric Araujo | 14382dc | 2011-07-28 22:49:11 +0200 | [diff] [blame] | 293 | |
| 294 | If the destination is on the current filesystem, then :func:`os.rename` is |
Senthil Kumaran | 7f728c1 | 2012-02-13 23:30:47 +0800 | [diff] [blame] | 295 | used. Otherwise, *src* is copied (using :func:`shutil.copy2`) to *dst* and |
Senthil Kumaran | 1fd6482 | 2012-02-13 23:35:44 +0800 | [diff] [blame] | 296 | then removed. In case of symlinks, a new symlink pointing to the target of |
| 297 | *src* will be created in or as *dst* and *src* will be removed. |
Antoine Pitrou | 0a08d7a | 2012-01-06 20:16:19 +0100 | [diff] [blame] | 298 | |
| 299 | .. versionchanged:: 3.3 |
| 300 | Added explicit symlink handling for foreign filesystems, thus adapting |
| 301 | it to the behavior of GNU's :program:`mv`. |
Larry Hastings | 7aa2c8b | 2012-07-15 16:58:29 -0700 | [diff] [blame] | 302 | Now returns *dst*. |
Brian Curtin | 066dacf | 2012-06-19 10:03:05 -0500 | [diff] [blame] | 303 | |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 304 | .. function:: disk_usage(path) |
| 305 | |
Éric Araujo | e4d5b8e | 2011-08-08 16:51:11 +0200 | [diff] [blame] | 306 | Return disk usage statistics about the given path as a :term:`named tuple` |
| 307 | with the attributes *total*, *used* and *free*, which are the amount of |
| 308 | total, used and free space, in bytes. |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 309 | |
| 310 | .. versionadded:: 3.3 |
| 311 | |
| 312 | Availability: Unix, Windows. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 313 | |
Sandro Tosi | d902a14 | 2011-08-22 23:28:27 +0200 | [diff] [blame] | 314 | .. function:: chown(path, user=None, group=None) |
| 315 | |
| 316 | Change owner *user* and/or *group* of the given *path*. |
| 317 | |
| 318 | *user* can be a system user name or a uid; the same applies to *group*. At |
| 319 | least one argument is required. |
| 320 | |
| 321 | See also :func:`os.chown`, the underlying function. |
| 322 | |
| 323 | Availability: Unix. |
| 324 | |
| 325 | .. versionadded:: 3.3 |
| 326 | |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 327 | |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 328 | .. function:: which(cmd, mode=os.F_OK | os.X_OK, path=None) |
| 329 | |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 330 | Return the path to an executable which would be run if the given *cmd* was |
| 331 | called. If no *cmd* would be called, return ``None``. |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 332 | |
| 333 | *mode* is a permission mask passed a to :func:`os.access`, by default |
| 334 | determining if the file exists and executable. |
| 335 | |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 336 | When no *path* is specified, the results of :func:`os.environ` are used, |
| 337 | returning either the "PATH" value or a fallback of :attr:`os.defpath`. |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 338 | |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 339 | On Windows, the current directory is always prepended to the *path* whether |
| 340 | or not you use the default or provide your own, which is the behavior the |
Senthil Kumaran | b4760ef | 2015-06-14 17:35:37 -0700 | [diff] [blame] | 341 | command shell uses when finding executables. Additionally, when finding the |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 342 | *cmd* in the *path*, the ``PATHEXT`` environment variable is checked. For |
| 343 | example, if you call ``shutil.which("python")``, :func:`which` will search |
| 344 | ``PATHEXT`` to know that it should look for ``python.exe`` within the *path* |
| 345 | directories. For example, on Windows:: |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 346 | |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 347 | >>> shutil.which("python") |
Serhiy Storchaka | 80c88f4 | 2013-01-22 10:31:36 +0200 | [diff] [blame] | 348 | 'C:\\Python33\\python.EXE' |
Brian Curtin | c57a345 | 2012-06-22 16:00:30 -0500 | [diff] [blame] | 349 | |
| 350 | .. versionadded:: 3.3 |
Sandro Tosi | d902a14 | 2011-08-22 23:28:27 +0200 | [diff] [blame] | 351 | |
Georg Brandl | 4a7e25f | 2012-06-24 17:37:07 +0200 | [diff] [blame] | 352 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 353 | .. exception:: Error |
| 354 | |
Éric Araujo | 14382dc | 2011-07-28 22:49:11 +0200 | [diff] [blame] | 355 | This exception collects exceptions that are raised during a multi-file |
| 356 | operation. For :func:`copytree`, the exception argument is a list of 3-tuples |
| 357 | (*srcname*, *dstname*, *exception*). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 358 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 359 | |
Éric Araujo | f2fbb9c | 2012-01-16 16:55:55 +0100 | [diff] [blame] | 360 | .. _shutil-copytree-example: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 361 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 362 | copytree example |
Georg Brandl | 03b9ad0 | 2012-06-24 18:09:40 +0200 | [diff] [blame] | 363 | ~~~~~~~~~~~~~~~~ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 364 | |
| 365 | This example is the implementation of the :func:`copytree` function, described |
| 366 | above, with the docstring omitted. It demonstrates many of the other functions |
| 367 | provided by this module. :: |
| 368 | |
| 369 | def copytree(src, dst, symlinks=False): |
| 370 | names = os.listdir(src) |
| 371 | os.makedirs(dst) |
| 372 | errors = [] |
| 373 | for name in names: |
| 374 | srcname = os.path.join(src, name) |
| 375 | dstname = os.path.join(dst, name) |
| 376 | try: |
| 377 | if symlinks and os.path.islink(srcname): |
| 378 | linkto = os.readlink(srcname) |
| 379 | os.symlink(linkto, dstname) |
| 380 | elif os.path.isdir(srcname): |
| 381 | copytree(srcname, dstname, symlinks) |
| 382 | else: |
| 383 | copy2(srcname, dstname) |
| 384 | # XXX What about devices, sockets etc.? |
Andrew Svetlov | 618c2e1 | 2012-12-15 22:59:24 +0200 | [diff] [blame] | 385 | except OSError as why: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 386 | errors.append((srcname, dstname, str(why))) |
| 387 | # catch the Error from the recursive copytree so that we can |
| 388 | # continue with other files |
| 389 | except Error as err: |
| 390 | errors.extend(err.args[0]) |
| 391 | try: |
| 392 | copystat(src, dst) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 393 | except OSError as why: |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 394 | # can't copy file access times on Windows |
| 395 | if why.winerror is None: |
| 396 | errors.extend((src, dst, str(why))) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 397 | if errors: |
Collin Winter | c79461b | 2007-09-01 23:34:30 +0000 | [diff] [blame] | 398 | raise Error(errors) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 399 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 400 | Another example that uses the :func:`ignore_patterns` helper:: |
| 401 | |
| 402 | from shutil import copytree, ignore_patterns |
| 403 | |
| 404 | copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*')) |
| 405 | |
| 406 | This will copy everything except ``.pyc`` files and files or directories whose |
| 407 | name starts with ``tmp``. |
| 408 | |
| 409 | Another example that uses the *ignore* argument to add a logging call:: |
| 410 | |
| 411 | from shutil import copytree |
| 412 | import logging |
| 413 | |
| 414 | def _logpath(path, names): |
| 415 | logging.info('Working in %s' % path) |
| 416 | return [] # nothing will be ignored |
| 417 | |
| 418 | copytree(source, destination, ignore=_logpath) |
| 419 | |
| 420 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 421 | .. _archiving-operations: |
| 422 | |
| 423 | Archiving operations |
| 424 | -------------------- |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 425 | |
Georg Brandl | 03b9ad0 | 2012-06-24 18:09:40 +0200 | [diff] [blame] | 426 | .. versionadded:: 3.2 |
| 427 | |
Éric Araujo | f2fbb9c | 2012-01-16 16:55:55 +0100 | [diff] [blame] | 428 | High-level utilities to create and read compressed and archived files are also |
| 429 | provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules. |
| 430 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 431 | .. function:: make_archive(base_name, format, [root_dir, [base_dir, [verbose, [dry_run, [owner, [group, [logger]]]]]]]) |
| 432 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 433 | Create an archive file (such as zip or tar) and return its name. |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 434 | |
| 435 | *base_name* is the name of the file to create, including the path, minus |
| 436 | any format-specific extension. *format* is the archive format: one of |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 437 | "zip", "tar", "bztar" (if the :mod:`bz2` module is available) or "gztar". |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 438 | |
| 439 | *root_dir* is a directory that will be the root directory of the |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 440 | archive; for example, we typically chdir into *root_dir* before creating the |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 441 | archive. |
| 442 | |
| 443 | *base_dir* is the directory where we start archiving from; |
Ezio Melotti | cb999a3 | 2010-04-20 11:26:51 +0000 | [diff] [blame] | 444 | i.e. *base_dir* will be the common prefix of all files and |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 445 | directories in the archive. |
| 446 | |
| 447 | *root_dir* and *base_dir* both default to the current directory. |
| 448 | |
Georg Brandl | 9b1b0e5 | 2014-10-31 10:02:40 +0100 | [diff] [blame] | 449 | If *dry_run* is true, no archive is created, but the operations that would be |
| 450 | executed are logged to *logger*. |
| 451 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 452 | *owner* and *group* are used when creating a tar archive. By default, |
| 453 | uses the current owner and group. |
| 454 | |
Éric Araujo | 06c42a3 | 2011-11-07 17:31:07 +0100 | [diff] [blame] | 455 | *logger* must be an object compatible with :pep:`282`, usually an instance of |
| 456 | :class:`logging.Logger`. |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 457 | |
Georg Brandl | 36ac510 | 2014-10-31 10:54:06 +0100 | [diff] [blame] | 458 | The *verbose* argument is unused and deprecated. |
Georg Brandl | 9b1b0e5 | 2014-10-31 10:02:40 +0100 | [diff] [blame] | 459 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 460 | |
| 461 | .. function:: get_archive_formats() |
| 462 | |
Éric Araujo | 14382dc | 2011-07-28 22:49:11 +0200 | [diff] [blame] | 463 | Return a list of supported formats for archiving. |
Martin Panter | d21e0b5 | 2015-10-10 10:36:22 +0000 | [diff] [blame^] | 464 | Each element of the returned sequence is a tuple ``(name, description)``. |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 465 | |
| 466 | By default :mod:`shutil` provides these formats: |
| 467 | |
| 468 | - *gztar*: gzip'ed tar-file |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 469 | - *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available.) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 470 | - *tar*: uncompressed tar file |
| 471 | - *zip*: ZIP file |
| 472 | |
| 473 | You can register new formats or provide your own archiver for any existing |
| 474 | formats, by using :func:`register_archive_format`. |
| 475 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 476 | |
| 477 | .. function:: register_archive_format(name, function, [extra_args, [description]]) |
| 478 | |
Georg Brandl | 9b1b0e5 | 2014-10-31 10:02:40 +0100 | [diff] [blame] | 479 | Register an archiver for the format *name*. |
| 480 | |
| 481 | *function* is the callable that will be used to unpack archives. The callable |
| 482 | will receive the *base_name* of the file to create, followed by the |
| 483 | *base_dir* (which defaults to :data:`os.curdir`) to start archiving from. |
| 484 | Further arguments are passed as keyword arguments: *owner*, *group*, |
| 485 | *dry_run* and *logger* (as passed in :func:`make_archive`). |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 486 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 487 | If given, *extra_args* is a sequence of ``(name, value)`` pairs that will be |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 488 | used as extra keywords arguments when the archiver callable is used. |
| 489 | |
| 490 | *description* is used by :func:`get_archive_formats` which returns the |
Georg Brandl | 9b1b0e5 | 2014-10-31 10:02:40 +0100 | [diff] [blame] | 491 | list of archivers. Defaults to an empty string. |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 492 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 493 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 494 | .. function:: unregister_archive_format(name) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 495 | |
| 496 | Remove the archive format *name* from the list of supported formats. |
| 497 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 498 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 499 | .. function:: unpack_archive(filename[, extract_dir[, format]]) |
| 500 | |
| 501 | Unpack an archive. *filename* is the full path of the archive. |
| 502 | |
| 503 | *extract_dir* is the name of the target directory where the archive is |
| 504 | unpacked. If not provided, the current working directory is used. |
| 505 | |
| 506 | *format* is the archive format: one of "zip", "tar", or "gztar". Or any |
| 507 | other format registered with :func:`register_unpack_format`. If not |
| 508 | provided, :func:`unpack_archive` will use the archive file name extension |
| 509 | and see if an unpacker was registered for that extension. In case none is |
| 510 | found, a :exc:`ValueError` is raised. |
| 511 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 512 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 513 | .. function:: register_unpack_format(name, extensions, function[, extra_args[, description]]) |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 514 | |
| 515 | Registers an unpack format. *name* is the name of the format and |
| 516 | *extensions* is a list of extensions corresponding to the format, like |
| 517 | ``.zip`` for Zip files. |
| 518 | |
| 519 | *function* is the callable that will be used to unpack archives. The |
| 520 | callable will receive the path of the archive, followed by the directory |
| 521 | the archive must be extracted to. |
| 522 | |
| 523 | When provided, *extra_args* is a sequence of ``(name, value)`` tuples that |
| 524 | will be passed as keywords arguments to the callable. |
| 525 | |
| 526 | *description* can be provided to describe the format, and will be returned |
| 527 | by the :func:`get_unpack_formats` function. |
| 528 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 529 | |
| 530 | .. function:: unregister_unpack_format(name) |
| 531 | |
| 532 | Unregister an unpack format. *name* is the name of the format. |
| 533 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 534 | |
| 535 | .. function:: get_unpack_formats() |
| 536 | |
| 537 | Return a list of all registered formats for unpacking. |
| 538 | Each element of the returned sequence is a tuple |
| 539 | ``(name, extensions, description)``. |
| 540 | |
| 541 | By default :mod:`shutil` provides these formats: |
| 542 | |
| 543 | - *gztar*: gzip'ed tar-file |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 544 | - *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available.) |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 545 | - *tar*: uncompressed tar file |
| 546 | - *zip*: ZIP file |
| 547 | |
| 548 | You can register new formats or provide your own unpacker for any existing |
| 549 | formats, by using :func:`register_unpack_format`. |
| 550 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 551 | |
Éric Araujo | f2fbb9c | 2012-01-16 16:55:55 +0100 | [diff] [blame] | 552 | .. _shutil-archiving-example: |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 553 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 554 | Archiving example |
Georg Brandl | 03b9ad0 | 2012-06-24 18:09:40 +0200 | [diff] [blame] | 555 | ~~~~~~~~~~~~~~~~~ |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 556 | |
| 557 | In this example, we create a gzip'ed tar-file archive containing all files |
| 558 | found in the :file:`.ssh` directory of the user:: |
| 559 | |
| 560 | >>> from shutil import make_archive |
| 561 | >>> import os |
| 562 | >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) |
| 563 | >>> root_dir = os.path.expanduser(os.path.join('~', '.ssh')) |
| 564 | >>> make_archive(archive_name, 'gztar', root_dir) |
| 565 | '/Users/tarek/myarchive.tar.gz' |
| 566 | |
| 567 | The resulting archive contains:: |
| 568 | |
| 569 | $ tar -tzvf /Users/tarek/myarchive.tar.gz |
| 570 | drwx------ tarek/staff 0 2010-02-01 16:23:40 ./ |
| 571 | -rw-r--r-- tarek/staff 609 2008-06-09 13:26:54 ./authorized_keys |
| 572 | -rwxr-xr-x tarek/staff 65 2008-06-09 13:26:54 ./config |
| 573 | -rwx------ tarek/staff 668 2008-06-09 13:26:54 ./id_dsa |
| 574 | -rwxr-xr-x tarek/staff 609 2008-06-09 13:26:54 ./id_dsa.pub |
| 575 | -rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa |
| 576 | -rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub |
| 577 | -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts |
Antoine Pitrou | bcf2b59 | 2012-02-08 23:28:36 +0100 | [diff] [blame] | 578 | |
| 579 | |
| 580 | Querying the size of the output terminal |
| 581 | ---------------------------------------- |
| 582 | |
| 583 | .. versionadded:: 3.3 |
| 584 | |
| 585 | .. function:: get_terminal_size(fallback=(columns, lines)) |
| 586 | |
| 587 | Get the size of the terminal window. |
| 588 | |
| 589 | For each of the two dimensions, the environment variable, ``COLUMNS`` |
| 590 | and ``LINES`` respectively, is checked. If the variable is defined and |
| 591 | the value is a positive integer, it is used. |
| 592 | |
| 593 | When ``COLUMNS`` or ``LINES`` is not defined, which is the common case, |
| 594 | the terminal connected to :data:`sys.__stdout__` is queried |
| 595 | by invoking :func:`os.get_terminal_size`. |
| 596 | |
| 597 | If the terminal size cannot be successfully queried, either because |
| 598 | the system doesn't support querying, or because we are not |
| 599 | connected to a terminal, the value given in ``fallback`` parameter |
| 600 | is used. ``fallback`` defaults to ``(80, 24)`` which is the default |
| 601 | size used by many terminal emulators. |
| 602 | |
| 603 | The value returned is a named tuple of type :class:`os.terminal_size`. |
| 604 | |
| 605 | See also: The Single UNIX Specification, Version 2, |
| 606 | `Other Environment Variables`_. |
| 607 | |
| 608 | .. _`Other Environment Variables`: |
| 609 | http://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003 |
| 610 | |