mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-31 23:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

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

Browse source
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
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 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()