Commit 9188fad2 authored by Benjamin Peterson's avatar Benjamin Peterson

document the compress_level argument to tarfile.open (closes #21404)

Patch by Katherine Busch.
parent 2af2d9e1
...@@ -81,6 +81,10 @@ Some facts and figures: ...@@ -81,6 +81,10 @@ Some facts and figures:
If *fileobj* is specified, it is used as an alternative to a :term:`file object` If *fileobj* is specified, it is used as an alternative to a :term:`file object`
opened in binary mode for *name*. It is supposed to be at position 0. opened in binary mode for *name*. It is supposed to be at position 0.
For modes ``'w:gz'``, ``'r:gz'``, ``'w:bz2'``, ``'r:bz2'``, :func:`tarfile.open`
accepts the keyword argument *compresslevel* to specify the compression level of
the file.
For special purposes, there is a second format for *mode*: For special purposes, there is a second format for *mode*:
``'filemode|[compression]'``. :func:`tarfile.open` will return a :class:`TarFile` ``'filemode|[compression]'``. :func:`tarfile.open` will return a :class:`TarFile`
object that processes its data as a stream of blocks. No random seeking will object that processes its data as a stream of blocks. No random seeking will
......
...@@ -195,6 +195,7 @@ Roger Burnham ...@@ -195,6 +195,7 @@ Roger Burnham
Alastair Burt Alastair Burt
Tarn Weisner Burton Tarn Weisner Burton
Lee Busby Lee Busby
Katherine Busch
Ralph Butler Ralph Butler
Nicolas Cadou Nicolas Cadou
Jp Calderone Jp Calderone
......
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