Module bz2 :: Class BZ2File

Class BZ2File

object --+
         |
        BZ2File

BZ2File(name [, mode='r', buffering=0, compresslevel=9]) -> file object

Open a bz2 file. The mode can be 'r' or 'w', for reading (default) or writing. When opened for writing, the file will be created if it doesn't exist, and truncated otherwise. If the buffering argument is given, 0 means unbuffered, and larger numbers specify the buffer size. If compresslevel is given, must be a number between 1 and 9.

Add a 'U' to mode to open the file for input with universal newline support. Any line ending in the input file will be seen as a '\n' in Python. Also, a file so opened gains the attribute 'newlines'; the value for this attribute is one of None (no newline read yet), '\r', '\n', '\r\n' or a tuple containing all the newline types seen. Universal newlines are available only when reading.

Instance Methods

[hide private]

__delattr__(...)
x.__delattr__('name') <==> del x.name

__getattribute__(...)
x.__getattribute__('name') <==> x.name

file object

__init__(name, mode='r', buffering=0, compresslevel=9)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

__iter__(x)
iter(x)

a new object with type S, a subtype of T

__new__(T, S, ...)

__setattr__(...)
x.__setattr__('name', value) <==> x.name = value

None or (perhaps) an integer

close()
Close the file.

the next value, or raise StopIteration

next(x)

string

read(size=...)
Read at most size uncompressed bytes, returned as a string.

string

readline(size=...)
Return the next line from the file, as a string, retaining newline.

list

readlines(size=...)
Call readline() repeatedly and return a list of lines read.

None

seek(offset, whence=...)
Move to new file position.

int

tell()
Return the current file position, an integer (may be a long integer).

None

write(data)
Write the 'data' string to file.

None

writelines(sequence_of_strings)
Write the sequence of strings to the file.

self

xreadlines()
For backward compatibility.

Inherited from object: __hash__, __reduce__, __reduce_ex__, __repr__, __str__

Properties

[hide private]

closed
True if the file is closed

mode
file mode ('r', 'w', or 'U')

name
file name

newlines
end-of-line convention used in this file

softspace
flag indicating that a space needs to be printed; used by print

Inherited from object: __class__

Method Details

[hide private]

delattr(...)

x.__delattr__('name') <==> del x.name

Overrides: object.__delattr__

getattribute(...)

x.__getattribute__('name') <==> x.name

Overrides: object.__getattribute__

init(name, mode='r', buffering=0, compresslevel=9)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Returns: file object
Overrides: object.__init__

new(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

setattr(...)

x.__setattr__('name', value) <==> x.name = value

Overrides: object.__setattr__

close()

Close the file. Sets data attribute .closed to true. A closed file cannot be used for further I/O operations. close() may be called more than once without error.

Returns: None or (perhaps) an integer

read(size=...)

Read at most size uncompressed bytes, returned as a string. If the size argument is negative or omitted, read until EOF is reached.

Returns: string

readline(size=...)

Return the next line from the file, as a string, retaining newline. A non-negative size argument will limit the maximum number of bytes to return (an incomplete line may be returned then). Return an empty string at EOF.

Returns: string

readlines(size=...)

Call readline() repeatedly and return a list of lines read. The optional size argument, if given, is an approximate bound on the total number of bytes in the lines returned.

Returns: list

seek(offset, whence=...)

Move to new file position. Argument offset is a byte count. Optional argument whence defaults to 0 (offset from start of file, offset should be >= 0); other values are 1 (move relative to current position, positive or negative), and 2 (move relative to end of file, usually negative, although many platforms allow seeking beyond the end of a file).

Note that seeking of bz2 files is emulated, and depending on the parameters the operation may be extremely slow.

Returns: None

write(data)

Write the 'data' string to file. Note that due to buffering, close() may be needed before the file on disk reflects the data written.

Returns: None

writelines(sequence_of_strings)

Write the sequence of strings to the file. Note that newlines are not added. The sequence can be any iterable object producing strings. This is equivalent to calling write() for each string.

Returns: None

xreadlines()

For backward compatibility. BZ2File objects now include the performance optimizations previously implemented in the xreadlines module.

Returns: self

Class BZ2File

__delattr__(...)

__getattribute__(...)

__init__(name, mode='r', buffering=0, compresslevel=9) (Constructor)

__new__(T, S, ...)

__setattr__(...)

close()

read(size=...)

readline(size=...)

readlines(size=...)

seek(offset, whence=...)

write(data)

writelines(sequence_of_strings)

xreadlines()

delattr(...)

getattribute(...)

init(name, mode='r', buffering=0, compresslevel=9)
(Constructor)

new(T, S, ...)

setattr(...)