PyDocs

Nav

Data Compression and Archiving

open

tarfile

function (source)
  • open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)
Open a tar archive for reading, writing or appending. Return
an appropriate TarFile class.

mode:
'r' or 'r:*' open for reading with transparent compression
'r:'         open for reading exclusively uncompressed
'r:gz'       open for reading with gzip compression
'r:bz2'      open for reading with bzip2 compression
'r:xz'       open for reading with lzma compression
'r:zst'      open for reading with zstd compression
'a' or 'a:'  open for appending, creating the file if necessary
'w' or 'w:'  open for writing without compression
'w:gz'       open for writing with gzip compression
'w:bz2'      open for writing with bzip2 compression
'w:xz'       open for writing with lzma compression
'w:zst'      open for writing with zstd compression

'x' or 'x:'  create a tarfile exclusively without compression, raise
             an exception if the file is already created
'x:gz'       create a gzip compressed tarfile, raise an exception
             if the file is already created
'x:bz2'      create a bzip2 compressed tarfile, raise an exception
             if the file is already created
'x:xz'       create an lzma compressed tarfile, raise an exception
             if the file is already created
'x:zst'      create a zstd compressed tarfile, raise an exception
             if the file is already created

'r|*'        open a stream of tar blocks with transparent compression
'r|'         open an uncompressed stream of tar blocks for reading
'r|gz'       open a gzip compressed stream of tar blocks
'r|bz2'      open a bzip2 compressed stream of tar blocks
'r|xz'       open an lzma compressed stream of tar blocks
'r|zst'      open a zstd compressed stream of tar blocks
'w|'         open an uncompressed stream for writing
'w|gz'       open a gzip compressed stream for writing
'w|bz2'      open a bzip2 compressed stream for writing
'w|xz'       open an lzma compressed stream for writing
'w|zst'      open a zstd compressed stream for writing
Changed in 3.5, 3.6, 3.12, 3.14, 3.15
  • 3.5: The 'x' (exclusive creation) mode was added.
  • 3.6: The name parameter accepts a path-like object.
  • 3.12: The compresslevel keyword argument also works for streams.
  • 3.14: The preset keyword argument also works for streams.
  • 3.15: The default compression level was reduced to 6 (down from 9). It is the default level used by most compression tools and a better tradeoff between speed and performance.
0 Examples
No examples for tarfile/open.
See Also
No see-alsos for tarfile/open
0 Notes
No notes for open