Document options used to control compression level in tarfile

[Sworddragon]

BPO	21404
Nosy	@gustaebel, @merwok
Files	tardocs.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-06-07.19:48:18.398>
created_at = <Date 2014-04-30.21:06:56.457>
labels = ['easy', 'type-feature', 'docs']
title = 'Document options used to control compression level in tarfile'
updated_at = <Date 2014-06-07.19:48:18.396>
user = 'https://bugs.python.org/Sworddragon'

bugs.python.org fields:

activity = <Date 2014-06-07.19:48:18.396>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-06-07.19:48:18.398>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2014-04-30.21:06:56.457>
creator = 'Sworddragon'
dependencies = []
files = ['35520']
hgrepos = []
issue_num = 21404
keywords = ['patch', 'easy']
message_count = 9.0
messages = ['217655', '217693', '217704', '217705', '217706', '217767', '217771', '219963', '219967']
nosy_count = 6.0
nosy_names = ['lars.gustaebel', 'eric.araujo', 'docs@python', 'Sworddragon', 'python-dev', 'Katherine.Busch']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue21404'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']

[Sworddragon]

The tarfile/zipfile libraries doesn't seem to provide a direct way to specify the compression level. I have now ported my code from subprocess to tarfile/zipfile to achieve platform independency but would be happy if I could also control the compression level. Or is there a special reason not to add this?

[gustaebel]

tarfile.open() actually supports a compress_level argument for gzip and bzip2 and a preset argument for lzma compression.

[Sworddragon]

Could it be that compress_level is not documented?

[gustaebel]

That's right. But it is there.

[Sworddragon]

Then this one is easy: The documentation needs just an update. But then there is still zipfile that doesn't provide (or at least document) a compression level.

[merwok]

I'm reclassifying this ticket as a doc bug, would you mind opening a separate ticket for zipfile?

[Sworddragon]

Sure, here is the new ticket: http://bugs.python.org/issue21417

[KatherineBusch]

Here's a patch. The docs built and I inspected the output. Everything looks correct.

[python-dev]

New changeset 390b7fd617a9 by Benjamin Peterson in branch '2.7':
document the compress_level argument to tarfile.open (closes bpo-21404)
http://hg.python.org/cpython/rev/390b7fd617a9

New changeset 0c712828fb6e by Benjamin Peterson in branch '3.4':
document the compress_level argument to tarfile.open (closes bpo-21404)
http://hg.python.org/cpython/rev/0c712828fb6e

New changeset 171e8f6c814c by Benjamin Peterson in branch 'default':
merge 3.4 (bpo-21404)
http://hg.python.org/cpython/rev/171e8f6c814c