bz2 --- bzip2 壓縮的支援

原始碼：Lib/bz2.py

This module provides a comprehensive interface for compressing and decompressing data using the bzip2 compression algorithm.

bz2 模組包含：

This is an optional module. If it is missing from your copy of CPython, look for documentation from your distributor (that is, whoever provided Python to you). If you are the distributor, see 可選模組的需求.

(De)compression of files

bz2.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

Open a bzip2-compressed file in binary or text mode, returning a file object.

As with the constructor for BZ2File, the filename argument can be an actual filename (a str or bytes object), or an existing file object to read from or write to.

The mode argument can be any of 'r', 'rb', 'w', 'wb', 'x', 'xb', 'a' or 'ab' for binary mode, or 'rt', 'wt', 'xt', or 'at' for text mode. The default is 'rb'.

The compresslevel argument is an integer from 1 to 9, as for the BZ2File constructor.

For binary mode, this function is equivalent to the BZ2File constructor: BZ2File(filename, mode, compresslevel=compresslevel). In this case, the encoding, errors and newline arguments must not be provided.

For text mode, a BZ2File object is created, and wrapped in an io.TextIOWrapper instance with the specified encoding, error handling behavior, and line ending(s).

在 3.3 版被加入.

在 3.4 版的變更: The 'x' (exclusive creation) mode was added.

在 3.6 版的變更: 接受一個類路徑物件。

class bz2.BZ2File(filename, mode='r', *, compresslevel=9)

Open a bzip2-compressed file in binary mode.

If filename is a str or bytes object, open the named file directly. Otherwise, filename should be a file object, which will be used to read or write the compressed data.

The mode argument can be either 'r' for reading (default), 'w' for overwriting, 'x' for exclusive creation, or 'a' for appending. These can equivalently be given as 'rb', 'wb', 'xb' and 'ab' respectively.

If filename is a file object (rather than an actual file name), a mode of 'w' does not truncate the file, and is instead equivalent to 'a'.

If mode is 'w' or 'a', compresslevel can be an integer between 1 and 9 specifying the level of compression: 1 produces the least compression, and 9 (default) produces the most compression.

If mode is 'r', the input file may be the concatenation of multiple compressed streams.

BZ2File provides all of the members specified by the io.BufferedIOBase, except for detach() and truncate(). Iteration and the with statement are supported.

BZ2File 也提供了以下方法和屬性：

peek([n])

Return buffered data without advancing the file position. At least one byte of data will be returned (unless at EOF). The exact number of bytes returned is unspecified.

備註

While calling peek() does not change the file position of the BZ2File, it may change the position of the underlying file object (e.g. if the BZ2File was constructed by passing a file object for filename).

在 3.3 版被加入.

fileno()

Return the file descriptor for the underlying file.

在 3.3 版被加入.

readable()

Return whether the file was opened for reading.

在 3.3 版被加入.

seekable()

Return whether the file supports seeking.

在 3.3 版被加入.

writable()

Return whether the file was opened for writing.

在 3.3 版被加入.

read1(size=-1)

Read up to size uncompressed bytes, while trying to avoid making multiple reads from the underlying stream. Reads up to a buffer's worth of data if size is negative.

如果檔案已經到達 EOF 則回傳 b''。

在 3.3 版被加入.

readinto(b)

Read bytes into b.

Returns the number of bytes read (0 for EOF).

在 3.3 版被加入.

mode

'rb' for reading and 'wb' for writing.

在 3.13 版被加入.

name

The bzip2 file name. Equivalent to the name attribute of the underlying file object.

在 3.13 版被加入.

在 3.1 版的變更: 新增對 with 陳述式的支援。

在 3.3 版的變更: Support was added for filename being a file object instead of an actual filename.

The 'a' (append) mode was added, along with support for reading multi-stream files.

在 3.4 版的變更: The 'x' (exclusive creation) mode was added.

在 3.5 版的變更: The read() method now accepts an argument of None.

在 3.6 版的變更: 接受一個類路徑物件。

在 3.9 版的變更: The buffering parameter has been removed. It was ignored and deprecated since Python 3.0. Pass an open file object to control how the file is opened.

The compresslevel parameter became keyword-only.

在 3.10 版的變更: This class is thread unsafe in the face of multiple simultaneous readers or writers, just like its equivalent classes in gzip and lzma have always been.

Incremental (de)compression

class bz2.BZ2Compressor(compresslevel=9)

Create a new compressor object. This object may be used to compress data incrementally. For one-shot compression, use the compress() function instead.

compresslevel, if given, must be an integer between 1 and 9. The default is 9.

compress(data)

Provide data to the compressor object. Returns a chunk of compressed data if possible, or an empty byte string otherwise.

When you have finished providing data to the compressor, call the flush() method to finish the compression process.

flush()

Finish the compression process. Returns the compressed data left in internal buffers.

The compressor object may not be used after this method has been called.

class bz2.BZ2Decompressor

Create a new decompressor object. This object may be used to decompress data incrementally. For one-shot compression, use the decompress() function instead.

備註

This class does not transparently handle inputs containing multiple compressed streams, unlike decompress() and