[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
This commit is contained in:
Andrés Delfino 2018-09-29 13:57:35 -03:00 committed by Brian Curtin
parent 911231e708
commit 8d3b0f4902
3 changed files with 10 additions and 0 deletions

View File

@ -35,6 +35,10 @@ Here is a summary of the features offered by the bz2 module:
* 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
------------------------

View File

@ -37,6 +37,10 @@ Some facts and figures:
character devices and block devices and is able to acquire and restore file
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)

View File

@ -0,0 +1,2 @@
Add a note to :mod:`bz2` and :mod:`tarfile` stating that handling of
multi-stream bzip2 files is not supported.