Skip to content

Commit 2e4b587

Browse files
committed
Update README to reflect transitional processing is gone
1 parent 7c6a8e6 commit 2e4b587

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

README.rst

+8-25
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,10 @@ ways a user may input a domain name. This functionality, known as
7979
a “mapping”, is considered by the specification to be a local
8080
user-interface issue distinct from IDNA conversion functionality.
8181

82-
This library provides one such mapping that was developed by the
83-
Unicode Consortium. Known as `Unicode IDNA Compatibility Processing
84-
<https://unicode.org/reports/tr46/>`_, it provides for both a regular
85-
mapping for typical applications, as well as a transitional mapping to
86-
help migrate from older IDNA 2003 applications. Strings are
87-
preprocessed according to Section 4.4 “Preprocessing for IDNA2008”
88-
prior to the IDNA operations.
82+
This library provides one such mapping — `Unicode IDNA Compatibility
83+
Processing <https://unicode.org/reports/tr46/>`_ developed by the Unicode
84+
Consortium. Strings are preprocessed according to Section 4.4
85+
“Preprocessing for IDNA2008” prior to the IDNA operations.
8986

9087
For example, “Königsgäßchen” is not a permissible label as *LATIN
9188
CAPITAL LETTER K* is not allowed (nor are capital letters in general).
@@ -103,24 +100,6 @@ conversion.
103100
>>> print(idna.decode('xn--knigsgchen-b4a3dun'))
104101
königsgäßchen
105102
106-
Transitional processing provides conversions to help transition from
107-
the older 2003 standard to the current standard. For example, in the
108-
original IDNA specification, the *LATIN SMALL LETTER SHARP S* (ß) was
109-
converted into two *LATIN SMALL LETTER S* (ss), whereas in the current
110-
IDNA specification this conversion is not performed.
111-
112-
.. code-block:: pycon
113-
114-
>>> idna.encode('Königsgäßchen', uts46=True, transitional=True)
115-
'xn--knigsgsschen-lcb0w'
116-
117-
Implementers should use transitional processing with caution, only in
118-
rare cases where conversion from legacy labels to current labels must be
119-
performed (i.e. IDNA implementations that pre-date 2008). For typical
120-
applications that just need to convert labels, transitional processing
121-
is unlikely to be beneficial and could produce unexpected incompatible
122-
results.
123-
124103
``encodings.idna`` Compatibility
125104
++++++++++++++++++++++++++++++++
126105

@@ -210,3 +189,7 @@ Additional Notes
210189
may wish to consider trying the encode/decode operation in this library
211190
first, and then falling back to using `encodings.idna`. See `the Github
212191
project <https://github.com/kjd/idna/issues/18>`_ for more discussion.
192+
193+
* **Transitional processing**. Unicode 16.0.0 removed transitional
194+
processing so the `transitional` argument for the encode() method
195+
no longer has any effect and will be removed at a later date.

0 commit comments

Comments
 (0)