Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-37408: Precise that Tarfile "format" argument only concerns writing. (GH-14389)

This commit is contained in:
Pascal Chambon 2019-09-28 17:04:44 +02:00 committed by Gregory P. Smith
parent c8165036f3
commit c5a7e0ce19
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/library/tarfile.rst
View File

@ -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.