Skip to content

Commit 8d3b0f4

Browse files
andresdelfinobriancurtin
authored andcommitted
[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
1 parent 911231e commit 8d3b0f4

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

Doc/library/bz2.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Here is a summary of the features offered by the bz2 module:
3535

3636
* Thread safety uses individual locking mechanism.
3737

38+
.. note::
39+
Handling of multi-stream bzip2 files is not supported. Modules such as
40+
`bz2file <https://github.com/nvawda/bz2file>`_ let you overcome this.
41+
3842

3943
(De)compression of files
4044
------------------------

Doc/library/tarfile.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ Some facts and figures:
3737
character devices and block devices and is able to acquire and restore file
3838
information like timestamp, access permissions and owner.
3939

40+
.. note::
41+
Handling of multi-stream bzip2 files is not supported. Modules such as
42+
`bz2file <https://github.com/nvawda/bz2file>`_ let you overcome this.
43+
4044

4145
.. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs)
4246

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Add a note to :mod:`bz2` and :mod:`tarfile` stating that handling of
2+
multi-stream bzip2 files is not supported.

0 commit comments

Comments
 (0)