2008-12-02 18:34:15 -04:00
|
|
|
.. _unicode-howto:
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
*****************
|
|
|
|
Unicode HOWTO
|
|
|
|
*****************
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
:Release: 1.1
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
This HOWTO discusses Python's support for Unicode, and explains various problems
|
|
|
|
that people commonly encounter when trying to work with Unicode.
|
|
|
|
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
Introduction to Unicode
|
|
|
|
=======================
|
|
|
|
|
|
|
|
History of Character Codes
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
In 1968, the American Standard Code for Information Interchange, better known by
|
|
|
|
its acronym ASCII, was standardized. ASCII defined numeric codes for various
|
2008-11-22 06:26:59 -04:00
|
|
|
characters, with the numeric values running from 0 to 127. For example, the
|
|
|
|
lowercase letter 'a' is assigned 97 as its code value.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
ASCII was an American-developed standard, so it only defined unaccented
|
|
|
|
characters. There was an 'e', but no 'é' or 'Í'. This meant that languages
|
|
|
|
which required accented characters couldn't be faithfully represented in ASCII.
|
|
|
|
(Actually the missing accents matter for English, too, which contains words such
|
|
|
|
as 'naïve' and 'café', and some publications have house styles which require
|
|
|
|
spellings such as 'coöperate'.)
|
|
|
|
|
|
|
|
For a while people just wrote programs that didn't display accents. I remember
|
|
|
|
looking at Apple ][ BASIC programs, published in French-language publications in
|
|
|
|
the mid-1980s, that had lines like these::
|
|
|
|
|
2009-01-03 17:26:05 -04:00
|
|
|
PRINT "FICHIER EST COMPLETE."
|
|
|
|
PRINT "CARACTERE NON ACCEPTE."
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Those messages should contain accents, and they just look wrong to someone who
|
|
|
|
can read French.
|
|
|
|
|
|
|
|
In the 1980s, almost all personal computers were 8-bit, meaning that bytes could
|
|
|
|
hold values ranging from 0 to 255. ASCII codes only went up to 127, so some
|
|
|
|
machines assigned values between 128 and 255 to accented characters. Different
|
|
|
|
machines had different codes, however, which led to problems exchanging files.
|
|
|
|
Eventually various commonly used sets of values for the 128-255 range emerged.
|
|
|
|
Some were true standards, defined by the International Standards Organization,
|
|
|
|
and some were **de facto** conventions that were invented by one company or
|
|
|
|
another and managed to catch on.
|
|
|
|
|
|
|
|
255 characters aren't very many. For example, you can't fit both the accented
|
|
|
|
characters used in Western Europe and the Cyrillic alphabet used for Russian
|
|
|
|
into the 128-255 range because there are more than 127 such characters.
|
|
|
|
|
|
|
|
You could write files using different codes (all your Russian files in a coding
|
|
|
|
system called KOI8, all your French files in a different coding system called
|
|
|
|
Latin1), but what if you wanted to write a French document that quotes some
|
|
|
|
Russian text? In the 1980s people began to want to solve this problem, and the
|
|
|
|
Unicode standardization effort began.
|
|
|
|
|
|
|
|
Unicode started out using 16-bit characters instead of 8-bit characters. 16
|
|
|
|
bits means you have 2^16 = 65,536 distinct values available, making it possible
|
|
|
|
to represent many different characters from many different alphabets; an initial
|
|
|
|
goal was to have Unicode contain the alphabets for every single human language.
|
|
|
|
It turns out that even 16 bits isn't enough to meet that goal, and the modern
|
|
|
|
Unicode specification uses a wider range of codes, 0-1,114,111 (0x10ffff in
|
|
|
|
base-16).
|
|
|
|
|
|
|
|
There's a related ISO standard, ISO 10646. Unicode and ISO 10646 were
|
|
|
|
originally separate efforts, but the specifications were merged with the 1.1
|
|
|
|
revision of Unicode.
|
|
|
|
|
|
|
|
(This discussion of Unicode's history is highly simplified. I don't think the
|
|
|
|
average Python programmer needs to worry about the historical details; consult
|
|
|
|
the Unicode consortium site listed in the References for more information.)
|
|
|
|
|
|
|
|
|
|
|
|
Definitions
|
|
|
|
-----------
|
|
|
|
|
|
|
|
A **character** is the smallest possible component of a text. 'A', 'B', 'C',
|
|
|
|
etc., are all different characters. So are 'È' and 'Í'. Characters are
|
|
|
|
abstractions, and vary depending on the language or context you're talking
|
|
|
|
about. For example, the symbol for ohms (Ω) is usually drawn much like the
|
|
|
|
capital letter omega (Ω) in the Greek alphabet (they may even be the same in
|
|
|
|
some fonts), but these are two different characters that have different
|
|
|
|
meanings.
|
|
|
|
|
|
|
|
The Unicode standard describes how characters are represented by **code
|
|
|
|
points**. A code point is an integer value, usually denoted in base 16. In the
|
|
|
|
standard, a code point is written using the notation U+12ca to mean the
|
|
|
|
character with value 0x12ca (4810 decimal). The Unicode standard contains a lot
|
|
|
|
of tables listing characters and their corresponding code points::
|
|
|
|
|
2009-01-03 17:26:05 -04:00
|
|
|
0061 'a'; LATIN SMALL LETTER A
|
|
|
|
0062 'b'; LATIN SMALL LETTER B
|
|
|
|
0063 'c'; LATIN SMALL LETTER C
|
|
|
|
...
|
|
|
|
007B '{'; LEFT CURLY BRACKET
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Strictly, these definitions imply that it's meaningless to say 'this is
|
|
|
|
character U+12ca'. U+12ca is a code point, which represents some particular
|
|
|
|
character; in this case, it represents the character 'ETHIOPIC SYLLABLE WI'. In
|
|
|
|
informal contexts, this distinction between code points and characters will
|
|
|
|
sometimes be forgotten.
|
|
|
|
|
|
|
|
A character is represented on a screen or on paper by a set of graphical
|
|
|
|
elements that's called a **glyph**. The glyph for an uppercase A, for example,
|
|
|
|
is two diagonal strokes and a horizontal stroke, though the exact details will
|
|
|
|
depend on the font being used. Most Python code doesn't need to worry about
|
|
|
|
glyphs; figuring out the correct glyph to display is generally the job of a GUI
|
|
|
|
toolkit or a terminal's font renderer.
|
|
|
|
|
|
|
|
|
|
|
|
Encodings
|
|
|
|
---------
|
|
|
|
|
|
|
|
To summarize the previous section: a Unicode string is a sequence of code
|
|
|
|
points, which are numbers from 0 to 0x10ffff. This sequence needs to be
|
|
|
|
represented as a set of bytes (meaning, values from 0-255) in memory. The rules
|
|
|
|
for translating a Unicode string into a sequence of bytes are called an
|
|
|
|
**encoding**.
|
|
|
|
|
|
|
|
The first encoding you might think of is an array of 32-bit integers. In this
|
|
|
|
representation, the string "Python" would look like this::
|
|
|
|
|
|
|
|
P y t h o n
|
2007-09-04 04:15:32 -03:00
|
|
|
0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00
|
|
|
|
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
This representation is straightforward but using it presents a number of
|
|
|
|
problems.
|
|
|
|
|
|
|
|
1. It's not portable; different processors order the bytes differently.
|
|
|
|
|
|
|
|
2. It's very wasteful of space. In most texts, the majority of the code points
|
|
|
|
are less than 127, or less than 255, so a lot of space is occupied by zero
|
|
|
|
bytes. The above string takes 24 bytes compared to the 6 bytes needed for an
|
|
|
|
ASCII representation. Increased RAM usage doesn't matter too much (desktop
|
|
|
|
computers have megabytes of RAM, and strings aren't usually that large), but
|
|
|
|
expanding our usage of disk and network bandwidth by a factor of 4 is
|
|
|
|
intolerable.
|
|
|
|
|
|
|
|
3. It's not compatible with existing C functions such as ``strlen()``, so a new
|
|
|
|
family of wide string functions would need to be used.
|
|
|
|
|
|
|
|
4. Many Internet standards are defined in terms of textual data, and can't
|
|
|
|
handle content with embedded zero bytes.
|
|
|
|
|
|
|
|
Generally people don't use this encoding, instead choosing other encodings that
|
|
|
|
are more efficient and convenient.
|
|
|
|
|
|
|
|
Encodings don't have to handle every possible Unicode character, and most
|
2009-09-11 17:42:29 -03:00
|
|
|
encodings don't. The rules for converting a Unicode string into the ASCII
|
|
|
|
encoding, for example, are simple; for each code point:
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
1. If the code point is < 128, each byte is the same as the value of the code
|
|
|
|
point.
|
|
|
|
|
|
|
|
2. If the code point is 128 or greater, the Unicode string can't be represented
|
|
|
|
in this encoding. (Python raises a :exc:`UnicodeEncodeError` exception in this
|
|
|
|
case.)
|
|
|
|
|
|
|
|
Latin-1, also known as ISO-8859-1, is a similar encoding. Unicode code points
|
|
|
|
0-255 are identical to the Latin-1 values, so converting to this encoding simply
|
|
|
|
requires converting code points to byte values; if a code point larger than 255
|
|
|
|
is encountered, the string can't be encoded into Latin-1.
|
|
|
|
|
|
|
|
Encodings don't have to be simple one-to-one mappings like Latin-1. Consider
|
|
|
|
IBM's EBCDIC, which was used on IBM mainframes. Letter values weren't in one
|
|
|
|
block: 'a' through 'i' had values from 129 to 137, but 'j' through 'r' were 145
|
|
|
|
through 153. If you wanted to use EBCDIC as an encoding, you'd probably use
|
|
|
|
some sort of lookup table to perform the conversion, but this is largely an
|
|
|
|
internal detail.
|
|
|
|
|
|
|
|
UTF-8 is one of the most commonly used encodings. UTF stands for "Unicode
|
|
|
|
Transformation Format", and the '8' means that 8-bit numbers are used in the
|
|
|
|
encoding. (There's also a UTF-16 encoding, but it's less frequently used than
|
|
|
|
UTF-8.) UTF-8 uses the following rules:
|
|
|
|
|
|
|
|
1. If the code point is <128, it's represented by the corresponding byte value.
|
|
|
|
2. If the code point is between 128 and 0x7ff, it's turned into two byte values
|
|
|
|
between 128 and 255.
|
|
|
|
3. Code points >0x7ff are turned into three- or four-byte sequences, where each
|
|
|
|
byte of the sequence is between 128 and 255.
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
UTF-8 has several convenient properties:
|
|
|
|
|
|
|
|
1. It can handle any Unicode code point.
|
|
|
|
2. A Unicode string is turned into a string of bytes containing no embedded zero
|
|
|
|
bytes. This avoids byte-ordering issues, and means UTF-8 strings can be
|
|
|
|
processed by C functions such as ``strcpy()`` and sent through protocols that
|
|
|
|
can't handle zero bytes.
|
|
|
|
3. A string of ASCII text is also valid UTF-8 text.
|
|
|
|
4. UTF-8 is fairly compact; the majority of code points are turned into two
|
|
|
|
bytes, and values less than 128 occupy only a single byte.
|
|
|
|
5. If bytes are corrupted or lost, it's possible to determine the start of the
|
|
|
|
next UTF-8-encoded code point and resynchronize. It's also unlikely that
|
|
|
|
random 8-bit data will look like valid UTF-8.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
References
|
|
|
|
----------
|
|
|
|
|
|
|
|
The Unicode Consortium site at <http://www.unicode.org> has character charts, a
|
|
|
|
glossary, and PDF versions of the Unicode specification. Be prepared for some
|
|
|
|
difficult reading. <http://www.unicode.org/history/> is a chronology of the
|
|
|
|
origin and development of Unicode.
|
|
|
|
|
|
|
|
To help understand the standard, Jukka Korpela has written an introductory guide
|
|
|
|
to reading the Unicode character tables, available at
|
|
|
|
<http://www.cs.tut.fi/~jkorpela/unicode/guide.html>.
|
|
|
|
|
2009-09-16 13:00:31 -03:00
|
|
|
Another good introductory article was written by Joel Spolsky
|
|
|
|
<http://www.joelonsoftware.com/articles/Unicode.html>.
|
|
|
|
If this introduction didn't make things clear to you, you should try reading this
|
|
|
|
alternate article before continuing.
|
|
|
|
|
|
|
|
.. Jason Orendorff XXX http://www.jorendorff.com/articles/unicode/ is broken
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Wikipedia entries are often helpful; see the entries for "character encoding"
|
|
|
|
<http://en.wikipedia.org/wiki/Character_encoding> and UTF-8
|
|
|
|
<http://en.wikipedia.org/wiki/UTF-8>, for example.
|
|
|
|
|
|
|
|
|
|
|
|
Python's Unicode Support
|
|
|
|
========================
|
|
|
|
|
|
|
|
Now that you've learned the rudiments of Unicode, we can look at Python's
|
|
|
|
Unicode features.
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
The String Type
|
|
|
|
---------------
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
Since Python 3.0, the language features a ``str`` type that contain Unicode
|
|
|
|
characters, meaning any string created using ``"unicode rocks!"``, ``'unicode
|
2009-05-04 18:01:20 -03:00
|
|
|
rocks!'``, or the triple-quoted string syntax is stored as Unicode.
|
2008-02-01 07:56:49 -04:00
|
|
|
|
|
|
|
To insert a Unicode character that is not part ASCII, e.g., any letters with
|
|
|
|
accents, one can use escape sequences in their string literals as such::
|
|
|
|
|
|
|
|
>>> "\N{GREEK CAPITAL LETTER DELTA}" # Using the character name
|
|
|
|
'\u0394'
|
|
|
|
>>> "\u0394" # Using a 16-bit hex value
|
|
|
|
'\u0394'
|
|
|
|
>>> "\U00000394" # Using a 32-bit hex value
|
|
|
|
'\u0394'
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
In addition, one can create a string using the :func:`decode` method of
|
|
|
|
:class:`bytes`. This method takes an encoding, such as UTF-8, and, optionally,
|
|
|
|
an *errors* argument.
|
|
|
|
|
|
|
|
The *errors* argument specifies the response when the input string can't be
|
2007-08-15 11:28:22 -03:00
|
|
|
converted according to the encoding's rules. Legal values for this argument are
|
2008-11-22 06:26:59 -04:00
|
|
|
'strict' (raise a :exc:`UnicodeDecodeError` exception), 'replace' (use U+FFFD,
|
2007-08-15 11:28:22 -03:00
|
|
|
'REPLACEMENT CHARACTER'), or 'ignore' (just leave the character out of the
|
|
|
|
Unicode result). The following examples show the differences::
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
>>> b'\x80abc'.decode("utf-8", "strict")
|
2007-08-15 11:28:22 -03:00
|
|
|
Traceback (most recent call last):
|
|
|
|
File "<stdin>", line 1, in ?
|
2008-11-22 06:26:59 -04:00
|
|
|
UnicodeDecodeError: 'utf8' codec can't decode byte 0x80 in position 0:
|
|
|
|
unexpected code byte
|
2008-02-01 07:56:49 -04:00
|
|
|
>>> b'\x80abc'.decode("utf-8", "replace")
|
|
|
|
'\ufffdabc'
|
|
|
|
>>> b'\x80abc'.decode("utf-8", "ignore")
|
|
|
|
'abc'
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
Encodings are specified as strings containing the encoding's name. Python comes
|
|
|
|
with roughly 100 different encodings; see the Python Library Reference at
|
|
|
|
:ref:`standard-encodings` for a list. Some encodings have multiple names; for
|
|
|
|
example, 'latin-1', 'iso_8859_1' and '8859' are all synonyms for the same
|
|
|
|
encoding.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
One-character Unicode strings can also be created with the :func:`chr`
|
2007-08-15 11:28:22 -03:00
|
|
|
built-in function, which takes integers and returns a Unicode string of length 1
|
|
|
|
that contains the corresponding code point. The reverse operation is the
|
|
|
|
built-in :func:`ord` function that takes a one-character Unicode string and
|
|
|
|
returns the code point value::
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
>>> chr(40960)
|
|
|
|
'\ua000'
|
|
|
|
>>> ord('\ua000')
|
2007-08-15 11:28:22 -03:00
|
|
|
40960
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
Converting to Bytes
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
Another important str method is ``.encode([encoding], [errors='strict'])``,
|
|
|
|
which returns a ``bytes`` representation of the Unicode string, encoded in the
|
|
|
|
requested encoding. The ``errors`` parameter is the same as the parameter of
|
|
|
|
the :meth:`decode` method, with one additional possibility; as well as 'strict',
|
2008-11-22 06:26:59 -04:00
|
|
|
'ignore', and 'replace' (which in this case inserts a question mark instead of
|
|
|
|
the unencodable character), you can also pass 'xmlcharrefreplace' which uses
|
|
|
|
XML's character references. The following example shows the different results::
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
>>> u = chr(40960) + 'abcd' + chr(1972)
|
2007-08-15 11:28:22 -03:00
|
|
|
>>> u.encode('utf-8')
|
2008-02-01 07:56:49 -04:00
|
|
|
b'\xea\x80\x80abcd\xde\xb4'
|
2007-08-15 11:28:22 -03:00
|
|
|
>>> u.encode('ascii')
|
|
|
|
Traceback (most recent call last):
|
|
|
|
File "<stdin>", line 1, in ?
|
2008-11-22 06:26:59 -04:00
|
|
|
UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in
|
|
|
|
position 0: ordinal not in range(128)
|
2007-08-15 11:28:22 -03:00
|
|
|
>>> u.encode('ascii', 'ignore')
|
2008-02-01 07:56:49 -04:00
|
|
|
b'abcd'
|
2007-08-15 11:28:22 -03:00
|
|
|
>>> u.encode('ascii', 'replace')
|
2008-02-01 07:56:49 -04:00
|
|
|
b'?abcd?'
|
2007-08-15 11:28:22 -03:00
|
|
|
>>> u.encode('ascii', 'xmlcharrefreplace')
|
2008-02-01 07:56:49 -04:00
|
|
|
b'ꀀabcd޴'
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
The low-level routines for registering and accessing the available encodings are
|
|
|
|
found in the :mod:`codecs` module. However, the encoding and decoding functions
|
|
|
|
returned by this module are usually more low-level than is comfortable, so I'm
|
|
|
|
not going to describe the :mod:`codecs` module here. If you need to implement a
|
|
|
|
completely new encoding, you'll need to learn about the :mod:`codecs` module
|
|
|
|
interfaces, but implementing encodings is a specialized task that also won't be
|
|
|
|
covered here. Consult the Python documentation to learn more about this module.
|
|
|
|
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
Unicode Literals in Python Source Code
|
|
|
|
--------------------------------------
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
In Python source code, specific Unicode code points can be written using the
|
|
|
|
``\u`` escape sequence, which is followed by four hex digits giving the code
|
|
|
|
point. The ``\U`` escape sequence is similar, but expects 8 hex digits, not 4::
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
>>> s = "a\xac\u1234\u20ac\U00008000"
|
|
|
|
^^^^ two-digit hex escape
|
|
|
|
^^^^^ four-digit Unicode escape
|
|
|
|
^^^^^^^^^^ eight-digit Unicode escape
|
2007-09-04 04:15:32 -03:00
|
|
|
>>> for c in s: print(ord(c), end=" ")
|
|
|
|
...
|
2007-08-15 11:28:22 -03:00
|
|
|
97 172 4660 8364 32768
|
|
|
|
|
|
|
|
Using escape sequences for code points greater than 127 is fine in small doses,
|
|
|
|
but becomes an annoyance if you're using many accented characters, as you would
|
|
|
|
in a program with messages in French or some other accent-using language. You
|
2008-02-01 07:56:49 -04:00
|
|
|
can also assemble strings using the :func:`chr` built-in function, but this is
|
2007-08-15 11:28:22 -03:00
|
|
|
even more tedious.
|
|
|
|
|
|
|
|
Ideally, you'd want to be able to write literals in your language's natural
|
|
|
|
encoding. You could then edit Python source code with your favorite editor
|
|
|
|
which would display the accented characters naturally, and have the right
|
|
|
|
characters used at runtime.
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
Python supports writing source code in UTF-8 by default, but you can use almost
|
|
|
|
any encoding if you declare the encoding being used. This is done by including
|
|
|
|
a special comment as either the first or second line of the source file::
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
#!/usr/bin/env python
|
|
|
|
# -*- coding: latin-1 -*-
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
u = 'abcdé'
|
2007-09-04 04:15:32 -03:00
|
|
|
print(ord(u[-1]))
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
The syntax is inspired by Emacs's notation for specifying variables local to a
|
|
|
|
file. Emacs supports many different variables, but Python only supports
|
2008-11-22 06:26:59 -04:00
|
|
|
'coding'. The ``-*-`` symbols indicate to Emacs that the comment is special;
|
|
|
|
they have no significance to Python but are a convention. Python looks for
|
|
|
|
``coding: name`` or ``coding=name`` in the comment.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
If you don't include such a comment, the default encoding used will be UTF-8 as
|
|
|
|
already mentioned.
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Unicode Properties
|
|
|
|
------------------
|
|
|
|
|
|
|
|
The Unicode specification includes a database of information about code points.
|
|
|
|
For each code point that's defined, the information includes the character's
|
|
|
|
name, its category, the numeric value if applicable (Unicode has characters
|
|
|
|
representing the Roman numerals and fractions such as one-third and
|
|
|
|
four-fifths). There are also properties related to the code point's use in
|
|
|
|
bidirectional text and other display-related properties.
|
|
|
|
|
|
|
|
The following program displays some information about several characters, and
|
|
|
|
prints the numeric value of one particular character::
|
|
|
|
|
|
|
|
import unicodedata
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
for i, c in enumerate(u):
|
2007-09-04 04:15:32 -03:00
|
|
|
print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")
|
|
|
|
print(unicodedata.name(c))
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
# Get numeric value of second character
|
2007-09-04 04:15:32 -03:00
|
|
|
print(unicodedata.numeric(u[1]))
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
When run, this prints::
|
|
|
|
|
|
|
|
0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE
|
|
|
|
1 0bf2 No TAMIL NUMBER ONE THOUSAND
|
|
|
|
2 0f84 Mn TIBETAN MARK HALANTA
|
|
|
|
3 1770 Lo TAGBANWA LETTER SA
|
|
|
|
4 33af So SQUARE RAD OVER S SQUARED
|
|
|
|
1000.0
|
|
|
|
|
|
|
|
The category codes are abbreviations describing the nature of the character.
|
|
|
|
These are grouped into categories such as "Letter", "Number", "Punctuation", or
|
|
|
|
"Symbol", which in turn are broken up into subcategories. To take the codes
|
|
|
|
from the above output, ``'Ll'`` means 'Letter, lowercase', ``'No'`` means
|
|
|
|
"Number, other", ``'Mn'`` is "Mark, nonspacing", and ``'So'`` is "Symbol,
|
|
|
|
other". See
|
|
|
|
<http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values> for a
|
|
|
|
list of category codes.
|
|
|
|
|
|
|
|
References
|
|
|
|
----------
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
The ``str`` type is described in the Python library reference at
|
|
|
|
:ref:`typesseq`.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
The documentation for the :mod:`unicodedata` module.
|
|
|
|
|
|
|
|
The documentation for the :mod:`codecs` module.
|
|
|
|
|
|
|
|
Marc-André Lemburg gave a presentation at EuroPython 2002 titled "Python and
|
|
|
|
Unicode". A PDF version of his slides is available at
|
Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61239 | andrew.kuchling | 2008-03-05 01:44:41 +0100 (Wed, 05 Mar 2008) | 1 line
Add more items; add fragmentary notes
........
r61240 | amaury.forgeotdarc | 2008-03-05 02:50:33 +0100 (Wed, 05 Mar 2008) | 13 lines
Issue#2238: some syntax errors from *args or **kwargs expressions
would give bogus error messages, because of untested exceptions::
>>> f(**g(1=2))
XXX undetected error
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'int' object is not iterable
instead of the expected SyntaxError: keyword can't be an expression
Will backport.
........
r61241 | neal.norwitz | 2008-03-05 06:10:48 +0100 (Wed, 05 Mar 2008) | 3 lines
Remove the files/dirs after closing the DB so the tests work on Windows.
Patch from Trent Nelson. Also simplified removing a file by using test_support.
........
r61242 | neal.norwitz | 2008-03-05 06:14:18 +0100 (Wed, 05 Mar 2008) | 3 lines
Get this test to pass even when there is no sound card in the system.
Patch from Trent Nelson. (I can't test this.)
........
r61243 | neal.norwitz | 2008-03-05 06:20:44 +0100 (Wed, 05 Mar 2008) | 3 lines
Catch OSError when trying to remove a file in case removal fails. This
should prevent a failure in tearDown masking any real test failure.
........
r61244 | neal.norwitz | 2008-03-05 06:38:06 +0100 (Wed, 05 Mar 2008) | 5 lines
Make the timeout longer to give slow machines a chance to pass the test
before timing out. This doesn't change the duration of the test under
normal circumstances. This is targetted at fixing the spurious failures
on the FreeBSD buildbot primarily.
........
r61245 | neal.norwitz | 2008-03-05 06:49:03 +0100 (Wed, 05 Mar 2008) | 1 line
Tabs -> spaces
........
r61246 | neal.norwitz | 2008-03-05 06:50:20 +0100 (Wed, 05 Mar 2008) | 1 line
Use -u urlfetch to run more tests
........
r61247 | neal.norwitz | 2008-03-05 06:51:20 +0100 (Wed, 05 Mar 2008) | 1 line
test_smtplib sometimes reports leaks too, suppress it
........
r61248 | jeffrey.yasskin | 2008-03-05 07:19:56 +0100 (Wed, 05 Mar 2008) | 5 lines
Fix test_socketserver on Windows after r61099 added several signal.alarm()
calls (which don't exist on non-Unix platforms).
Thanks to Trent Nelson for the report and patch.
........
r61249 | georg.brandl | 2008-03-05 08:10:35 +0100 (Wed, 05 Mar 2008) | 2 lines
Fix some rst.
........
r61252 | thomas.heller | 2008-03-05 15:53:39 +0100 (Wed, 05 Mar 2008) | 2 lines
News entry for yesterdays commit.
........
r61253 | thomas.heller | 2008-03-05 16:34:29 +0100 (Wed, 05 Mar 2008) | 3 lines
Issue 1872: Changed the struct module typecode from 't' to '?', for
compatibility with PEP3118.
........
r61254 | skip.montanaro | 2008-03-05 17:41:09 +0100 (Wed, 05 Mar 2008) | 4 lines
Elaborate on the role of the altinstall target when installing multiple
versions.
........
r61255 | georg.brandl | 2008-03-05 20:31:44 +0100 (Wed, 05 Mar 2008) | 2 lines
#2239: PYTHONPATH delimiter is os.pathsep.
........
r61256 | raymond.hettinger | 2008-03-05 21:59:58 +0100 (Wed, 05 Mar 2008) | 1 line
C implementation of itertools.permutations().
........
r61257 | raymond.hettinger | 2008-03-05 22:04:32 +0100 (Wed, 05 Mar 2008) | 1 line
Small code cleanup.
........
r61260 | martin.v.loewis | 2008-03-05 23:24:31 +0100 (Wed, 05 Mar 2008) | 2 lines
cd PCbuild only after deleting all pyc files.
........
r61261 | raymond.hettinger | 2008-03-06 02:15:52 +0100 (Thu, 06 Mar 2008) | 1 line
Add examples.
........
r61262 | andrew.kuchling | 2008-03-06 02:36:27 +0100 (Thu, 06 Mar 2008) | 1 line
Add two items
........
r61263 | georg.brandl | 2008-03-06 07:47:18 +0100 (Thu, 06 Mar 2008) | 2 lines
#1725737: ignore other VC directories other than CVS and SVN's too.
........
r61264 | martin.v.loewis | 2008-03-06 07:55:22 +0100 (Thu, 06 Mar 2008) | 4 lines
Patch #2232: os.tmpfile might fail on Windows if the user has no
permission to create files in the root directory.
Will backport to 2.5.
........
r61269 | georg.brandl | 2008-03-06 08:19:15 +0100 (Thu, 06 Mar 2008) | 2 lines
Expand on re.split behavior with captured expressions.
........
r61270 | georg.brandl | 2008-03-06 08:22:09 +0100 (Thu, 06 Mar 2008) | 2 lines
Little clarification of assignments.
........
r61271 | georg.brandl | 2008-03-06 08:31:34 +0100 (Thu, 06 Mar 2008) | 2 lines
Add isinstance/issubclass to tutorial.
........
r61272 | georg.brandl | 2008-03-06 08:34:52 +0100 (Thu, 06 Mar 2008) | 2 lines
Add missing NEWS entry for r61263.
........
r61273 | georg.brandl | 2008-03-06 08:41:16 +0100 (Thu, 06 Mar 2008) | 2 lines
#2225: return nonzero status code from py_compile if not all files could be compiled.
........
r61274 | georg.brandl | 2008-03-06 08:43:02 +0100 (Thu, 06 Mar 2008) | 2 lines
#2220: handle matching failure more gracefully.
........
r61275 | georg.brandl | 2008-03-06 08:45:52 +0100 (Thu, 06 Mar 2008) | 2 lines
Bug #2220: handle rlcompleter attribute match failure more gracefully.
........
r61278 | martin.v.loewis | 2008-03-06 14:49:47 +0100 (Thu, 06 Mar 2008) | 1 line
Rely on x64 platform configuration when building _bsddb on AMD64.
........
r61279 | martin.v.loewis | 2008-03-06 14:50:28 +0100 (Thu, 06 Mar 2008) | 1 line
Update db-4.4.20 build procedure.
........
r61285 | raymond.hettinger | 2008-03-06 21:52:01 +0100 (Thu, 06 Mar 2008) | 1 line
More tests.
........
r61286 | raymond.hettinger | 2008-03-06 23:51:36 +0100 (Thu, 06 Mar 2008) | 1 line
Issue 2246: itertools grouper object did not participate in GC (should be backported).
........
r61288 | raymond.hettinger | 2008-03-07 02:33:20 +0100 (Fri, 07 Mar 2008) | 1 line
Tweak recipes and tests
........
r61289 | jeffrey.yasskin | 2008-03-07 07:22:15 +0100 (Fri, 07 Mar 2008) | 5 lines
Progress on issue #1193577 by adding a polling .shutdown() method to
SocketServers. The core of the patch was written by Pedro Werneck, but any bugs
are mine. I've also rearranged the code for timeouts in order to avoid
interfering with the shutdown poll.
........
r61290 | nick.coghlan | 2008-03-07 15:13:28 +0100 (Fri, 07 Mar 2008) | 1 line
Speed up with statements by storing the __exit__ method on the stack instead of in a temp variable (bumps the magic number for pyc files)
........
r61298 | andrew.kuchling | 2008-03-07 22:09:23 +0100 (Fri, 07 Mar 2008) | 1 line
Grammar fix
........
r61303 | georg.brandl | 2008-03-08 10:54:06 +0100 (Sat, 08 Mar 2008) | 2 lines
#2253: fix continue vs. finally docs.
........
r61304 | marc-andre.lemburg | 2008-03-08 11:01:43 +0100 (Sat, 08 Mar 2008) | 3 lines
Add new name for Mandrake: Mandriva.
........
r61305 | georg.brandl | 2008-03-08 11:05:24 +0100 (Sat, 08 Mar 2008) | 2 lines
#1533486: fix types in refcount intro.
........
r61312 | facundo.batista | 2008-03-08 17:50:27 +0100 (Sat, 08 Mar 2008) | 5 lines
Issue 1106316. post_mortem()'s parameter, traceback, is now
optional: it defaults to the traceback of the exception that is currently
being handled.
........
r61313 | jeffrey.yasskin | 2008-03-08 19:26:54 +0100 (Sat, 08 Mar 2008) | 2 lines
Add tests for with and finally performance to pybench.
........
r61314 | jeffrey.yasskin | 2008-03-08 21:08:21 +0100 (Sat, 08 Mar 2008) | 2 lines
Fix pybench for pythons < 2.6, tested back to 2.3.
........
r61317 | jeffrey.yasskin | 2008-03-08 22:35:15 +0100 (Sat, 08 Mar 2008) | 3 lines
Well that was dumb. platform.python_implementation returns a function, not a
string.
........
r61329 | georg.brandl | 2008-03-09 16:11:39 +0100 (Sun, 09 Mar 2008) | 2 lines
#2249: document assertTrue and assertFalse.
........
r61332 | neal.norwitz | 2008-03-09 20:03:42 +0100 (Sun, 09 Mar 2008) | 4 lines
Introduce a lock to fix a race condition which caused an exception in the test.
Some buildbots were consistently failing (e.g., amd64).
Also remove a couple of semi-colons.
........
r61344 | raymond.hettinger | 2008-03-11 01:19:07 +0100 (Tue, 11 Mar 2008) | 1 line
Add recipe to docs.
........
r61350 | guido.van.rossum | 2008-03-11 22:18:06 +0100 (Tue, 11 Mar 2008) | 3 lines
Fix the overflows in expandtabs(). "This time for sure!"
(Exploit at request.)
........
r61351 | raymond.hettinger | 2008-03-11 22:37:46 +0100 (Tue, 11 Mar 2008) | 1 line
Improve docs for itemgetter(). Show that it works with slices.
........
r61363 | georg.brandl | 2008-03-13 08:15:56 +0100 (Thu, 13 Mar 2008) | 2 lines
#2265: fix example.
........
r61364 | georg.brandl | 2008-03-13 08:17:14 +0100 (Thu, 13 Mar 2008) | 2 lines
#2270: fix typo.
........
r61365 | georg.brandl | 2008-03-13 08:21:41 +0100 (Thu, 13 Mar 2008) | 2 lines
#1720705: add docs about import/threading interaction, wording by Nick.
........
r61366 | andrew.kuchling | 2008-03-13 12:07:35 +0100 (Thu, 13 Mar 2008) | 1 line
Add class decorators
........
r61367 | raymond.hettinger | 2008-03-13 17:43:17 +0100 (Thu, 13 Mar 2008) | 1 line
Add 2-to-3 support for the itertools moved to builtins or renamed.
........
r61368 | raymond.hettinger | 2008-03-13 17:43:59 +0100 (Thu, 13 Mar 2008) | 1 line
Consistent tense.
........
r61369 | raymond.hettinger | 2008-03-13 20:03:51 +0100 (Thu, 13 Mar 2008) | 1 line
Issue 2274: Add heapq.heappushpop().
........
r61370 | raymond.hettinger | 2008-03-13 20:33:34 +0100 (Thu, 13 Mar 2008) | 1 line
Simplify the nlargest() code using heappushpop().
........
r61371 | brett.cannon | 2008-03-13 21:27:00 +0100 (Thu, 13 Mar 2008) | 4 lines
Move test_thread over to unittest. Commits GHOP 237.
Thanks Benjamin Peterson for the patch.
........
r61372 | brett.cannon | 2008-03-13 21:33:10 +0100 (Thu, 13 Mar 2008) | 4 lines
Move test_tokenize to doctest.
Done as GHOP 238 by Josip Dzolonga.
........
r61373 | brett.cannon | 2008-03-13 21:47:41 +0100 (Thu, 13 Mar 2008) | 4 lines
Convert test_contains, test_crypt, and test_select to unittest.
Patch from GHOP 294 by David Marek.
........
r61374 | brett.cannon | 2008-03-13 22:02:16 +0100 (Thu, 13 Mar 2008) | 4 lines
Move test_gdbm to use unittest.
Closes issue #1960. Thanks Giampaolo Rodola.
........
r61375 | brett.cannon | 2008-03-13 22:09:28 +0100 (Thu, 13 Mar 2008) | 4 lines
Convert test_fcntl to unittest.
Closes issue #2055. Thanks Giampaolo Rodola.
........
r61376 | raymond.hettinger | 2008-03-14 06:03:44 +0100 (Fri, 14 Mar 2008) | 1 line
Leave heapreplace() unchanged.
........
r61378 | martin.v.loewis | 2008-03-14 14:56:09 +0100 (Fri, 14 Mar 2008) | 2 lines
Patch #2284: add -x64 option to rt.bat.
........
r61379 | martin.v.loewis | 2008-03-14 14:57:59 +0100 (Fri, 14 Mar 2008) | 2 lines
Use -x64 flag.
........
r61382 | brett.cannon | 2008-03-14 15:03:10 +0100 (Fri, 14 Mar 2008) | 2 lines
Remove a bad test.
........
r61383 | mark.dickinson | 2008-03-14 15:23:37 +0100 (Fri, 14 Mar 2008) | 9 lines
Issue 705836: Fix struct.pack(">f", 1e40) to behave consistently
across platforms: it should now raise OverflowError on all
platforms. (Previously it raised OverflowError only on
non IEEE 754 platforms.)
Also fix the (already existing) test for this behaviour
so that it actually raises TestFailed instead of just
referencing it.
........
r61387 | thomas.heller | 2008-03-14 22:06:21 +0100 (Fri, 14 Mar 2008) | 1 line
Remove unneeded initializer.
........
r61388 | martin.v.loewis | 2008-03-14 22:19:28 +0100 (Fri, 14 Mar 2008) | 2 lines
Run debug version, cd to PCbuild.
........
r61392 | georg.brandl | 2008-03-15 00:10:34 +0100 (Sat, 15 Mar 2008) | 2 lines
Remove obsolete paragraph. #2288.
........
r61395 | georg.brandl | 2008-03-15 01:20:19 +0100 (Sat, 15 Mar 2008) | 2 lines
Fix lots of broken links in the docs, found by Sphinx' external link checker.
........
r61396 | skip.montanaro | 2008-03-15 03:32:49 +0100 (Sat, 15 Mar 2008) | 1 line
note that fork and forkpty raise OSError on failure
........
r61402 | skip.montanaro | 2008-03-15 17:04:45 +0100 (Sat, 15 Mar 2008) | 1 line
add %f format to datetime - issue 1158
........
r61403 | skip.montanaro | 2008-03-15 17:07:11 +0100 (Sat, 15 Mar 2008) | 2 lines
.
........
2008-03-15 21:07:10 -03:00
|
|
|
<http://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf>, and is an
|
2008-11-22 06:26:59 -04:00
|
|
|
excellent overview of the design of Python's Unicode features (based on Python
|
|
|
|
2, where the Unicode string type is called ``unicode`` and literals start with
|
|
|
|
``u``).
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
|
|
|
|
Reading and Writing Unicode Data
|
|
|
|
================================
|
|
|
|
|
|
|
|
Once you've written some code that works with Unicode data, the next problem is
|
|
|
|
input/output. How do you get Unicode strings into your program, and how do you
|
|
|
|
convert Unicode into a form suitable for storage or transmission?
|
|
|
|
|
|
|
|
It's possible that you may not need to do anything depending on your input
|
|
|
|
sources and output destinations; you should check whether the libraries used in
|
|
|
|
your application support Unicode natively. XML parsers often return Unicode
|
|
|
|
data, for example. Many relational databases also support Unicode-valued
|
|
|
|
columns and can return Unicode values from an SQL query.
|
|
|
|
|
|
|
|
Unicode data is usually converted to a particular encoding before it gets
|
|
|
|
written to disk or sent over a socket. It's possible to do all the work
|
2008-11-22 06:26:59 -04:00
|
|
|
yourself: open a file, read an 8-bit byte string from it, and convert the string
|
|
|
|
with ``str(bytes, encoding)``. However, the manual approach is not recommended.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
One problem is the multi-byte nature of encodings; one Unicode character can be
|
|
|
|
represented by several bytes. If you want to read the file in arbitrary-sized
|
|
|
|
chunks (say, 1K or 4K), you need to write error-handling code to catch the case
|
|
|
|
where only part of the bytes encoding a single Unicode character are read at the
|
|
|
|
end of a chunk. One solution would be to read the entire file into memory and
|
|
|
|
then perform the decoding, but that prevents you from working with files that
|
|
|
|
are extremely large; if you need to read a 2Gb file, you need 2Gb of RAM.
|
|
|
|
(More, really, since for at least a moment you'd need to have both the encoded
|
|
|
|
string and its Unicode version in memory.)
|
|
|
|
|
|
|
|
The solution would be to use the low-level decoding interface to catch the case
|
|
|
|
of partial coding sequences. The work of implementing this has already been
|
2008-11-22 06:26:59 -04:00
|
|
|
done for you: the built-in :func:`open` function can return a file-like object
|
|
|
|
that assumes the file's contents are in a specified encoding and accepts Unicode
|
|
|
|
parameters for methods such as ``.read()`` and ``.write()``. This works through
|
|
|
|
:func:`open`\'s *encoding* and *errors* parameters which are interpreted just
|
|
|
|
like those in string objects' :meth:`encode` and :meth:`decode` methods.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Reading Unicode from a file is therefore simple::
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
f = open('unicode.rst', encoding='utf-8')
|
2007-08-15 11:28:22 -03:00
|
|
|
for line in f:
|
2007-09-04 04:15:32 -03:00
|
|
|
print(repr(line))
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
It's also possible to open files in update mode, allowing both reading and
|
|
|
|
writing::
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
f = open('test', encoding='utf-8', mode='w+')
|
2008-02-01 07:56:49 -04:00
|
|
|
f.write('\u4500 blah blah blah\n')
|
2007-08-15 11:28:22 -03:00
|
|
|
f.seek(0)
|
2007-09-04 04:15:32 -03:00
|
|
|
print(repr(f.readline()[:1]))
|
2007-08-15 11:28:22 -03:00
|
|
|
f.close()
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
The Unicode character U+FEFF is used as a byte-order mark (BOM), and is often
|
2007-08-15 11:28:22 -03:00
|
|
|
written as the first character of a file in order to assist with autodetection
|
|
|
|
of the file's byte ordering. Some encodings, such as UTF-16, expect a BOM to be
|
|
|
|
present at the start of a file; when such an encoding is used, the BOM will be
|
|
|
|
automatically written as the first character and will be silently dropped when
|
|
|
|
the file is read. There are variants of these encodings, such as 'utf-16-le'
|
|
|
|
and 'utf-16-be' for little-endian and big-endian encodings, that specify one
|
|
|
|
particular byte ordering and don't skip the BOM.
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
In some areas, it is also convention to use a "BOM" at the start of UTF-8
|
|
|
|
encoded files; the name is misleading since UTF-8 is not byte-order dependent.
|
|
|
|
The mark simply announces that the file is encoded in UTF-8. Use the
|
|
|
|
'utf-8-sig' codec to automatically skip the mark if present for reading such
|
|
|
|
files.
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
Unicode filenames
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Most of the operating systems in common use today support filenames that contain
|
|
|
|
arbitrary Unicode characters. Usually this is implemented by converting the
|
|
|
|
Unicode string into some encoding that varies depending on the system. For
|
2008-09-13 14:46:05 -03:00
|
|
|
example, Mac OS X uses UTF-8 while Windows uses a configurable encoding; on
|
2007-08-15 11:28:22 -03:00
|
|
|
Windows, Python uses the name "mbcs" to refer to whatever the currently
|
|
|
|
configured encoding is. On Unix systems, there will only be a filesystem
|
|
|
|
encoding if you've set the ``LANG`` or ``LC_CTYPE`` environment variables; if
|
|
|
|
you haven't, the default encoding is ASCII.
|
|
|
|
|
|
|
|
The :func:`sys.getfilesystemencoding` function returns the encoding to use on
|
|
|
|
your current system, in case you want to do the encoding manually, but there's
|
|
|
|
not much reason to bother. When opening a file for reading or writing, you can
|
|
|
|
usually just provide the Unicode string as the filename, and it will be
|
|
|
|
automatically converted to the right encoding for you::
|
|
|
|
|
2008-02-01 07:56:49 -04:00
|
|
|
filename = 'filename\u4500abc'
|
2007-08-15 11:28:22 -03:00
|
|
|
f = open(filename, 'w')
|
|
|
|
f.write('blah\n')
|
|
|
|
f.close()
|
|
|
|
|
|
|
|
Functions in the :mod:`os` module such as :func:`os.stat` will also accept Unicode
|
|
|
|
filenames.
|
|
|
|
|
|
|
|
:func:`os.listdir`, which returns filenames, raises an issue: should it return
|
2008-11-22 06:26:59 -04:00
|
|
|
the Unicode version of filenames, or should it return byte strings containing
|
2007-08-15 11:28:22 -03:00
|
|
|
the encoded versions? :func:`os.listdir` will do both, depending on whether you
|
2008-11-22 06:26:59 -04:00
|
|
|
provided the directory path as a byte string or a Unicode string. If you pass a
|
|
|
|
Unicode string as the path, filenames will be decoded using the filesystem's
|
|
|
|
encoding and a list of Unicode strings will be returned, while passing a byte
|
|
|
|
path will return the byte string versions of the filenames. For example,
|
|
|
|
assuming the default filesystem encoding is UTF-8, running the following
|
|
|
|
program::
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2009-01-03 17:26:05 -04:00
|
|
|
fn = 'filename\u4500abc'
|
|
|
|
f = open(fn, 'w')
|
|
|
|
f.close()
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2009-01-03 17:26:05 -04:00
|
|
|
import os
|
|
|
|
print(os.listdir(b'.'))
|
|
|
|
print(os.listdir('.'))
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
will produce the following output::
|
|
|
|
|
2009-01-03 17:26:05 -04:00
|
|
|
amk:~$ python t.py
|
|
|
|
[b'.svn', b'filename\xe4\x94\x80abc', ...]
|
|
|
|
['.svn', 'filename\u4500abc', ...]
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
The first list contains UTF-8-encoded filenames, and the second list contains
|
|
|
|
the Unicode versions.
|
|
|
|
|
2009-09-12 00:09:02 -03:00
|
|
|
Note that in most occasions, the Unicode APIs should be used. The bytes APIs
|
2008-11-22 06:26:59 -04:00
|
|
|
should only be used on systems where undecodable file names can be present,
|
|
|
|
i.e. Unix systems.
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
Tips for Writing Unicode-aware Programs
|
|
|
|
---------------------------------------
|
|
|
|
|
|
|
|
This section provides some suggestions on writing software that deals with
|
|
|
|
Unicode.
|
|
|
|
|
|
|
|
The most important tip is:
|
|
|
|
|
|
|
|
Software should only work with Unicode strings internally, converting to a
|
|
|
|
particular encoding on output.
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
If you attempt to write processing functions that accept both Unicode and byte
|
2007-08-15 11:28:22 -03:00
|
|
|
strings, you will find your program vulnerable to bugs wherever you combine the
|
2008-11-22 06:26:59 -04:00
|
|
|
two different kinds of strings. There is no automatic encoding or decoding if
|
|
|
|
you do e.g. ``str + bytes``, a :exc:`TypeError` is raised for this expression.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
It's easy to miss such problems if you only test your software with data that
|
|
|
|
doesn't contain any accents; everything will seem to work, but there's actually
|
|
|
|
a bug in your program waiting for the first user who attempts to use characters
|
|
|
|
> 127. A second tip, therefore, is:
|
|
|
|
|
|
|
|
Include characters > 127 and, even better, characters > 255 in your test
|
|
|
|
data.
|
|
|
|
|
|
|
|
When using data coming from a web browser or some other untrusted source, a
|
|
|
|
common technique is to check for illegal characters in a string before using the
|
|
|
|
string in a generated command line or storing it in a database. If you're doing
|
|
|
|
this, be careful to check the string once it's in the form that will be used or
|
|
|
|
stored; it's possible for encodings to be used to disguise characters. This is
|
|
|
|
especially true if the input data also specifies the encoding; many encodings
|
|
|
|
leave the commonly checked-for characters alone, but Python includes some
|
|
|
|
encodings such as ``'base64'`` that modify every single character.
|
|
|
|
|
|
|
|
For example, let's say you have a content management system that takes a Unicode
|
|
|
|
filename, and you want to disallow paths with a '/' character. You might write
|
|
|
|
this code::
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
def read_file(filename, encoding):
|
2007-08-15 11:28:22 -03:00
|
|
|
if '/' in filename:
|
|
|
|
raise ValueError("'/' not allowed in filenames")
|
|
|
|
unicode_name = filename.decode(encoding)
|
|
|
|
f = open(unicode_name, 'r')
|
|
|
|
# ... return contents of file ...
|
2007-09-04 04:15:32 -03:00
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
However, if an attacker could specify the ``'base64'`` encoding, they could pass
|
|
|
|
``'L2V0Yy9wYXNzd2Q='``, which is the base-64 encoded form of the string
|
|
|
|
``'/etc/passwd'``, to read a system file. The above code looks for ``'/'``
|
|
|
|
characters in the encoded form and misses the dangerous character in the
|
|
|
|
resulting decoded form.
|
|
|
|
|
|
|
|
References
|
|
|
|
----------
|
|
|
|
|
|
|
|
The PDF slides for Marc-André Lemburg's presentation "Writing Unicode-aware
|
|
|
|
Applications in Python" are available at
|
Merged revisions 61239-61249,61252-61257,61260-61264,61269-61275,61278-61279,61285-61286,61288-61290,61298,61303-61305,61312-61314,61317,61329,61332,61344,61350-61351,61363-61376,61378-61379,61382-61383,61387-61388,61392,61395-61396,61402-61403 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r61239 | andrew.kuchling | 2008-03-05 01:44:41 +0100 (Wed, 05 Mar 2008) | 1 line
Add more items; add fragmentary notes
........
r61240 | amaury.forgeotdarc | 2008-03-05 02:50:33 +0100 (Wed, 05 Mar 2008) | 13 lines
Issue#2238: some syntax errors from *args or **kwargs expressions
would give bogus error messages, because of untested exceptions::
>>> f(**g(1=2))
XXX undetected error
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'int' object is not iterable
instead of the expected SyntaxError: keyword can't be an expression
Will backport.
........
r61241 | neal.norwitz | 2008-03-05 06:10:48 +0100 (Wed, 05 Mar 2008) | 3 lines
Remove the files/dirs after closing the DB so the tests work on Windows.
Patch from Trent Nelson. Also simplified removing a file by using test_support.
........
r61242 | neal.norwitz | 2008-03-05 06:14:18 +0100 (Wed, 05 Mar 2008) | 3 lines
Get this test to pass even when there is no sound card in the system.
Patch from Trent Nelson. (I can't test this.)
........
r61243 | neal.norwitz | 2008-03-05 06:20:44 +0100 (Wed, 05 Mar 2008) | 3 lines
Catch OSError when trying to remove a file in case removal fails. This
should prevent a failure in tearDown masking any real test failure.
........
r61244 | neal.norwitz | 2008-03-05 06:38:06 +0100 (Wed, 05 Mar 2008) | 5 lines
Make the timeout longer to give slow machines a chance to pass the test
before timing out. This doesn't change the duration of the test under
normal circumstances. This is targetted at fixing the spurious failures
on the FreeBSD buildbot primarily.
........
r61245 | neal.norwitz | 2008-03-05 06:49:03 +0100 (Wed, 05 Mar 2008) | 1 line
Tabs -> spaces
........
r61246 | neal.norwitz | 2008-03-05 06:50:20 +0100 (Wed, 05 Mar 2008) | 1 line
Use -u urlfetch to run more tests
........
r61247 | neal.norwitz | 2008-03-05 06:51:20 +0100 (Wed, 05 Mar 2008) | 1 line
test_smtplib sometimes reports leaks too, suppress it
........
r61248 | jeffrey.yasskin | 2008-03-05 07:19:56 +0100 (Wed, 05 Mar 2008) | 5 lines
Fix test_socketserver on Windows after r61099 added several signal.alarm()
calls (which don't exist on non-Unix platforms).
Thanks to Trent Nelson for the report and patch.
........
r61249 | georg.brandl | 2008-03-05 08:10:35 +0100 (Wed, 05 Mar 2008) | 2 lines
Fix some rst.
........
r61252 | thomas.heller | 2008-03-05 15:53:39 +0100 (Wed, 05 Mar 2008) | 2 lines
News entry for yesterdays commit.
........
r61253 | thomas.heller | 2008-03-05 16:34:29 +0100 (Wed, 05 Mar 2008) | 3 lines
Issue 1872: Changed the struct module typecode from 't' to '?', for
compatibility with PEP3118.
........
r61254 | skip.montanaro | 2008-03-05 17:41:09 +0100 (Wed, 05 Mar 2008) | 4 lines
Elaborate on the role of the altinstall target when installing multiple
versions.
........
r61255 | georg.brandl | 2008-03-05 20:31:44 +0100 (Wed, 05 Mar 2008) | 2 lines
#2239: PYTHONPATH delimiter is os.pathsep.
........
r61256 | raymond.hettinger | 2008-03-05 21:59:58 +0100 (Wed, 05 Mar 2008) | 1 line
C implementation of itertools.permutations().
........
r61257 | raymond.hettinger | 2008-03-05 22:04:32 +0100 (Wed, 05 Mar 2008) | 1 line
Small code cleanup.
........
r61260 | martin.v.loewis | 2008-03-05 23:24:31 +0100 (Wed, 05 Mar 2008) | 2 lines
cd PCbuild only after deleting all pyc files.
........
r61261 | raymond.hettinger | 2008-03-06 02:15:52 +0100 (Thu, 06 Mar 2008) | 1 line
Add examples.
........
r61262 | andrew.kuchling | 2008-03-06 02:36:27 +0100 (Thu, 06 Mar 2008) | 1 line
Add two items
........
r61263 | georg.brandl | 2008-03-06 07:47:18 +0100 (Thu, 06 Mar 2008) | 2 lines
#1725737: ignore other VC directories other than CVS and SVN's too.
........
r61264 | martin.v.loewis | 2008-03-06 07:55:22 +0100 (Thu, 06 Mar 2008) | 4 lines
Patch #2232: os.tmpfile might fail on Windows if the user has no
permission to create files in the root directory.
Will backport to 2.5.
........
r61269 | georg.brandl | 2008-03-06 08:19:15 +0100 (Thu, 06 Mar 2008) | 2 lines
Expand on re.split behavior with captured expressions.
........
r61270 | georg.brandl | 2008-03-06 08:22:09 +0100 (Thu, 06 Mar 2008) | 2 lines
Little clarification of assignments.
........
r61271 | georg.brandl | 2008-03-06 08:31:34 +0100 (Thu, 06 Mar 2008) | 2 lines
Add isinstance/issubclass to tutorial.
........
r61272 | georg.brandl | 2008-03-06 08:34:52 +0100 (Thu, 06 Mar 2008) | 2 lines
Add missing NEWS entry for r61263.
........
r61273 | georg.brandl | 2008-03-06 08:41:16 +0100 (Thu, 06 Mar 2008) | 2 lines
#2225: return nonzero status code from py_compile if not all files could be compiled.
........
r61274 | georg.brandl | 2008-03-06 08:43:02 +0100 (Thu, 06 Mar 2008) | 2 lines
#2220: handle matching failure more gracefully.
........
r61275 | georg.brandl | 2008-03-06 08:45:52 +0100 (Thu, 06 Mar 2008) | 2 lines
Bug #2220: handle rlcompleter attribute match failure more gracefully.
........
r61278 | martin.v.loewis | 2008-03-06 14:49:47 +0100 (Thu, 06 Mar 2008) | 1 line
Rely on x64 platform configuration when building _bsddb on AMD64.
........
r61279 | martin.v.loewis | 2008-03-06 14:50:28 +0100 (Thu, 06 Mar 2008) | 1 line
Update db-4.4.20 build procedure.
........
r61285 | raymond.hettinger | 2008-03-06 21:52:01 +0100 (Thu, 06 Mar 2008) | 1 line
More tests.
........
r61286 | raymond.hettinger | 2008-03-06 23:51:36 +0100 (Thu, 06 Mar 2008) | 1 line
Issue 2246: itertools grouper object did not participate in GC (should be backported).
........
r61288 | raymond.hettinger | 2008-03-07 02:33:20 +0100 (Fri, 07 Mar 2008) | 1 line
Tweak recipes and tests
........
r61289 | jeffrey.yasskin | 2008-03-07 07:22:15 +0100 (Fri, 07 Mar 2008) | 5 lines
Progress on issue #1193577 by adding a polling .shutdown() method to
SocketServers. The core of the patch was written by Pedro Werneck, but any bugs
are mine. I've also rearranged the code for timeouts in order to avoid
interfering with the shutdown poll.
........
r61290 | nick.coghlan | 2008-03-07 15:13:28 +0100 (Fri, 07 Mar 2008) | 1 line
Speed up with statements by storing the __exit__ method on the stack instead of in a temp variable (bumps the magic number for pyc files)
........
r61298 | andrew.kuchling | 2008-03-07 22:09:23 +0100 (Fri, 07 Mar 2008) | 1 line
Grammar fix
........
r61303 | georg.brandl | 2008-03-08 10:54:06 +0100 (Sat, 08 Mar 2008) | 2 lines
#2253: fix continue vs. finally docs.
........
r61304 | marc-andre.lemburg | 2008-03-08 11:01:43 +0100 (Sat, 08 Mar 2008) | 3 lines
Add new name for Mandrake: Mandriva.
........
r61305 | georg.brandl | 2008-03-08 11:05:24 +0100 (Sat, 08 Mar 2008) | 2 lines
#1533486: fix types in refcount intro.
........
r61312 | facundo.batista | 2008-03-08 17:50:27 +0100 (Sat, 08 Mar 2008) | 5 lines
Issue 1106316. post_mortem()'s parameter, traceback, is now
optional: it defaults to the traceback of the exception that is currently
being handled.
........
r61313 | jeffrey.yasskin | 2008-03-08 19:26:54 +0100 (Sat, 08 Mar 2008) | 2 lines
Add tests for with and finally performance to pybench.
........
r61314 | jeffrey.yasskin | 2008-03-08 21:08:21 +0100 (Sat, 08 Mar 2008) | 2 lines
Fix pybench for pythons < 2.6, tested back to 2.3.
........
r61317 | jeffrey.yasskin | 2008-03-08 22:35:15 +0100 (Sat, 08 Mar 2008) | 3 lines
Well that was dumb. platform.python_implementation returns a function, not a
string.
........
r61329 | georg.brandl | 2008-03-09 16:11:39 +0100 (Sun, 09 Mar 2008) | 2 lines
#2249: document assertTrue and assertFalse.
........
r61332 | neal.norwitz | 2008-03-09 20:03:42 +0100 (Sun, 09 Mar 2008) | 4 lines
Introduce a lock to fix a race condition which caused an exception in the test.
Some buildbots were consistently failing (e.g., amd64).
Also remove a couple of semi-colons.
........
r61344 | raymond.hettinger | 2008-03-11 01:19:07 +0100 (Tue, 11 Mar 2008) | 1 line
Add recipe to docs.
........
r61350 | guido.van.rossum | 2008-03-11 22:18:06 +0100 (Tue, 11 Mar 2008) | 3 lines
Fix the overflows in expandtabs(). "This time for sure!"
(Exploit at request.)
........
r61351 | raymond.hettinger | 2008-03-11 22:37:46 +0100 (Tue, 11 Mar 2008) | 1 line
Improve docs for itemgetter(). Show that it works with slices.
........
r61363 | georg.brandl | 2008-03-13 08:15:56 +0100 (Thu, 13 Mar 2008) | 2 lines
#2265: fix example.
........
r61364 | georg.brandl | 2008-03-13 08:17:14 +0100 (Thu, 13 Mar 2008) | 2 lines
#2270: fix typo.
........
r61365 | georg.brandl | 2008-03-13 08:21:41 +0100 (Thu, 13 Mar 2008) | 2 lines
#1720705: add docs about import/threading interaction, wording by Nick.
........
r61366 | andrew.kuchling | 2008-03-13 12:07:35 +0100 (Thu, 13 Mar 2008) | 1 line
Add class decorators
........
r61367 | raymond.hettinger | 2008-03-13 17:43:17 +0100 (Thu, 13 Mar 2008) | 1 line
Add 2-to-3 support for the itertools moved to builtins or renamed.
........
r61368 | raymond.hettinger | 2008-03-13 17:43:59 +0100 (Thu, 13 Mar 2008) | 1 line
Consistent tense.
........
r61369 | raymond.hettinger | 2008-03-13 20:03:51 +0100 (Thu, 13 Mar 2008) | 1 line
Issue 2274: Add heapq.heappushpop().
........
r61370 | raymond.hettinger | 2008-03-13 20:33:34 +0100 (Thu, 13 Mar 2008) | 1 line
Simplify the nlargest() code using heappushpop().
........
r61371 | brett.cannon | 2008-03-13 21:27:00 +0100 (Thu, 13 Mar 2008) | 4 lines
Move test_thread over to unittest. Commits GHOP 237.
Thanks Benjamin Peterson for the patch.
........
r61372 | brett.cannon | 2008-03-13 21:33:10 +0100 (Thu, 13 Mar 2008) | 4 lines
Move test_tokenize to doctest.
Done as GHOP 238 by Josip Dzolonga.
........
r61373 | brett.cannon | 2008-03-13 21:47:41 +0100 (Thu, 13 Mar 2008) | 4 lines
Convert test_contains, test_crypt, and test_select to unittest.
Patch from GHOP 294 by David Marek.
........
r61374 | brett.cannon | 2008-03-13 22:02:16 +0100 (Thu, 13 Mar 2008) | 4 lines
Move test_gdbm to use unittest.
Closes issue #1960. Thanks Giampaolo Rodola.
........
r61375 | brett.cannon | 2008-03-13 22:09:28 +0100 (Thu, 13 Mar 2008) | 4 lines
Convert test_fcntl to unittest.
Closes issue #2055. Thanks Giampaolo Rodola.
........
r61376 | raymond.hettinger | 2008-03-14 06:03:44 +0100 (Fri, 14 Mar 2008) | 1 line
Leave heapreplace() unchanged.
........
r61378 | martin.v.loewis | 2008-03-14 14:56:09 +0100 (Fri, 14 Mar 2008) | 2 lines
Patch #2284: add -x64 option to rt.bat.
........
r61379 | martin.v.loewis | 2008-03-14 14:57:59 +0100 (Fri, 14 Mar 2008) | 2 lines
Use -x64 flag.
........
r61382 | brett.cannon | 2008-03-14 15:03:10 +0100 (Fri, 14 Mar 2008) | 2 lines
Remove a bad test.
........
r61383 | mark.dickinson | 2008-03-14 15:23:37 +0100 (Fri, 14 Mar 2008) | 9 lines
Issue 705836: Fix struct.pack(">f", 1e40) to behave consistently
across platforms: it should now raise OverflowError on all
platforms. (Previously it raised OverflowError only on
non IEEE 754 platforms.)
Also fix the (already existing) test for this behaviour
so that it actually raises TestFailed instead of just
referencing it.
........
r61387 | thomas.heller | 2008-03-14 22:06:21 +0100 (Fri, 14 Mar 2008) | 1 line
Remove unneeded initializer.
........
r61388 | martin.v.loewis | 2008-03-14 22:19:28 +0100 (Fri, 14 Mar 2008) | 2 lines
Run debug version, cd to PCbuild.
........
r61392 | georg.brandl | 2008-03-15 00:10:34 +0100 (Sat, 15 Mar 2008) | 2 lines
Remove obsolete paragraph. #2288.
........
r61395 | georg.brandl | 2008-03-15 01:20:19 +0100 (Sat, 15 Mar 2008) | 2 lines
Fix lots of broken links in the docs, found by Sphinx' external link checker.
........
r61396 | skip.montanaro | 2008-03-15 03:32:49 +0100 (Sat, 15 Mar 2008) | 1 line
note that fork and forkpty raise OSError on failure
........
r61402 | skip.montanaro | 2008-03-15 17:04:45 +0100 (Sat, 15 Mar 2008) | 1 line
add %f format to datetime - issue 1158
........
r61403 | skip.montanaro | 2008-03-15 17:07:11 +0100 (Sat, 15 Mar 2008) | 2 lines
.
........
2008-03-15 21:07:10 -03:00
|
|
|
<http://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf>
|
2007-08-15 11:28:22 -03:00
|
|
|
and discuss questions of character encodings as well as how to internationalize
|
|
|
|
and localize an application.
|
|
|
|
|
|
|
|
|
|
|
|
Revision History and Acknowledgements
|
|
|
|
=====================================
|
|
|
|
|
|
|
|
Thanks to the following people who have noted errors or offered suggestions on
|
|
|
|
this article: Nicholas Bastin, Marius Gedminas, Kent Johnson, Ken Krugler,
|
|
|
|
Marc-André Lemburg, Martin von Löwis, Chad Whitacre.
|
|
|
|
|
|
|
|
Version 1.0: posted August 5 2005.
|
|
|
|
|
|
|
|
Version 1.01: posted August 7 2005. Corrects factual and markup errors; adds
|
|
|
|
several links.
|
|
|
|
|
|
|
|
Version 1.02: posted August 16 2005. Corrects factual errors.
|
|
|
|
|
2008-11-22 06:26:59 -04:00
|
|
|
Version 1.1: Feb-Nov 2008. Updates the document with respect to Python 3 changes.
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
.. comment Additional topic: building Python w/ UCS2 or UCS4 support
|
|
|
|
.. comment Describe use of codecs.StreamRecoder and StreamReaderWriter
|
|
|
|
|
2007-09-04 04:15:32 -03:00
|
|
|
.. comment
|
2007-08-15 11:28:22 -03:00
|
|
|
Original outline:
|
|
|
|
|
|
|
|
- [ ] Unicode introduction
|
|
|
|
- [ ] ASCII
|
|
|
|
- [ ] Terms
|
2009-01-03 17:26:05 -04:00
|
|
|
- [ ] Character
|
|
|
|
- [ ] Code point
|
|
|
|
- [ ] Encodings
|
|
|
|
- [ ] Common encodings: ASCII, Latin-1, UTF-8
|
2007-08-15 11:28:22 -03:00
|
|
|
- [ ] Unicode Python type
|
2009-01-03 17:26:05 -04:00
|
|
|
- [ ] Writing unicode literals
|
|
|
|
- [ ] Obscurity: -U switch
|
|
|
|
- [ ] Built-ins
|
|
|
|
- [ ] unichr()
|
|
|
|
- [ ] ord()
|
|
|
|
- [ ] unicode() constructor
|
|
|
|
- [ ] Unicode type
|
|
|
|
- [ ] encode(), decode() methods
|
2007-08-15 11:28:22 -03:00
|
|
|
- [ ] Unicodedata module for character properties
|
|
|
|
- [ ] I/O
|
2009-01-03 17:26:05 -04:00
|
|
|
- [ ] Reading/writing Unicode data into files
|
|
|
|
- [ ] Byte-order marks
|
|
|
|
- [ ] Unicode filenames
|
2007-08-15 11:28:22 -03:00
|
|
|
- [ ] Writing Unicode programs
|
2009-01-03 17:26:05 -04:00
|
|
|
- [ ] Do everything in Unicode
|
|
|
|
- [ ] Declaring source code encodings (PEP 263)
|
2007-08-15 11:28:22 -03:00
|
|
|
- [ ] Other issues
|
2009-01-03 17:26:05 -04:00
|
|
|
- [ ] Building Python (UCS2, UCS4)
|