[Python-checkins] cpython (2.7): Issue #1625: Document BZ2File's lack of support for multi-stream inputs.
nadeem.vawda
python-checkins at python.org
Sat Feb 4 22:46:54 CET 2012
http://hg.python.org/cpython/rev/e73d549b7458
changeset: 74769:e73d549b7458
branch: 2.7
parent: 74766:741d4aaf7947
user: Nadeem Vawda <nadeem.vawda at gmail.com>
date: Sat Feb 04 23:43:25 2012 +0200
summary:
Issue #1625: Document BZ2File's lack of support for multi-stream inputs.
files:
Doc/library/bz2.rst | 9 +++++++++
1 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -67,6 +67,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 <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
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list