Argument Clinic doesn't handle module level functions with module parameter well

[serhiy-storchaka]

BPO	20388
Nosy	@larryhastings, @zware, @serhiy-storchaka

^{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-01-25.10:53:17.256>
created_at = <Date 2014-01-25.08:53:26.983>
labels = ['type-bug', 'invalid']
title = "Argument Clinic doesn't handle module level functions with module parameter well"
updated_at = <Date 2014-01-25.10:53:17.255>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2014-01-25.10:53:17.255>
actor = 'larry'
assignee = 'none'
closed = True
closed_date = <Date 2014-01-25.10:53:17.256>
closer = 'larry'
components = ['Demos and Tools']
creation = <Date 2014-01-25.08:53:26.983>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 20388
keywords = []
message_count = 7.0
messages = ['209166', '209167', '209169', '209171', '209178', '209182', '209188']
nosy_count = 3.0
nosy_names = ['larry', 'zach.ware', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue20388'
versions = ['Python 3.4']

[serhiy-storchaka]

Argument Clinic generates wrong signature for module level functions.

For example for the following declaration

/*[clinic input]
binascii.a2b_uu

ascii: ascii_buffer
/

Decode a line of uuencoded data.
[clinic start generated code]*/

Argument Clinic generates

PyDoc_STRVAR(binascii_a2b_uu__doc__,
"a2b_uu(module, ascii)\n"
"Decode a line of uuencoded data.");

[zware]

That's by design (of bpo-20189); inspect.Signature.from_builtin strips out the 'module' param.

[serhiy-storchaka]

What if function already has the "module" parameter? E.g. _warnings.warn_explicit.

[zware]

Ahh, that is a good point, though the real problem with that is in compilation rather than the Python signature. I believe there's a fix in the works, somewhere in Larry's to-do list. _winapi also has a function that takes a 'module' parameter, though being undocumented (and referring to a handle, not a Python module), I was able to just name that one 'module_handle'.

[larryhastings]

If you use a self converter you can name your first parameter anything you like.

[larryhastings]

So, are you still claiming there's a bug here? Or can we close this?

[serhiy-storchaka]

Well, if originally reported behavior is by design, and there is other open issue for the "module" parameter, we can close this.