From acd51f9ea944504fd981ef552563b375acfcba40 Mon Sep 17 00:00:00 2001 From: Nadeem Vawda Date: Sat, 4 Feb 2012 23:43:25 +0200 Subject: Issue #1625: Document BZ2File's lack of support for multi-stream inputs. --- Doc/library/bz2.rst | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'Doc/library/bz2.rst') diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index ed281bd72c..3ff227b34a 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -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 `_ instead of this class. + + .. method:: close() Close the file. Sets data attribute :attr:`closed` to true. A closed file -- cgit v1.2.1