Module tarfile :: Class TarFile

Class TarFile

object --+
         |
        TarFile

The TarFile Class provides an interface to tar archives.

Nested Classes

[hide private]

fileobject
File-like object for reading an archive member.

Instance Methods

[hide private]

__init__(self, name=None, mode='r', fileobj=None)
Open an (uncompressed) tar archive `name'.

close(self)
Close the TarFile.

getmember(self, name)
Return a TarInfo object for member `name'.

getmembers(self)
Return the members of the archive as a list of TarInfo objects.

getnames(self)
Return the members of the archive as a list of their names.

gettarinfo(self, name=None, arcname=None, fileobj=None)
Create a TarInfo object for either the file `name' or the file object `fileobj' (using os.fstat on its file descriptor).

list(self, verbose=True)
Print a table of contents to sys.stdout.

add(self, name, arcname=None, recursive=True)
Add the file `name' to the archive.

addfile(self, tarinfo, fileobj=None)
Add the TarInfo object `tarinfo' to the archive.

extractall(self, path='.', members=None)
Extract all members from the archive to the current working directory and set owner, modification time and permissions on directories afterwards.

extract(self, member, path='')
Extract a member from the archive to the current working directory, using its full name.

extractfile(self, member)
Extract a member from the archive as a file object.

_extract_member(self, tarinfo, targetpath)
Extract the TarInfo object tarinfo to a physical file called targetpath.

makedir(self, tarinfo, targetpath)
Make a directory called targetpath.

makefile(self, tarinfo, targetpath)
Make a file called targetpath.

makeunknown(self, tarinfo, targetpath)
Make a file from a TarInfo object with an unknown type at targetpath.

makefifo(self, tarinfo, targetpath)
Make a fifo called targetpath.

makedev(self, tarinfo, targetpath)
Make a character or block device called targetpath.

makelink(self, tarinfo, targetpath)
Make a (symbolic) link called targetpath.

chown(self, tarinfo, targetpath)
Set owner of targetpath according to tarinfo.

chmod(self, tarinfo, targetpath)
Set file permissions of targetpath according to tarinfo.

utime(self, tarinfo, targetpath)
Set modification time of targetpath according to tarinfo.

next(self)
Return the next member of the archive as a TarInfo object, when TarFile is opened for reading.

proc_member(self, tarinfo)
Choose the right processing method for tarinfo depending on its type and call it.

proc_builtin(self, tarinfo)
Process a builtin type member or an unknown member which will be treated as a regular file.

proc_gnulong(self, tarinfo)
Process the blocks that hold a GNU longname or longlink member.

proc_sparse(self, tarinfo)
Process a GNU sparse header plus extra headers.

_block(self, count)
Round up a byte count by BLOCKSIZE and return it, e.g.

_getmember(self, name, tarinfo=None)
Find an archive member by name from bottom to top.

_load(self)
Read through the entire archive file and look for readable members.

_check(self, mode=None)
Check if TarFile is still open, and if the operation's mode corresponds to TarFile's mode.

__iter__(self)
Provide an iterator object.

_dbg(self, level, msg)
Write debugging output to sys.stderr.

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Methods

[hide private]

open(cls, name=None, mode='r', fileobj=None, bufsize=10240)
Open a tar archive for reading, writing or appending.

taropen(cls, name, mode='r', fileobj=None)
Open uncompressed tar archive name for reading or writing.

gzopen(cls, name, mode='r', fileobj=None, compresslevel=9)
Open gzip compressed tar archive name for reading or writing.

bz2open(cls, name, mode='r', fileobj=None, compresslevel=9)
Open bzip2 compressed tar archive name for reading or writing.

Class Variables

[hide private]

debug = 0

dereference = False

ignore_zeros = False

errorlevel = 0

posix = False

OPEN_METH = {'bz2': 'bz2open', 'gz': 'gzopen', 'tar': 'taropen'}

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, name=None, mode=`'r'`, fileobj=None)
(Constructor)

