diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-04 21:44:49 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-04 21:44:49 (GMT) |
| commit | 8f50912f8709446d379d76defc495a981bb1d8f8 (patch) | |
| tree | e54f015a4a952a4df0edc843a4b256042b219526 /Doc/library/bz2.rst | |
| parent | ed3b867f330c107ed77044cffb4b28703aa17d08 (diff) | |
| download | cpython-8f50912f8709446d379d76defc495a981bb1d8f8.zip cpython-8f50912f8709446d379d76defc495a981bb1d8f8.tar.gz cpython-8f50912f8709446d379d76defc495a981bb1d8f8.tar.bz2 | |
Issue #1625: Document BZ2File's lack of support for multi-stream inputs.
Diffstat (limited to 'Doc/library/bz2.rst')
| -rw-r--r-- | Doc/library/bz2.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index d9a2bad..e493ddd 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -65,6 +65,15 @@ Handling of compressed files is offered by the :class:`BZ2File` class. Support for the :keyword:`with` statement was added. + .. note:: + + This class does not support input files containing multiple streams (such + as those produced by the :program:`pbzip2` tool). When reading such an + input file, only the first stream will be accessible. If you require + support for multi-stream files, consider using the third-party `bz2file + module <http://pypi.python.org/pypi/bz2file>`_ instead of this class. + + .. method:: close() Close the file. Sets data attribute :attr:`closed` to true. A closed file |