rarfile API documentation ¶

Table Of Contents

rarfile API documentation

RarFile class ¶

class rarfile.RarFile(rarfile, mode='r', charset=None, info_callback=None, crc_check=True, errors='stop')¶

Bases: object

Parse RAR structure, provide access to files in archive.

Open and parse a RAR archive.

Parameters:

rarfile

archive file name

mode

only ‘r’ is supported.

charset

fallback charset to use, if filenames are not already Unicode-enabled.

info_callback

debug callback, gets to see all archive entries.

crc_check

set to False to disable CRC checks

errors

Either “stop” to quietly stop parsing on errors, or “strict” to raise errors. Default is “stop”.

comment = None¶: Archive comment. Byte string or None. Use UNICODE_COMMENTS to get automatic decoding to unicode.

setpassword(password)¶: Sets the password to use when extracting.

needs_password()¶: Returns True if any archive entries require password for extraction.

namelist()¶: Return list of filenames in archive.

infolist()¶: Return RarInfo objects for all files/directories in archive.

volumelist()¶

Returns filenames of archive volumes.

In case of single-volume archive, the list contains just the name of main archive file.

getinfo(fname)¶: Return RarInfo for file.

open(fname, mode='r', psw=None)¶

Returns file-like object (RarExtFile), from where the data can be read.

The object implements io.RawIOBase interface, so it can be further wrapped with io.BufferedReader and io.TextIOWrapper.

On older Python where io module is not available, it implements only .read(), .seek(), .tell() and .close() methods.

The object is seekable, although the seeking is fast only on uncompressed files, on compressed files the seeking is implemented by reading ahead and/or restarting the decompression.

Parameters:

fname

file name or RarInfo instance.

mode

must be ‘r’

psw

password to use for extracting.

read(fname, psw=None)¶

Return uncompressed data for archive entry.

For longer files using RarFile.open() may be better idea.

Parameters:

fname

filename or RarInfo instance

psw

password to use for extracting.

close()¶: Release open resources.

printdir()¶: Print archive file list to stdout.

extract(member, path=None, pwd=None)¶

Extract single file into current directory.

Parameters:

member

filename or RarInfo instance

path

optional destination path

pwd

optional password to use

extractall(path=None, members=None, pwd=None)¶

Extract all files into current directory.

Parameters:

path

optional destination path

members

optional filename or RarInfo instance list to extract

pwd

optional password to use

testrar()¶: Let ‘unrar’ test the archive.

strerror()¶: Return error string if parsing failed, or None if no problems.

RarInfo class ¶

class rarfile.RarInfo¶

Bases: object

An entry in rar archive.

zipfile-compatible fields:

filename

File name with relative path. Default path separator is ‘\’, to change set rarfile.PATH_SEP. Always unicode string.

date_time

Modification time, tuple of (year, month, day, hour, minute, second). Or datetime() object if USE_DATETIME is set.

file_size

Uncompressed size.

compress_size

Compressed size.

CRC

CRC-32 of uncompressed file, unsigned int.

comment

File comment. Byte string or None. Use UNICODE_COMMENTS to get automatic decoding to unicode.

volume

Volume nr, starting from 0.

RAR-specific fields:

compress_type

Compression method: 0x30 - 0x35.

extract_version

Minimal Rar version needed for decompressing.

host_os

Host OS type, one of RAR_OS_* constants.

mode

File attributes. May be either dos-style or unix-style, depending on host_os.

volume_file

Volume file name, where file starts.

mtime

Optional time field: Modification time, with float seconds. Same as .date_time but with more precision.

ctime

Optional time field: creation time, with float seconds.

atime

Optional time field: last access time, with float seconds.

arctime

Optional time field: archival time, with float seconds.

Internal fields:

type

One of RAR_BLOCK_* types. Only entries with type==RAR_BLOCK_FILE are shown in .infolist().

flags

For files, RAR_FILE_* bits.

isdir()¶: Returns True if the entry is a directory.

RarExtFile class ¶

class rarfile.RarExtFile(rf, inf)¶

Bases: io.RawIOBase

Base class for file-like object that RarFile.open() returns.

Provides public methods and common crc checking.

Behaviour:

no short reads - .read() and .readinfo() read as much as requested.
no internal buffer, use io.BufferedReader for that.

If io module is available (Python 2.6+, 3.x), then this calls will inherit from io.RawIOBase class. This makes line-based access available: RarExtFile.readline() and for ln in f.

name = None¶: Filename of the archive entry

read(cnt=None)¶: Read all or specified amount of data from archive entry.

close()¶: Close open resources.

readinto(buf)¶

Zero-copy read directly into buffer.

Returns bytes read.

tell()¶: Return current reading position in uncompressed data.

seek(ofs, whence=0)¶

Seek in data.

On uncompressed files, the seeking works by actual seeks so it’s fast. On compresses files its slow - forward seeking happends by reading ahead, backwards by re-opening and decompressing from the start.

readable()¶: Returns True

writable()¶

Returns False.

Writing is not supported.

seekable()¶

Returns True.

Seeking is supported, although it’s slow on compressed files.

readall()¶: Read all remaining data

closed¶

closed: bool. True iff the file has been closed.

For backwards compatibility, this is a property, not a predicate.

fileno()¶

Returns underlying file descriptor if one exists.

An IOError is raised if the IO object does not use a file descriptor.

flush()¶

Flush write buffers, if applicable.

This is not implemented for read-only and non-blocking streams.

isatty()¶

Return whether this is an ‘interactive’ stream.

Return False if it can’t be determined.

readline(limit=-1)¶

Read and return a line from the stream.

If limit is specified, at most limit bytes will be read.

The line terminator is always b’n’ for binary files; for text files, the newlines argument to open can be used to select the line terminator(s) recognized.

readlines(hint=None)¶

Return a list of lines from the stream.

hint can be specified to control the number of lines read: no more lines will be read if the total size (in bytes/characters) of all lines so far exceeds hint.

truncate(pos=None)¶

Truncate file to size bytes.

Size defaults to the current IO position as reported by tell(). Return the new size.

write(b)¶

Write the given buffer to the IO stream.

Returns the number of bytes written, which may be less than len(b).