Commit bd249c1b authored by Nadeem Vawda's avatar Nadeem Vawda

Clarify note in BZ2File docs about lack of multi-stream support (issue #1625).

parent 9701eb6e
...@@ -70,8 +70,11 @@ Handling of compressed files is offered by the :class:`BZ2File` class. ...@@ -70,8 +70,11 @@ Handling of compressed files is offered by the :class:`BZ2File` class.
This class does not support input files containing multiple streams (such This class does not support input files containing multiple streams (such
as those produced by the :program:`pbzip2` tool). When reading such an as those produced by the :program:`pbzip2` tool). When reading such an
input file, only the first stream will be accessible. If you require input file, only the first stream will be accessible. If you require
support for multi-stream files, consider using the third-party `bz2file support for multi-stream files, consider using the third-party
module <http://pypi.python.org/pypi/bz2file>`_ instead of this class. :mod:`bz2file` module (available from
`PyPI <http://pypi.python.org/pypi/bz2file>`_). This module provides a
backport of Python 3.3's :class:`BZ2File` class, which does support
multi-stream files.
.. method:: close() .. method:: close()
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment