(original) (raw)

changeset: 74770:190826ee0450 branch: 3.2 parent: 74767:3e9a7fdf0498 user: Nadeem Vawda nadeem.vawda@gmail.com date: Sat Feb 04 23:44:49 2012 +0200 files: Doc/library/bz2.rst description: Issue #1625: Document BZ2File's lack of support for multi-stream inputs. diff -r 3e9a7fdf0498 -r 190826ee0450 Doc/library/bz2.rst --- a/Doc/library/bz2.rst Sat Feb 04 18:36:43 2012 +0100 +++ b/Doc/library/bz2.rst Sat Feb 04 23:44:49 2012 +0200 @@ -65,6 +65,15 @@ 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/nadeem.vawda@gmail.com