Rename parameter name of imghdr what

[corona10]

BPO	37303
Nosy	@serhiy-storchaka, @corona10, @tirkarthi

^{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 2019-06-16.06:24:06.966>
created_at = <Date 2019-06-16.04:55:09.524>
labels = ['type-feature', 'library', '3.9']
title = 'Rename parameter name of imghdr what'
updated_at = <Date 2019-06-16.06:24:06.960>
user = 'https://github.com/corona10'

bugs.python.org fields:

activity = <Date 2019-06-16.06:24:06.960>
actor = 'serhiy.storchaka'
assignee = 'none'
closed = True
closed_date = <Date 2019-06-16.06:24:06.966>
closer = 'serhiy.storchaka'
components = ['Library (Lib)']
creation = <Date 2019-06-16.04:55:09.524>
creator = 'corona10'
dependencies = []
files = []
hgrepos = []
issue_num = 37303
keywords = []
message_count = 3.0
messages = ['345727', '345728', '345729']
nosy_count = 3.0
nosy_names = ['serhiy.storchaka', 'corona10', 'xtreak']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue37303'
versions = ['Python 3.9']

[corona10]

Still

cpython/Lib/imghdr.py

Line 11 in 3a1d50e

def what(file, h=None):

signature is def what(file, h=None).

I 'd like to suggest to update it into def what(filename, h=None)
Also, the doc of imghdr represents it as the filename.
https://docs.python.org/3/library/imghdr.html

note that sndhdr is already using this name.

cpython/Lib/sndhdr.py

Line 52 in 3a1d50e

def what(filename):

If this proposal is accepted, I'd like to send a patch for it.

[tirkarthi]

file can be a positional or keyword argument. Someone might be using it as a keyword argument and this would require a deprecation period before renaming could be done.

./python.exe
Python 3.9.0a0 (heads/master:7a68f8c28b, Jun 15 2019, 21:00:05)
[Clang 7.0.2 (clang-700.1.81)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import inspect, imghdr
>>> imghdr.what(file="README.rst")
>>> imghdr.what("README.rst")
>>> inspect.signature(imghdr.what).parameters['file'].kind.description
'positional or keyword'

[serhiy-storchaka]

Inlike to sndhdr.what(), imghdr.what() accepts not only file names, by file objects theirself. The feature was added at 1997 in 45ac47c.