Mr.Combet Webshell 🔥

Edit File Name : shutil.html

<!DOCTYPE html>

<title>shutil — High-level file operations &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
 <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
 
 <script src="../_static/documentation_options.js?v=2c828074"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.12.3 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Data Persistence" href="persistence.html" />
 <link rel="prev" title="linecache — Random access to text lines" href="linecache.html" />
 <link rel="canonical" href="https://docs.python.org/3/library/shutil.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <nav class="nav-content" role="navigation">
 <label for="menuToggler" class="toggler__label">
 
 </label>
 
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Python logo"/>
 </a>
 
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
 </svg>
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
 <input type="submit" value="Go"/>
 </form>
 
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label>
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">shutil</code> — High-level file operations</a><ul>
<li><a class="reference internal" href="#directory-and-files-operations">Directory and files operations</a><ul>
<li><a class="reference internal" href="#platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a></li>
<li><a class="reference internal" href="#copytree-example">copytree example</a></li>
<li><a class="reference internal" href="#rmtree-example">rmtree example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#archiving-operations">Archiving operations</a><ul>
<li><a class="reference internal" href="#archiving-example">Archiving example</a></li>
<li><a class="reference internal" href="#archiving-example-with-base-dir">Archiving example with base_dir</a></li>
</ul>
</li>
<li><a class="reference internal" href="#querying-the-size-of-the-output-terminal">Querying the size of the output terminal</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="linecache.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">linecache</code> — Random access to text lines</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="persistence.html"
 title="next chapter">Data Persistence</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/main/Doc/library/shutil.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </div>
