Make zlib accept keyword-arguments

[ebfe]

BPO	16764
Nosy	@vstinner, @ezio-melotti, @vadmium, @serhiy-storchaka, @matrixise, @zhangyangyu
Files	zlib_keywords.patch zlib_tests_pep8.patch: PEP8/PyFlakes-fixes for test_zlib.py zlib_keyword_argument.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 2016-09-04.04:17:30.905>
created_at = <Date 2012-12-24.12:45:08.618>
labels = ['extension-modules', 'type-feature']
title = 'Make zlib accept keyword-arguments'
updated_at = <Date 2016-09-04.04:17:30.904>
user = 'https://bugs.python.org/ebfe'

bugs.python.org fields:

activity = <Date 2016-09-04.04:17:30.904>
actor = 'martin.panter'
assignee = 'none'
closed = True
closed_date = <Date 2016-09-04.04:17:30.905>
closer = 'martin.panter'
components = ['Extension Modules']
creation = <Date 2012-12-24.12:45:08.618>
creator = 'ebfe'
dependencies = []
files = ['28418', '28419', '44074']
hgrepos = []
issue_num = 16764
keywords = ['patch']
message_count = 21.0
messages = ['178053', '178054', '178058', '178059', '178063', '259453', '272350', '272357', '272404', '272437', '272481', '272491', '272722', '272723', '272731', '272897', '272920', '273014', '273015', '273271', '273279']
nosy_count = 8.0
nosy_names = ['vstinner', 'ezio.melotti', 'ebfe', 'python-dev', 'martin.panter', 'serhiy.storchaka', 'matrixise', 'xiang.zhang']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue16764'
versions = ['Python 3.6']

[ebfe]

The patch "zlib_keywords.patch" makes zlib's classes and functions accept keyword arguments as documented. It also fixes two cases in which the docstring differ from the documentation (decompress(data) vs. decompress(string) and compressobj(memlevel) vs. compressobj(memLevel)). Additional tests are provided.

[ebfe]

Attaching a patch to fix all pep8/pyflakes warnings and errors in test_zlib.py

[serhiy-storchaka]

I don't think it worth to add support of keyword for the first mandatory argument. This can freeze the poor and inconsistent () names. For example compress()/decompress() methods of bz2 and lzma objects doesn't support keyword arguments. And why you use "string" name for decompress() argument?

Renaming of "memLevel" argument to "memlevel" is not backward compatible and can break third-part code (if anyone use it). This may require starting of deprecation process. Difference between a code and a documentation is a bug and should be fixed for all Python versions.

Note, that calling a function with keyword arguments is a little slower (a lot of slower for fast functions) than calling a function with positional-only arguments.

[ebfe]

Nothing of what you mention is a problem of this patch.

The memLevel-keyword was not supported as of now, only the docstring ("memLevel") and the documentation ("memlevel") mentioned it. There is no third-party code that could have used it.

The current docstring says that a "string"-keyword should be used with decompress(), the documentation talks about a "data"-keyword. Both are not supported, the patch adds support for a "data"-keyword and fixes the docstring.

[serhiy-storchaka]

Sorry, I missed, not decompress(), but compress(). Except this small error all of what I said *is* a problem of this patch.