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 | |
| 24 | Even the higher-level file copying functions (:func:`copy`, :func:`copy2`) |
Raymond Hettinger | 1048094 | 2011-01-10 03:26:08 +0000 | [diff] [blame] | 25 | 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 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 34 | Directory and files operations |
| 35 | ------------------------------ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 36 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 37 | .. function:: copyfileobj(fsrc, fdst[, length]) |
| 38 | |
| 39 | Copy the contents of the file-like object *fsrc* to the file-like object *fdst*. |
| 40 | The integer *length*, if given, is the buffer size. In particular, a negative |
| 41 | *length* value means to copy the data without looping over the source data in |
| 42 | chunks; by default the data is read in chunks to avoid uncontrolled memory |
| 43 | consumption. Note that if the current file position of the *fsrc* object is not |
| 44 | 0, only the contents from the current file position to the end of the file will |
| 45 | be copied. |
| 46 | |
| 47 | |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 48 | .. function:: copyfile(src, dst) |
| 49 | |
| 50 | Copy the contents (no metadata) of the file named *src* to a file named *dst*. |
| 51 | *dst* must be the complete target file name; look at :func:`copy` for a copy that |
Georg Brandl | af265f4 | 2008-12-07 15:06:20 +0000 | [diff] [blame] | 52 | accepts a target directory path. If *src* and *dst* are the same files, |
| 53 | :exc:`Error` is raised. |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 54 | The destination location must be writable; otherwise, an :exc:`IOError` exception |
| 55 | will be raised. If *dst* already exists, it will be replaced. Special files |
| 56 | such as character or block devices and pipes cannot be copied with this |
| 57 | function. *src* and *dst* are path names given as strings. |
| 58 | |
| 59 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 60 | .. function:: copymode(src, dst) |
| 61 | |
| 62 | Copy the permission bits from *src* to *dst*. The file contents, owner, and |
| 63 | group are unaffected. *src* and *dst* are path names given as strings. |
| 64 | |
| 65 | |
| 66 | .. function:: copystat(src, dst) |
| 67 | |
| 68 | Copy the permission bits, last access time, last modification time, and flags |
| 69 | from *src* to *dst*. The file contents, owner, and group are unaffected. *src* |
| 70 | and *dst* are path names given as strings. |
| 71 | |
| 72 | |
| 73 | .. function:: copy(src, dst) |
| 74 | |
| 75 | Copy the file *src* to the file or directory *dst*. If *dst* is a directory, a |
| 76 | file with the same basename as *src* is created (or overwritten) in the |
| 77 | directory specified. Permission bits are copied. *src* and *dst* are path |
| 78 | names given as strings. |
| 79 | |
| 80 | |
| 81 | .. function:: copy2(src, dst) |
| 82 | |
Alexandre Vassalotti | bee3253 | 2008-05-16 18:15:12 +0000 | [diff] [blame] | 83 | Similar to :func:`copy`, but metadata is copied as well -- in fact, this is just |
| 84 | :func:`copy` followed by :func:`copystat`. This is similar to the |
| 85 | Unix command :program:`cp -p`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 86 | |
| 87 | |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 88 | .. function:: ignore_patterns(\*patterns) |
| 89 | |
| 90 | This factory function creates a function that can be used as a callable for |
| 91 | :func:`copytree`\'s *ignore* argument, ignoring files and directories that |
| 92 | match one of the glob-style *patterns* provided. See the example below. |
| 93 | |
| 94 | |
Ezio Melotti | cb999a3 | 2010-04-20 11:26:51 +0000 | [diff] [blame] | 95 | .. 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] | 96 | |
| 97 | Recursively copy an entire directory tree rooted at *src*. The destination |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 98 | directory, named by *dst*, must not already exist; it will be created as well |
| 99 | as missing parent directories. Permissions and times of directories are |
| 100 | copied with :func:`copystat`, individual files are copied using |
| 101 | :func:`copy2`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 102 | |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 103 | If *symlinks* is true, symbolic links in the source tree are represented as |
| 104 | symbolic links in the new tree; if false or omitted, the contents of the |
| 105 | linked files are copied to the new tree. |
| 106 | |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 107 | When *symlinks* is false, if the file pointed by the symlink doesn't |
| 108 | exist, a exception will be added in the list of errors raised in |
| 109 | a :exc:`Error` exception at the end of the copy process. |
| 110 | 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] | 111 | want to silence this exception. Notice that this option has no effect |
| 112 | on platforms that don't support :func:`os.symlink`. |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 113 | |
Georg Brandl | 86b2fb9 | 2008-07-16 03:43:04 +0000 | [diff] [blame] | 114 | If *ignore* is given, it must be a callable that will receive as its |
| 115 | arguments the directory being visited by :func:`copytree`, and a list of its |
| 116 | contents, as returned by :func:`os.listdir`. Since :func:`copytree` is |
| 117 | called recursively, the *ignore* callable will be called once for each |
| 118 | directory that is copied. The callable must return a sequence of directory |
| 119 | and file names relative to the current directory (i.e. a subset of the items |
| 120 | in its second argument); these names will then be ignored in the copy |
| 121 | process. :func:`ignore_patterns` can be used to create such a callable that |
| 122 | ignores names based on glob-style patterns. |
| 123 | |
| 124 | If exception(s) occur, an :exc:`Error` is raised with a list of reasons. |
| 125 | |
Tarek Ziadé | 5340db3 | 2010-04-19 22:30:51 +0000 | [diff] [blame] | 126 | If *copy_function* is given, it must be a callable that will be used |
| 127 | to copy each file. It will be called with the source path and the |
| 128 | destination path as arguments. By default, :func:`copy2` is used, but any |
| 129 | function that supports the same signature (like :func:`copy`) can be used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 130 | |
Tarek Ziadé | 5340db3 | 2010-04-19 22:30:51 +0000 | [diff] [blame] | 131 | .. versionchanged:: 3.2 |
| 132 | Added the *copy_function* argument to be able to provide a custom copy |
| 133 | function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 134 | |
Ezio Melotti | cb999a3 | 2010-04-20 11:26:51 +0000 | [diff] [blame] | 135 | .. versionchanged:: 3.2 |
Tarek Ziadé | fb43751 | 2010-04-20 08:57:33 +0000 | [diff] [blame] | 136 | Added the *ignore_dangling_symlinks* argument to silent dangling symlinks |
| 137 | errors when *symlinks* is false. |
| 138 | |
| 139 | |
Georg Brandl | 1824415 | 2009-09-02 20:34:52 +0000 | [diff] [blame] | 140 | .. function:: rmtree(path, ignore_errors=False, onerror=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 141 | |
| 142 | .. index:: single: directory; deleting |
| 143 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 144 | Delete an entire directory tree; *path* must point to a directory (but not a |
| 145 | symbolic link to a directory). If *ignore_errors* is true, errors resulting |
| 146 | from failed removals will be ignored; if false or omitted, such errors are |
| 147 | handled by calling a handler specified by *onerror* or, if that is omitted, |
| 148 | they raise an exception. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 149 | |
Christian Heimes | 9bd667a | 2008-01-20 15:14:11 +0000 | [diff] [blame] | 150 | If *onerror* is provided, it must be a callable that accepts three |
| 151 | parameters: *function*, *path*, and *excinfo*. The first parameter, |
| 152 | *function*, is the function which raised the exception; it will be |
| 153 | :func:`os.path.islink`, :func:`os.listdir`, :func:`os.remove` or |
| 154 | :func:`os.rmdir`. The second parameter, *path*, will be the path name passed |
| 155 | to *function*. The third parameter, *excinfo*, will be the exception |
| 156 | information return by :func:`sys.exc_info`. Exceptions raised by *onerror* |
| 157 | will not be caught. |
| 158 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 159 | |
| 160 | .. function:: move(src, dst) |
| 161 | |
| 162 | Recursively move a file or directory to another location. |
| 163 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 164 | If the destination is on the current filesystem, then simply use rename. |
Benjamin Peterson | 6ebe78f | 2008-12-21 00:06:59 +0000 | [diff] [blame] | 165 | Otherwise, copy src (with :func:`copy2`) to the dst and then remove src. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 166 | |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 167 | .. function:: disk_usage(path) |
| 168 | |
| 169 | Return disk usage statistics about the given path as a namedtuple including |
| 170 | total, used and free space expressed in bytes. |
| 171 | |
| 172 | .. versionadded:: 3.3 |
| 173 | |
| 174 | Availability: Unix, Windows. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 175 | |
| 176 | .. exception:: Error |
| 177 | |
Christian Heimes | 7f04431 | 2008-01-06 17:05:40 +0000 | [diff] [blame] | 178 | This exception collects exceptions that raised during a multi-file operation. For |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 179 | :func:`copytree`, the exception argument is a list of 3-tuples (*srcname*, |
| 180 | *dstname*, *exception*). |
| 181 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 182 | |
| 183 | .. _shutil-example: |
| 184 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 185 | copytree example |
| 186 | :::::::::::::::: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 187 | |
| 188 | This example is the implementation of the :func:`copytree` function, described |
| 189 | above, with the docstring omitted. It demonstrates many of the other functions |
| 190 | provided by this module. :: |
| 191 | |
| 192 | def copytree(src, dst, symlinks=False): |
| 193 | names = os.listdir(src) |
| 194 | os.makedirs(dst) |
| 195 | errors = [] |
| 196 | for name in names: |
| 197 | srcname = os.path.join(src, name) |
| 198 | dstname = os.path.join(dst, name) |
| 199 | try: |
| 200 | if symlinks and os.path.islink(srcname): |
| 201 | linkto = os.readlink(srcname) |
| 202 | os.symlink(linkto, dstname) |
| 203 | elif os.path.isdir(srcname): |
| 204 | copytree(srcname, dstname, symlinks) |
| 205 | else: |
| 206 | copy2(srcname, dstname) |
| 207 | # XXX What about devices, sockets etc.? |
| 208 | except (IOError, os.error) as why: |
| 209 | errors.append((srcname, dstname, str(why))) |
| 210 | # catch the Error from the recursive copytree so that we can |
| 211 | # continue with other files |
| 212 | except Error as err: |
| 213 | errors.extend(err.args[0]) |
| 214 | try: |
| 215 | copystat(src, dst) |
| 216 | except WindowsError: |
| 217 | # can't copy file access times on Windows |
| 218 | pass |
| 219 | except OSError as why: |
| 220 | errors.extend((src, dst, str(why))) |
| 221 | if errors: |
Collin Winter | c79461b | 2007-09-01 23:34:30 +0000 | [diff] [blame] | 222 | raise Error(errors) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 223 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 224 | Another example that uses the :func:`ignore_patterns` helper:: |
| 225 | |
| 226 | from shutil import copytree, ignore_patterns |
| 227 | |
| 228 | copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*')) |
| 229 | |
| 230 | This will copy everything except ``.pyc`` files and files or directories whose |
| 231 | name starts with ``tmp``. |
| 232 | |
| 233 | Another example that uses the *ignore* argument to add a logging call:: |
| 234 | |
| 235 | from shutil import copytree |
| 236 | import logging |
| 237 | |
| 238 | def _logpath(path, names): |
| 239 | logging.info('Working in %s' % path) |
| 240 | return [] # nothing will be ignored |
| 241 | |
| 242 | copytree(source, destination, ignore=_logpath) |
| 243 | |
| 244 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 245 | .. _archiving-operations: |
| 246 | |
| 247 | Archiving operations |
| 248 | -------------------- |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 249 | |
| 250 | .. function:: make_archive(base_name, format, [root_dir, [base_dir, [verbose, [dry_run, [owner, [group, [logger]]]]]]]) |
| 251 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 252 | 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] | 253 | |
| 254 | *base_name* is the name of the file to create, including the path, minus |
| 255 | any format-specific extension. *format* is the archive format: one of |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 256 | "zip", "tar", "bztar" (if the :mod:`bz2` module is available) or "gztar". |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 257 | |
| 258 | *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] | 259 | archive; for example, we typically chdir into *root_dir* before creating the |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 260 | archive. |
| 261 | |
| 262 | *base_dir* is the directory where we start archiving from; |
Ezio Melotti | cb999a3 | 2010-04-20 11:26:51 +0000 | [diff] [blame] | 263 | 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] | 264 | directories in the archive. |
| 265 | |
| 266 | *root_dir* and *base_dir* both default to the current directory. |
| 267 | |
| 268 | *owner* and *group* are used when creating a tar archive. By default, |
| 269 | uses the current owner and group. |
| 270 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 271 | *logger* is an instance of :class:`logging.Logger`. |
| 272 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 273 | .. versionadded:: 3.2 |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 274 | |
| 275 | |
| 276 | .. function:: get_archive_formats() |
| 277 | |
| 278 | Returns a list of supported formats for archiving. |
| 279 | Each element of the returned sequence is a tuple ``(name, description)`` |
| 280 | |
| 281 | By default :mod:`shutil` provides these formats: |
| 282 | |
| 283 | - *gztar*: gzip'ed tar-file |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 284 | - *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available.) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 285 | - *tar*: uncompressed tar file |
| 286 | - *zip*: ZIP file |
| 287 | |
| 288 | You can register new formats or provide your own archiver for any existing |
| 289 | formats, by using :func:`register_archive_format`. |
| 290 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 291 | .. versionadded:: 3.2 |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 292 | |
| 293 | |
| 294 | .. function:: register_archive_format(name, function, [extra_args, [description]]) |
| 295 | |
| 296 | Registers an archiver for the format *name*. *function* is a callable that |
| 297 | will be used to invoke the archiver. |
| 298 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 299 | 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] | 300 | used as extra keywords arguments when the archiver callable is used. |
| 301 | |
| 302 | *description* is used by :func:`get_archive_formats` which returns the |
| 303 | list of archivers. Defaults to an empty list. |
| 304 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 305 | .. versionadded:: 3.2 |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 306 | |
| 307 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 308 | .. function:: unregister_archive_format(name) |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 309 | |
| 310 | Remove the archive format *name* from the list of supported formats. |
| 311 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 312 | .. versionadded:: 3.2 |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 313 | |
| 314 | |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 315 | .. function:: unpack_archive(filename[, extract_dir[, format]]) |
| 316 | |
| 317 | Unpack an archive. *filename* is the full path of the archive. |
| 318 | |
| 319 | *extract_dir* is the name of the target directory where the archive is |
| 320 | unpacked. If not provided, the current working directory is used. |
| 321 | |
| 322 | *format* is the archive format: one of "zip", "tar", or "gztar". Or any |
| 323 | other format registered with :func:`register_unpack_format`. If not |
| 324 | provided, :func:`unpack_archive` will use the archive file name extension |
| 325 | and see if an unpacker was registered for that extension. In case none is |
| 326 | found, a :exc:`ValueError` is raised. |
| 327 | |
| 328 | .. versionadded:: 3.2 |
| 329 | |
| 330 | |
Raymond Hettinger | 0929b1f | 2011-01-23 11:29:08 +0000 | [diff] [blame] | 331 | .. function:: register_unpack_format(name, extensions, function[, extra_args[, description]]) |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 332 | |
| 333 | Registers an unpack format. *name* is the name of the format and |
| 334 | *extensions* is a list of extensions corresponding to the format, like |
| 335 | ``.zip`` for Zip files. |
| 336 | |
| 337 | *function* is the callable that will be used to unpack archives. The |
| 338 | callable will receive the path of the archive, followed by the directory |
| 339 | the archive must be extracted to. |
| 340 | |
| 341 | When provided, *extra_args* is a sequence of ``(name, value)`` tuples that |
| 342 | will be passed as keywords arguments to the callable. |
| 343 | |
| 344 | *description* can be provided to describe the format, and will be returned |
| 345 | by the :func:`get_unpack_formats` function. |
| 346 | |
| 347 | .. versionadded:: 3.2 |
| 348 | |
| 349 | |
| 350 | .. function:: unregister_unpack_format(name) |
| 351 | |
| 352 | Unregister an unpack format. *name* is the name of the format. |
| 353 | |
| 354 | .. versionadded:: 3.2 |
| 355 | |
| 356 | |
| 357 | .. function:: get_unpack_formats() |
| 358 | |
| 359 | Return a list of all registered formats for unpacking. |
| 360 | Each element of the returned sequence is a tuple |
| 361 | ``(name, extensions, description)``. |
| 362 | |
| 363 | By default :mod:`shutil` provides these formats: |
| 364 | |
| 365 | - *gztar*: gzip'ed tar-file |
Tarek Ziadé | ffa155a | 2010-04-29 13:34:35 +0000 | [diff] [blame] | 366 | - *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available.) |
Tarek Ziadé | 6ac9172 | 2010-04-28 17:51:36 +0000 | [diff] [blame] | 367 | - *tar*: uncompressed tar file |
| 368 | - *zip*: ZIP file |
| 369 | |
| 370 | You can register new formats or provide your own unpacker for any existing |
| 371 | formats, by using :func:`register_unpack_format`. |
| 372 | |
| 373 | .. versionadded:: 3.2 |
| 374 | |
| 375 | |
| 376 | |
Tarek Ziadé | 396fad7 | 2010-02-23 05:30:31 +0000 | [diff] [blame] | 377 | Archiving example |
| 378 | ::::::::::::::::: |
| 379 | |
| 380 | In this example, we create a gzip'ed tar-file archive containing all files |
| 381 | found in the :file:`.ssh` directory of the user:: |
| 382 | |
| 383 | >>> from shutil import make_archive |
| 384 | >>> import os |
| 385 | >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive')) |
| 386 | >>> root_dir = os.path.expanduser(os.path.join('~', '.ssh')) |
| 387 | >>> make_archive(archive_name, 'gztar', root_dir) |
| 388 | '/Users/tarek/myarchive.tar.gz' |
| 389 | |
| 390 | The resulting archive contains:: |
| 391 | |
| 392 | $ tar -tzvf /Users/tarek/myarchive.tar.gz |
| 393 | drwx------ tarek/staff 0 2010-02-01 16:23:40 ./ |
| 394 | -rw-r--r-- tarek/staff 609 2008-06-09 13:26:54 ./authorized_keys |
| 395 | -rwxr-xr-x tarek/staff 65 2008-06-09 13:26:54 ./config |
| 396 | -rwx------ tarek/staff 668 2008-06-09 13:26:54 ./id_dsa |
| 397 | -rwxr-xr-x tarek/staff 609 2008-06-09 13:26:54 ./id_dsa.pub |
| 398 | -rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa |
| 399 | -rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub |
| 400 | -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts |
| 401 | |
| 402 | |