Prefer using __spec__ over module_repr() for ModuleType.__repr__

[brettcannon]

BPO	42137
Nosy	@brettcannon
PRs	bpo-42137: have ModuleType.__repr__ prefer __spec__ over module_repr() #24953

^{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 = 'https://github.com/brettcannon'
closed_at = <Date 2021-03-24.15:27:17.592>
created_at = <Date 2020-10-23.23:20:55.502>
labels = ['interpreter-core', 'type-bug']
title = 'Prefer using __spec__ over module_repr() for ModuleType.__repr__'
updated_at = <Date 2021-03-24.15:27:17.591>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2021-03-24.15:27:17.591>
actor = 'brett.cannon'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2021-03-24.15:27:17.592>
closer = 'brett.cannon'
components = ['Interpreter Core']
creation = <Date 2020-10-23.23:20:55.502>
creator = 'brett.cannon'
dependencies = []
files = []
hgrepos = []
issue_num = 42137
keywords = ['patch']
message_count = 5.0
messages = ['379496', '389177', '389206', '389326', '389470']
nosy_count = 1.0
nosy_names = ['brett.cannon']
pr_nums = ['24953']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue42137'
versions = []

[brettcannon]

Once all traces of module_repr() are gone, raise an ImportWarning when using module_repr().

Once this is implemented and has been out in the wild for a sufficient amount of time, it should be switching to a DeprecationWarning and then the fallback eventually removed.

[brettcannon]

Should try to use __spec__ first, but if it isn't set then fall back on module_repr() and raise an ImportWarning. See Lib/importlib/_bootstrap.py:_module_repr.

[brettcannon]

Thinking about it more, raising ImportWarning (or DeprecationWarning) is unnecessarily noisy as the existence of the module isn't problematic, it just won't be used anymore in the future. So updating the code to use __spec__ first and then document in "What's New" should be good enough.

[brettcannon]

Meant to say, "existence of the _method_ isn't problematic".

[brettcannon]

New changeset 9cb31d6 by Brett Cannon in branch 'master':
bpo-42137: have ModuleType.__repr__ prefer __spec__ over module_repr() (GH-24953)
9cb31d6