Open an (uncompressed) tar archive `name'. `mode' is either 'r' to read from an existing archive, 'a' to append data to an existing file or 'w' to create a new file overwriting an existing one. `mode' defaults to 'r'. If `fileobj' is given, it is used for reading or writing data. If it can be determined, `mode' is overridden by `fileobj's mode. `fileobj' is not closed, when TarFile is closed.

Overrides: object.__init__

open(cls, name=None, mode=`'r'`, fileobj=None, bufsize=10240)
Class Method

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 'a' or 'a:' open for appending 'w' or 'w:' open for writing without compression 'w:gz' open for writing with gzip compression 'w:bz2' open for writing with bzip2 compression

'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 '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

gzopen(cls, name, mode=`'r'`, fileobj=None, compresslevel=9)
Class Method

Open gzip compressed tar archive name for reading or writing. Appending is not allowed.

bz2open(cls, name, mode=`'r'`, fileobj=None, compresslevel=9)
Class Method

Open bzip2 compressed tar archive name for reading or writing. Appending is not allowed.

close(self)

Close the TarFile. In write-mode, two finishing zero blocks are appended to the archive.

getmember(self, name)

Return a TarInfo object for member `name'. If `name' can not be found in the archive, KeyError is raised. If a member occurs more than once in the archive, its last occurence is assumed to be the most up-to-date version.

getmembers(self)

Return the members of the archive as a list of TarInfo objects. The list has the same order as the members in the archive.

getnames(self)

Return the members of the archive as a list of their names. It has the same order as the list returned by getmembers().

gettarinfo(self, name=None, arcname=None, fileobj=None)

Create a TarInfo object for either the file `name' or the file object `fileobj' (using os.fstat on its file descriptor). You can modify some of the TarInfo's attributes before you add it using addfile(). If given, `arcname' specifies an alternative name for the file in the archive.

list(self, verbose=True)

Print a table of contents to sys.stdout. If `verbose' is False, only the names of the members are printed. If it is True, an `ls -l'-like output is produced.

add(self, name, arcname=None, recursive=True)

Add the file `name' to the archive. `name' may be any type of file (directory, fifo, symbolic link, etc.). If given, `arcname' specifies an alternative name for the file in the archive. Directories are added recursively by default. This can be avoided by setting `recursive' to False.

addfile(self, tarinfo, fileobj=None)

Add the TarInfo object `tarinfo' to the archive. If `fileobj' is given, tarinfo.size bytes are read from it and added to the archive. You can create TarInfo objects using gettarinfo(). On Windows platforms, `fileobj' should always be opened with mode 'rb' to avoid irritation about the file size.

extractall(self, path=`'.'`, members=None)

Extract all members from the archive to the current working directory and set owner, modification time and permissions on directories afterwards. `path' specifies a different directory to extract to. `members' is optional and must be a subset of the list returned by getmembers().

extract(self, member, path=`''`)

Extract a member from the archive to the current working directory, using its full name. Its file information is extracted as accurately as possible. `member' may be a filename or a TarInfo object. You can specify a different directory using `path'.

extractfile(self, member)

Extract a member from the archive as a file object. `member' may be a filename or a TarInfo object. If `member' is a regular file, a file-like object is returned. If `member' is a link, a file-like object is constructed from the link's target. If `member' is none of the above, None is returned. The file-like object is read-only and provides the following methods: read(), readline(), readlines(), seek() and tell()

makelink(self, tarinfo, targetpath)

Make a (symbolic) link called targetpath. If it cannot be created (platform limitation), we try to make a copy of the referenced file instead of a link.

next(self)

Return the next member of the archive as a TarInfo object, when TarFile is opened for reading. Return None if there is no more available.

_block(self, count)

Round up a byte count by BLOCKSIZE and return it, e.g. _block(834) => 1024.

_getmember(self, name, tarinfo=None)

Find an archive member by name from bottom to top. If tarinfo is given, it is used as the starting point.

Class TarFile

__init__(self, name=None, mode='r', fileobj=None) (Constructor)

open(cls, name=None, mode='r', fileobj=None, bufsize=10240) Class Method

gzopen(cls, name, mode='r', fileobj=None, compresslevel=9) Class Method

bz2open(cls, name, mode='r', fileobj=None, compresslevel=9) Class Method

close(self)

getmember(self, name)

getmembers(self)

getnames(self)

gettarinfo(self, name=None, arcname=None, fileobj=None)

list(self, verbose=True)

add(self, name, arcname=None, recursive=True)

addfile(self, tarinfo, fileobj=None)

extractall(self, path='.', members=None)

extract(self, member, path='')

extractfile(self, member)

makelink(self, tarinfo, targetpath)

next(self)

_block(self, count)

_getmember(self, name, tarinfo=None)

init(self, name=None, mode=`'r'`, fileobj=None)
(Constructor)

open(cls, name=None, mode=`'r'`, fileobj=None, bufsize=10240)
Class Method

gzopen(cls, name, mode=`'r'`, fileobj=None, compresslevel=9)
Class Method

bz2open(cls, name, mode=`'r'`, fileobj=None, compresslevel=9)
Class Method

extractall(self, path=`'.'`, members=None)

extract(self, member, path=`''`)