blob: a01d723ef33201e815979489c34f5bbb5199ccfc [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
35 PRINT "FICHER EST COMPLETE."
36 PRINT "CARACTERE NON ACCEPTE."
37
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
94 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
99
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
153encodings don't. For example, Python's default encoding is the 'ascii'
154encoding. The rules for converting a Unicode string into the ASCII encoding are
155simple; for each code point:
156
1571. If the code point is < 128, each byte is the same as the value of the code
158 point.
159
1602. If the code point is 128 or greater, the Unicode string can't be represented
161 in this encoding. (Python raises a :exc:`UnicodeEncodeError` exception in this
162 case.)
163
164Latin-1, also known as ISO-8859-1, is a similar encoding. Unicode code points
1650-255 are identical to the Latin-1 values, so converting to this encoding simply
166requires converting code points to byte values; if a code point larger than 255
167is encountered, the string can't be encoded into Latin-1.
168
169Encodings don't have to be simple one-to-one mappings like Latin-1. Consider
170IBM's EBCDIC, which was used on IBM mainframes. Letter values weren't in one
171block: 'a' through 'i' had values from 129 to 137, but 'j' through 'r' were 145
172through 153. If you wanted to use EBCDIC as an encoding, you'd probably use
173some sort of lookup table to perform the conversion, but this is largely an
174internal detail.
175
176UTF-8 is one of the most commonly used encodings. UTF stands for "Unicode
177Transformation Format", and the '8' means that 8-bit numbers are used in the
178encoding. (There's also a UTF-16 encoding, but it's less frequently used than
179UTF-8.) UTF-8 uses the following rules:
180
1811. If the code point is <128, it's represented by the corresponding byte value.
1822. If the code point is between 128 and 0x7ff, it's turned into two byte values
183 between 128 and 255.
1843. Code points >0x7ff are turned into three- or four-byte sequences, where each
185 byte of the sequence is between 128 and 255.
Georg Brandl6911e3c2007-09-04 07:15:32 +0000186
Georg Brandl116aa622007-08-15 14:28:22 +0000187UTF-8 has several convenient properties:
188
1891. It can handle any Unicode code point.
1902. A Unicode string is turned into a string of bytes containing no embedded zero
191 bytes. This avoids byte-ordering issues, and means UTF-8 strings can be
192 processed by C functions such as ``strcpy()`` and sent through protocols that
193 can't handle zero bytes.
1943. A string of ASCII text is also valid UTF-8 text.
1954. UTF-8 is fairly compact; the majority of code points are turned into two
196 bytes, and values less than 128 occupy only a single byte.
1975. If bytes are corrupted or lost, it's possible to determine the start of the
198 next UTF-8-encoded code point and resynchronize. It's also unlikely that
199 random 8-bit data will look like valid UTF-8.
200
201
202
203References
204----------
205
206The Unicode Consortium site at <http://www.unicode.org> has character charts, a
207glossary, and PDF versions of the Unicode specification. Be prepared for some
208difficult reading. <http://www.unicode.org/history/> is a chronology of the
209origin and development of Unicode.
210
211To help understand the standard, Jukka Korpela has written an introductory guide
212to reading the Unicode character tables, available at
213<http://www.cs.tut.fi/~jkorpela/unicode/guide.html>.
214
Georg Brandl116aa622007-08-15 14:28:22 +0000215Two other good introductory articles were written by Joel Spolsky
216<http://www.joelonsoftware.com/articles/Unicode.html> and Jason Orendorff
217<http://www.jorendorff.com/articles/unicode/>. If this introduction didn't make
218things clear to you, you should try reading one of these alternate articles
219before continuing.
220
221Wikipedia entries are often helpful; see the entries for "character encoding"
222<http://en.wikipedia.org/wiki/Character_encoding> and UTF-8
223<http://en.wikipedia.org/wiki/UTF-8>, for example.
224
225
226Python's Unicode Support
227========================
228
229Now that you've learned the rudiments of Unicode, we can look at Python's
230Unicode features.
231
Georg Brandlf6945182008-02-01 11:56:49 +0000232The String Type
233---------------
Georg Brandl116aa622007-08-15 14:28:22 +0000234
Georg Brandlf6945182008-02-01 11:56:49 +0000235Since Python 3.0, the language features a ``str`` type that contain Unicode
236characters, meaning any string created using ``"unicode rocks!"``, ``'unicode
237rocks!``, or the triple-quoted string syntax is stored as Unicode.
Georg Brandl116aa622007-08-15 14:28:22 +0000238
Georg Brandlf6945182008-02-01 11:56:49 +0000239To insert a Unicode character that is not part ASCII, e.g., any letters with
240accents, one can use escape sequences in their string literals as such::
Georg Brandl116aa622007-08-15 14:28:22 +0000241
Georg Brandlf6945182008-02-01 11:56:49 +0000242 >>> "\N{GREEK CAPITAL LETTER DELTA}" # Using the character name
243 '\u0394'
244 >>> "\u0394" # Using a 16-bit hex value
245 '\u0394'
246 >>> "\U00000394" # Using a 32-bit hex value
247 '\u0394'
Georg Brandl116aa622007-08-15 14:28:22 +0000248
Georg Brandlf6945182008-02-01 11:56:49 +0000249In addition, one can create a string using the :func:`decode` method of
250:class:`bytes`. This method takes an encoding, such as UTF-8, and, optionally,
251an *errors* argument.
Georg Brandl116aa622007-08-15 14:28:22 +0000252
Georg Brandlf6945182008-02-01 11:56:49 +0000253The *errors* argument specifies the response when the input string can't be
Georg Brandl116aa622007-08-15 14:28:22 +0000254converted according to the encoding's rules. Legal values for this argument are
Georg Brandl0c074222008-11-22 10:26:59 +0000255'strict' (raise a :exc:`UnicodeDecodeError` exception), 'replace' (use U+FFFD,
Georg Brandl116aa622007-08-15 14:28:22 +0000256'REPLACEMENT CHARACTER'), or 'ignore' (just leave the character out of the
257Unicode result). The following examples show the differences::
258
Georg Brandlf6945182008-02-01 11:56:49 +0000259 >>> b'\x80abc'.decode("utf-8", "strict")
Georg Brandl116aa622007-08-15 14:28:22 +0000260 Traceback (most recent call last):
261 File "<stdin>", line 1, in ?
Georg Brandl0c074222008-11-22 10:26:59 +0000262 UnicodeDecodeError: 'utf8' codec can't decode byte 0x80 in position 0:
263 unexpected code byte
Georg Brandlf6945182008-02-01 11:56:49 +0000264 >>> b'\x80abc'.decode("utf-8", "replace")
265 '\ufffdabc'
266 >>> b'\x80abc'.decode("utf-8", "ignore")
267 'abc'
Georg Brandl116aa622007-08-15 14:28:22 +0000268
Georg Brandl0c074222008-11-22 10:26:59 +0000269Encodings are specified as strings containing the encoding's name. Python comes
270with roughly 100 different encodings; see the Python Library Reference at
271:ref:`standard-encodings` for a list. Some encodings have multiple names; for
272example, 'latin-1', 'iso_8859_1' and '8859' are all synonyms for the same
273encoding.
Georg Brandl116aa622007-08-15 14:28:22 +0000274
Georg Brandlf6945182008-02-01 11:56:49 +0000275One-character Unicode strings can also be created with the :func:`chr`
Georg Brandl116aa622007-08-15 14:28:22 +0000276built-in function, which takes integers and returns a Unicode string of length 1
277that contains the corresponding code point. The reverse operation is the
278built-in :func:`ord` function that takes a one-character Unicode string and
279returns the code point value::
280
Georg Brandlf6945182008-02-01 11:56:49 +0000281 >>> chr(40960)
282 '\ua000'
283 >>> ord('\ua000')
Georg Brandl116aa622007-08-15 14:28:22 +0000284 40960
285
Georg Brandlf6945182008-02-01 11:56:49 +0000286Converting to Bytes
287-------------------
Georg Brandl116aa622007-08-15 14:28:22 +0000288
Georg Brandlf6945182008-02-01 11:56:49 +0000289Another important str method is ``.encode([encoding], [errors='strict'])``,
290which returns a ``bytes`` representation of the Unicode string, encoded in the
291requested encoding. The ``errors`` parameter is the same as the parameter of
292the :meth:`decode` method, with one additional possibility; as well as 'strict',
Georg Brandl0c074222008-11-22 10:26:59 +0000293'ignore', and 'replace' (which in this case inserts a question mark instead of
294the unencodable character), you can also pass 'xmlcharrefreplace' which uses
295XML's character references. The following example shows the different results::
Georg Brandl116aa622007-08-15 14:28:22 +0000296
Georg Brandlf6945182008-02-01 11:56:49 +0000297 >>> u = chr(40960) + 'abcd' + chr(1972)
Georg Brandl116aa622007-08-15 14:28:22 +0000298 >>> u.encode('utf-8')
Georg Brandlf6945182008-02-01 11:56:49 +0000299 b'\xea\x80\x80abcd\xde\xb4'
Georg Brandl116aa622007-08-15 14:28:22 +0000300 >>> u.encode('ascii')
301 Traceback (most recent call last):
302 File "<stdin>", line 1, in ?
Georg Brandl0c074222008-11-22 10:26:59 +0000303 UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in
304 position 0: ordinal not in range(128)
Georg Brandl116aa622007-08-15 14:28:22 +0000305 >>> u.encode('ascii', 'ignore')
Georg Brandlf6945182008-02-01 11:56:49 +0000306 b'abcd'
Georg Brandl116aa622007-08-15 14:28:22 +0000307 >>> u.encode('ascii', 'replace')
Georg Brandlf6945182008-02-01 11:56:49 +0000308 b'?abcd?'
Georg Brandl116aa622007-08-15 14:28:22 +0000309 >>> u.encode('ascii', 'xmlcharrefreplace')
Georg Brandlf6945182008-02-01 11:56:49 +0000310 b'&#40960;abcd&#1972;'
Georg Brandl6911e3c2007-09-04 07:15:32 +0000311
Georg Brandl116aa622007-08-15 14:28:22 +0000312The low-level routines for registering and accessing the available encodings are
313found in the :mod:`codecs` module. However, the encoding and decoding functions
314returned by this module are usually more low-level than is comfortable, so I'm
315not going to describe the :mod:`codecs` module here. If you need to implement a
316completely new encoding, you'll need to learn about the :mod:`codecs` module
317interfaces, but implementing encodings is a specialized task that also won't be
318covered here. Consult the Python documentation to learn more about this module.
319
Georg Brandl6911e3c2007-09-04 07:15:32 +0000320
Georg Brandl116aa622007-08-15 14:28:22 +0000321Unicode Literals in Python Source Code
322--------------------------------------
323
Georg Brandlf6945182008-02-01 11:56:49 +0000324In Python source code, specific Unicode code points can be written using the
325``\u`` escape sequence, which is followed by four hex digits giving the code
326point. The ``\U`` escape sequence is similar, but expects 8 hex digits, not 4::
Georg Brandl116aa622007-08-15 14:28:22 +0000327
Georg Brandlf6945182008-02-01 11:56:49 +0000328 >>> s = "a\xac\u1234\u20ac\U00008000"
329 ^^^^ two-digit hex escape
330 ^^^^^ four-digit Unicode escape
331 ^^^^^^^^^^ eight-digit Unicode escape
Georg Brandl6911e3c2007-09-04 07:15:32 +0000332 >>> for c in s: print(ord(c), end=" ")
333 ...
Georg Brandl116aa622007-08-15 14:28:22 +0000334 97 172 4660 8364 32768
335
336Using escape sequences for code points greater than 127 is fine in small doses,
337but becomes an annoyance if you're using many accented characters, as you would
338in a program with messages in French or some other accent-using language. You
Georg Brandlf6945182008-02-01 11:56:49 +0000339can also assemble strings using the :func:`chr` built-in function, but this is
Georg Brandl116aa622007-08-15 14:28:22 +0000340even more tedious.
341
342Ideally, you'd want to be able to write literals in your language's natural
343encoding. You could then edit Python source code with your favorite editor
344which would display the accented characters naturally, and have the right
345characters used at runtime.
346
Georg Brandl0c074222008-11-22 10:26:59 +0000347Python supports writing source code in UTF-8 by default, but you can use almost
348any encoding if you declare the encoding being used. This is done by including
349a special comment as either the first or second line of the source file::
Georg Brandl116aa622007-08-15 14:28:22 +0000350
351 #!/usr/bin/env python
352 # -*- coding: latin-1 -*-
Georg Brandl6911e3c2007-09-04 07:15:32 +0000353
Georg Brandlf6945182008-02-01 11:56:49 +0000354 u = 'abcdé'
Georg Brandl6911e3c2007-09-04 07:15:32 +0000355 print(ord(u[-1]))
356
Georg Brandl116aa622007-08-15 14:28:22 +0000357The syntax is inspired by Emacs's notation for specifying variables local to a
358file. Emacs supports many different variables, but Python only supports
Georg Brandl0c074222008-11-22 10:26:59 +0000359'coding'. The ``-*-`` symbols indicate to Emacs that the comment is special;
360they have no significance to Python but are a convention. Python looks for
361``coding: name`` or ``coding=name`` in the comment.
Georg Brandl116aa622007-08-15 14:28:22 +0000362
Georg Brandlf6945182008-02-01 11:56:49 +0000363If you don't include such a comment, the default encoding used will be UTF-8 as
364already mentioned.
Georg Brandl6911e3c2007-09-04 07:15:32 +0000365
Georg Brandl116aa622007-08-15 14:28:22 +0000366
367Unicode Properties
368------------------
369
370The Unicode specification includes a database of information about code points.
371For each code point that's defined, the information includes the character's
372name, its category, the numeric value if applicable (Unicode has characters
373representing the Roman numerals and fractions such as one-third and
374four-fifths). There are also properties related to the code point's use in
375bidirectional text and other display-related properties.
376
377The following program displays some information about several characters, and
378prints the numeric value of one particular character::
379
380 import unicodedata
Georg Brandl6911e3c2007-09-04 07:15:32 +0000381
Georg Brandlf6945182008-02-01 11:56:49 +0000382 u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)
Georg Brandl6911e3c2007-09-04 07:15:32 +0000383
Georg Brandl116aa622007-08-15 14:28:22 +0000384 for i, c in enumerate(u):
Georg Brandl6911e3c2007-09-04 07:15:32 +0000385 print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")
386 print(unicodedata.name(c))
387
Georg Brandl116aa622007-08-15 14:28:22 +0000388 # Get numeric value of second character
Georg Brandl6911e3c2007-09-04 07:15:32 +0000389 print(unicodedata.numeric(u[1]))
Georg Brandl116aa622007-08-15 14:28:22 +0000390
391When run, this prints::
392
393 0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE
394 1 0bf2 No TAMIL NUMBER ONE THOUSAND
395 2 0f84 Mn TIBETAN MARK HALANTA
396 3 1770 Lo TAGBANWA LETTER SA
397 4 33af So SQUARE RAD OVER S SQUARED
398 1000.0
399
400The category codes are abbreviations describing the nature of the character.
401These are grouped into categories such as "Letter", "Number", "Punctuation", or
402"Symbol", which in turn are broken up into subcategories. To take the codes
403from the above output, ``'Ll'`` means 'Letter, lowercase', ``'No'`` means
404"Number, other", ``'Mn'`` is "Mark, nonspacing", and ``'So'`` is "Symbol,
405other". See
406<http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values> for a
407list of category codes.
408
409References
410----------
411
Georg Brandlf6945182008-02-01 11:56:49 +0000412The ``str`` type is described in the Python library reference at
413:ref:`typesseq`.
Georg Brandl116aa622007-08-15 14:28:22 +0000414
415The documentation for the :mod:`unicodedata` module.
416
417The documentation for the :mod:`codecs` module.
418
419Marc-André Lemburg gave a presentation at EuroPython 2002 titled "Python and
420Unicode". A PDF version of his slides is available at
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000421<http://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf>, and is an
Georg Brandl0c074222008-11-22 10:26:59 +0000422excellent overview of the design of Python's Unicode features (based on Python
4232, where the Unicode string type is called ``unicode`` and literals start with
424``u``).
Georg Brandl116aa622007-08-15 14:28:22 +0000425
426
427Reading and Writing Unicode Data
428================================
429
430Once you've written some code that works with Unicode data, the next problem is
431input/output. How do you get Unicode strings into your program, and how do you
432convert Unicode into a form suitable for storage or transmission?
433
434It's possible that you may not need to do anything depending on your input
435sources and output destinations; you should check whether the libraries used in
436your application support Unicode natively. XML parsers often return Unicode
437data, for example. Many relational databases also support Unicode-valued
438columns and can return Unicode values from an SQL query.
439
440Unicode data is usually converted to a particular encoding before it gets
441written to disk or sent over a socket. It's possible to do all the work
Georg Brandl0c074222008-11-22 10:26:59 +0000442yourself: open a file, read an 8-bit byte string from it, and convert the string
443with ``str(bytes, encoding)``. However, the manual approach is not recommended.
Georg Brandl116aa622007-08-15 14:28:22 +0000444
445One problem is the multi-byte nature of encodings; one Unicode character can be
446represented by several bytes. If you want to read the file in arbitrary-sized
447chunks (say, 1K or 4K), you need to write error-handling code to catch the case
448where only part of the bytes encoding a single Unicode character are read at the
449end of a chunk. One solution would be to read the entire file into memory and
450then perform the decoding, but that prevents you from working with files that
451are extremely large; if you need to read a 2Gb file, you need 2Gb of RAM.
452(More, really, since for at least a moment you'd need to have both the encoded
453string and its Unicode version in memory.)
454
455The solution would be to use the low-level decoding interface to catch the case
456of partial coding sequences. The work of implementing this has already been
Georg Brandl0c074222008-11-22 10:26:59 +0000457done for you: the built-in :func:`open` function can return a file-like object
458that assumes the file's contents are in a specified encoding and accepts Unicode
459parameters for methods such as ``.read()`` and ``.write()``. This works through
460:func:`open`\'s *encoding* and *errors* parameters which are interpreted just
461like those in string objects' :meth:`encode` and :meth:`decode` methods.
Georg Brandl116aa622007-08-15 14:28:22 +0000462
463Reading Unicode from a file is therefore simple::
464
Georg Brandl0c074222008-11-22 10:26:59 +0000465 f = open('unicode.rst', encoding='utf-8')
Georg Brandl116aa622007-08-15 14:28:22 +0000466 for line in f:
Georg Brandl6911e3c2007-09-04 07:15:32 +0000467 print(repr(line))
Georg Brandl116aa622007-08-15 14:28:22 +0000468
469It's also possible to open files in update mode, allowing both reading and
470writing::
471
Georg Brandl0c074222008-11-22 10:26:59 +0000472 f = open('test', encoding='utf-8', mode='w+')
Georg Brandlf6945182008-02-01 11:56:49 +0000473 f.write('\u4500 blah blah blah\n')
Georg Brandl116aa622007-08-15 14:28:22 +0000474 f.seek(0)
Georg Brandl6911e3c2007-09-04 07:15:32 +0000475 print(repr(f.readline()[:1]))
Georg Brandl116aa622007-08-15 14:28:22 +0000476 f.close()
477
Georg Brandl0c074222008-11-22 10:26:59 +0000478The Unicode character U+FEFF is used as a byte-order mark (BOM), and is often
Georg Brandl116aa622007-08-15 14:28:22 +0000479written as the first character of a file in order to assist with autodetection
480of the file's byte ordering. Some encodings, such as UTF-16, expect a BOM to be
481present at the start of a file; when such an encoding is used, the BOM will be
482automatically written as the first character and will be silently dropped when
483the file is read. There are variants of these encodings, such as 'utf-16-le'
484and 'utf-16-be' for little-endian and big-endian encodings, that specify one
485particular byte ordering and don't skip the BOM.
486
Georg Brandl0c074222008-11-22 10:26:59 +0000487In some areas, it is also convention to use a "BOM" at the start of UTF-8
488encoded files; the name is misleading since UTF-8 is not byte-order dependent.
489The mark simply announces that the file is encoded in UTF-8. Use the
490'utf-8-sig' codec to automatically skip the mark if present for reading such
491files.
492
Georg Brandl116aa622007-08-15 14:28:22 +0000493
494Unicode filenames
495-----------------
496
497Most of the operating systems in common use today support filenames that contain
498arbitrary Unicode characters. Usually this is implemented by converting the
499Unicode string into some encoding that varies depending on the system. For
Georg Brandlc575c902008-09-13 17:46:05 +0000500example, Mac OS X uses UTF-8 while Windows uses a configurable encoding; on
Georg Brandl116aa622007-08-15 14:28:22 +0000501Windows, Python uses the name "mbcs" to refer to whatever the currently
502configured encoding is. On Unix systems, there will only be a filesystem
503encoding if you've set the ``LANG`` or ``LC_CTYPE`` environment variables; if
504you haven't, the default encoding is ASCII.
505
506The :func:`sys.getfilesystemencoding` function returns the encoding to use on
507your current system, in case you want to do the encoding manually, but there's
508not much reason to bother. When opening a file for reading or writing, you can
509usually just provide the Unicode string as the filename, and it will be
510automatically converted to the right encoding for you::
511
Georg Brandlf6945182008-02-01 11:56:49 +0000512 filename = 'filename\u4500abc'
Georg Brandl116aa622007-08-15 14:28:22 +0000513 f = open(filename, 'w')
514 f.write('blah\n')
515 f.close()
516
517Functions in the :mod:`os` module such as :func:`os.stat` will also accept Unicode
518filenames.
519
520:func:`os.listdir`, which returns filenames, raises an issue: should it return
Georg Brandl0c074222008-11-22 10:26:59 +0000521the Unicode version of filenames, or should it return byte strings containing
Georg Brandl116aa622007-08-15 14:28:22 +0000522the encoded versions? :func:`os.listdir` will do both, depending on whether you
Georg Brandl0c074222008-11-22 10:26:59 +0000523provided the directory path as a byte string or a Unicode string. If you pass a
524Unicode string as the path, filenames will be decoded using the filesystem's
525encoding and a list of Unicode strings will be returned, while passing a byte
526path will return the byte string versions of the filenames. For example,
527assuming the default filesystem encoding is UTF-8, running the following
528program::
Georg Brandl116aa622007-08-15 14:28:22 +0000529
Georg Brandlf6945182008-02-01 11:56:49 +0000530 fn = 'filename\u4500abc'
Georg Brandl116aa622007-08-15 14:28:22 +0000531 f = open(fn, 'w')
532 f.close()
533
534 import os
Georg Brandl0c074222008-11-22 10:26:59 +0000535 print(os.listdir(b'.'))
Georg Brandl6911e3c2007-09-04 07:15:32 +0000536 print(os.listdir('.'))
Georg Brandl116aa622007-08-15 14:28:22 +0000537
538will produce the following output::
539
540 amk:~$ python t.py
Georg Brandl0c074222008-11-22 10:26:59 +0000541 [b'.svn', b'filename\xe4\x94\x80abc', ...]
Georg Brandlf6945182008-02-01 11:56:49 +0000542 ['.svn', 'filename\u4500abc', ...]
Georg Brandl116aa622007-08-15 14:28:22 +0000543
544The first list contains UTF-8-encoded filenames, and the second list contains
545the Unicode versions.
546
Georg Brandl0c074222008-11-22 10:26:59 +0000547Note that in most occasions, the Uniode APIs should be used. The bytes APIs
548should only be used on systems where undecodable file names can be present,
549i.e. Unix systems.
550
Georg Brandl116aa622007-08-15 14:28:22 +0000551
Georg Brandl6911e3c2007-09-04 07:15:32 +0000552
Georg Brandl116aa622007-08-15 14:28:22 +0000553Tips for Writing Unicode-aware Programs
554---------------------------------------
555
556This section provides some suggestions on writing software that deals with
557Unicode.
558
559The most important tip is:
560
561 Software should only work with Unicode strings internally, converting to a
562 particular encoding on output.
563
Georg Brandl0c074222008-11-22 10:26:59 +0000564If you attempt to write processing functions that accept both Unicode and byte
Georg Brandl116aa622007-08-15 14:28:22 +0000565strings, you will find your program vulnerable to bugs wherever you combine the
Georg Brandl0c074222008-11-22 10:26:59 +0000566two different kinds of strings. There is no automatic encoding or decoding if
567you do e.g. ``str + bytes``, a :exc:`TypeError` is raised for this expression.
Georg Brandl116aa622007-08-15 14:28:22 +0000568
569It's easy to miss such problems if you only test your software with data that
570doesn't contain any accents; everything will seem to work, but there's actually
571a bug in your program waiting for the first user who attempts to use characters
572> 127. A second tip, therefore, is:
573
574 Include characters > 127 and, even better, characters > 255 in your test
575 data.
576
577When using data coming from a web browser or some other untrusted source, a
578common technique is to check for illegal characters in a string before using the
579string in a generated command line or storing it in a database. If you're doing
580this, be careful to check the string once it's in the form that will be used or
581stored; it's possible for encodings to be used to disguise characters. This is
582especially true if the input data also specifies the encoding; many encodings
583leave the commonly checked-for characters alone, but Python includes some
584encodings such as ``'base64'`` that modify every single character.
585
586For example, let's say you have a content management system that takes a Unicode
587filename, and you want to disallow paths with a '/' character. You might write
588this code::
589
Georg Brandl0c074222008-11-22 10:26:59 +0000590 def read_file(filename, encoding):
Georg Brandl116aa622007-08-15 14:28:22 +0000591 if '/' in filename:
592 raise ValueError("'/' not allowed in filenames")
593 unicode_name = filename.decode(encoding)
594 f = open(unicode_name, 'r')
595 # ... return contents of file ...
Georg Brandl6911e3c2007-09-04 07:15:32 +0000596
Georg Brandl116aa622007-08-15 14:28:22 +0000597However, if an attacker could specify the ``'base64'`` encoding, they could pass
598``'L2V0Yy9wYXNzd2Q='``, which is the base-64 encoded form of the string
599``'/etc/passwd'``, to read a system file. The above code looks for ``'/'``
600characters in the encoded form and misses the dangerous character in the
601resulting decoded form.
602
603References
604----------
605
606The PDF slides for Marc-André Lemburg's presentation "Writing Unicode-aware
607Applications in Python" are available at
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000608<http://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf>
Georg Brandl116aa622007-08-15 14:28:22 +0000609and discuss questions of character encodings as well as how to internationalize
610and localize an application.
611
612
613Revision History and Acknowledgements
614=====================================
615
616Thanks to the following people who have noted errors or offered suggestions on
617this article: Nicholas Bastin, Marius Gedminas, Kent Johnson, Ken Krugler,
618Marc-André Lemburg, Martin von Löwis, Chad Whitacre.
619
620Version 1.0: posted August 5 2005.
621
622Version 1.01: posted August 7 2005. Corrects factual and markup errors; adds
623several links.
624
625Version 1.02: posted August 16 2005. Corrects factual errors.
626
Georg Brandl0c074222008-11-22 10:26:59 +0000627Version 1.1: Feb-Nov 2008. Updates the document with respect to Python 3 changes.
628
Georg Brandl116aa622007-08-15 14:28:22 +0000629
630.. comment Additional topic: building Python w/ UCS2 or UCS4 support
Georg Brandl116aa622007-08-15 14:28:22 +0000631.. comment Describe use of codecs.StreamRecoder and StreamReaderWriter
632
Georg Brandl6911e3c2007-09-04 07:15:32 +0000633.. comment
Georg Brandl116aa622007-08-15 14:28:22 +0000634 Original outline:
635
636 - [ ] Unicode introduction
637 - [ ] ASCII
638 - [ ] Terms
639 - [ ] Character
640 - [ ] Code point
641 - [ ] Encodings
642 - [ ] Common encodings: ASCII, Latin-1, UTF-8
643 - [ ] Unicode Python type
644 - [ ] Writing unicode literals
645 - [ ] Obscurity: -U switch
646 - [ ] Built-ins
647 - [ ] unichr()
648 - [ ] ord()
649 - [ ] unicode() constructor
650 - [ ] Unicode type
651 - [ ] encode(), decode() methods
652 - [ ] Unicodedata module for character properties
653 - [ ] I/O
654 - [ ] Reading/writing Unicode data into files
655 - [ ] Byte-order marks
656 - [ ] Unicode filenames
657 - [ ] Writing Unicode programs
658 - [ ] Do everything in Unicode
659 - [ ] Declaring source code encodings (PEP 263)
660 - [ ] Other issues
661 - [ ] Building Python (UCS2, UCS4)