diff options
| author | Pascal Chambon <pythoniks@gmail.com> | 2019-09-28 15:04:44 (GMT) |
|---|---|---|
| committer | Gregory P. Smith <greg@krypto.org> | 2019-09-28 15:04:44 (GMT) |
| commit | c5a7e0ce194c0eafe82eb3e431881012398e7d46 (patch) | |
| tree | bb3b565bf79789a06e7ede5bbddb85b87873b69d /Doc/library | |
| parent | c8165036f374cd2ee64d4314eeb2514f7acb5026 (diff) | |
| download | cpython-c5a7e0ce194c0eafe82eb3e431881012398e7d46.zip cpython-c5a7e0ce194c0eafe82eb3e431881012398e7d46.tar.gz cpython-c5a7e0ce194c0eafe82eb3e431881012398e7d46.tar.bz2 | |
bpo-37408: Precise that Tarfile "format" argument only concerns writing. (GH-14389)
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/tarfile.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index f25af8c..c34f2c4 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -290,9 +290,10 @@ be finalized; only the internally used file object will be closed. See the *fileobj* is not closed, when :class:`TarFile` is closed. - *format* controls the archive format. It must be one of the constants + *format* controls the archive format for writing. It must be one of the constants :const:`USTAR_FORMAT`, :const:`GNU_FORMAT` or :const:`PAX_FORMAT` that are - defined at module level. + defined at module level. When reading, format will be automatically detected, even + if different formats are present in a single archive. The *tarinfo* argument can be used to replace the default :class:`TarInfo` class with a different one. |