Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Issue #1625: Document BZ2File's lack of support for multi-stream inputs.

This commit is contained in:
Nadeem Vawda 2012-02-04 23:43:25 +02:00
parent 61c9534363
commit acd51f9ea9
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/library/bz2.rst
View File

@ -67,6 +67,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