Skip to main content

A library to support the Internationalised Domain Names in Applications (IDNA) protocol as specified in RFC 5891. This version of the protocol is often referred to as “IDNA2008” and can produce different results from the earlier standard from 2003.

The library is also intended to act as a suitable drop-in replacement for the “encodings.idna” module that comes with the Python standard library but currently only supports the 2003 specification.

Its basic functions are simply executed:

>>> import idna
>>> idna.encode(u'ドメイン.テスト')
'xn--eckwd4c7c.xn--zckzah'
>>> print idna.decode('xn--eckwd4c7c.xn--zckzah')
ドメイン.テスト

Packages

The latest tagged release version is published in the PyPI repository:

https://badge.fury.io/py/idna.svg

Installation

To install this library, you can use PIP:

$ pip install idna

Alternatively, you can install the package using the bundled setup script:

$ python setup.py install

This library should work with Python 2.7, and Python 3.3 or later.

Usage

For typical usage, the encode and decode functions will take a domain name argument and perform a conversion to an A-label or U-label respectively.

>>> import idna
>>> idna.encode(u'ドメイン.テスト')
'xn--eckwd4c7c.xn--zckzah'
>>> print idna.decode('xn--eckwd4c7c.xn--zckzah')
ドメイン.テスト

You may use the stream encoding and decoding methods using the encodings.idna compatibility module.

>>> import idna.compat
>>> print u'домена.испытание'.encode('idna')
xn--80ahd1agd.xn--80akhbyknj4f
>>> print 'xn--80ahd1agd.xn--80akhbyknj4f'.decode('idna')
домена.испытание

Conversions can be applied at a per-label basis using the ulabel or alabel functions if necessary:

>>> idna.alabel(u'测试')
'xn--0zwm56d'

Exceptions

All errors raised during the conversion following the specification should raise an exception derived from the idna.IDNAError base class.

More specific exceptions that may be generated as idna.IDNABidiError when the error reflects an illegal combination of left-to-right and right-to-left characters in a label; idna.InvalidCodepoint when a specific codepoint is an illegal character in an IDN label (i.e. INVALID); and idna.InvalidCodepointContext when the codepoint is illegal based on its positional context (i.e. it is CONTEXTO or CONTEXTJ but the contextual requirements are not satisfied.)

Testing

The library has a test suite based on each rule of the IDNA specification, as well as a subset of tests that are defined in Unicode Technical Standard 46, Unicode IDNA Compatibility Processing. Note that not all tests defined there are used, as TR46 defines tests for a normalisation approach beyond merely implementing IDNA2008.

The tests are run automatically on each commit to the master branch of the idna git repository at Travis CI:

https://travis-ci.org/kjd/idna.svg?branch=master

Release files for idna 0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for idna 0.8
File Size Uploaded
idna-0.8.tar.gz 95.3 kB Details

Release files / idna-0.8.tar.gz

Download URL idna-0.8.tar.gz
Size 95.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1d2cc002082a0835cc6a4d3710f01f6ca565e65dca013144fa73c652c7d224af
BLAKE2b-256 checksum
How to use checksums
654aa571c5d86b11d98244fc822bf75322d2f5663372b8a80d2348d8a55c4332
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

3.20

2 release files

3.19

2 release files

3.18

2 release files

3.17

2 release files

3.16

2 release files

3.15

2 release files

3.14

2 release files

3.13

2 release files

3.12

2 release files

3.11

2 release files

3.10

2 release files

3.9

2 release files

3.8

2 release files

3.7

2 release files

3.6

2 release files

3.5

2 release files

3.4

2 release files

3.3

2 release files

3.2

2 release files

3.1

2 release files

3.0

2 release files

2.10

2 release files

2.9

2 release files

2.8

2 release files

2.7

2 release files

2.6

2 release files

2.5

2 release files

2.4

2 release files

2.3

2 release files

2.2

2 release files

2.1

3 release files

2.0

2 release files

1.1

1 release file

1.0

1 release file

0.9

1 release file

This release

0.8 This release

1 release file

0.7

1 release file

0.6

1 release file

0.5

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page