Skip to content

Commit 8742298

Browse files
miss-islingtonRogdhamzware
authored
[3.14] gh-132983: Add missing references to Zstandard in shutil docstrings (GH-136617) (#137052)
Co-authored-by: Rogdham <3994389+Rogdham@users.noreply.github.com> Co-authored-by: Zachary Ware <zach@python.org>
1 parent d996cb6 commit 8742298

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Lib/shutil.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -994,14 +994,14 @@ def _make_tarball(base_name, base_dir, compress="gzip", verbose=0, dry_run=0,
994994
"""Create a (possibly compressed) tar file from all the files under
995995
'base_dir'.
996996
997-
'compress' must be "gzip" (the default), "bzip2", "xz", or None.
997+
'compress' must be "gzip" (the default), "bzip2", "xz", "zst", or None.
998998
999999
'owner' and 'group' can be used to define an owner and a group for the
10001000
archive that is being built. If not provided, the current owner and group
10011001
will be used.
10021002
10031003
The output tar file will be named 'base_name' + ".tar", possibly plus
1004-
the appropriate compression extension (".gz", ".bz2", or ".xz").
1004+
the appropriate compression extension (".gz", ".bz2", ".xz", or ".zst").
10051005
10061006
Returns the output filename.
10071007
"""
@@ -1187,7 +1187,7 @@ def make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0,
11871187
11881188
'base_name' is the name of the file to create, minus any format-specific
11891189
extension; 'format' is the archive format: one of "zip", "tar", "gztar",
1190-
"bztar", "zstdtar", or "xztar". Or any other registered format.
1190+
"bztar", "xztar", or "zstdtar". Or any other registered format.
11911191
11921192
'root_dir' is a directory that will be the root directory of the
11931193
archive; ie. we typically chdir into 'root_dir' before creating the
@@ -1337,7 +1337,7 @@ def _unpack_zipfile(filename, extract_dir):
13371337
zip.close()
13381338

13391339
def _unpack_tarfile(filename, extract_dir, *, filter=None):
1340-
"""Unpack tar/tar.gz/tar.bz2/tar.xz `filename` to `extract_dir`
1340+
"""Unpack tar/tar.gz/tar.bz2/tar.xz/tar.zst `filename` to `extract_dir`
13411341
"""
13421342
import tarfile # late import for breaking circular dependency
13431343
try:
@@ -1392,7 +1392,7 @@ def unpack_archive(filename, extract_dir=None, format=None, *, filter=None):
13921392
is unpacked. If not provided, the current working directory is used.
13931393
13941394
`format` is the archive format: one of "zip", "tar", "gztar", "bztar",
1395-
or "xztar". Or any other registered format. If not provided,
1395+
"xztar", or "zstdtar". Or any other registered format. If not provided,
13961396
unpack_archive will use the filename extension and see if an unpacker
13971397
was registered for that extension.
13981398

0 commit comments

Comments
 (0)