diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-04 23:43:25 +0200 |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-04 23:43:25 +0200 |
| commit | acd51f9ea944504fd981ef552563b375acfcba40 (patch) | |
| tree | 762cada974c44239aabedd64bb6c18aee08fb82b /Doc/library/bz2.rst | |
| parent | 61c953436399944d0159209acf1eb373a4e97dec (diff) | |
| download | cpython-git-acd51f9ea944504fd981ef552563b375acfcba40.tar.gz | |
Issue #1625: Document BZ2File's lack of support for multi-stream inputs.
Diffstat (limited to 'Doc/library/bz2.rst')
| -rw-r--r-- | Doc/library/bz2.rst | 9 |
1 files changed, 9 insertions, 0 deletions
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 <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 |