Deprecate modules listed in PEP 594

[brettcannon]

BPO	47061
Nosy	@warsaw, @brettcannon, @hugovk, @miss-islington, @tirkarthi
PRs	bpo-47061: document module deprecations due to PEP 594 #31984 [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) #32039 [3.9] bpo-47061: document module deprecations due to PEP 594 (GH-31984) #32082 bpo-47061: deprecate the aifc module #32134 bpo-47061: use warnings._deprecated() with asynchat, asyncore, and smtpd #32350 bpo-47061: deprecate audioop #32392 bpo-47061: deprecate cgi and cgitb #32410
Dependencies	bpo-47022: PEP 594: Document removal of asynchat, asyncore and smtpd

^{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 = None
created_at = <Date 2022-03-18.19:46:10.638>
labels = ['deferred-blocker', 'library', '3.11']
title = 'Deprecate modules listed in PEP 594'
updated_at = <Date 2022-04-08.03:39:21.812>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2022-04-08.03:39:21.812>
actor = 'brett.cannon'
assignee = 'brett.cannon'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2022-03-18.19:46:10.638>
creator = 'brett.cannon'
dependencies = ['47022']
files = []
hgrepos = []
issue_num = 47061
keywords = ['patch']
message_count = 8.0
messages = ['415521', '415525', '415725', '415732', '415733', '415906', '416804', '416896']
nosy_count = 5.0
nosy_names = ['barry', 'brett.cannon', 'hugovk', 'miss-islington', 'xtreak']
pr_nums = ['31984', '32039', '32082', '32134', '32350', '32392', '32410']
priority = 'deferred blocker'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue47061'
versions = ['Python 3.11']

[brettcannon]

https://peps.python.org/pep-0594/

The SC has asked that all modules deprecated by PEP-594 have the documented deprecation backported. The message should also not have any specific removal version to avoid any potential delay, but then making the bugfix-only docs incorrect.

• aifc
• asynchat: https://bugs.python.org/issue47022
• asyncore: https://bugs.python.org/issue47022
• audioop
• cgi
• cgitb
• chunk 3869a83
• crypt gh-91217: deprecate crypt #91459
• imghdr gh-91217: deprecate imghdr #91461
• mailcap gh-68966: Deprecate the mailcap module #91951
• msilib gh-91217: deprecate msilib #91515
• nis gh-91217: deprecate nis #91606
• nntplib gh-91217: deprecate nntplib #91543
• ossaudiodev gh-91217: deprecate ossaudiodev #91641
• pipes gh-91217: deprecate-pipes #91779
• smtpd: https://bugs.python.org/issue47022
• sndhdr gh-91217: deprecate-sndhdr #91806
• spwd gh-91217: deprecate spwd #91846
• sunau gh-91217: deprecate sunau #91866
• telnetlib gh-91217: deprecate telnetlib #91958
• uu gh-91217: deprecate uu #92009
• xdrlib gh-91217: deprecate xdrlib #92066

[brettcannon]

The first PR for documenting the modules is up. Once this gets merged and backported I will add a helper function in warnings and then make the appropriate code changes.

[miss-islington]

New changeset 9ac2de9 by Brett Cannon in branch 'main':
bpo-47061: document module deprecations due to PEP-594 (GH-31984)
9ac2de9

[miss-islington]

New changeset c353835 by Miss Islington (bot) in branch '3.10':
[3.10] bpo-47061: document module deprecations due to PEP-594 (GH-31984) (GH-32039)
c353835

[brettcannon]

One thing I forgot to mention is that I will be updating What's New as the code deprecations land.

[miss-islington]

New changeset e513b81 by Hugo van Kemenade in branch '3.9':
[3.9] bpo-47061: document module deprecations due to PEP-594 (GH-31984) (GH-32082)
e513b81

[brettcannon]

New changeset c1d93b6 by Brett Cannon in branch 'main':
bpo-47061: deprecate the aifc module (GH-32134)
c1d93b6

[brettcannon]

New changeset 32b3387 by Brett Cannon in branch 'main':
bpo-47061: use warnings._deprecated() with asynchat, asyncore, and smtpd (GH-32350)
32b3387

[vstinner]

I created the PR #91951 to deprecate the mailcap module (see issue #68966).

[gnat]

Is deprecating CGI a logical thing to do here? Was there any real benefit to this?

There's very likely going to be breakage from this in the Python ecosystem. Deprecating CGI is kind of like deprecating HTTP or JSON or CSV.. it's a very well established standard.

Just because "my current project at work" doesn't use something, doesn't mean it should go into the trashbin for everybody. Seems totally random.

[hugovk]

cgi has been moved to a separate package on PyPI that you can use instead:

• https://discuss.python.org/t/pep-594-take-2-removing-dead-batteries-from-the-standard-library/13508/23?u=hugovk

• https://pypi.org/project/legacy-cgi/

[brettcannon]

Is deprecating CGI a logical thing to do here? Was there any real benefit to this?

Yes, please read the PEP for the motivation.