Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 1 | :mod:`bz2` --- Support for :program:`bzip2` compression |
| 2 | ======================================================= |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
| 4 | .. module:: bz2 |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 5 | :synopsis: Interfaces for bzip2 compression and decompression. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 6 | .. moduleauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 7 | .. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 8 | .. sectionauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 9 | .. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 10 | |
| 11 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 12 | This module provides a comprehensive interface for compressing and |
| 13 | decompressing data using the bzip2 compression algorithm. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 15 | The :mod:`bz2` module contains: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 16 | |
Nadeem Vawda | af518c1 | 2012-06-04 23:32:38 +0200 | [diff] [blame] | 17 | * The :func:`.open` function and :class:`BZ2File` class for reading and |
| 18 | writing compressed files. |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 19 | * The :class:`BZ2Compressor` and :class:`BZ2Decompressor` classes for |
| 20 | incremental (de)compression. |
| 21 | * The :func:`compress` and :func:`decompress` functions for one-shot |
| 22 | (de)compression. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 23 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 24 | All of the classes in this module may safely be accessed from multiple threads. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 25 | |
| 26 | |
| 27 | (De)compression of files |
| 28 | ------------------------ |
| 29 | |
Nadeem Vawda | af518c1 | 2012-06-04 23:32:38 +0200 | [diff] [blame] | 30 | .. function:: open(filename, mode='r', compresslevel=9, encoding=None, errors=None, newline=None) |
| 31 | |
| 32 | Open a bzip2-compressed file in binary or text mode, returning a :term:`file |
| 33 | object`. |
| 34 | |
| 35 | As with the constructor for :class:`BZ2File`, the *filename* argument can be |
| 36 | an actual filename (a :class:`str` or :class:`bytes` object), or an existing |
| 37 | file object to read from or write to. |
| 38 | |
| 39 | The *mode* argument can be any of ``'r'``, ``'rb'``, ``'w'``, ``'wb'``, |
Nadeem Vawda | 8a9e99c | 2013-10-19 00:11:06 +0200 | [diff] [blame] | 40 | ``'x'``, ``'xb'``, ``'a'`` or ``'ab'`` for binary mode, or ``'rt'``, |
| 41 | ``'wt'``, ``'xt'``, or ``'at'`` for text mode. The default is ``'rb'``. |
Nadeem Vawda | af518c1 | 2012-06-04 23:32:38 +0200 | [diff] [blame] | 42 | |
| 43 | The *compresslevel* argument is an integer from 1 to 9, as for the |
| 44 | :class:`BZ2File` constructor. |
| 45 | |
| 46 | For binary mode, this function is equivalent to the :class:`BZ2File` |
| 47 | constructor: ``BZ2File(filename, mode, compresslevel=compresslevel)``. In |
| 48 | this case, the *encoding*, *errors* and *newline* arguments must not be |
| 49 | provided. |
| 50 | |
| 51 | For text mode, a :class:`BZ2File` object is created, and wrapped in an |
| 52 | :class:`io.TextIOWrapper` instance with the specified encoding, error |
| 53 | handling behavior, and line ending(s). |
| 54 | |
| 55 | .. versionadded:: 3.3 |
| 56 | |
Nadeem Vawda | 8a9e99c | 2013-10-19 00:11:06 +0200 | [diff] [blame] | 57 | .. versionchanged:: 3.4 |
| 58 | The ``'x'`` (exclusive creation) mode was added. |
| 59 | |
Nadeem Vawda | af518c1 | 2012-06-04 23:32:38 +0200 | [diff] [blame] | 60 | |
Nadeem Vawda | aebcdba | 2012-06-04 23:31:20 +0200 | [diff] [blame] | 61 | .. class:: BZ2File(filename, mode='r', buffering=None, compresslevel=9) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 62 | |
Nadeem Vawda | af518c1 | 2012-06-04 23:32:38 +0200 | [diff] [blame] | 63 | Open a bzip2-compressed file in binary mode. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 64 | |
Nadeem Vawda | aebcdba | 2012-06-04 23:31:20 +0200 | [diff] [blame] | 65 | If *filename* is a :class:`str` or :class:`bytes` object, open the named file |
| 66 | directly. Otherwise, *filename* should be a :term:`file object`, which will |
| 67 | be used to read or write the compressed data. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 68 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 69 | The *mode* argument can be either ``'r'`` for reading (default), ``'w'`` for |
Nadeem Vawda | 8a9e99c | 2013-10-19 00:11:06 +0200 | [diff] [blame] | 70 | overwriting, ``'x'`` for exclusive creation, or ``'a'`` for appending. These |
| 71 | can equivalently be given as ``'rb'``, ``'wb'``, ``'xb'`` and ``'ab'`` |
| 72 | respectively. |
Nadeem Vawda | 50cb936 | 2012-06-04 23:31:22 +0200 | [diff] [blame] | 73 | |
| 74 | If *filename* is a file object (rather than an actual file name), a mode of |
| 75 | ``'w'`` does not truncate the file, and is instead equivalent to ``'a'``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 76 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 77 | The *buffering* argument is ignored. Its use is deprecated. |
| 78 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 79 | If *mode* is ``'w'`` or ``'a'``, *compresslevel* can be a number between |
| 80 | ``1`` and ``9`` specifying the level of compression: ``1`` produces the |
| 81 | least compression, and ``9`` (default) produces the most compression. |
| 82 | |
| 83 | If *mode* is ``'r'``, the input file may be the concatenation of multiple |
| 84 | compressed streams. |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 85 | |
| 86 | :class:`BZ2File` provides all of the members specified by the |
| 87 | :class:`io.BufferedIOBase`, except for :meth:`detach` and :meth:`truncate`. |
| 88 | Iteration and the :keyword:`with` statement are supported. |
| 89 | |
| 90 | :class:`BZ2File` also provides the following method: |
| 91 | |
| 92 | .. method:: peek([n]) |
| 93 | |
| 94 | Return buffered data without advancing the file position. At least one |
| 95 | byte of data will be returned (unless at EOF). The exact number of bytes |
| 96 | returned is unspecified. |
| 97 | |
Nadeem Vawda | 6976104 | 2013-12-08 19:47:22 +0100 | [diff] [blame] | 98 | .. note:: While calling :meth:`peek` does not change the file position of |
| 99 | the :class:`BZ2File`, it may change the position of the underlying file |
| 100 | object (e.g. if the :class:`BZ2File` was constructed by passing a file |
| 101 | object for *filename*). |
| 102 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 103 | .. versionadded:: 3.3 |
Benjamin Peterson | e0124bd | 2009-03-09 21:04:33 +0000 | [diff] [blame] | 104 | |
Benjamin Peterson | 10745a9 | 2009-03-09 21:08:47 +0000 | [diff] [blame] | 105 | .. versionchanged:: 3.1 |
Benjamin Peterson | e0124bd | 2009-03-09 21:04:33 +0000 | [diff] [blame] | 106 | Support for the :keyword:`with` statement was added. |
| 107 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 108 | .. versionchanged:: 3.3 |
| 109 | The :meth:`fileno`, :meth:`readable`, :meth:`seekable`, :meth:`writable`, |
| 110 | :meth:`read1` and :meth:`readinto` methods were added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 111 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 112 | .. versionchanged:: 3.3 |
Nadeem Vawda | aebcdba | 2012-06-04 23:31:20 +0200 | [diff] [blame] | 113 | Support was added for *filename* being a :term:`file object` instead of an |
| 114 | actual filename. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 115 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 116 | .. versionchanged:: 3.3 |
| 117 | The ``'a'`` (append) mode was added, along with support for reading |
| 118 | multi-stream files. |
| 119 | |
Nadeem Vawda | 8a9e99c | 2013-10-19 00:11:06 +0200 | [diff] [blame] | 120 | .. versionchanged:: 3.4 |
| 121 | The ``'x'`` (exclusive creation) mode was added. |
| 122 | |
Antoine Pitrou | 2dbc6e6 | 2015-04-11 00:31:01 +0200 | [diff] [blame] | 123 | .. versionchanged:: 3.5 |
| 124 | The :meth:`~io.BufferedIOBase.read` method now accepts an argument of |
| 125 | ``None``. |
| 126 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 127 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 128 | Incremental (de)compression |
| 129 | --------------------------- |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 130 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 131 | .. class:: BZ2Compressor(compresslevel=9) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 132 | |
| 133 | Create a new compressor object. This object may be used to compress data |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 134 | incrementally. For one-shot compression, use the :func:`compress` function |
| 135 | instead. |
| 136 | |
| 137 | *compresslevel*, if given, must be a number between ``1`` and ``9``. The |
| 138 | default is ``9``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 139 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 140 | .. method:: compress(data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 141 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 142 | Provide data to the compressor object. Returns a chunk of compressed data |
| 143 | if possible, or an empty byte string otherwise. |
| 144 | |
| 145 | When you have finished providing data to the compressor, call the |
| 146 | :meth:`flush` method to finish the compression process. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 147 | |
| 148 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 149 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 150 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 151 | Finish the compression process. Returns the compressed data left in |
| 152 | internal buffers. |
| 153 | |
| 154 | The compressor object may not be used after this method has been called. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 155 | |
| 156 | |
| 157 | .. class:: BZ2Decompressor() |
| 158 | |
| 159 | Create a new decompressor object. This object may be used to decompress data |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 160 | incrementally. For one-shot compression, use the :func:`decompress` function |
| 161 | instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 162 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 163 | .. note:: |
| 164 | This class does not transparently handle inputs containing multiple |
| 165 | compressed streams, unlike :func:`decompress` and :class:`BZ2File`. If |
| 166 | you need to decompress a multi-stream input with :class:`BZ2Decompressor`, |
| 167 | you must use a new decompressor for each stream. |
| 168 | |
Antoine Pitrou | e71258a | 2015-02-26 13:08:07 +0100 | [diff] [blame] | 169 | .. method:: decompress(data, max_length=-1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 170 | |
Antoine Pitrou | e71258a | 2015-02-26 13:08:07 +0100 | [diff] [blame] | 171 | Decompress *data* (a :term:`bytes-like object`), returning |
| 172 | uncompressed data as bytes. Some of *data* may be buffered |
| 173 | internally, for use in later calls to :meth:`decompress`. The |
| 174 | returned data should be concatenated with the output of any |
| 175 | previous calls to :meth:`decompress`. |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 176 | |
Antoine Pitrou | e71258a | 2015-02-26 13:08:07 +0100 | [diff] [blame] | 177 | If *max_length* is nonnegative, returns at most *max_length* |
| 178 | bytes of decompressed data. If this limit is reached and further |
| 179 | output can be produced, the :attr:`~.needs_input` attribute will |
| 180 | be set to ``False``. In this case, the next call to |
| 181 | :meth:`~.decompress` may provide *data* as ``b''`` to obtain |
| 182 | more of the output. |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 183 | |
Antoine Pitrou | e71258a | 2015-02-26 13:08:07 +0100 | [diff] [blame] | 184 | If all of the input data was decompressed and returned (either |
| 185 | because this was less than *max_length* bytes, or because |
| 186 | *max_length* was negative), the :attr:`~.needs_input` attribute |
| 187 | will be set to ``True``. |
| 188 | |
| 189 | Attempting to decompress data after the end of stream is reached |
| 190 | raises an `EOFError`. Any data found after the end of the |
| 191 | stream is ignored and saved in the :attr:`~.unused_data` attribute. |
| 192 | |
| 193 | .. versionchanged:: 3.5 |
| 194 | Added the *max_length* parameter. |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 195 | |
| 196 | .. attribute:: eof |
| 197 | |
Serhiy Storchaka | fbc1c26 | 2013-11-29 12:17:13 +0200 | [diff] [blame] | 198 | ``True`` if the end-of-stream marker has been reached. |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 199 | |
| 200 | .. versionadded:: 3.3 |
| 201 | |
| 202 | |
| 203 | .. attribute:: unused_data |
| 204 | |
| 205 | Data found after the end of the compressed stream. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 206 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 207 | If this attribute is accessed before the end of the stream has been |
| 208 | reached, its value will be ``b''``. |
| 209 | |
Antoine Pitrou | e71258a | 2015-02-26 13:08:07 +0100 | [diff] [blame] | 210 | .. attribute:: needs_input |
| 211 | |
| 212 | ``False`` if the :meth:`.decompress` method can provide more |
| 213 | decompressed data before requiring new uncompressed input. |
| 214 | |
| 215 | .. versionadded:: 3.5 |
| 216 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 217 | |
| 218 | One-shot (de)compression |
| 219 | ------------------------ |
| 220 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 221 | .. function:: compress(data, compresslevel=9) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 222 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 223 | Compress *data*. |
| 224 | |
| 225 | *compresslevel*, if given, must be a number between ``1`` and ``9``. The |
| 226 | default is ``9``. |
| 227 | |
| 228 | For incremental compression, use a :class:`BZ2Compressor` instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 229 | |
| 230 | |
| 231 | .. function:: decompress(data) |
| 232 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 233 | Decompress *data*. |
| 234 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 235 | If *data* is the concatenation of multiple compressed streams, decompress |
| 236 | all of the streams. |
| 237 | |
Antoine Pitrou | 37dc5f8 | 2011-04-03 17:05:46 +0200 | [diff] [blame] | 238 | For incremental decompression, use a :class:`BZ2Decompressor` instead. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 239 | |
Nadeem Vawda | 200e00a | 2011-05-27 01:52:16 +0200 | [diff] [blame] | 240 | .. versionchanged:: 3.3 |
| 241 | Support for multi-stream inputs was added. |
| 242 | |