PyDocs

Data Compression and Archiving

PyDocs
PyDocs
Data Compression and Archiving
All modules

tarfile

Read from and write to tar format archives.

© Python Software Foundation. PSF License Version 2 · Official docs ↗

Symbols in tarfile

a

AbsoluteLinkError
Raised to refuse extracting a symbolic link with an absolute path.
AbsolutePathError
Raised to refuse extracting a member with an absolute path.
AREGTYPE
A regular file type.

b

BLKTYPE
A block special device type.

c

CHRTYPE
A character special device type.
CompressionError
Exception for unavailable compression methods.
CONTTYPE
A contiguous file type.

d

data_filter
Implements the 'data' filter.
DEFAULT_FORMAT
The default format for creating archives.
DIRTYPE
A directory type.

e

ENCODING
The default character encoding: 'utf-8' on Windows, the value returned by sys.getfilesystemencoding() otherwise.
ExtractError
General exception for extract errors.

f

FIFOTYPE
A FIFO special device type.
FilterError
Base class for members refused by filters.
fully_trusted_filter
Return member unchanged.

g

GNU_FORMAT
GNU tar format.
GNUTYPE_LONGLINK
A GNU tar longlink type.
GNUTYPE_LONGNAME
A GNU tar longname type.
GNUTYPE_SPARSE
A GNU tar sparse file type.

h

HeaderError
Base exception for header errors.

i

is_tarfile
Return True if name points to a tar archive that we are able to handle, else return False.

l

LinkFallbackError
Raised to refuse emulating a link (hard or symbolic) by extracting another archive member, when that member would be rejected by the filter location.
LinkOutsideDestinationError
Raised to refuse extracting a symbolic link pointing outside the destination directory.
LNKTYPE
A link (inside tarfile) type.

o

open
Open a tar archive for reading, writing or appending.
OutsideDestinationError
Raised to refuse extracting a member outside the destination directory.

p

PAX_FORMAT
POSIX.1-2001 (pax) format.

r

ReadError
Exception for unreadable tar archives.
REGTYPE
A regular file type.

s

SpecialFileError
Raised to refuse extracting a special file (e.g.
StreamError
Exception for unsupported operations on stream-like TarFiles.
SYMTYPE
A symbolic link type.

t

tar_filter
Implements the 'tar' filter.
TarError
Base exception.
TarFile
The TarFile Class provides an interface to tar archives.
TarInfo
Informational class which holds the details about an archive member given by a tar header block.

u

USTAR_FORMAT
POSIX.1-1988 (ustar) format.