Commit 8d3b0f49 authored by Andrés Delfino's avatar Andrés Delfino Committed by Brian Curtin

[2.7] bpo-13407: Mention that bz2/tarfile doesn't support multi-stream bzip2 files (GH-8428)

* bpo-13407: Mention that tarfile doesn't support multistream bzip2 files

* Add mention to bz2 module also
parent 911231e7
...@@ -35,6 +35,10 @@ Here is a summary of the features offered by the bz2 module: ...@@ -35,6 +35,10 @@ Here is a summary of the features offered by the bz2 module:
* Thread safety uses individual locking mechanism. * Thread safety uses individual locking mechanism.
.. note::
Handling of multi-stream bzip2 files is not supported. Modules such as
`bz2file <https://github.com/nvawda/bz2file>`_ let you overcome this.
(De)compression of files (De)compression of files
------------------------ ------------------------
......
...@@ -37,6 +37,10 @@ Some facts and figures: ...@@ -37,6 +37,10 @@ Some facts and figures:
character devices and block devices and is able to acquire and restore file character devices and block devices and is able to acquire and restore file
information like timestamp, access permissions and owner. information like timestamp, access permissions and owner.
.. note::
Handling of multi-stream bzip2 files is not supported. Modules such as
`bz2file <https://github.com/nvawda/bz2file>`_ let you overcome this.
.. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs) .. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs)
......
Add a note to :mod:`bz2` and :mod:`tarfile` stating that handling of
multi-stream bzip2 files is not supported.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment