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

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

This commit is contained in:
Nadeem Vawda 2012-02-05 14:29:00 +02:00
parent 9701eb6e14
commit bd249c1bae
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/library/bz2.rst
View File

@ -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
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.
support for multi-stream files, consider using the third-party
: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()