https://github.com/python/cpython/commit/a10235ea672d0cfae2949beca0478b7c3b2eafb0
commit: a10235ea672d0cfae2949beca0478b7c3b2eafb0
branch: main
author: Rogdham <[email protected]>
committer: gpshead <[email protected]>
date: 2025-07-23T18:09:53Z
summary:
gh-132983: Add missing references to Zstandard in shutil docstrings (GH-136617)
Zstd references in shutil docstrings
files:
M Lib/shutil.py
diff --git a/Lib/shutil.py b/Lib/shutil.py
index ca0a2ea2f7fa8a..8d8fe145567822 100644
--- a/Lib/shutil.py
+++ b/Lib/shutil.py
@@ -994,14 +994,14 @@ def _make_tarball(base_name, base_dir, compress="gzip",
verbose=0, dry_run=0,
"""Create a (possibly compressed) tar file from all the files under
'base_dir'.
- 'compress' must be "gzip" (the default), "bzip2", "xz", or None.
+ 'compress' must be "gzip" (the default), "bzip2", "xz", "zst", or None.
'owner' and 'group' can be used to define an owner and a group for the
archive that is being built. If not provided, the current owner and group
will be used.
The output tar file will be named 'base_name' + ".tar", possibly plus
- the appropriate compression extension (".gz", ".bz2", or ".xz").
+ the appropriate compression extension (".gz", ".bz2", ".xz", or ".zst").
Returns the output filename.
"""
@@ -1187,7 +1187,7 @@ def make_archive(base_name, format, root_dir=None,
base_dir=None, verbose=0,
'base_name' is the name of the file to create, minus any format-specific
extension; 'format' is the archive format: one of "zip", "tar", "gztar",
- "bztar", "zstdtar", or "xztar". Or any other registered format.
+ "bztar", "xztar", or "zstdtar". Or any other registered format.
'root_dir' is a directory that will be the root directory of the
archive; ie. we typically chdir into 'root_dir' before creating the
@@ -1337,7 +1337,7 @@ def _unpack_zipfile(filename, extract_dir):
zip.close()
def _unpack_tarfile(filename, extract_dir, *, filter=None):
- """Unpack tar/tar.gz/tar.bz2/tar.xz `filename` to `extract_dir`
+ """Unpack tar/tar.gz/tar.bz2/tar.xz/tar.zst `filename` to `extract_dir`
"""
import tarfile # late import for breaking circular dependency
try:
@@ -1392,7 +1392,7 @@ def unpack_archive(filename, extract_dir=None,
format=None, *, filter=None):
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 registered format. If not provided,
+ "xztar", or "zstdtar". Or any other registered format. If not provided,
unpack_archive will use the filename extension and see if an unpacker
was registered for that extension.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
