Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/lib/python3.8/site-packages/idna-3.10.dist-info/METADATA @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
rev   line source
jpayne@68 1 Metadata-Version: 2.1
jpayne@68 2 Name: idna
jpayne@68 3 Version: 3.10
jpayne@68 4 Summary: Internationalized Domain Names in Applications (IDNA)
jpayne@68 5 Author-email: Kim Davies <kim+pypi@gumleaf.org>
jpayne@68 6 Requires-Python: >=3.6
jpayne@68 7 Description-Content-Type: text/x-rst
jpayne@68 8 Classifier: Development Status :: 5 - Production/Stable
jpayne@68 9 Classifier: Intended Audience :: Developers
jpayne@68 10 Classifier: Intended Audience :: System Administrators
jpayne@68 11 Classifier: License :: OSI Approved :: BSD License
jpayne@68 12 Classifier: Operating System :: OS Independent
jpayne@68 13 Classifier: Programming Language :: Python
jpayne@68 14 Classifier: Programming Language :: Python :: 3
jpayne@68 15 Classifier: Programming Language :: Python :: 3 :: Only
jpayne@68 16 Classifier: Programming Language :: Python :: 3.6
jpayne@68 17 Classifier: Programming Language :: Python :: 3.7
jpayne@68 18 Classifier: Programming Language :: Python :: 3.8
jpayne@68 19 Classifier: Programming Language :: Python :: 3.9
jpayne@68 20 Classifier: Programming Language :: Python :: 3.10
jpayne@68 21 Classifier: Programming Language :: Python :: 3.11
jpayne@68 22 Classifier: Programming Language :: Python :: 3.12
jpayne@68 23 Classifier: Programming Language :: Python :: 3.13
jpayne@68 24 Classifier: Programming Language :: Python :: Implementation :: CPython
jpayne@68 25 Classifier: Programming Language :: Python :: Implementation :: PyPy
jpayne@68 26 Classifier: Topic :: Internet :: Name Service (DNS)
jpayne@68 27 Classifier: Topic :: Software Development :: Libraries :: Python Modules
jpayne@68 28 Classifier: Topic :: Utilities
jpayne@68 29 Requires-Dist: ruff >= 0.6.2 ; extra == "all"
jpayne@68 30 Requires-Dist: mypy >= 1.11.2 ; extra == "all"
jpayne@68 31 Requires-Dist: pytest >= 8.3.2 ; extra == "all"
jpayne@68 32 Requires-Dist: flake8 >= 7.1.1 ; extra == "all"
jpayne@68 33 Project-URL: Changelog, https://github.com/kjd/idna/blob/master/HISTORY.rst
jpayne@68 34 Project-URL: Issue tracker, https://github.com/kjd/idna/issues
jpayne@68 35 Project-URL: Source, https://github.com/kjd/idna
jpayne@68 36 Provides-Extra: all
jpayne@68 37
jpayne@68 38 Internationalized Domain Names in Applications (IDNA)
jpayne@68 39 =====================================================
jpayne@68 40
jpayne@68 41 Support for the Internationalized Domain Names in
jpayne@68 42 Applications (IDNA) protocol as specified in `RFC 5891
jpayne@68 43 <https://tools.ietf.org/html/rfc5891>`_. This is the latest version of
jpayne@68 44 the protocol and is sometimes referred to as “IDNA 2008”.
jpayne@68 45
jpayne@68 46 This library also provides support for Unicode Technical
jpayne@68 47 Standard 46, `Unicode IDNA Compatibility Processing
jpayne@68 48 <https://unicode.org/reports/tr46/>`_.
jpayne@68 49
jpayne@68 50 This acts as a suitable replacement for the “encodings.idna”
jpayne@68 51 module that comes with the Python standard library, but which
jpayne@68 52 only supports the older superseded IDNA specification (`RFC 3490
jpayne@68 53 <https://tools.ietf.org/html/rfc3490>`_).
jpayne@68 54
jpayne@68 55 Basic functions are simply executed:
jpayne@68 56
jpayne@68 57 .. code-block:: pycon
jpayne@68 58
jpayne@68 59 >>> import idna
jpayne@68 60 >>> idna.encode('ドメイン.テスト')
jpayne@68 61 b'xn--eckwd4c7c.xn--zckzah'
jpayne@68 62 >>> print(idna.decode('xn--eckwd4c7c.xn--zckzah'))
jpayne@68 63 ドメイン.テスト
jpayne@68 64
jpayne@68 65
jpayne@68 66 Installation
jpayne@68 67 ------------
jpayne@68 68
jpayne@68 69 This package is available for installation from PyPI:
jpayne@68 70
jpayne@68 71 .. code-block:: bash
jpayne@68 72
jpayne@68 73 $ python3 -m pip install idna
jpayne@68 74
jpayne@68 75
jpayne@68 76 Usage
jpayne@68 77 -----
jpayne@68 78
jpayne@68 79 For typical usage, the ``encode`` and ``decode`` functions will take a
jpayne@68 80 domain name argument and perform a conversion to A-labels or U-labels
jpayne@68 81 respectively.
jpayne@68 82
jpayne@68 83 .. code-block:: pycon
jpayne@68 84
jpayne@68 85 >>> import idna
jpayne@68 86 >>> idna.encode('ドメイン.テスト')
jpayne@68 87 b'xn--eckwd4c7c.xn--zckzah'
jpayne@68 88 >>> print(idna.decode('xn--eckwd4c7c.xn--zckzah'))
jpayne@68 89 ドメイン.テスト
jpayne@68 90
jpayne@68 91 You may use the codec encoding and decoding methods using the
jpayne@68 92 ``idna.codec`` module:
jpayne@68 93
jpayne@68 94 .. code-block:: pycon
jpayne@68 95
jpayne@68 96 >>> import idna.codec
jpayne@68 97 >>> print('домен.испытание'.encode('idna2008'))
jpayne@68 98 b'xn--d1acufc.xn--80akhbyknj4f'
jpayne@68 99 >>> print(b'xn--d1acufc.xn--80akhbyknj4f'.decode('idna2008'))
jpayne@68 100 домен.испытание
jpayne@68 101
jpayne@68 102 Conversions can be applied at a per-label basis using the ``ulabel`` or
jpayne@68 103 ``alabel`` functions if necessary:
jpayne@68 104
jpayne@68 105 .. code-block:: pycon
jpayne@68 106
jpayne@68 107 >>> idna.alabel('测试')
jpayne@68 108 b'xn--0zwm56d'
jpayne@68 109
jpayne@68 110 Compatibility Mapping (UTS #46)
jpayne@68 111 +++++++++++++++++++++++++++++++
jpayne@68 112
jpayne@68 113 As described in `RFC 5895 <https://tools.ietf.org/html/rfc5895>`_, the
jpayne@68 114 IDNA specification does not normalize input from different potential
jpayne@68 115 ways a user may input a domain name. This functionality, known as
jpayne@68 116 a “mapping”, is considered by the specification to be a local
jpayne@68 117 user-interface issue distinct from IDNA conversion functionality.
jpayne@68 118
jpayne@68 119 This library provides one such mapping that was developed by the
jpayne@68 120 Unicode Consortium. Known as `Unicode IDNA Compatibility Processing
jpayne@68 121 <https://unicode.org/reports/tr46/>`_, it provides for both a regular
jpayne@68 122 mapping for typical applications, as well as a transitional mapping to
jpayne@68 123 help migrate from older IDNA 2003 applications. Strings are
jpayne@68 124 preprocessed according to Section 4.4 “Preprocessing for IDNA2008”
jpayne@68 125 prior to the IDNA operations.
jpayne@68 126
jpayne@68 127 For example, “Königsgäßchen” is not a permissible label as *LATIN
jpayne@68 128 CAPITAL LETTER K* is not allowed (nor are capital letters in general).
jpayne@68 129 UTS 46 will convert this into lower case prior to applying the IDNA
jpayne@68 130 conversion.
jpayne@68 131
jpayne@68 132 .. code-block:: pycon
jpayne@68 133
jpayne@68 134 >>> import idna
jpayne@68 135 >>> idna.encode('Königsgäßchen')
jpayne@68 136 ...
jpayne@68 137 idna.core.InvalidCodepoint: Codepoint U+004B at position 1 of 'Königsgäßchen' not allowed
jpayne@68 138 >>> idna.encode('Königsgäßchen', uts46=True)
jpayne@68 139 b'xn--knigsgchen-b4a3dun'
jpayne@68 140 >>> print(idna.decode('xn--knigsgchen-b4a3dun'))
jpayne@68 141 königsgäßchen
jpayne@68 142
jpayne@68 143 Transitional processing provides conversions to help transition from
jpayne@68 144 the older 2003 standard to the current standard. For example, in the
jpayne@68 145 original IDNA specification, the *LATIN SMALL LETTER SHARP S* (ß) was
jpayne@68 146 converted into two *LATIN SMALL LETTER S* (ss), whereas in the current
jpayne@68 147 IDNA specification this conversion is not performed.
jpayne@68 148
jpayne@68 149 .. code-block:: pycon
jpayne@68 150
jpayne@68 151 >>> idna.encode('Königsgäßchen', uts46=True, transitional=True)
jpayne@68 152 'xn--knigsgsschen-lcb0w'
jpayne@68 153
jpayne@68 154 Implementers should use transitional processing with caution, only in
jpayne@68 155 rare cases where conversion from legacy labels to current labels must be
jpayne@68 156 performed (i.e. IDNA implementations that pre-date 2008). For typical
jpayne@68 157 applications that just need to convert labels, transitional processing
jpayne@68 158 is unlikely to be beneficial and could produce unexpected incompatible
jpayne@68 159 results.
jpayne@68 160
jpayne@68 161 ``encodings.idna`` Compatibility
jpayne@68 162 ++++++++++++++++++++++++++++++++
jpayne@68 163
jpayne@68 164 Function calls from the Python built-in ``encodings.idna`` module are
jpayne@68 165 mapped to their IDNA 2008 equivalents using the ``idna.compat`` module.
jpayne@68 166 Simply substitute the ``import`` clause in your code to refer to the new
jpayne@68 167 module name.
jpayne@68 168
jpayne@68 169 Exceptions
jpayne@68 170 ----------
jpayne@68 171
jpayne@68 172 All errors raised during the conversion following the specification
jpayne@68 173 should raise an exception derived from the ``idna.IDNAError`` base
jpayne@68 174 class.
jpayne@68 175
jpayne@68 176 More specific exceptions that may be generated as ``idna.IDNABidiError``
jpayne@68 177 when the error reflects an illegal combination of left-to-right and
jpayne@68 178 right-to-left characters in a label; ``idna.InvalidCodepoint`` when
jpayne@68 179 a specific codepoint is an illegal character in an IDN label (i.e.
jpayne@68 180 INVALID); and ``idna.InvalidCodepointContext`` when the codepoint is
jpayne@68 181 illegal based on its positional context (i.e. it is CONTEXTO or CONTEXTJ
jpayne@68 182 but the contextual requirements are not satisfied.)
jpayne@68 183
jpayne@68 184 Building and Diagnostics
jpayne@68 185 ------------------------
jpayne@68 186
jpayne@68 187 The IDNA and UTS 46 functionality relies upon pre-calculated lookup
jpayne@68 188 tables for performance. These tables are derived from computing against
jpayne@68 189 eligibility criteria in the respective standards. These tables are
jpayne@68 190 computed using the command-line script ``tools/idna-data``.
jpayne@68 191
jpayne@68 192 This tool will fetch relevant codepoint data from the Unicode repository
jpayne@68 193 and perform the required calculations to identify eligibility. There are
jpayne@68 194 three main modes:
jpayne@68 195
jpayne@68 196 * ``idna-data make-libdata``. Generates ``idnadata.py`` and
jpayne@68 197 ``uts46data.py``, the pre-calculated lookup tables used for IDNA and
jpayne@68 198 UTS 46 conversions. Implementers who wish to track this library against
jpayne@68 199 a different Unicode version may use this tool to manually generate a
jpayne@68 200 different version of the ``idnadata.py`` and ``uts46data.py`` files.
jpayne@68 201
jpayne@68 202 * ``idna-data make-table``. Generate a table of the IDNA disposition
jpayne@68 203 (e.g. PVALID, CONTEXTJ, CONTEXTO) in the format found in Appendix
jpayne@68 204 B.1 of RFC 5892 and the pre-computed tables published by `IANA
jpayne@68 205 <https://www.iana.org/>`_.
jpayne@68 206
jpayne@68 207 * ``idna-data U+0061``. Prints debugging output on the various
jpayne@68 208 properties associated with an individual Unicode codepoint (in this
jpayne@68 209 case, U+0061), that are used to assess the IDNA and UTS 46 status of a
jpayne@68 210 codepoint. This is helpful in debugging or analysis.
jpayne@68 211
jpayne@68 212 The tool accepts a number of arguments, described using ``idna-data
jpayne@68 213 -h``. Most notably, the ``--version`` argument allows the specification
jpayne@68 214 of the version of Unicode to be used in computing the table data. For
jpayne@68 215 example, ``idna-data --version 9.0.0 make-libdata`` will generate
jpayne@68 216 library data against Unicode 9.0.0.
jpayne@68 217
jpayne@68 218
jpayne@68 219 Additional Notes
jpayne@68 220 ----------------
jpayne@68 221
jpayne@68 222 * **Packages**. The latest tagged release version is published in the
jpayne@68 223 `Python Package Index <https://pypi.org/project/idna/>`_.
jpayne@68 224
jpayne@68 225 * **Version support**. This library supports Python 3.6 and higher.
jpayne@68 226 As this library serves as a low-level toolkit for a variety of
jpayne@68 227 applications, many of which strive for broad compatibility with older
jpayne@68 228 Python versions, there is no rush to remove older interpreter support.
jpayne@68 229 Removing support for older versions should be well justified in that the
jpayne@68 230 maintenance burden has become too high.
jpayne@68 231
jpayne@68 232 * **Python 2**. Python 2 is supported by version 2.x of this library.
jpayne@68 233 Use "idna<3" in your requirements file if you need this library for
jpayne@68 234 a Python 2 application. Be advised that these versions are no longer
jpayne@68 235 actively developed.
jpayne@68 236
jpayne@68 237 * **Testing**. The library has a test suite based on each rule of the
jpayne@68 238 IDNA specification, as well as tests that are provided as part of the
jpayne@68 239 Unicode Technical Standard 46, `Unicode IDNA Compatibility Processing
jpayne@68 240 <https://unicode.org/reports/tr46/>`_.
jpayne@68 241
jpayne@68 242 * **Emoji**. It is an occasional request to support emoji domains in
jpayne@68 243 this library. Encoding of symbols like emoji is expressly prohibited by
jpayne@68 244 the technical standard IDNA 2008 and emoji domains are broadly phased
jpayne@68 245 out across the domain industry due to associated security risks. For
jpayne@68 246 now, applications that need to support these non-compliant labels
jpayne@68 247 may wish to consider trying the encode/decode operation in this library
jpayne@68 248 first, and then falling back to using `encodings.idna`. See `the Github
jpayne@68 249 project <https://github.com/kjd/idna/issues/18>`_ for more discussion.
jpayne@68 250