6.21 shutil -- High-level file operations
Keywords: lib

# 6.21 `shutil` -- High-level file operations

The `shutil` module offers a number of high-level operations on files and collections of files. In particular, functions are provided which support file copying and removal.

Caveat: On MacOS, the resource fork and other metadata are not used. For file copies, this means that resources will be lost and file type and creator codes will not be correct.

`copyfile` (src, dst)
  Copy the contents of src to dst. If dst exists, it will be replaced, otherwise it will be created.

`copyfileobj` (fsrc, fdst[, length])
  Copy the contents of the file-like object fsrc to the file-like object fdst. The integer length, if given, is the buffer size. In particular, a negative length value means to copy the data without looping over the source data in chunks; by default the data is read in chunks to avoid uncontrolled memory consumption.

`copymode` (src, dst)
  Copy the permission bits from src to dst. The file contents, owner, and group are unaffected.

`copystat` (src, dst)
  Copy the permission bits, last access time, and last modification time from src to dst. The file contents, owner, and group are unaffected.

`copy` (src, dst)
  Copy the file src to the file or directory dst. If dst is a directory, a file with the same basename as src is created (or overwritten) in the directory specified. Permission bits are copied.

`copy2` (src, dst)
  Similar to `copy()`, but last access time and last modification time are copied as well. This is similar to the Unix command cp -p.

`copytree` (src, dst[, symlinks])
  Recursively copy an entire directory tree rooted at src. The destination directory, named by dst, must not already exist; it will be created. Individual files are copied using `copy2()`. If symlinks is true, symbolic links in the source tree are represented as symbolic links in the new tree; if false or omitted, the contents of the linked files are copied to the new tree. Errors are reported to standard output.

  The source code for this should be considered an example rather than a tool.

`rmtree` (path[, ignore_errors[, onerror]])
  Delete an entire directory tree. If ignore_errors is true, errors will be ignored; if false or omitted, errors are handled by calling a handler specified by onerror or raise an exception.

  If onerror is provided, it must be a callable that accepts three parameters: function, path, and excinfo. The first parameter, function, is the function which raised the exception; it will be `os.remove()` or `os.rmdir()`. The second parameter, path, will be the path name passed to function. The third parameter, excinfo, will be the exception information return by `sys.exc_info()`. Exceptions raised by onerror will not be caught.

Subsections

- 6.21.1 Example