summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHelmut Grohne <helmut@subdivi.de>2025-06-26 18:11:27 +0200
committerHelmut Grohne <helmut@subdivi.de>2025-06-26 18:11:27 +0200
commit506cc89119d0416fa33ad3d97a5ed95be368b801 (patch)
tree92a1daddf5bca2a064a73921f3865a9dd0abd1ac
parentf175519443a343910523ee0f1eb24e51e1f9c26b (diff)
downloadpython-linuxnamespaces-506cc89119d0416fa33ad3d97a5ed95be368b801.tar.gz
Document ZstdTarFile.zstopen
-rw-r--r--linuxnamespaces/tarutils.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/linuxnamespaces/tarutils.py b/linuxnamespaces/tarutils.py
index 1bbfab4..3a152d6 100644
--- a/linuxnamespaces/tarutils.py
+++ b/linuxnamespaces/tarutils.py
@@ -34,6 +34,9 @@ class ZstdTarFile(tarfile.TarFile):
compresslevel: int | None = None,
**kwargs: typing.Any,
) -> tarfile.TarFile:
+ """Open a zstd compressed tar archive with the given name for readin or
+ writing. Appending is not supported.
+ """
if mode not in ("r", "w", "x"):
raise ValueError("mode must be 'r', 'w' or 'x'")
openobj: str | typing.BinaryIO = name if fileobj is None else fileobj