blob: 3b337727f643a4d9be17324690b133dfcfb981b2 [file] [log] [blame]
Guido van Rossum715287f2008-12-02 22:34:15 +00001.. _unicode-howto:
2
Georg Brandl116aa622007-08-15 14:28:22 +00003*****************
4 Unicode HOWTO
5*****************
6
Georg Brandl0c074222008-11-22 10:26:59 +00007:Release: 1.1
Georg Brandl116aa622007-08-15 14:28:22 +00008
9This HOWTO discusses Python's support for Unicode, and explains various problems
10that people commonly encounter when trying to work with Unicode.
11
Georg Brandl6911e3c2007-09-04 07:15:32 +000012
Georg Brandl116aa622007-08-15 14:28:22 +000013Introduction to Unicode
14=======================
15
16History of Character Codes
17--------------------------
18
19In 1968, the American Standard Code for Information Interchange, better known by
20its acronym ASCII, was standardized. ASCII defined numeric codes for various
Georg Brandl0c074222008-11-22 10:26:59 +000021characters, with the numeric values running from 0 to 127. For example, the
22lowercase letter 'a' is assigned 97 as its code value.
Georg Brandl116aa622007-08-15 14:28:22 +000023
24ASCII was an American-developed standard, so it only defined unaccented
25characters. There was an 'e', but no 'é' or 'Í'. This meant that languages
26which required accented characters couldn't be faithfully represented in ASCII.
27(Actually the missing accents matter for English, too, which contains words such
28as 'naïve' and 'café', and some publications have house styles which require
29spellings such as 'coöperate'.)
30
31For a while people just wrote programs that didn't display accents. I remember
32looking at Apple ][ BASIC programs, published in French-language publications in
33the mid-1980s, that had lines like these::
34
Georg Brandla1c6a1c2009-01-03 21:26:05 +000035 PRINT "FICHIER EST COMPLETE."
36 PRINT "CARACTERE NON ACCEPTE."
Georg Brandl116aa622007-08-15 14:28:22 +000037
38Those messages should contain accents, and they just look wrong to someone who
39can read French.
40
41In the 1980s, almost all personal computers were 8-bit, meaning that bytes could
42hold values ranging from 0 to 255. ASCII codes only went up to 127, so some
43machines assigned values between 128 and 255 to accented characters. Different
44machines had different codes, however, which led to problems exchanging files.
45Eventually various commonly used sets of values for the 128-255 range emerged.
46Some were true standards, defined by the International Standards Organization,
47and some were **de facto** conventions that were invented by one company or
48another and managed to catch on.
49
50255 characters aren't very many. For example, you can't fit both the accented
51characters used in Western Europe and the Cyrillic alphabet used for Russian
52into the 128-255 range because there are more than 127 such characters.
53
54You could write files using different codes (all your Russian files in a coding
55system called KOI8, all your French files in a different coding system called
56Latin1), but what if you wanted to write a French document that quotes some
57Russian text? In the 1980s people began to want to solve this problem, and the
58Unicode standardization effort began.
59
60Unicode started out using 16-bit characters instead of 8-bit characters. 16
61bits means you have 2^16 = 65,536 distinct values available, making it possible
62to represent many different characters from many different alphabets; an initial
63goal was to have Unicode contain the alphabets for every single human language.
64It turns out that even 16 bits isn't enough to meet that goal, and the modern
65Unicode specification uses a wider range of codes, 0-1,114,111 (0x10ffff in
66base-16).
67
68There's a related ISO standard, ISO 10646. Unicode and ISO 10646 were
69originally separate efforts, but the specifications were merged with the 1.1
70revision of Unicode.
71
72(This discussion of Unicode's history is highly simplified. I don't think the
73average Python programmer needs to worry about the historical details; consult
74the Unicode consortium site listed in the References for more information.)
75
76
77Definitions
78-----------
79
80A **character** is the smallest possible component of a text. 'A', 'B', 'C',
81etc., are all different characters. So are 'È' and 'Í'. Characters are
82abstractions, and vary depending on the language or context you're talking
83about. For example, the symbol for ohms (Ω) is usually drawn much like the
84capital letter omega (Ω) in the Greek alphabet (they may even be the same in
85some fonts), but these are two different characters that have different
86meanings.
87
88The Unicode standard describes how characters are represented by **code
89points**. A code point is an integer value, usually denoted in base 16. In the
90standard, a code point is written using the notation U+12ca to mean the
91character with value 0x12ca (4810 decimal). The Unicode standard contains a lot
92of tables listing characters and their corresponding code points::
93
Georg Brandla1c6a1c2009-01-03 21:26:05 +000094 0061 'a'; LATIN SMALL LETTER A
95 0062 'b'; LATIN SMALL LETTER B
96 0063 'c'; LATIN SMALL LETTER C
97 ...
98 007B '{'; LEFT CURLY BRACKET
Georg Brandl116aa622007-08-15 14:28:22 +000099
100Strictly, these definitions imply that it's meaningless to say 'this is
101character U+12ca'. U+12ca is a code point, which represents some particular
102character; in this case, it represents the character 'ETHIOPIC SYLLABLE WI'. In
103informal contexts, this distinction between code points and characters will
104sometimes be forgotten.
105
106A character is represented on a screen or on paper by a set of graphical
107elements that's called a **glyph**. The glyph for an uppercase A, for example,
108is two diagonal strokes and a horizontal stroke, though the exact details will
109depend on the font being used. Most Python code doesn't need to worry about
110glyphs; figuring out the correct glyph to display is generally the job of a GUI
111toolkit or a terminal's font renderer.
112
113
114Encodings
115---------
116
117To summarize the previous section: a Unicode string is a sequence of code
118points, which are numbers from 0 to 0x10ffff. This sequence needs to be
119represented as a set of bytes (meaning, values from 0-255) in memory. The rules
120for translating a Unicode string into a sequence of bytes are called an
121**encoding**.
122
123The first encoding you might think of is an array of 32-bit integers. In this
124representation, the string "Python" would look like this::
125
126 P y t h o n
Georg Brandl6911e3c2007-09-04 07:15:32 +0000127 0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00
128 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Georg Brandl116aa622007-08-15 14:28:22 +0000129
130This representation is straightforward but using it presents a number of
131problems.
132
1331. It's not portable; different processors order the bytes differently.
134
1352. It's very wasteful of space. In most texts, the majority of the code points
136 are less than 127, or less than 255, so a lot of space is occupied by zero
137 bytes. The above string takes 24 bytes compared to the 6 bytes needed for an
138 ASCII representation. Increased RAM usage doesn't matter too much (desktop
139 computers have megabytes of RAM, and strings aren't usually that large), but
140 expanding our usage of disk and network bandwidth by a factor of 4 is
141 intolerable.
142
1433. It's not compatible with existing C functions such as ``strlen()``, so a new
144 family of wide string functions would need to be used.
145
1464. Many Internet standards are defined in terms of textual data, and can't
147 handle content with embedded zero bytes.
148
149Generally people don't use this encoding, instead choosing other encodings that
150are more efficient and convenient.
151
152Encodings don't have to handle every possible Unicode character, and most
Benjamin Peterson1f316972009-09-11 20:42:29 +0000153encodings don't. The rules for converting a Unicode string into the ASCII
154encoding, for example, are simple; for each code point:
Georg Brandl116aa622007-08-15 14:28:22 +0000155
1561. If the code point is < 128, each byte is the same as the value of the code
157 point.
158
1592. If the code point is 128 or greater, the Unicode string can't be represented
160 in this encoding. (Python raises a :exc:`UnicodeEncodeError` exception in this
161 case.)
162
163Latin-1, also known as ISO-8859-1, is a similar encoding. Unicode code points
1640-255 are identical to the Latin-1 values, so converting to this encoding simply
165requires converting code points to byte values; if a code point larger than 255
166is encountered, the string can't be encoded into Latin-1.
167
168Encodings don't have to be simple one-to-one mappings like Latin-1. Consider
169IBM's EBCDIC, which was used on IBM mainframes. Letter values weren't in one
170block: 'a' through 'i' had values from 129 to 137, but 'j' through 'r' were 145
171through 153. If you wanted to use EBCDIC as an encoding, you'd probably use
172some sort of lookup table to perform the conversion, but this is largely an
173internal detail.
174
175UTF-8 is one of the most commonly used encodings. UTF stands for "Unicode
176Transformation Format", and the '8' means that 8-bit numbers are used in the
177encoding. (There's also a UTF-16 encoding, but it's less frequently used than
178UTF-8.) UTF-8 uses the following rules:
179
1801. If the code point is <128, it's represented by the corresponding byte value.
1812. If the code point is between 128 and 0x7ff, it's turned into two byte values
182 between 128 and 255.
1833. Code points >0x7ff are turned into three- or four-byte sequences, where each
184 byte of the sequence is between 128 and 255.
Georg Brandl6911e3c2007-09-04 07:15:32 +0000185
Georg Brandl116aa622007-08-15 14:28:22 +0000186UTF-8 has several convenient properties:
187
1881. It can handle any Unicode code point.
1892. A Unicode string is turned into a string of bytes containing no embedded zero
190 bytes. This avoids byte-ordering issues, and means UTF-8 strings can be
191 processed by C functions such as ``strcpy()`` and sent through protocols that
192 can't handle zero bytes.
1933. A string of ASCII text is also valid UTF-8 text.
1944. UTF-8 is fairly compact; the majority of code points are turned into two
195 bytes, and values less than 128 occupy only a single byte.
1965. If bytes are corrupted or lost, it's possible to determine the start of the
197 next UTF-8-encoded code point and resynchronize. It's also unlikely that
198 random 8-bit data will look like valid UTF-8.
199
200
201
202References
203----------
204
205The Unicode Consortium site at <http://www.unicode.org> has character charts, a
206glossary, and PDF versions of the Unicode specification. Be prepared for some
207difficult reading. <http://www.unicode.org/history/> is a chronology of the
208origin and development of Unicode.
209
210To help understand the standard, Jukka Korpela has written an introductory guide
211to reading the Unicode character tables, available at
212<http://www.cs.tut.fi/~jkorpela/unicode/guide.html>.
213
Georg Brandl116aa622007-08-15 14:28:22 +0000214Two other good introductory articles were written by Joel Spolsky
215<http://www.joelonsoftware.com/articles/Unicode.html> and Jason Orendorff
216<http://www.jorendorff.com/articles/unicode/>. If this introduction didn't make
217things clear to you, you should try reading one of these alternate articles
218before continuing.
219
220Wikipedia entries are often helpful; see the entries for "character encoding"
221<http://en.wikipedia.org/wiki/Character_encoding> and UTF-8
222<http://en.wikipedia.org/wiki/UTF-8>, for example.
223
224
225Python's Unicode Support
226========================
227
228Now that you've learned the rudiments of Unicode, we can look at Python's
229Unicode features.
230
Georg Brandlf6945182008-02-01 11:56:49 +0000231The String Type
232---------------
Georg Brandl116aa622007-08-15 14:28:22 +0000233
Georg Brandlf6945182008-02-01 11:56:49 +0000234Since Python 3.0, the language features a ``str`` type that contain Unicode
235characters, meaning any string created using ``"unicode rocks!"``, ``'unicode
Georg Brandl4f5f98d2009-05-04 21:01:20 +0000236rocks!'``, or the triple-quoted string syntax is stored as Unicode.
Georg Brandl116aa622007-08-15 14:28:22 +0000237
Georg Brandlf6945182008-02-01 11:56:49 +0000238To insert a Unicode character that is not part ASCII, e.g., any letters with
239accents, one can use escape sequences in their string literals as such::
Georg Brandl116aa622007-08-15 14:28:22 +0000240
Georg Brandlf6945182008-02-01 11:56:49 +0000241 >>> "\N{GREEK CAPITAL LETTER DELTA}" # Using the character name
242 '\u0394'
243 >>> "\u0394" # Using a 16-bit hex value
244 '\u0394'
245 >>> "\U00000394" # Using a 32-bit hex value
246 '\u0394'
Georg Brandl116aa622007-08-15 14:28:22 +0000247
Georg Brandlf6945182008-02-01 11:56:49 +0000248In addition, one can create a string using the :func:`decode` method of
249:class:`bytes`. This method takes an encoding, such as UTF-8, and, optionally,
250an *errors* argument.
Georg Brandl116aa622007-08-15 14:28:22 +0000251
Georg Brandlf6945182008-02-01 11:56:49 +0000252The *errors* argument specifies the response when the input string can't be
Georg Brandl116aa622007-08-15 14:28:22 +0000253converted according to the encoding's rules. Legal values for this argument are
Georg Brandl0c074222008-11-22 10:26:59 +0000254'strict' (raise a :exc:`UnicodeDecodeError` exception), 'replace' (use U+FFFD,
Georg Brandl116aa622007-08-15 14:28:22 +0000255'REPLACEMENT CHARACTER'), or 'ignore' (just leave the character out of the
256Unicode result). The following examples show the differences::
257
Georg Brandlf6945182008-02-01 11:56:49 +0000258 >>> b'\x80abc'.decode("utf-8", "strict")
Georg Brandl116aa622007-08-15 14:28:22 +0000259 Traceback (most recent call last):
260 File "<stdin>", line 1, in ?
Georg Brandl0c074222008-11-22 10:26:59 +0000261 UnicodeDecodeError: 'utf8' codec can't decode byte 0x80 in position 0:
262 unexpected code byte
Georg Brandlf6945182008-02-01 11:56:49 +0000263 >>> b'\x80abc'.decode("utf-8", "replace")
264 '\ufffdabc'
265 >>> b'\x80abc'.decode("utf-8", "ignore")
266 'abc'
Georg Brandl116aa622007-08-15 14:28:22 +0000267
Georg Brandl0c074222008-11-22 10:26:59 +0000268Encodings are specified as strings containing the encoding's name. Python comes
269with roughly 100 different encodings; see the Python Library Reference at
270:ref:`standard-encodings` for a list. Some encodings have multiple names; for
271example, 'latin-1', 'iso_8859_1' and '8859' are all synonyms for the same
272encoding.
Georg Brandl116aa622007-08-15 14:28:22 +0000273
Georg Brandlf6945182008-02-01 11:56:49 +0000274One-character Unicode strings can also be created with the :func:`chr`
Georg Brandl116aa622007-08-15 14:28:22 +0000275built-in function, which takes integers and returns a Unicode string of length 1
276that contains the corresponding code point. The reverse operation is the
277built-in :func:`ord` function that takes a one-character Unicode string and
278returns the code point value::
279
Georg Brandlf6945182008-02-01 11:56:49 +0000280 >>> chr(40960)
281 '\ua000'
282 >>> ord('\ua000')
Georg Brandl116aa622007-08-15 14:28:22 +0000283 40960
284
Georg Brandlf6945182008-02-01 11:56:49 +0000285Converting to Bytes
286-------------------
Georg Brandl116aa622007-08-15 14:28:22 +0000287
Georg Brandlf6945182008-02-01 11:56:49 +0000288Another important str method is ``.encode([encoding], [errors='strict'])``,
289which returns a ``bytes`` representation of the Unicode string, encoded in the
290requested encoding. The ``errors`` parameter is the same as the parameter of
291the :meth:`decode` method, with one additional possibility; as well as 'strict',
Georg Brandl0c074222008-11-22 10:26:59 +0000292'ignore', and 'replace' (which in this case inserts a question mark instead of
293the unencodable character), you can also pass 'xmlcharrefreplace' which uses
294XML's character references. The following example shows the different results::
Georg Brandl116aa622007-08-15 14:28:22 +0000295
Georg Brandlf6945182008-02-01 11:56:49 +0000296 >>> u = chr(40960) + 'abcd' + chr(1972)
Georg Brandl116aa622007-08-15 14:28:22 +0000297 >>> u.encode('utf-8')
Georg Brandlf6945182008-02-01 11:56:49 +0000298 b'\xea\x80\x80abcd\xde\xb4'
Georg Brandl116aa622007-08-15 14:28:22 +0000299 >>> u.encode('ascii')
300 Traceback (most recent call last):
301 File "<stdin>", line 1, in ?
Georg Brandl0c074222008-11-22 10:26:59 +0000302 UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in
303 position 0: ordinal not in range(128)
Georg Brandl116aa622007-08-15 14:28:22 +0000304 >>> u.encode('ascii', 'ignore')
Georg Brandlf6945182008-02-01 11:56:49 +0000305 b'abcd'
Georg Brandl116aa622007-08-15 14:28:22 +0000306 >>> u.encode('ascii', 'replace')
Georg Brandlf6945182008-02-01 11:56:49 +0000307 b'?abcd?'
Georg Brandl116aa622007-08-15 14:28:22 +0000308 >>> u.encode('ascii', 'xmlcharrefreplace')
Georg Brandlf6945182008-02-01 11:56:49 +0000309 b'&#40960;abcd&#1972;'
Georg Brandl6911e3c2007-09-04 07:15:32 +0000310
Georg Brandl116aa622007-08-15 14:28:22 +0000311The low-level routines for registering and accessing the available encodings are
312found in the :mod:`codecs` module. However, the encoding and decoding functions
313returned by this module are usually more low-level than is comfortable, so I'm
314not going to describe the :mod:`codecs` module here. If you need to implement a
315completely new encoding, you'll need to learn about the :mod:`codecs` module
316interfaces, but implementing encodings is a specialized task that also won't be
317covered here. Consult the Python documentation to learn more about this module.
318
Georg Brandl6911e3c2007-09-04 07:15:32 +0000319
Georg Brandl116aa622007-08-15 14:28:22 +0000320Unicode Literals in Python Source Code
321--------------------------------------
322
Georg Brandlf6945182008-02-01 11:56:49 +0000323In Python source code, specific Unicode code points can be written using the
324``\u`` escape sequence, which is followed by four hex digits giving the code
325point. The ``\U`` escape sequence is similar, but expects 8 hex digits, not 4::
Georg Brandl116aa622007-08-15 14:28:22 +0000326
Georg Brandlf6945182008-02-01 11:56:49 +0000327 >>> s = "a\xac\u1234\u20ac\U00008000"
328 ^^^^ two-digit hex escape
329 ^^^^^ four-digit Unicode escape
330 ^^^^^^^^^^ eight-digit Unicode escape
Georg Brandl6911e3c2007-09-04 07:15:32 +0000331 >>> for c in s: print(ord(c), end=" ")
332 ...
Georg Brandl116aa622007-08-15 14:28:22 +0000333 97 172 4660 8364 32768
334
335Using escape sequences for code points greater than 127 is fine in small doses,
336but becomes an annoyance if you're using many accented characters, as you would
337in a program with messages in French or some other accent-using language. You
Georg Brandlf6945182008-02-01 11:56:49 +0000338can also assemble strings using the :func:`chr` built-in function, but this is
Georg Brandl116aa622007-08-15 14:28:22 +0000339even more tedious.
340
341Ideally, you'd want to be able to write literals in your language's natural
342encoding. You could then edit Python source code with your favorite editor
343which would display the accented characters naturally, and have the right
344characters used at runtime.
345
Georg Brandl0c074222008-11-22 10:26:59 +0000346Python supports writing source code in UTF-8 by default, but you can use almost
347any encoding if you declare the encoding being used. This is done by including
348a special comment as either the first or second line of the source file::
Georg Brandl116aa622007-08-15 14:28:22 +0000349
350 #!/usr/bin/env python
351 # -*- coding: latin-1 -*-
Georg Brandl6911e3c2007-09-04 07:15:32 +0000352
Georg Brandlf6945182008-02-01 11:56:49 +0000353 u = 'abcdé'
Georg Brandl6911e3c2007-09-04 07:15:32 +0000354 print(ord(u[-1]))
355
Georg Brandl116aa622007-08-15 14:28:22 +0000356The syntax is inspired by Emacs's notation for specifying variables local to a
357file. Emacs supports many different variables, but Python only supports
Georg Brandl0c074222008-11-22 10:26:59 +0000358'coding'. The ``-*-`` symbols indicate to Emacs that the comment is special;
359they have no significance to Python but are a convention. Python looks for
360``coding: name`` or ``coding=name`` in the comment.
Georg Brandl116aa622007-08-15 14:28:22 +0000361
Georg Brandlf6945182008-02-01 11:56:49 +0000362If you don't include such a comment, the default encoding used will be UTF-8 as
363already mentioned.
Georg Brandl6911e3c2007-09-04 07:15:32 +0000364
Georg Brandl116aa622007-08-15 14:28:22 +0000365
366Unicode Properties
367------------------
368
369The Unicode specification includes a database of information about code points.
370For each code point that's defined, the information includes the character's
371name, its category, the numeric value if applicable (Unicode has characters
372representing the Roman numerals and fractions such as one-third and
373four-fifths). There are also properties related to the code point's use in
374bidirectional text and other display-related properties.
375
376The following program displays some information about several characters, and
377prints the numeric value of one particular character::
378
379 import unicodedata
Georg Brandl6911e3c2007-09-04 07:15:32 +0000380
Georg Brandlf6945182008-02-01 11:56:49 +0000381 u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)
Georg Brandl6911e3c2007-09-04 07:15:32 +0000382
Georg Brandl116aa622007-08-15 14:28:22 +0000383 for i, c in enumerate(u):
Georg Brandl6911e3c2007-09-04 07:15:32 +0000384 print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")
385 print(unicodedata.name(c))
386
Georg Brandl116aa622007-08-15 14:28:22 +0000387 # Get numeric value of second character
Georg Brandl6911e3c2007-09-04 07:15:32 +0000388 print(unicodedata.numeric(u[1]))
Georg Brandl116aa622007-08-15 14:28:22 +0000389
390When run, this prints::
391
392 0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE
393 1 0bf2 No TAMIL NUMBER ONE THOUSAND
394 2 0f84 Mn TIBETAN MARK HALANTA
395 3 1770 Lo TAGBANWA LETTER SA
396 4 33af So SQUARE RAD OVER S SQUARED
397 1000.0
398
399The category codes are abbreviations describing the nature of the character.
400These are grouped into categories such as "Letter", "Number", "Punctuation", or
401"Symbol", which in turn are broken up into subcategories. To take the codes
402from the above output, ``'Ll'`` means 'Letter, lowercase', ``'No'`` means
403"Number, other", ``'Mn'`` is "Mark, nonspacing", and ``'So'`` is "Symbol,
404other". See
405<http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values> for a
406list of category codes.
407
408References
409----------
410
Georg Brandlf6945182008-02-01 11:56:49 +0000411The ``str`` type is described in the Python library reference at
412:ref:`typesseq`.
Georg Brandl116aa622007-08-15 14:28:22 +0000413
414The documentation for the :mod:`unicodedata` module.
415
416The documentation for the :mod:`codecs` module.
417
418Marc-André Lemburg gave a presentation at EuroPython 2002 titled "Python and
419Unicode". A PDF version of his slides is available at
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000420<http://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf>, and is an
Georg Brandl0c074222008-11-22 10:26:59 +0000421excellent overview of the design of Python's Unicode features (based on Python
4222, where the Unicode string type is called ``unicode`` and literals start with
423``u``).
Georg Brandl116aa622007-08-15 14:28:22 +0000424
425
426Reading and Writing Unicode Data
427================================
428
429Once you've written some code that works with Unicode data, the next problem is
430input/output. How do you get Unicode strings into your program, and how do you
431convert Unicode into a form suitable for storage or transmission?
432
433It's possible that you may not need to do anything depending on your input
434sources and output destinations; you should check whether the libraries used in
435your application support Unicode natively. XML parsers often return Unicode
436data, for example. Many relational databases also support Unicode-valued
437columns and can return Unicode values from an SQL query.
438
439Unicode data is usually converted to a particular encoding before it gets
440written to disk or sent over a socket. It's possible to do all the work
Georg Brandl0c074222008-11-22 10:26:59 +0000441yourself: open a file, read an 8-bit byte string from it, and convert the string
442with ``str(bytes, encoding)``. However, the manual approach is not recommended.
Georg Brandl116aa622007-08-15 14:28:22 +0000443
444One problem is the multi-byte nature of encodings; one Unicode character can be
445represented by several bytes. If you want to read the file in arbitrary-sized
446chunks (say, 1K or 4K), you need to write error-handling code to catch the case
447where only part of the bytes encoding a single Unicode character are read at the
448end of a chunk. One solution would be to read the entire file into memory and
449then perform the decoding, but that prevents you from working with files that
450are extremely large; if you need to read a 2Gb file, you need 2Gb of RAM.
451(More, really, since for at least a moment you'd need to have both the encoded
452string and its Unicode version in memory.)
453
454The solution would be to use the low-level decoding interface to catch the case
455of partial coding sequences. The work of implementing this has already been
Georg Brandl0c074222008-11-22 10:26:59 +0000456done for you: the built-in :func:`open` function can return a file-like object
457that assumes the file's contents are in a specified encoding and accepts Unicode
458parameters for methods such as ``.read()`` and ``.write()``. This works through
459:func:`open`\'s *encoding* and *errors* parameters which are interpreted just
460like those in string objects' :meth:`encode` and :meth:`decode` methods.
Georg Brandl116aa622007-08-15 14:28:22 +0000461
462Reading Unicode from a file is therefore simple::
463
Georg Brandl0c074222008-11-22 10:26:59 +0000464 f = open('unicode.rst', encoding='utf-8')
Georg Brandl116aa622007-08-15 14:28:22 +0000465 for line in f:
Georg Brandl6911e3c2007-09-04 07:15:32 +0000466 print(repr(line))
Georg Brandl116aa622007-08-15 14:28:22 +0000467
468It's also possible to open files in update mode, allowing both reading and
469writing::
470
Georg Brandl0c074222008-11-22 10:26:59 +0000471 f = open('test', encoding='utf-8', mode='w+')
Georg Brandlf6945182008-02-01 11:56:49 +0000472 f.write('\u4500 blah blah blah\n')
Georg Brandl116aa622007-08-15 14:28:22 +0000473 f.seek(0)
Georg Brandl6911e3c2007-09-04 07:15:32 +0000474 print(repr(f.readline()[:1]))
Georg Brandl116aa622007-08-15 14:28:22 +0000475 f.close()
476
Georg Brandl0c074222008-11-22 10:26:59 +0000477The Unicode character U+FEFF is used as a byte-order mark (BOM), and is often
Georg Brandl116aa622007-08-15 14:28:22 +0000478written as the first character of a file in order to assist with autodetection
479of the file's byte ordering. Some encodings, such as UTF-16, expect a BOM to be
480present at the start of a file; when such an encoding is used, the BOM will be
481automatically written as the first character and will be silently dropped when
482the file is read. There are variants of these encodings, such as 'utf-16-le'
483and 'utf-16-be' for little-endian and big-endian encodings, that specify one
484particular byte ordering and don't skip the BOM.
485
Georg Brandl0c074222008-11-22 10:26:59 +0000486In some areas, it is also convention to use a "BOM" at the start of UTF-8
487encoded files; the name is misleading since UTF-8 is not byte-order dependent.
488The mark simply announces that the file is encoded in UTF-8. Use the
489'utf-8-sig' codec to automatically skip the mark if present for reading such
490files.
491
Georg Brandl116aa622007-08-15 14:28:22 +0000492
493Unicode filenames
494-----------------
495
496Most of the operating systems in common use today support filenames that contain
497arbitrary Unicode characters. Usually this is implemented by converting the
498Unicode string into some encoding that varies depending on the system. For
Georg Brandlc575c902008-09-13 17:46:05 +0000499example, Mac OS X uses UTF-8 while Windows uses a configurable encoding; on
Georg Brandl116aa622007-08-15 14:28:22 +0000500Windows, Python uses the name "mbcs" to refer to whatever the currently
501configured encoding is. On Unix systems, there will only be a filesystem
502encoding if you've set the ``LANG`` or ``LC_CTYPE`` environment variables; if
503you haven't, the default encoding is ASCII.
504
505The :func:`sys.getfilesystemencoding` function returns the encoding to use on
506your current system, in case you want to do the encoding manually, but there's
507not much reason to bother. When opening a file for reading or writing, you can
508usually just provide the Unicode string as the filename, and it will be
509automatically converted to the right encoding for you::
510
Georg Brandlf6945182008-02-01 11:56:49 +0000511 filename = 'filename\u4500abc'
Georg Brandl116aa622007-08-15 14:28:22 +0000512 f = open(filename, 'w')
513 f.write('blah\n')
514 f.close()
515
516Functions in the :mod:`os` module such as :func:`os.stat` will also accept Unicode
517filenames.
518
519:func:`os.listdir`, which returns filenames, raises an issue: should it return
Georg Brandl0c074222008-11-22 10:26:59 +0000520the Unicode version of filenames, or should it return byte strings containing
Georg Brandl116aa622007-08-15 14:28:22 +0000521the encoded versions? :func:`os.listdir` will do both, depending on whether you
Georg Brandl0c074222008-11-22 10:26:59 +0000522provided the directory path as a byte string or a Unicode string. If you pass a
523Unicode string as the path, filenames will be decoded using the filesystem's
524encoding and a list of Unicode strings will be returned, while passing a byte
525path will return the byte string versions of the filenames. For example,
526assuming the default filesystem encoding is UTF-8, running the following
527program::
Georg Brandl116aa622007-08-15 14:28:22 +0000528
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000529 fn = 'filename\u4500abc'
530 f = open(fn, 'w')
531 f.close()
Georg Brandl116aa622007-08-15 14:28:22 +0000532
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000533 import os
534 print(os.listdir(b'.'))
535 print(os.listdir('.'))
Georg Brandl116aa622007-08-15 14:28:22 +0000536
537will produce the following output::
538
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000539 amk:~$ python t.py
540 [b'.svn', b'filename\xe4\x94\x80abc', ...]
541 ['.svn', 'filename\u4500abc', ...]
Georg Brandl116aa622007-08-15 14:28:22 +0000542
543The first list contains UTF-8-encoded filenames, and the second list contains
544the Unicode versions.
545
Georg Brandl0c074222008-11-22 10:26:59 +0000546Note that in most occasions, the Uniode APIs should be used. The bytes APIs
547should only be used on systems where undecodable file names can be present,
548i.e. Unix systems.
549
Georg Brandl116aa622007-08-15 14:28:22 +0000550
Georg Brandl6911e3c2007-09-04 07:15:32 +0000551
Georg Brandl116aa622007-08-15 14:28:22 +0000552Tips for Writing Unicode-aware Programs
553---------------------------------------
554
555This section provides some suggestions on writing software that deals with
556Unicode.
557
558The most important tip is:
559
560 Software should only work with Unicode strings internally, converting to a
561 particular encoding on output.
562
Georg Brandl0c074222008-11-22 10:26:59 +0000563If you attempt to write processing functions that accept both Unicode and byte
Georg Brandl116aa622007-08-15 14:28:22 +0000564strings, you will find your program vulnerable to bugs wherever you combine the
Georg Brandl0c074222008-11-22 10:26:59 +0000565two different kinds of strings. There is no automatic encoding or decoding if
566you do e.g. ``str + bytes``, a :exc:`TypeError` is raised for this expression.
Georg Brandl116aa622007-08-15 14:28:22 +0000567
568It's easy to miss such problems if you only test your software with data that
569doesn't contain any accents; everything will seem to work, but there's actually
570a bug in your program waiting for the first user who attempts to use characters
571> 127. A second tip, therefore, is:
572
573 Include characters > 127 and, even better, characters > 255 in your test
574 data.
575
576When using data coming from a web browser or some other untrusted source, a
577common technique is to check for illegal characters in a string before using the
578string in a generated command line or storing it in a database. If you're doing
579this, be careful to check the string once it's in the form that will be used or
580stored; it's possible for encodings to be used to disguise characters. This is
581especially true if the input data also specifies the encoding; many encodings
582leave the commonly checked-for characters alone, but Python includes some
583encodings such as ``'base64'`` that modify every single character.
584
585For example, let's say you have a content management system that takes a Unicode
586filename, and you want to disallow paths with a '/' character. You might write
587this code::
588
Georg Brandl0c074222008-11-22 10:26:59 +0000589 def read_file(filename, encoding):
Georg Brandl116aa622007-08-15 14:28:22 +0000590 if '/' in filename:
591 raise ValueError("'/' not allowed in filenames")
592 unicode_name = filename.decode(encoding)
593 f = open(unicode_name, 'r')
594 # ... return contents of file ...
Georg Brandl6911e3c2007-09-04 07:15:32 +0000595
Georg Brandl116aa622007-08-15 14:28:22 +0000596However, if an attacker could specify the ``'base64'`` encoding, they could pass
597``'L2V0Yy9wYXNzd2Q='``, which is the base-64 encoded form of the string
598``'/etc/passwd'``, to read a system file. The above code looks for ``'/'``
599characters in the encoded form and misses the dangerous character in the
600resulting decoded form.
601
602References
603----------
604
605The PDF slides for Marc-André Lemburg's presentation "Writing Unicode-aware
606Applications in Python" are available at
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000607<http://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf>
Georg Brandl116aa622007-08-15 14:28:22 +0000608and discuss questions of character encodings as well as how to internationalize
609and localize an application.
610
611
612Revision History and Acknowledgements
613=====================================
614
615Thanks to the following people who have noted errors or offered suggestions on
616this article: Nicholas Bastin, Marius Gedminas, Kent Johnson, Ken Krugler,
617Marc-André Lemburg, Martin von Löwis, Chad Whitacre.
618
619Version 1.0: posted August 5 2005.
620
621Version 1.01: posted August 7 2005. Corrects factual and markup errors; adds
622several links.
623
624Version 1.02: posted August 16 2005. Corrects factual errors.
625
Georg Brandl0c074222008-11-22 10:26:59 +0000626Version 1.1: Feb-Nov 2008. Updates the document with respect to Python 3 changes.
627
Georg Brandl116aa622007-08-15 14:28:22 +0000628
629.. comment Additional topic: building Python w/ UCS2 or UCS4 support
Georg Brandl116aa622007-08-15 14:28:22 +0000630.. comment Describe use of codecs.StreamRecoder and StreamReaderWriter
631
Georg Brandl6911e3c2007-09-04 07:15:32 +0000632.. comment
Georg Brandl116aa622007-08-15 14:28:22 +0000633 Original outline:
634
635 - [ ] Unicode introduction
636 - [ ] ASCII
637 - [ ] Terms
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000638 - [ ] Character
639 - [ ] Code point
640 - [ ] Encodings
641 - [ ] Common encodings: ASCII, Latin-1, UTF-8
Georg Brandl116aa622007-08-15 14:28:22 +0000642 - [ ] Unicode Python type
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000643 - [ ] Writing unicode literals
644 - [ ] Obscurity: -U switch
645 - [ ] Built-ins
646 - [ ] unichr()
647 - [ ] ord()
648 - [ ] unicode() constructor
649 - [ ] Unicode type
650 - [ ] encode(), decode() methods
Georg Brandl116aa622007-08-15 14:28:22 +0000651 - [ ] Unicodedata module for character properties
652 - [ ] I/O
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000653 - [ ] Reading/writing Unicode data into files
654 - [ ] Byte-order marks
655 - [ ] Unicode filenames
Georg Brandl116aa622007-08-15 14:28:22 +0000656 - [ ] Writing Unicode programs
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000657 - [ ] Do everything in Unicode
658 - [ ] Declaring source code encodings (PEP 263)
Georg Brandl116aa622007-08-15 14:28:22 +0000659 - [ ] Other issues
Georg Brandla1c6a1c2009-01-03 21:26:05 +0000660 - [ ] Building Python (UCS2, UCS4)