Deprecate the typing.io and typing.re pseudo-modules

[dgelessus]

BPO	38291
Nosy	@gvanrossum, @srittau, @ambv, @serhiy-storchaka, @ilevkivskyi, @JelleZijlstra, @miss-islington, @tirkarthi, @dgelessus, @Fidget-Spinner
PRs	bpo-38291: Remove mention of typing.io and typing.re again #26113 bpo-38291: DeprecationWarning when importing typing.{io,re} #26719 [3.10] bpo-38291: Remove mention of typing.io and typing.re again (GH-26113) #26720 [3.9] bpo-38291: Remove mention of typing.io and typing.re again (GH-26113) #26721 bpo-38291: Reset DeprecationWarning filters in test_typing io and re #26811 bpo-38291: Fix a spurious warning when using help(object) #27039 bpo-38291: Fix a deprecation warning in typing tests #27312 bpo-38291: Update 3.10 WhatsNew with typing.{io|re} DeprecationWarning #27872 [3.10] bpo-38291: Update 3.10 WhatsNew with typing.{io|re} DeprecationWarning (GH-27872) #27907

^{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 2021-07-24.04:12:34.707>
created_at = <Date 2019-09-27.11:48:37.318>
labels = ['3.11', 'type-bug', 'library', 'docs']
title = 'Deprecate the typing.io and typing.re pseudo-modules'
updated_at = <Date 2021-08-23.17:32:39.463>
user = 'https://github.com/dgelessus'

bugs.python.org fields:

activity = <Date 2021-08-23.17:32:39.463>
actor = 'miss-islington'
assignee = 'none'
closed = True
closed_date = <Date 2021-07-24.04:12:34.707>
closer = 'kj'
components = ['Documentation', 'Library (Lib)']
creation = <Date 2019-09-27.11:48:37.318>
creator = 'dgelessus'
dependencies = []
files = []
hgrepos = []
issue_num = 38291
keywords = ['patch']
message_count = 28.0
messages = ['353356', '353400', '392730', '393611', '393613', '395794', '395800', '395803', '395805', '396147', '396183', '396217', '396219', '396317', '396322', '396324', '396968', '396975', '397001', '397012', '397013', '397016', '397018', '397020', '397042', '398082', '400151', '400152']
nosy_count = 11.0
nosy_names = ['gvanrossum', 'srittau', 'docs@python', 'lukasz.langa', 'serhiy.storchaka', 'levkivskyi', 'JelleZijlstra', 'miss-islington', 'xtreak', 'dgelessus', 'kj']
pr_nums = ['26113', '26719', '26720', '26721', '26811', '27039', '27312', '27872', '27907']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38291'
versions = ['Python 3.11']

[dgelessus]

According to bpo-35089 (and the GitHub issues linked there), the typing.io and typing.re modules should no longer be used. Starting with Python 3.6, the typing documentation no longer mentions the typing.io and typing.re modules, and instead documents their contents as part of the main typing module.

However, the typing module at runtime still supports typing.io and typing.re as before. Since these modules are not meant to be used anymore and are no longer documented, I would expect at least a DeprecationWarning when using them at runtime.

The documentation on this could also be a bit clearer. As long as the modules are still supported at runtime, I would expect the documentation to mention that they still exist, but shouldn't be used anymore. In its current state, the documentation is confusing when coming from Python 3.5 (where typing.io and typing.re were the only documented way to access IO, Pattern, etc., but accessing typing.IO and typing.Pattern directly also works at runtime).

[ilevkivskyi]

Guido, what is your final opinion on this?

[JelleZijlstra]

The documentation (https://docs.python.org/3.10/library/typing.html#typing.BinaryIO) now mentions the typing.io and typing.re namespaces.

I would prefer that they be deprecated and eventually completely removed. They don't work with most static type checkers. https://bugs.python.org/issue42001 makes the same points.