unicodedata — Unicode Database

This module provides access to the Unicode Character Database (UCD) whichdefines character properties for all Unicode characters. The data contained inthis database is compiled from theUCD version 15.1.0.

The module uses the same names and symbols as defined by UnicodeStandard Annex #44,“Unicode Character Database”. It defines thefollowing functions:

unicodedata.lookup(name)

Look up character by name. If a character with the given name is found, returnthe corresponding character. If not found,KeyError is raised.

Changed in version 3.3:Support for name aliases[1] and named sequences[2] has been added.

unicodedata.name(chr[,default])

Returns the name assigned to the characterchr as a string. If noname is defined,default is returned, or, if not given,ValueError israised.

unicodedata.decimal(chr[,default])

Returns the decimal value assigned to the characterchr as integer.If no such value is defined,default is returned, or, if not given,ValueError is raised.

unicodedata.digit(chr[,default])

Returns the digit value assigned to the characterchr as integer.If no such value is defined,default is returned, or, if not given,ValueError is raised.

unicodedata.numeric(chr[,default])

Returns the numeric value assigned to the characterchr as float.If no such value is defined,default is returned, or, if not given,ValueError is raised.

unicodedata.category(chr)

Returns the general category assigned to the characterchr asstring.

unicodedata.bidirectional(chr)

Returns the bidirectional class assigned to the characterchr asstring. If no such value is defined, an empty string is returned.

unicodedata.combining(chr)

Returns the canonical combining class assigned to the characterchras integer. Returns0 if no combining class is defined.

unicodedata.east_asian_width(chr)

Returns the east asian width assigned to the characterchr asstring.

unicodedata.mirrored(chr)

Returns the mirrored property assigned to the characterchr asinteger. Returns1 if the character has been identified as a “mirrored”character in bidirectional text,0 otherwise.

unicodedata.decomposition(chr)

Returns the character decomposition mapping assigned to the characterchr as string. An empty string is returned in case no such mapping isdefined.

unicodedata.normalize(form,unistr)

Return the normal formform for the Unicode stringunistr. Valid values forform are ‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

The Unicode standard defines various normalization forms of a Unicode string,based on the definition of canonical equivalence and compatibility equivalence.In Unicode, several characters can be expressed in various way. For example, thecharacter U+00C7 (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed asthe sequence U+0043 (LATIN CAPITAL LETTER C) U+0327 (COMBINING CEDILLA).

For each character, there are two normal forms: normal form C and normal form D.Normal form D (NFD) is also known as canonical decomposition, and translateseach character into its decomposed form. Normal form C (NFC) first applies acanonical decomposition, then composes pre-combined characters again.

In addition to these two forms, there are two additional normal forms based oncompatibility equivalence. In Unicode, certain characters are supported whichnormally would be unified with other characters. For example, U+2160 (ROMANNUMERAL ONE) is really the same thing as U+0049 (LATIN CAPITAL LETTER I).However, it is supported in Unicode for compatibility with existing charactersets (e.g. gb2312).

The normal form KD (NFKD) will apply the compatibility decomposition, i.e.replace all compatibility characters with their equivalents. The normal form KC(NFKC) first applies the compatibility decomposition, followed by the canonicalcomposition.

Even if two unicode strings are normalized and look the same toa human reader, if one has combining characters and the otherdoesn’t, they may not compare equal.

unicodedata.is_normalized(form,unistr)

Return whether the Unicode stringunistr is in the normal formform. Validvalues forform are ‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

Added in version 3.8.

In addition, the module exposes the following constant:

unicodedata.unidata_version

The version of the Unicode database used in this module.

unicodedata.ucd_3_2_0

This is an object that has the same methods as the entire module, but uses theUnicode database version 3.2 instead, for applications that require thisspecific version of the Unicode database (such as IDNA).

Examples:

>>>importunicodedata>>>unicodedata.lookup('LEFT CURLY BRACKET')'{'>>>unicodedata.name('/')'SOLIDUS'>>>unicodedata.decimal('9')9>>>unicodedata.decimal('a')Traceback (most recent call last):  File"<stdin>", line1, in<module>ValueError:not a decimal>>>unicodedata.category('A')# 'L'etter, 'u'ppercase'Lu'>>>unicodedata.bidirectional('\u0660')# 'A'rabic, 'N'umber'AN'

Footnotes

[1]

https://www.unicode.org/Public/15.1.0/ucd/NameAliases.txt

[2]

https://www.unicode.org/Public/15.1.0/ucd/NamedSequences.txt