</div>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="persistence.html" title="Data Persistence"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="linecache.html" title="linecache — Random access to text lines"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.12.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">shutil</code> — High-level file operations</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-shutil">
<h1><a class="reference internal" href="#module-shutil" title="shutil: High-level file operations, including copying."><code class="xref py py-mod docutils literal notranslate">shutil</code></a> — High-level file operations<a class="headerlink" href="#module-shutil" title="Link to this heading">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/shutil.py">Lib/shutil.py</a>
<hr class="docutils" id="index-0" />
The <a class="reference internal" href="#module-shutil" title="shutil: High-level file operations, including copying."><code class="xref py py-mod docutils literal notranslate">shutil</code></a> 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. For operations on individual files, see also the
<a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate">os</code></a> module.
<div class="admonition warning">
Warning
Even the higher-level file copying functions (<a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">shutil.copy()</code></a>,
<a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">shutil.copy2()</code></a>) cannot copy all file metadata.
On POSIX platforms, this means that file owner and group are lost as well
as ACLs. On Mac OS, the resource fork and other metadata are not used.
This means that resources will be lost and file type and creator codes will
not be correct. On Windows, file owners, ACLs and alternate data streams
are not copied.
</div>
<section id="directory-and-files-operations">
<h2>Directory and files operations<a class="headerlink" href="#directory-and-files-operations" title="Link to this heading">¶</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="shutil.copyfileobj">
shutil.copyfileobj(fsrc, fdst[, length])<a class="headerlink" href="#shutil.copyfileobj" title="Link to this definition">¶</a></dt>
<dd>Copy the contents of the <a class="reference internal" href="../glossary.html#term-file-object">file-like object</a> 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. Note that if the current file position of the fsrc object is not
0, only the contents from the current file position to the end of the file will
be copied.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.copyfile">
shutil.copyfile(src, dst, *, follow_symlinks=True)<a class="headerlink" href="#shutil.copyfile" title="Link to this definition">¶</a></dt>
<dd>Copy the contents (no metadata) of the file named src to a file named
dst and return dst in the most efficient way possible.
src and dst are <a class="reference internal" href="../glossary.html#term-path-like-object">path-like objects</a> or path names given as strings.
dst must be the complete target file name; look at <a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">copy()</code></a>
for a copy that accepts a target directory path. If src and dst
specify the same file, <a class="reference internal" href="#shutil.SameFileError" title="shutil.SameFileError"><code class="xref py py-exc docutils literal notranslate">SameFileError</code></a> is raised.
The destination location must be writable; otherwise, an <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a>
exception will be raised. If dst already exists, it will be replaced.
Special files such as character or block devices and pipes cannot be
copied with this function.
If follow_symlinks is false and src is a symbolic link,
a new symbolic link will be created instead of copying the
file src points to.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copyfile</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.3: <a class="reference internal" href="exceptions.html#IOError" title="IOError"><code class="xref py py-exc docutils literal notranslate">IOError</code></a> used to be raised instead of <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a>.
Added follow_symlinks argument.
Now returns dst.
</div>
<div class="versionchanged">
Changed in version 3.4: Raise <a class="reference internal" href="#shutil.SameFileError" title="shutil.SameFileError"><code class="xref py py-exc docutils literal notranslate">SameFileError</code></a> instead of <a class="reference internal" href="#shutil.Error" title="shutil.Error"><code class="xref py py-exc docutils literal notranslate">Error</code></a>. Since the former is
a subclass of the latter, this change is backward compatible.
</div>
<div class="versionchanged">
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to
copy the file more efficiently. See
<a class="reference internal" href="#shutil-platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a> section.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="shutil.SameFileError">
exception shutil.SameFileError<a class="headerlink" href="#shutil.SameFileError" title="Link to this definition">¶</a></dt>
<dd>This exception is raised if source and destination in <a class="reference internal" href="#shutil.copyfile" title="shutil.copyfile"><code class="xref py py-func docutils literal notranslate">copyfile()</code></a>
are the same file.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.copymode">
shutil.copymode(src, dst, *, follow_symlinks=True)<a class="headerlink" href="#shutil.copymode" title="Link to this definition">¶</a></dt>
<dd>Copy the permission bits from src to dst. The file contents, owner, and
group are unaffected. src and dst are <a class="reference internal" href="../glossary.html#term-path-like-object">path-like objects</a> or path names
given as strings.
If follow_symlinks is false, and both src and dst are symbolic links,
<a class="reference internal" href="#shutil.copymode" title="shutil.copymode"><code class="xref py py-func docutils literal notranslate">copymode()</code></a> will attempt to modify the mode of dst itself (rather
than the file it points to). This functionality is not available on every
platform; please see <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> for more information. If
<a class="reference internal" href="#shutil.copymode" title="shutil.copymode"><code class="xref py py-func docutils literal notranslate">copymode()</code></a> cannot modify symbolic links on the local platform, and it
is asked to do so, it will do nothing and return.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copymode</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.3: Added follow_symlinks argument.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.copystat">
shutil.copystat(src, dst, *, follow_symlinks=True)<a class="headerlink" href="#shutil.copystat" title="Link to this definition">¶</a></dt>
<dd>Copy the permission bits, last access time, last modification time, and
flags from src to dst. On Linux, <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> also copies the
“extended attributes” where possible. The file contents, owner, and
group are unaffected. src and dst are <a class="reference internal" href="../glossary.html#term-path-like-object">path-like objects</a> or path
names given as strings.
If follow_symlinks is false, and src and dst both
refer to symbolic links, <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> will operate on
the symbolic links themselves rather than the files the
symbolic links refer to—reading the information from the
src symbolic link, and writing the information to the
dst symbolic link.
<div class="admonition note">
Note
Not all platforms provide the ability to examine and
modify symbolic links. Python itself can tell you what
functionality is locally available.
<ul class="simple">
<li>If <code class="docutils literal notranslate">os.chmod in os.supports_follow_symlinks</code> is
<code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> can modify the permission
bits of a symbolic link.</li>
<li>If <code class="docutils literal notranslate">os.utime in os.supports_follow_symlinks</code> is
<code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> can modify the last access
and modification times of a symbolic link.</li>
<li>If <code class="docutils literal notranslate">os.chflags in os.supports_follow_symlinks</code> is
<code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> can modify the flags of
a symbolic link. (<code class="docutils literal notranslate">os.chflags</code> is not available on
all platforms.)</li>
</ul>
On platforms where some or all of this functionality
is unavailable, when asked to modify a symbolic link,
<a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> will copy everything it can.
<a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> never returns failure.
Please see <a class="reference internal" href="os.html#os.supports_follow_symlinks" title="os.supports_follow_symlinks"><code class="xref py py-data docutils literal notranslate">os.supports_follow_symlinks</code></a>
for more information.
</div>
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copystat</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.3: Added follow_symlinks argument and support for Linux extended attributes.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.copy">
shutil.copy(src, dst, *, follow_symlinks=True)<a class="headerlink" href="#shutil.copy" title="Link to this definition">¶</a></dt>
<dd>Copies the file src to the file or directory dst. src and dst
should be <a class="reference internal" href="../glossary.html#term-path-like-object">path-like objects</a> or strings. If
dst specifies a directory, the file will be copied into dst using the
base filename from src. If dst specifies a file that already exists,
it will be replaced. Returns the path to the newly created file.
If follow_symlinks is false, and src is a symbolic link,
dst will be created as a symbolic link. If follow_symlinks
is true and src is a symbolic link, dst will be a copy of
the file src refers to.
<a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">copy()</code></a> copies the file data and the file’s permission
mode (see <a class="reference internal" href="os.html#os.chmod" title="os.chmod"><code class="xref py py-func docutils literal notranslate">os.chmod()</code></a>). Other metadata, like the
file’s creation and modification times, is not preserved.
To preserve all file metadata from the original, use
<a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a> instead.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copyfile</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copymode</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.3: Added follow_symlinks argument.
Now returns path to the newly created file.
</div>
<div class="versionchanged">
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to
copy the file more efficiently. See
<a class="reference internal" href="#shutil-platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a> section.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.copy2">
shutil.copy2(src, dst, *, follow_symlinks=True)<a class="headerlink" href="#shutil.copy2" title="Link to this definition">¶</a></dt>
<dd>Identical to <a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">copy()</code></a> except that <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a>
also attempts to preserve file metadata.
When follow_symlinks is false, and src is a symbolic
link, <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a> attempts to copy all metadata from the
src symbolic link to the newly created dst symbolic link.
However, this functionality is not available on all platforms.
On platforms where some or all of this functionality is
unavailable, <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a> will preserve all the metadata
it can; <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a> never raises an exception because it
cannot preserve file metadata.
<a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a> uses <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> to copy the file metadata.
Please see <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a> for more information
about platform support for modifying symbolic link metadata.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copyfile</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copystat</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.3: Added follow_symlinks argument, try to copy extended
file system attributes too (currently Linux only).
Now returns path to the newly created file.
</div>
<div class="versionchanged">
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to
copy the file more efficiently. See
<a class="reference internal" href="#shutil-platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a> section.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.ignore_patterns">
shutil.ignore_patterns(*patterns)<a class="headerlink" href="#shutil.ignore_patterns" title="Link to this definition">¶</a></dt>
<dd>This factory function creates a function that can be used as a callable for
<a class="reference internal" href="#shutil.copytree" title="shutil.copytree"><code class="xref py py-func docutils literal notranslate">copytree()</code></a>'s ignore argument, ignoring files and directories that
match one of the glob-style patterns provided. See the example below.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.copytree">
shutil.copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)<a class="headerlink" href="#shutil.copytree" title="Link to this definition">¶</a></dt>
<dd>Recursively copy an entire directory tree rooted at src to a directory
named dst and return the destination directory. All intermediate
directories needed to contain dst will also be created by default.
Permissions and times of directories are copied with <a class="reference internal" href="#shutil.copystat" title="shutil.copystat"><code class="xref py py-func docutils literal notranslate">copystat()</code></a>,
individual files are copied using <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a>.
If symlinks is true, symbolic links in the source tree are represented as
symbolic links in the new tree and the metadata of the original links will
be copied as far as the platform allows; if false or omitted, the contents
and metadata of the linked files are copied to the new tree.
When symlinks is false, if the file pointed by the symlink doesn’t
exist, an exception will be added in the list of errors raised in
an <a class="reference internal" href="#shutil.Error" title="shutil.Error"><code class="xref py py-exc docutils literal notranslate">Error</code></a> exception at the end of the copy process.
You can set the optional ignore_dangling_symlinks flag to true if you
want to silence this exception. Notice that this option has no effect
on platforms that don’t support <a class="reference internal" href="os.html#os.symlink" title="os.symlink"><code class="xref py py-func docutils literal notranslate">os.symlink()</code></a>.
If ignore is given, it must be a callable that will receive as its
arguments the directory being visited by <a class="reference internal" href="#shutil.copytree" title="shutil.copytree"><code class="xref py py-func docutils literal notranslate">copytree()</code></a>, and a list of its
contents, as returned by <a class="reference internal" href="os.html#os.listdir" title="os.listdir"><code class="xref py py-func docutils literal notranslate">os.listdir()</code></a>. Since <a class="reference internal" href="#shutil.copytree" title="shutil.copytree"><code class="xref py py-func docutils literal notranslate">copytree()</code></a> is
called recursively, the ignore callable will be called once for each
directory that is copied. The callable must return a sequence of directory
and file names relative to the current directory (i.e. a subset of the items
in its second argument); these names will then be ignored in the copy
process. <a class="reference internal" href="#shutil.ignore_patterns" title="shutil.ignore_patterns"><code class="xref py py-func docutils literal notranslate">ignore_patterns()</code></a> can be used to create such a callable that
ignores names based on glob-style patterns.
If exception(s) occur, an <a class="reference internal" href="#shutil.Error" title="shutil.Error"><code class="xref py py-exc docutils literal notranslate">Error</code></a> is raised with a list of reasons.
If copy_function is given, it must be a callable that will be used to copy
each file. It will be called with the source path and the destination path
as arguments. By default, <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a> is used, but any function
that supports the same signature (like <a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">copy()</code></a>) can be used.
If dirs_exist_ok is false (the default) and dst already exists, a
<a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate">FileExistsError</code></a> is raised. If dirs_exist_ok is true, the copying
operation will continue if it encounters existing directories, and files
within the dst tree will be overwritten by corresponding files from the
src tree.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.copytree</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.2: Added the copy_function argument to be able to provide a custom copy
function.
Added the ignore_dangling_symlinks argument to silence dangling symlinks
errors when symlinks is false.
</div>
<div class="versionchanged">
Changed in version 3.3: Copy metadata when symlinks is false.
Now returns dst.
</div>
<div class="versionchanged">
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to
copy the file more efficiently. See
<a class="reference internal" href="#shutil-platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a> section.
</div>
<div class="versionchanged">
Changed in version 3.8: Added the dirs_exist_ok parameter.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.rmtree">
shutil.rmtree(path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None)<a class="headerlink" href="#shutil.rmtree" title="Link to this definition">¶</a></dt>
<dd>Delete an entire directory tree; path must point to a directory (but not a
symbolic link to a directory). If ignore_errors is true, errors resulting
from failed removals will be ignored; if false or omitted, such errors are
handled by calling a handler specified by onexc or onerror or, if both
are omitted, exceptions are propagated to the caller.
This function can support <a class="reference internal" href="os.html#dir-fd">paths relative to directory descriptors</a>.
<div class="admonition note">
Note
On platforms that support the necessary fd-based functions a symlink
attack resistant version of <a class="reference internal" href="#shutil.rmtree" title="shutil.rmtree"><code class="xref py py-func docutils literal notranslate">rmtree()</code></a> is used by default. On other
platforms, the <a class="reference internal" href="#shutil.rmtree" title="shutil.rmtree"><code class="xref py py-func docutils literal notranslate">rmtree()</code></a> implementation is susceptible to a symlink
attack: given proper timing and circumstances, attackers can manipulate
symlinks on the filesystem to delete files they wouldn’t be able to access
otherwise. Applications can use the <a class="reference internal" href="#shutil.rmtree.avoids_symlink_attacks" title="shutil.rmtree.avoids_symlink_attacks"><code class="xref py py-data docutils literal notranslate">rmtree.avoids_symlink_attacks</code></a>
function attribute to determine which case applies.
</div>
If onexc 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 depends on the platform and implementation. The second parameter,
path, will be the path name passed to function. The third parameter,
excinfo, is the exception that was raised. Exceptions raised by onexc
will not be caught.
The deprecated onerror is similar to onexc, except that the third
parameter it receives is the tuple returned from <a class="reference internal" href="sys.html#sys.exc_info" title="sys.exc_info"><code class="xref py py-func docutils literal notranslate">sys.exc_info()</code></a>.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.rmtree</code> with arguments <code class="docutils literal notranslate">path</code>, <code class="docutils literal notranslate">dir_fd</code>.
<div class="versionchanged">
Changed in version 3.3: Added a symlink attack resistant version that is used automatically
if platform supports fd-based functions.
</div>
<div class="versionchanged">
Changed in version 3.8: On Windows, will no longer delete the contents of a directory junction
before removing the junction.
</div>
<div class="versionchanged">
Changed in version 3.11: The dir_fd parameter.
</div>
<div class="versionchanged">
Changed in version 3.12: Added the onexc parameter, deprecated onerror.
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="shutil.rmtree.avoids_symlink_attacks">
rmtree.avoids_symlink_attacks<a class="headerlink" href="#shutil.rmtree.avoids_symlink_attacks" title="Link to this definition">¶</a></dt>
<dd>Indicates whether the current platform and implementation provides a
symlink attack resistant version of <a class="reference internal" href="#shutil.rmtree" title="shutil.rmtree"><code class="xref py py-func docutils literal notranslate">rmtree()</code></a>. Currently this is
only true for platforms supporting fd-based directory access functions.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.move">
shutil.move(src, dst, copy_function=copy2)<a class="headerlink" href="#shutil.move" title="Link to this definition">¶</a></dt>
<dd>Recursively move a file or directory (src) to another location and return
the destination.
If dst is an existing directory or a symlink to a directory, then src
is moved inside that directory. The destination path in that directory must
not already exist.
If dst already exists but is not a directory, it may be overwritten
depending on <a class="reference internal" href="os.html#os.rename" title="os.rename"><code class="xref py py-func docutils literal notranslate">os.rename()</code></a> semantics.
If the destination is on the current filesystem, then <a class="reference internal" href="os.html#os.rename" title="os.rename"><code class="xref py py-func docutils literal notranslate">os.rename()</code></a> is
used. Otherwise, src is copied to the destination using copy_function
and then removed. In case of symlinks, a new symlink pointing to the target
of src will be created as the destination and src will be removed.
If copy_function is given, it must be a callable that takes two arguments,
src and the destination, and will be used to copy src to the destination
if <a class="reference internal" href="os.html#os.rename" title="os.rename"><code class="xref py py-func docutils literal notranslate">os.rename()</code></a> cannot be used. If the source is a directory,
<a class="reference internal" href="#shutil.copytree" title="shutil.copytree"><code class="xref py py-func docutils literal notranslate">copytree()</code></a> is called, passing it the copy_function. The
default copy_function is <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a>. Using <a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">copy()</code></a> as the
copy_function allows the move to succeed when it is not possible to also
copy the metadata, at the expense of not copying any of the metadata.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.move</code> with arguments <code class="docutils literal notranslate">src</code>, <code class="docutils literal notranslate">dst</code>.
<div class="versionchanged">
Changed in version 3.3: Added explicit symlink handling for foreign filesystems, thus adapting
it to the behavior of GNU’s mv.
Now returns dst.
</div>
<div class="versionchanged">
Changed in version 3.5: Added the copy_function keyword argument.
</div>
<div class="versionchanged">
Changed in version 3.8: Platform-specific fast-copy syscalls may be used internally in order to
copy the file more efficiently. See
<a class="reference internal" href="#shutil-platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a> section.
</div>
<div class="versionchanged">
Changed in version 3.9: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a> for both src and dst.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.disk_usage">
shutil.disk_usage(path)<a class="headerlink" href="#shutil.disk_usage" title="Link to this definition">¶</a></dt>
<dd>Return disk usage statistics about the given path as a <a class="reference internal" href="../glossary.html#term-named-tuple">named tuple</a>
with the attributes total, used and free, which are the amount of
total, used and free space, in bytes. path may be a file or a
directory.
<div class="admonition note">
Note
On Unix filesystems, path must point to a path within a mounted
filesystem partition. On those platforms, CPython doesn’t attempt to
retrieve disk usage information from non-mounted filesystems.
</div>
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.8: On Windows, path can now be a file or directory.
</div>
<div class="availability docutils container">
<a class="reference internal" href="intro.html#availability">Availability</a>: Unix, Windows.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.chown">
shutil.chown(path, user=None, group=None)<a class="headerlink" href="#shutil.chown" title="Link to this definition">¶</a></dt>
<dd>Change owner user and/or group of the given path.
user can be a system user name or a uid; the same applies to group. At
least one argument is required.
See also <a class="reference internal" href="os.html#os.chown" title="os.chown"><code class="xref py py-func docutils literal notranslate">os.chown()</code></a>, the underlying function.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.chown</code> with arguments <code class="docutils literal notranslate">path</code>, <code class="docutils literal notranslate">user</code>, <code class="docutils literal notranslate">group</code>.
<div class="availability docutils container">
<a class="reference internal" href="intro.html#availability">Availability</a>: Unix.
</div>
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.which">
shutil.which(cmd, mode=os.F_OK | os.X_OK, path=None)<a class="headerlink" href="#shutil.which" title="Link to this definition">¶</a></dt>
<dd>Return the path to an executable which would be run if the given cmd was
called. If no cmd would be called, return <code class="docutils literal notranslate">None</code>.
mode is a permission mask passed to <a class="reference internal" href="os.html#os.access" title="os.access"><code class="xref py py-func docutils literal notranslate">os.access()</code></a>, by default
determining if the file exists and executable.
When no path is specified, the results of <a class="reference internal" href="os.html#os.environ" title="os.environ"><code class="xref py py-func docutils literal notranslate">os.environ()</code></a> are used,
returning either the “PATH” value or a fallback of <a class="reference internal" href="os.html#os.defpath" title="os.defpath"><code class="xref py py-data docutils literal notranslate">os.defpath</code></a>.
On Windows, the current directory is prepended to the path if mode does
not include <code class="docutils literal notranslate">os.X_OK</code>. When the mode does include <code class="docutils literal notranslate">os.X_OK</code>, the
Windows API <code class="docutils literal notranslate">NeedCurrentDirectoryForExePathW</code> will be consulted to
determine if the current directory should be prepended to path. To avoid
consulting the current working directory for executables: set the environment
variable <code class="docutils literal notranslate">NoDefaultCurrentDirectoryInExePath</code>.
Also on Windows, the <code class="docutils literal notranslate">PATHEXT</code> variable is used to resolve commands
that may not already include an extension. For example, if you call
<code class="docutils literal notranslate">shutil.which(&quot;python&quot;)</code>, <a class="reference internal" href="#shutil.which" title="shutil.which"><code class="xref py py-func docutils literal notranslate">which()</code></a> will search <code class="docutils literal notranslate">PATHEXT</code>
to know that it should look for <code class="docutils literal notranslate">python.exe</code> within the path
directories. For example, on Windows:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; shutil.which(&quot;python&quot;)
&#39;C:\\Python33\\python.EXE&#39;
</pre></div>
</div>
This is also applied when cmd is a path that contains a directory
component:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt; shutil.which(&quot;C:\\Python33\\python&quot;)
&#39;C:\\Python33\\python.EXE&#39;
</pre></div>
</div>
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.8: The <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> type is now accepted. If cmd type is
<a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>, the result type is also <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>.
</div>
<div class="versionchanged">
Changed in version 3.12: On Windows, the current directory is no longer prepended to the search
path if mode includes <code class="docutils literal notranslate">os.X_OK</code> and WinAPI
<code class="docutils literal notranslate">NeedCurrentDirectoryForExePathW(cmd)</code> is false, else the current
directory is prepended even if it is already in the search path;
<code class="docutils literal notranslate">PATHEXT</code> is used now even when cmd includes a directory component
or ends with an extension that is in <code class="docutils literal notranslate">PATHEXT</code>; and filenames that
have no extension can now be found.
</div>
<div class="versionchanged">
Changed in version 3.12.1: On Windows, if mode includes <code class="docutils literal notranslate">os.X_OK</code>, executables with an
extension in <code class="docutils literal notranslate">PATHEXT</code> will be preferred over executables without a
matching extension.
This brings behavior closer to that of Python 3.11.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="shutil.Error">
exception shutil.Error<a class="headerlink" href="#shutil.Error" title="Link to this definition">¶</a></dt>
<dd>This exception collects exceptions that are raised during a multi-file
operation. For <a class="reference internal" href="#shutil.copytree" title="shutil.copytree"><code class="xref py py-func docutils literal notranslate">copytree()</code></a>, the exception argument is a list of 3-tuples
(srcname, dstname, exception).
</dd></dl>

<section id="platform-dependent-efficient-copy-operations">
<h3>Platform-dependent efficient copy operations<a class="headerlink" href="#platform-dependent-efficient-copy-operations" title="Link to this heading">¶</a></h3>
Starting from Python 3.8, all functions involving a file copy
(<a class="reference internal" href="#shutil.copyfile" title="shutil.copyfile"><code class="xref py py-func docutils literal notranslate">copyfile()</code></a>, <a class="reference internal" href="#shutil.copy" title="shutil.copy"><code class="xref py py-func docutils literal notranslate">copy()</code></a>, <a class="reference internal" href="#shutil.copy2" title="shutil.copy2"><code class="xref py py-func docutils literal notranslate">copy2()</code></a>,
<a class="reference internal" href="#shutil.copytree" title="shutil.copytree"><code class="xref py py-func docutils literal notranslate">copytree()</code></a>, and <a class="reference internal" href="#shutil.move" title="shutil.move"><code class="xref py py-func docutils literal notranslate">move()</code></a>) may use
platform-specific “fast-copy” syscalls in order to copy the file more
efficiently (see <a class="reference external" href="https://bugs.python.org/issue?&#64;action=redirect&amp;bpo=33671">bpo-33671</a>).
“fast-copy” means that the copying operation occurs within the kernel, avoiding
the use of userspace buffers in Python as in “<code class="docutils literal notranslate">outfd.write(infd.read())</code>”.
On macOS <a class="reference external" href="http://www.manpagez.com/man/3/copyfile/">fcopyfile</a> is used to copy the file content (not metadata).
On Linux <a class="reference internal" href="os.html#os.sendfile" title="os.sendfile"><code class="xref py py-func docutils literal notranslate">os.sendfile()</code></a> is used.
On Windows <a class="reference internal" href="#shutil.copyfile" title="shutil.copyfile"><code class="xref py py-func docutils literal notranslate">shutil.copyfile()</code></a> uses a bigger default buffer size (1 MiB
instead of 64 KiB) and a <a class="reference internal" href="stdtypes.html#memoryview" title="memoryview"><code class="xref py py-func docutils literal notranslate">memoryview()</code></a>-based variant of
<a class="reference internal" href="#shutil.copyfileobj" title="shutil.copyfileobj"><code class="xref py py-func docutils literal notranslate">shutil.copyfileobj()</code></a> is used.
If the fast-copy operation fails and no data was written in the destination
file then shutil will silently fallback on using less efficient
<a class="reference internal" href="#shutil.copyfileobj" title="shutil.copyfileobj"><code class="xref py py-func docutils literal notranslate">copyfileobj()</code></a> function internally.
<div class="versionchanged">
Changed in version 3.8.
</div>
</section>
<section id="copytree-example">
<h3>copytree example<a class="headerlink" href="#copytree-example" title="Link to this heading">¶</a></h3>
An example that uses the <a class="reference internal" href="#shutil.ignore_patterns" title="shutil.ignore_patterns"><code class="xref py py-func docutils literal notranslate">ignore_patterns()</code></a> helper:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from shutil import copytree, ignore_patterns

copytree(source, destination, ignore=ignore_patterns(&#39;*.pyc&#39;, &#39;tmp*&#39;))
</pre></div>
</div>
This will copy everything except <code class="docutils literal notranslate">.pyc</code> files and files or directories whose
name starts with <code class="docutils literal notranslate">tmp</code>.
Another example that uses the ignore argument to add a logging call:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from shutil import copytree
import logging

def _logpath(path, names):
 logging.info(&#39;Working in %s&#39;, path)
 return [] # nothing will be ignored

copytree(source, destination, ignore=_logpath)
</pre></div>
</div>
</section>
<section id="rmtree-example">
<h3>rmtree example<a class="headerlink" href="#rmtree-example" title="Link to this heading">¶</a></h3>
This example shows how to remove a directory tree on Windows where some
of the files have their read-only bit set. It uses the onexc callback
to clear the readonly bit and reattempt the remove. Any subsequent failure
will propagate.
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import os, stat
import shutil

def remove_readonly(func, path, _):
 &quot;Clear the readonly bit and reattempt the removal&quot;
 os.chmod(path, stat.S_IWRITE)
 func(path)

shutil.rmtree(directory, onexc=remove_readonly)
</pre></div>
</div>
</section>
</section>
<section id="archiving-operations">
<h2>Archiving operations<a class="headerlink" href="#archiving-operations" title="Link to this heading">¶</a></h2>
<div class="versionadded">
New in version 3.2.
</div>
<div class="versionchanged">
Changed in version 3.5: Added support for the xztar format.
</div>
High-level utilities to create and read compressed and archived files are also
provided. They rely on the <a class="reference internal" href="zipfile.html#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> and <a class="reference internal" href="tarfile.html#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> modules.
<dl class="py function">
<dt class="sig sig-object py" id="shutil.make_archive">
shutil.make_archive(base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])<a class="headerlink" href="#shutil.make_archive" title="Link to this definition">¶</a></dt>
<dd>Create an archive file (such as zip or tar) and return its name.
base_name is the name of the file to create, including the path, minus
any format-specific extension.
format is the archive format: one of
“zip” (if the <a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module is available), “tar”, “gztar” (if the
<a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module is available), “bztar” (if the <a class="reference internal" href="bz2.html#module-bz2" title="bz2: Interfaces for bzip2 compression and decompression."><code class="xref py py-mod docutils literal notranslate">bz2</code></a> module is
available), or “xztar” (if the <a class="reference internal" href="lzma.html#module-lzma" title="lzma: A Python wrapper for the liblzma compression library."><code class="xref py py-mod docutils literal notranslate">lzma</code></a> module is available).
root_dir is a directory that will be the root directory of the
archive, all paths in the archive will be relative to it; for example,
we typically chdir into root_dir before creating the archive.
base_dir is the directory where we start archiving from;
i.e. base_dir will be the common prefix of all files and
directories in the archive. base_dir must be given relative
to root_dir. See <a class="reference internal" href="#shutil-archiving-example-with-basedir">Archiving example with base_dir</a> for how to
use base_dir and root_dir together.
root_dir and base_dir both default to the current directory.
If dry_run is true, no archive is created, but the operations that would be
executed are logged to logger.
owner and group are used when creating a tar archive. By default,
uses the current owner and group.
logger must be an object compatible with <a class="pep reference external" href="https://peps.python.org/pep-0282/">PEP 282</a>, usually an instance of
<a class="reference internal" href="logging.html#logging.Logger" title="logging.Logger"><code class="xref py py-class docutils literal notranslate">logging.Logger</code></a>.
The verbose argument is unused and deprecated.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.make_archive</code> with arguments <code class="docutils literal notranslate">base_name</code>, <code class="docutils literal notranslate">format</code>, <code class="docutils literal notranslate">root_dir</code>, <code class="docutils literal notranslate">base_dir</code>.
<div class="admonition note">
Note
This function is not thread-safe when custom archivers registered
with <a class="reference internal" href="#shutil.register_archive_format" title="shutil.register_archive_format"><code class="xref py py-func docutils literal notranslate">register_archive_format()</code></a> do not support the root_dir
argument. In this case it
temporarily changes the current working directory of the process
to root_dir to perform archiving.
</div>
<div class="versionchanged">
Changed in version 3.8: The modern pax (POSIX.1-2001) format is now used instead of
the legacy GNU format for archives created with <code class="docutils literal notranslate">format=&quot;tar&quot;</code>.
</div>
<div class="versionchanged">
Changed in version 3.10.6: This function is now made thread-safe during creation of standard
<code class="docutils literal notranslate">.zip</code> and tar archives.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.get_archive_formats">
shutil.get_archive_formats()<a class="headerlink" href="#shutil.get_archive_formats" title="Link to this definition">¶</a></dt>
<dd>Return a list of supported formats for archiving.
Each element of the returned sequence is a tuple <code class="docutils literal notranslate">(name, description)</code>.
By default <a class="reference internal" href="#module-shutil" title="shutil: High-level file operations, including copying."><code class="xref py py-mod docutils literal notranslate">shutil</code></a> provides these formats:
<ul class="simple">
<li>zip: ZIP file (if the <a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module is available).</li>
<li>tar: Uncompressed tar file. Uses POSIX.1-2001 pax format for new archives.</li>
<li>gztar: gzip’ed tar-file (if the <a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module is available).</li>
<li>bztar: bzip2’ed tar-file (if the <a class="reference internal" href="bz2.html#module-bz2" title="bz2: Interfaces for bzip2 compression and decompression."><code class="xref py py-mod docutils literal notranslate">bz2</code></a> module is available).</li>
<li>xztar: xz’ed tar-file (if the <a class="reference internal" href="lzma.html#module-lzma" title="lzma: A Python wrapper for the liblzma compression library."><code class="xref py py-mod docutils literal notranslate">lzma</code></a> module is available).</li>
</ul>
You can register new formats or provide your own archiver for any existing
formats, by using <a class="reference internal" href="#shutil.register_archive_format" title="shutil.register_archive_format"><code class="xref py py-func docutils literal notranslate">register_archive_format()</code></a>.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.register_archive_format">
shutil.register_archive_format(name, function[, extra_args[, description]])<a class="headerlink" href="#shutil.register_archive_format" title="Link to this definition">¶</a></dt>
<dd>Register an archiver for the format name.
function is the callable that will be used to unpack archives. The callable
will receive the base_name of the file to create, followed by the
base_dir (which defaults to <a class="reference internal" href="os.html#os.curdir" title="os.curdir"><code class="xref py py-data docutils literal notranslate">os.curdir</code></a>) to start archiving from.
Further arguments are passed as keyword arguments: owner, group,
dry_run and logger (as passed in <a class="reference internal" href="#shutil.make_archive" title="shutil.make_archive"><code class="xref py py-func docutils literal notranslate">make_archive()</code></a>).
If function has the custom attribute <code class="docutils literal notranslate">function.supports_root_dir</code> set to <code class="docutils literal notranslate">True</code>,
the root_dir argument is passed as a keyword argument.
Otherwise the current working directory of the process is temporarily
changed to root_dir before calling function.
In this case <a class="reference internal" href="#shutil.make_archive" title="shutil.make_archive"><code class="xref py py-func docutils literal notranslate">make_archive()</code></a> is not thread-safe.
If given, extra_args is a sequence of <code class="docutils literal notranslate">(name, value)</code> pairs that will be
used as extra keywords arguments when the archiver callable is used.
description is used by <a class="reference internal" href="#shutil.get_archive_formats" title="shutil.get_archive_formats"><code class="xref py py-func docutils literal notranslate">get_archive_formats()</code></a> which returns the
list of archivers. Defaults to an empty string.
<div class="versionchanged">
Changed in version 3.12: Added support for functions supporting the root_dir argument.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.unregister_archive_format">
shutil.unregister_archive_format(name)<a class="headerlink" href="#shutil.unregister_archive_format" title="Link to this definition">¶</a></dt>
<dd>Remove the archive format name from the list of supported formats.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.unpack_archive">
shutil.unpack_archive(filename[, extract_dir[, format[, filter]]])<a class="headerlink" href="#shutil.unpack_archive" title="Link to this definition">¶</a></dt>
<dd>Unpack an archive. filename is the full path of the archive.
extract_dir is the name of the target directory where the archive is
unpacked. If not provided, the current working directory is used.
format is the archive format: one of “zip”, “tar”, “gztar”, “bztar”, or
“xztar”. Or any other format registered with
<a class="reference internal" href="#shutil.register_unpack_format" title="shutil.register_unpack_format"><code class="xref py py-func docutils literal notranslate">register_unpack_format()</code></a>. If not provided, <a class="reference internal" href="#shutil.unpack_archive" title="shutil.unpack_archive"><code class="xref py py-func docutils literal notranslate">unpack_archive()</code></a>
will use the archive file name extension and see if an unpacker was
registered for that extension. In case none is found,
a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised.
The keyword-only filter argument is passed to the underlying unpacking
function. For zip files, filter is not accepted.
For tar files, it is recommended to set it to <code class="docutils literal notranslate">'data'</code>,
unless using features specific to tar and UNIX-like filesystems.
(See <a class="reference internal" href="tarfile.html#tarfile-extraction-filter">Extraction filters</a> for details.)
The <code class="docutils literal notranslate">'data'</code> filter will become the default for tar files
in Python 3.14.
Raises an <a class="reference internal" href="sys.html#auditing">auditing event</a> <code class="docutils literal notranslate">shutil.unpack_archive</code> with arguments <code class="docutils literal notranslate">filename</code>, <code class="docutils literal notranslate">extract_dir</code>, <code class="docutils literal notranslate">format</code>.
<div class="admonition warning">
Warning
Never extract archives from untrusted sources without prior inspection.
It is possible that files are created outside of the path specified in
the extract_dir argument, e.g. members that have absolute filenames
starting with “/” or filenames with two dots “..”.
</div>
<div class="versionchanged">
Changed in version 3.7: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a> for filename and extract_dir.
</div>
<div class="versionchanged">
Changed in version 3.12: Added the filter argument.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.register_unpack_format">
shutil.register_unpack_format(name, extensions, function[, extra_args[, description]])<a class="headerlink" href="#shutil.register_unpack_format" title="Link to this definition">¶</a></dt>
<dd>Registers an unpack format. name is the name of the format and
extensions is a list of extensions corresponding to the format, like
<code class="docutils literal notranslate">.zip</code> for Zip files.
function is the callable that will be used to unpack archives. The
callable will receive:
<ul class="simple">
<li>the path of the archive, as a positional argument;</li>
<li>the directory the archive must be extracted to, as a positional argument;</li>
<li>possibly a filter keyword argument, if it was given to
<a class="reference internal" href="#shutil.unpack_archive" title="shutil.unpack_archive"><code class="xref py py-func docutils literal notranslate">unpack_archive()</code></a>;</li>
<li>additional keyword arguments, specified by extra_args as a sequence
of <code class="docutils literal notranslate">(name, value)</code> tuples.</li>
</ul>
description can be provided to describe the format, and will be returned
by the <a class="reference internal" href="#shutil.get_unpack_formats" title="shutil.get_unpack_formats"><code class="xref py py-func docutils literal notranslate">get_unpack_formats()</code></a> function.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.unregister_unpack_format">
shutil.unregister_unpack_format(name)<a class="headerlink" href="#shutil.unregister_unpack_format" title="Link to this definition">¶</a></dt>
<dd>Unregister an unpack format. name is the name of the format.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="shutil.get_unpack_formats">
shutil.get_unpack_formats()<a class="headerlink" href="#shutil.get_unpack_formats" title="Link to this definition">¶</a></dt>
<dd>Return a list of all registered formats for unpacking.
Each element of the returned sequence is a tuple
<code class="docutils literal notranslate">(name, extensions, description)</code>.
By default <a class="reference internal" href="#module-shutil" title="shutil: High-level file operations, including copying."><code class="xref py py-mod docutils literal notranslate">shutil</code></a> provides these formats:
<ul class="simple">
<li>zip: ZIP file (unpacking compressed files works only if the corresponding
module is available).</li>
<li>tar: uncompressed tar file.</li>
<li>gztar: gzip’ed tar-file (if the <a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module is available).</li>
<li>bztar: bzip2’ed tar-file (if the <a class="reference internal" href="bz2.html#module-bz2" title="bz2: Interfaces for bzip2 compression and decompression."><code class="xref py py-mod docutils literal notranslate">bz2</code></a> module is available).</li>
<li>xztar: xz’ed tar-file (if the <a class="reference internal" href="lzma.html#module-lzma" title="lzma: A Python wrapper for the liblzma compression library."><code class="xref py py-mod docutils literal notranslate">lzma</code></a> module is available).</li>
</ul>
You can register new formats or provide your own unpacker for any existing
formats, by using <a class="reference internal" href="#shutil.register_unpack_format" title="shutil.register_unpack_format"><code class="xref py py-func docutils literal notranslate">register_unpack_format()</code></a>.
</dd></dl>

<section id="archiving-example">
<h3>Archiving example<a class="headerlink" href="#archiving-example" title="Link to this heading">¶</a></h3>
In this example, we create a gzip’ed tar-file archive containing all files
found in the <code class="file docutils literal notranslate">.ssh</code> directory of the user:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from shutil import make_archive
&gt;&gt;&gt; import os
&gt;&gt;&gt; archive_name = os.path.expanduser(os.path.join(&#39;~&#39;, &#39;myarchive&#39;))
&gt;&gt;&gt; root_dir = os.path.expanduser(os.path.join(&#39;~&#39;, &#39;.ssh&#39;))
&gt;&gt;&gt; make_archive(archive_name, &#39;gztar&#39;, root_dir)
&#39;/Users/tarek/myarchive.tar.gz&#39;
</pre></div>
</div>
The resulting archive contains:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ tar -tzvf /Users/tarek/myarchive.tar.gz
drwx------ tarek/staff 0 2010-02-01 16:23:40 ./
-rw-r--r-- tarek/staff 609 2008-06-09 13:26:54 ./authorized_keys
-rwxr-xr-x tarek/staff 65 2008-06-09 13:26:54 ./config
-rwx------ tarek/staff 668 2008-06-09 13:26:54 ./id_dsa
-rwxr-xr-x tarek/staff 609 2008-06-09 13:26:54 ./id_dsa.pub
-rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa
-rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub
-rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts
</pre></div>
</div>
</section>
<section id="archiving-example-with-base-dir">
<h3>Archiving example with base_dir<a class="headerlink" href="#archiving-example-with-base-dir" title="Link to this heading">¶</a></h3>
In this example, similar to the <a class="reference internal" href="#shutil-archiving-example">one above</a>,
we show how to use <a class="reference internal" href="#shutil.make_archive" title="shutil.make_archive"><code class="xref py py-func docutils literal notranslate">make_archive()</code></a>, but this time with the usage of
base_dir. We now have the following directory structure:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ tree tmp
tmp
└── root
 └── structure
 ├── content
 └── please_add.txt
 └── do_not_add.txt
</pre></div>
</div>
In the final archive, <code class="file docutils literal notranslate">please_add.txt</code> should be included, but
<code class="file docutils literal notranslate">do_not_add.txt</code> should not. Therefore we use the following:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from shutil import make_archive
&gt;&gt;&gt; import os
&gt;&gt;&gt; archive_name = os.path.expanduser(os.path.join(&#39;~&#39;, &#39;myarchive&#39;))
&gt;&gt;&gt; make_archive(
... archive_name,
... &#39;tar&#39;,
... root_dir=&#39;tmp/root&#39;,
... base_dir=&#39;structure/content&#39;,
... )
&#39;/Users/tarek/my_archive.tar&#39;
</pre></div>
</div>
Listing the files in the resulting archive gives us:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m tarfile -l /Users/tarek/myarchive.tar
structure/content/
structure/content/please_add.txt
</pre></div>
</div>
</section>
</section>
<section id="querying-the-size-of-the-output-terminal">
<h2>Querying the size of the output terminal<a class="headerlink" href="#querying-the-size-of-the-output-terminal" title="Link to this heading">¶</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="shutil.get_terminal_size">
shutil.get_terminal_size(fallback=(columns, lines))<a class="headerlink" href="#shutil.get_terminal_size" title="Link to this definition">¶</a></dt>
<dd>Get the size of the terminal window.
For each of the two dimensions, the environment variable, <code class="docutils literal notranslate">COLUMNS</code>
and <code class="docutils literal notranslate">LINES</code> respectively, is checked. If the variable is defined and
the value is a positive integer, it is used.
When <code class="docutils literal notranslate">COLUMNS</code> or <code class="docutils literal notranslate">LINES</code> is not defined, which is the common case,
the terminal connected to <a class="reference internal" href="sys.html#sys.__stdout__" title="sys.__stdout__"><code class="xref py py-data docutils literal notranslate">sys.__stdout__</code></a> is queried
by invoking <a class="reference internal" href="os.html#os.get_terminal_size" title="os.get_terminal_size"><code class="xref py py-func docutils literal notranslate">os.get_terminal_size()</code></a>.
If the terminal size cannot be successfully queried, either because
the system doesn’t support querying, or because we are not
connected to a terminal, the value given in <code class="docutils literal notranslate">fallback</code> parameter
is used. <code class="docutils literal notranslate">fallback</code> defaults to <code class="docutils literal notranslate">(80, 24)</code> which is the default
size used by many terminal emulators.
The value returned is a named tuple of type <a class="reference internal" href="os.html#os.terminal_size" title="os.terminal_size"><code class="xref py py-class docutils literal notranslate">os.terminal_size</code></a>.
See also: The Single UNIX Specification, Version 2,
<a class="reference external" href="https://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003">Other Environment Variables</a>.
<div class="versionadded">
New in version 3.3.
</div>
<div class="versionchanged">
Changed in version 3.11: The <code class="docutils literal notranslate">fallback</code> values are also used if <a class="reference internal" href="os.html#os.get_terminal_size" title="os.get_terminal_size"><code class="xref py py-func docutils literal notranslate">os.get_terminal_size()</code></a>
returns zeroes.
</div>
</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">shutil</code> — High-level file operations</a><ul>
<li><a class="reference internal" href="#directory-and-files-operations">Directory and files operations</a><ul>
<li><a class="reference internal" href="#platform-dependent-efficient-copy-operations">Platform-dependent efficient copy operations</a></li>
<li><a class="reference internal" href="#copytree-example">copytree example</a></li>
<li><a class="reference internal" href="#rmtree-example">rmtree example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#archiving-operations">Archiving operations</a><ul>
<li><a class="reference internal" href="#archiving-example">Archiving example</a></li>
<li><a class="reference internal" href="#archiving-example-with-base-dir">Archiving example with base_dir</a></li>
</ul>
</li>
<li><a class="reference internal" href="#querying-the-size-of-the-output-terminal">Querying the size of the output terminal</a></li>
</ul>
</li>
</ul>

</div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="persistence.html" title="Data Persistence"
 >next</a> |</li>
 <li class="right" >
 <a href="linecache.html" title="linecache — Random access to text lines"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">shutil</code> — High-level file operations</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
 <input type="submit" value="Go" />
 </form>
 </div>
 |
 </li>
 <li class="right">
<label class="theme-selector-label">
 Theme
 <select class="theme-selector" oninput="activateTheme(this.value)">
 <option value="auto" selected>Auto</option>
 <option value="light">Light</option>
 <option value="dark">Dark</option>
 </select>
</label> |</li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; 
 <a href="../copyright.html">
 
 Copyright
 
 </a>
 2001-2024, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 
 Last updated on Apr 09, 2024 (13:47 UTC).
 
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
 </div>

</body>
</html>