classification
Title: Document encodings.idna limitations
Type: enhancement Stage:
Components: Documentation, Unicode Versions: Python 3.10
process
Status: open Resolution:
Dependencies: Superseder: IDNA2008 encoding is missing
View: 17305
Assigned To: docs@python Nosy List: christian.heimes, docs@python, ezio.melotti, rixx
Priority: normal Keywords:

Created on 2020-12-02 09:54 by rixx, last changed 2020-12-02 12:18 by christian.heimes.

Messages (2)
msg382300 - (view) Author: Tobias Kunze (rixx) * Date: 2020-12-02 09:54
The documentation for the encodings.idna module contains no indicator that the RFC it supports has been obsoleted by another RFC: https://docs.python.org/3.10/library/codecs.html#module-encodings.idna

I'm sure this is obvious when you know your RFCs, but when just looking at the docs, it's easy to miss. In #msg379674, Marc-Andre suggested to fix the situation by deprecating or updating IDNA support. I'd like to propose to add a warning message in the meantime, pointing out the newer RFC and linking to the idna package on PyPI (if links to PyPI packages are alright in the docs?)
msg382308 - (view) Author: Christian Heimes (christian.heimes) * (Python committer) Date: 2020-12-02 12:18
+1 for updating our documentation.

Please use bpo-17305. The ticket contains more information on the issue.
History
Date User Action Args
2020-12-02 12:18:41christian.heimessetsuperseder: IDNA2008 encoding is missing
messages: + msg382308
2020-12-02 10:55:41vstinnersetnosy: + christian.heimes, - vstinner
2020-12-02 09:54:58rixxcreate