Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > e870e6598e1c7e3918555a3d0ba5f3d4 > files > 550

python3-docs-3.1.1-2mdv2010.0.i586.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Unicode HOWTO &mdash; Python v3.1.1 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '3.1.1',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Python v3.1.1 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="copyright" title="Copyright" href="../copyright.html" />
    <link rel="top" title="Python v3.1.1 documentation" href="../index.html" />
    <link rel="up" title="Python HOWTOs" href="index.html" />
    <link rel="next" title="HOWTO Fetch Internet Resources Using The urllib Package" href="urllib2.html" />
    <link rel="prev" title="Socket Programming HOWTO" href="sockets.html" />
    <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 

  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="urllib2.html" title="HOWTO Fetch Internet Resources Using The urllib Package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="sockets.html" title="Socket Programming HOWTO"
             accesskey="P">previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="../index.html">Python v3.1.1 documentation</a> &raquo;</li>

          <li><a href="index.html" accesskey="U">Python HOWTOs</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="unicode-howto">
<span id="id1"></span><h1>Unicode HOWTO<a class="headerlink" href="#unicode-howto" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Release:</th><td class="field-body">1.1</td>
</tr>
</tbody>
</table>
<p>This HOWTO discusses Python&#8217;s support for Unicode, and explains various problems
that people commonly encounter when trying to work with Unicode.</p>
<div class="section" id="introduction-to-unicode">
<h2>Introduction to Unicode<a class="headerlink" href="#introduction-to-unicode" title="Permalink to this headline">¶</a></h2>
<div class="section" id="history-of-character-codes">
<h3>History of Character Codes<a class="headerlink" href="#history-of-character-codes" title="Permalink to this headline">¶</a></h3>
<p>In 1968, the American Standard Code for Information Interchange, better known by
its acronym ASCII, was standardized.  ASCII defined numeric codes for various
characters, with the numeric values running from 0 to 127.  For example, the
lowercase letter &#8216;a&#8217; is assigned 97 as its code value.</p>
<p>ASCII was an American-developed standard, so it only defined unaccented
characters.  There was an &#8216;e&#8217;, but no &#8216;é&#8217; or &#8216;Í&#8217;.  This meant that languages
which required accented characters couldn&#8217;t be faithfully represented in ASCII.
(Actually the missing accents matter for English, too, which contains words such
as &#8216;naïve&#8217; and &#8216;café&#8217;, and some publications have house styles which require
spellings such as &#8216;coöperate&#8217;.)</p>
<p>For a while people just wrote programs that didn&#8217;t display accents.  I remember
looking at Apple ][ BASIC programs, published in French-language publications in
the mid-1980s, that had lines like these:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="n">PRINT</span> <span class="s">&quot;FICHIER EST COMPLETE.&quot;</span>
<span class="n">PRINT</span> <span class="s">&quot;CARACTERE NON ACCEPTE.&quot;</span>
</pre></div>
</div>
<p>Those messages should contain accents, and they just look wrong to someone who
can read French.</p>
<p>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 <strong>de facto</strong> conventions that were invented by one company or
another and managed to catch on.</p>
<p>255 characters aren&#8217;t very many.  For example, you can&#8217;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.</p>
<p>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.</p>
<p>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&#8217;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).</p>
<p>There&#8217;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.</p>
<p>(This discussion of Unicode&#8217;s history is highly simplified.  I don&#8217;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.)</p>
</div>
<div class="section" id="definitions">
<h3>Definitions<a class="headerlink" href="#definitions" title="Permalink to this headline">¶</a></h3>
<p>A <strong>character</strong> is the smallest possible component of a text.  &#8216;A&#8217;, &#8216;B&#8217;, &#8216;C&#8217;,
etc., are all different characters.  So are &#8216;È&#8217; and &#8216;Í&#8217;.  Characters are
abstractions, and vary depending on the language or context you&#8217;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.</p>
<p>The Unicode standard describes how characters are represented by <strong>code
points</strong>.  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:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="mi">0061</span>    <span class="s">&#39;a&#39;</span><span class="p">;</span> <span class="n">LATIN</span> <span class="n">SMALL</span> <span class="n">LETTER</span> <span class="n">A</span>
<span class="mi">0062</span>    <span class="s">&#39;b&#39;</span><span class="p">;</span> <span class="n">LATIN</span> <span class="n">SMALL</span> <span class="n">LETTER</span> <span class="n">B</span>
<span class="mi">0063</span>    <span class="s">&#39;c&#39;</span><span class="p">;</span> <span class="n">LATIN</span> <span class="n">SMALL</span> <span class="n">LETTER</span> <span class="n">C</span>
<span class="o">...</span>
<span class="mi">007</span><span class="n">B</span>    <span class="s">&#39;{&#39;</span><span class="p">;</span> <span class="n">LEFT</span> <span class="n">CURLY</span> <span class="n">BRACKET</span>
</pre></div>
</div>
<p>Strictly, these definitions imply that it&#8217;s meaningless to say &#8216;this is
character U+12ca&#8217;.  U+12ca is a code point, which represents some particular
character; in this case, it represents the character &#8216;ETHIOPIC SYLLABLE WI&#8217;.  In
informal contexts, this distinction between code points and characters will
sometimes be forgotten.</p>
<p>A character is represented on a screen or on paper by a set of graphical
elements that&#8217;s called a <strong>glyph</strong>.  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&#8217;t need to worry about
glyphs; figuring out the correct glyph to display is generally the job of a GUI
toolkit or a terminal&#8217;s font renderer.</p>
</div>
<div class="section" id="encodings">
<h3>Encodings<a class="headerlink" href="#encodings" title="Permalink to this headline">¶</a></h3>
<p>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
<strong>encoding</strong>.</p>
<p>The first encoding you might think of is an array of 32-bit integers.  In this
representation, the string &#8220;Python&#8221; would look like this:</p>
<div class="highlight-python3"><div class="highlight"><pre>   <span class="n">P</span>           <span class="n">y</span>           <span class="n">t</span>           <span class="n">h</span>           <span class="n">o</span>           <span class="n">n</span>
<span class="mh">0x50</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">79</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">74</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">68</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">6</span><span class="n">f</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span>
   <span class="mi">0</span>  <span class="mi">1</span>  <span class="mi">2</span>  <span class="mi">3</span>  <span class="mi">4</span>  <span class="mi">5</span>  <span class="mi">6</span>  <span class="mi">7</span>  <span class="mi">8</span>  <span class="mi">9</span> <span class="mi">10</span> <span class="mi">11</span> <span class="mi">12</span> <span class="mi">13</span> <span class="mi">14</span> <span class="mi">15</span> <span class="mi">16</span> <span class="mi">17</span> <span class="mi">18</span> <span class="mi">19</span> <span class="mi">20</span> <span class="mi">21</span> <span class="mi">22</span> <span class="mi">23</span>
</pre></div>
</div>
<p>This representation is straightforward but using it presents a number of
problems.</p>
<ol class="arabic simple">
<li>It&#8217;s not portable; different processors order the bytes differently.</li>
<li>It&#8217;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&#8217;t matter too much (desktop
computers have megabytes of RAM, and strings aren&#8217;t usually that large), but
expanding our usage of disk and network bandwidth by a factor of 4 is
intolerable.</li>
<li>It&#8217;s not compatible with existing C functions such as <tt class="docutils literal"><span class="pre">strlen()</span></tt>, so a new
family of wide string functions would need to be used.</li>
<li>Many Internet standards are defined in terms of textual data, and can&#8217;t
handle content with embedded zero bytes.</li>
</ol>
<p>Generally people don&#8217;t use this encoding, instead choosing other encodings that
are more efficient and convenient.</p>
<p>Encodings don&#8217;t have to handle every possible Unicode character, and most
encodings don&#8217;t.  For example, Python&#8217;s default encoding is the &#8216;ascii&#8217;
encoding.  The rules for converting a Unicode string into the ASCII encoding are
simple; for each code point:</p>
<ol class="arabic simple">
<li>If the code point is &lt; 128, each byte is the same as the value of the code
point.</li>
<li>If the code point is 128 or greater, the Unicode string can&#8217;t be represented
in this encoding.  (Python raises a <a title="exceptions.UnicodeEncodeError" class="reference external" href="../library/exceptions.html#exceptions.UnicodeEncodeError"><tt class="xref docutils literal"><span class="pre">UnicodeEncodeError</span></tt></a> exception in this
case.)</li>
</ol>
<p>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&#8217;t be encoded into Latin-1.</p>
<p>Encodings don&#8217;t have to be simple one-to-one mappings like Latin-1.  Consider
IBM&#8217;s EBCDIC, which was used on IBM mainframes.  Letter values weren&#8217;t in one
block: &#8216;a&#8217; through &#8216;i&#8217; had values from 129 to 137, but &#8216;j&#8217; through &#8216;r&#8217; were 145
through 153.  If you wanted to use EBCDIC as an encoding, you&#8217;d probably use
some sort of lookup table to perform the conversion, but this is largely an
internal detail.</p>
<p>UTF-8 is one of the most commonly used encodings.  UTF stands for &#8220;Unicode
Transformation Format&#8221;, and the &#8216;8&#8217; means that 8-bit numbers are used in the
encoding.  (There&#8217;s also a UTF-16 encoding, but it&#8217;s less frequently used than
UTF-8.)  UTF-8 uses the following rules:</p>
<ol class="arabic simple">
<li>If the code point is &lt;128, it&#8217;s represented by the corresponding byte value.</li>
<li>If the code point is between 128 and 0x7ff, it&#8217;s turned into two byte values
between 128 and 255.</li>
<li>Code points &gt;0x7ff are turned into three- or four-byte sequences, where each
byte of the sequence is between 128 and 255.</li>
</ol>
<p>UTF-8 has several convenient properties:</p>
<ol class="arabic simple">
<li>It can handle any Unicode code point.</li>
<li>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 <tt class="docutils literal"><span class="pre">strcpy()</span></tt> and sent through protocols that
can&#8217;t handle zero bytes.</li>
<li>A string of ASCII text is also valid UTF-8 text.</li>
<li>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.</li>
<li>If bytes are corrupted or lost, it&#8217;s possible to determine the start of the
next UTF-8-encoded code point and resynchronize.  It&#8217;s also unlikely that
random 8-bit data will look like valid UTF-8.</li>
</ol>
</div>
<div class="section" id="references">
<h3>References<a class="headerlink" href="#references" title="Permalink to this headline">¶</a></h3>
<p>The Unicode Consortium site at &lt;<a class="reference external" href="http://www.unicode.org">http://www.unicode.org</a>&gt; has character charts, a
glossary, and PDF versions of the Unicode specification.  Be prepared for some
difficult reading.  &lt;<a class="reference external" href="http://www.unicode.org/history/">http://www.unicode.org/history/</a>&gt; is a chronology of the
origin and development of Unicode.</p>
<p>To help understand the standard, Jukka Korpela has written an introductory guide
to reading the Unicode character tables, available at
&lt;<a class="reference external" href="http://www.cs.tut.fi/~jkorpela/unicode/guide.html">http://www.cs.tut.fi/~jkorpela/unicode/guide.html</a>&gt;.</p>
<p>Two other good introductory articles were written by Joel Spolsky
&lt;<a class="reference external" href="http://www.joelonsoftware.com/articles/Unicode.html">http://www.joelonsoftware.com/articles/Unicode.html</a>&gt; and Jason Orendorff
&lt;<a class="reference external" href="http://www.jorendorff.com/articles/unicode/">http://www.jorendorff.com/articles/unicode/</a>&gt;.  If this introduction didn&#8217;t make
things clear to you, you should try reading one of these alternate articles
before continuing.</p>
<p>Wikipedia entries are often helpful; see the entries for &#8220;character encoding&#8221;
&lt;<a class="reference external" href="http://en.wikipedia.org/wiki/Character_encoding">http://en.wikipedia.org/wiki/Character_encoding</a>&gt; and UTF-8
&lt;<a class="reference external" href="http://en.wikipedia.org/wiki/UTF-8">http://en.wikipedia.org/wiki/UTF-8</a>&gt;, for example.</p>
</div>
</div>
<div class="section" id="python-s-unicode-support">
<h2>Python&#8217;s Unicode Support<a class="headerlink" href="#python-s-unicode-support" title="Permalink to this headline">¶</a></h2>
<p>Now that you&#8217;ve learned the rudiments of Unicode, we can look at Python&#8217;s
Unicode features.</p>
<div class="section" id="the-string-type">
<h3>The String Type<a class="headerlink" href="#the-string-type" title="Permalink to this headline">¶</a></h3>
<p>Since Python 3.0, the language features a <tt class="docutils literal"><span class="pre">str</span></tt> type that contain Unicode
characters, meaning any string created using <tt class="docutils literal"><span class="pre">&quot;unicode</span> <span class="pre">rocks!&quot;</span></tt>, <tt class="docutils literal"><span class="pre">'unicode</span>
<span class="pre">rocks!'</span></tt>, or the triple-quoted string syntax is stored as Unicode.</p>
<p>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:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="s">&quot;</span><span class="se">\N{GREEK CAPITAL LETTER DELTA}</span><span class="s">&quot;</span>  <span class="c"># Using the character name</span>
<span class="go">&#39;\u0394&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="s">&quot;</span><span class="se">\u0394</span><span class="s">&quot;</span>                          <span class="c"># Using a 16-bit hex value</span>
<span class="go">&#39;\u0394&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="s">&quot;</span><span class="se">\U00000394</span><span class="s">&quot;</span>                      <span class="c"># Using a 32-bit hex value</span>
<span class="go">&#39;\u0394&#39;</span>
</pre></div>
</div>
<p>In addition, one can create a string using the <tt class="xref docutils literal"><span class="pre">decode()</span></tt> method of
<a title="bytes" class="reference external" href="../library/functions.html#bytes"><tt class="xref docutils literal"><span class="pre">bytes</span></tt></a>.  This method takes an encoding, such as UTF-8, and, optionally,
an <em>errors</em> argument.</p>
<p>The <em>errors</em> argument specifies the response when the input string can&#8217;t be
converted according to the encoding&#8217;s rules.  Legal values for this argument are
&#8216;strict&#8217; (raise a <a title="exceptions.UnicodeDecodeError" class="reference external" href="../library/exceptions.html#exceptions.UnicodeDecodeError"><tt class="xref docutils literal"><span class="pre">UnicodeDecodeError</span></tt></a> exception), &#8216;replace&#8217; (use U+FFFD,
&#8216;REPLACEMENT CHARACTER&#8217;), or &#8216;ignore&#8217; (just leave the character out of the
Unicode result).  The following examples show the differences:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">b</span><span class="s">&#39;</span><span class="se">\x80</span><span class="s">abc&#39;</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">&quot;utf-8&quot;</span><span class="p">,</span> <span class="s">&quot;strict&quot;</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
  File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n-Identifier">?</span>
<span class="nc">UnicodeDecodeError</span>: <span class="n-Identifier">&#39;utf8&#39; codec can&#39;t decode byte 0x80 in position 0:</span>
<span class="go">                    unexpected code byte</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">b</span><span class="s">&#39;</span><span class="se">\x80</span><span class="s">abc&#39;</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">&quot;utf-8&quot;</span><span class="p">,</span> <span class="s">&quot;replace&quot;</span><span class="p">)</span>
<span class="go">&#39;\ufffdabc&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">b</span><span class="s">&#39;</span><span class="se">\x80</span><span class="s">abc&#39;</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">&quot;utf-8&quot;</span><span class="p">,</span> <span class="s">&quot;ignore&quot;</span><span class="p">)</span>
<span class="go">&#39;abc&#39;</span>
</pre></div>
</div>
<p>Encodings are specified as strings containing the encoding&#8217;s name.  Python comes
with roughly 100 different encodings; see the Python Library Reference at
<a class="reference external" href="../library/codecs.html#standard-encodings"><em>Standard Encodings</em></a> for a list.  Some encodings have multiple names; for
example, &#8216;latin-1&#8217;, &#8216;iso_8859_1&#8217; and &#8216;8859&#8217; are all synonyms for the same
encoding.</p>
<p>One-character Unicode strings can also be created with the <a title="chr" class="reference external" href="../library/functions.html#chr"><tt class="xref docutils literal"><span class="pre">chr()</span></tt></a>
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 <a title="ord" class="reference external" href="../library/functions.html#ord"><tt class="xref docutils literal"><span class="pre">ord()</span></tt></a> function that takes a one-character Unicode string and
returns the code point value:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="nb">chr</span><span class="p">(</span><span class="mf">40960</span><span class="p">)</span>
<span class="go">&#39;\ua000&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">ord</span><span class="p">(</span><span class="s">&#39;</span><span class="se">\ua000</span><span class="s">&#39;</span><span class="p">)</span>
<span class="go">40960</span>
</pre></div>
</div>
</div>
<div class="section" id="converting-to-bytes">
<h3>Converting to Bytes<a class="headerlink" href="#converting-to-bytes" title="Permalink to this headline">¶</a></h3>
<p>Another important str method is <tt class="docutils literal"><span class="pre">.encode([encoding],</span> <span class="pre">[errors='strict'])</span></tt>,
which returns a <tt class="docutils literal"><span class="pre">bytes</span></tt> representation of the Unicode string, encoded in the
requested encoding.  The <tt class="docutils literal"><span class="pre">errors</span></tt> parameter is the same as the parameter of
the <tt class="xref docutils literal"><span class="pre">decode()</span></tt> method, with one additional possibility; as well as &#8216;strict&#8217;,
&#8216;ignore&#8217;, and &#8216;replace&#8217; (which in this case inserts a question mark instead of
the unencodable character), you can also pass &#8216;xmlcharrefreplace&#8217; which uses
XML&#8217;s character references.  The following example shows the different results:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">u</span> <span class="o">=</span> <span class="nb">chr</span><span class="p">(</span><span class="mf">40960</span><span class="p">)</span> <span class="o">+</span> <span class="s">&#39;abcd&#39;</span> <span class="o">+</span> <span class="nb">chr</span><span class="p">(</span><span class="mf">1972</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">&#39;utf-8&#39;</span><span class="p">)</span>
<span class="go">b&#39;\xea\x80\x80abcd\xde\xb4&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">&#39;ascii&#39;</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
  File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n-Identifier">?</span>
<span class="nc">UnicodeEncodeError</span>: <span class="n-Identifier">&#39;ascii&#39; codec can&#39;t encode character &#39;\ua000&#39; in</span>
<span class="go">                    position 0: ordinal not in range(128)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">&#39;ascii&#39;</span><span class="p">,</span> <span class="s">&#39;ignore&#39;</span><span class="p">)</span>
<span class="go">b&#39;abcd&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">&#39;ascii&#39;</span><span class="p">,</span> <span class="s">&#39;replace&#39;</span><span class="p">)</span>
<span class="go">b&#39;?abcd?&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">&#39;ascii&#39;</span><span class="p">,</span> <span class="s">&#39;xmlcharrefreplace&#39;</span><span class="p">)</span>
<span class="go">b&#39;&amp;#40960;abcd&amp;#1972;&#39;</span>
</pre></div>
</div>
<p>The low-level routines for registering and accessing the available encodings are
found in the <a title="Encode and decode data and streams." class="reference external" href="../library/codecs.html#module-codecs"><tt class="xref docutils literal"><span class="pre">codecs</span></tt></a> module.  However, the encoding and decoding functions
returned by this module are usually more low-level than is comfortable, so I&#8217;m
not going to describe the <a title="Encode and decode data and streams." class="reference external" href="../library/codecs.html#module-codecs"><tt class="xref docutils literal"><span class="pre">codecs</span></tt></a> module here.  If you need to implement a
completely new encoding, you&#8217;ll need to learn about the <a title="Encode and decode data and streams." class="reference external" href="../library/codecs.html#module-codecs"><tt class="xref docutils literal"><span class="pre">codecs</span></tt></a> module
interfaces, but implementing encodings is a specialized task that also won&#8217;t be
covered here.  Consult the Python documentation to learn more about this module.</p>
</div>
<div class="section" id="unicode-literals-in-python-source-code">
<h3>Unicode Literals in Python Source Code<a class="headerlink" href="#unicode-literals-in-python-source-code" title="Permalink to this headline">¶</a></h3>
<p>In Python source code, specific Unicode code points can be written using the
<tt class="docutils literal"><span class="pre">\u</span></tt> escape sequence, which is followed by four hex digits giving the code
point.  The <tt class="docutils literal"><span class="pre">\U</span></tt> escape sequence is similar, but expects 8 hex digits, not 4:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">s</span> <span class="o">=</span> <span class="s">&quot;a</span><span class="se">\xac\u1234\u20ac\U00008000</span><span class="s">&quot;</span>
<span class="go">          ^^^^ two-digit hex escape</span>
<span class="go">               ^^^^^ four-digit Unicode escape</span>
<span class="go">                          ^^^^^^^^^^ eight-digit Unicode escape</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>  <span class="k">print</span><span class="p">(</span><span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">),</span> <span class="n">end</span><span class="o">=</span><span class="s">&quot; &quot;</span><span class="p">)</span>
<span class="gp">...</span>
<span class="go">97 172 4660 8364 32768</span>
</pre></div>
</div>
<p>Using escape sequences for code points greater than 127 is fine in small doses,
but becomes an annoyance if you&#8217;re using many accented characters, as you would
in a program with messages in French or some other accent-using language.  You
can also assemble strings using the <a title="chr" class="reference external" href="../library/functions.html#chr"><tt class="xref docutils literal"><span class="pre">chr()</span></tt></a> built-in function, but this is
even more tedious.</p>
<p>Ideally, you&#8217;d want to be able to write literals in your language&#8217;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.</p>
<p>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:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="c">#!/usr/bin/env python</span>
<span class="c"># -*- coding: latin-1 -*-</span>

<span class="n">u</span> <span class="o">=</span> <span class="s">&#39;abcdé&#39;</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">ord</span><span class="p">(</span><span class="n">u</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
</pre></div>
</div>
<p>The syntax is inspired by Emacs&#8217;s notation for specifying variables local to a
file.  Emacs supports many different variables, but Python only supports
&#8216;coding&#8217;.  The <tt class="docutils literal"><span class="pre">-*-</span></tt> symbols indicate to Emacs that the comment is special;
they have no significance to Python but are a convention.  Python looks for
<tt class="docutils literal"><span class="pre">coding:</span> <span class="pre">name</span></tt> or <tt class="docutils literal"><span class="pre">coding=name</span></tt> in the comment.</p>
<p>If you don&#8217;t include such a comment, the default encoding used will be UTF-8 as
already mentioned.</p>
</div>
<div class="section" id="unicode-properties">
<h3>Unicode Properties<a class="headerlink" href="#unicode-properties" title="Permalink to this headline">¶</a></h3>
<p>The Unicode specification includes a database of information about code points.
For each code point that&#8217;s defined, the information includes the character&#8217;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&#8217;s use in
bidirectional text and other display-related properties.</p>
<p>The following program displays some information about several characters, and
prints the numeric value of one particular character:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">unicodedata</span>

<span class="n">u</span> <span class="o">=</span> <span class="nb">chr</span><span class="p">(</span><span class="mi">233</span><span class="p">)</span> <span class="o">+</span> <span class="nb">chr</span><span class="p">(</span><span class="mh">0x0bf2</span><span class="p">)</span> <span class="o">+</span> <span class="nb">chr</span><span class="p">(</span><span class="mi">3972</span><span class="p">)</span> <span class="o">+</span> <span class="nb">chr</span><span class="p">(</span><span class="mi">6000</span><span class="p">)</span> <span class="o">+</span> <span class="nb">chr</span><span class="p">(</span><span class="mi">13231</span><span class="p">)</span>

<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">u</span><span class="p">):</span>
    <span class="nb">print</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="s">&#39;%04x&#39;</span> <span class="o">%</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">),</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">category</span><span class="p">(</span><span class="n">c</span><span class="p">),</span> <span class="n">end</span><span class="o">=</span><span class="s">&quot; &quot;</span><span class="p">)</span>
    <span class="nb">print</span><span class="p">(</span><span class="n">unicodedata</span><span class="o">.</span><span class="n">name</span><span class="p">(</span><span class="n">c</span><span class="p">))</span>

<span class="c"># Get numeric value of second character</span>
<span class="nb">print</span><span class="p">(</span><span class="n">unicodedata</span><span class="o">.</span><span class="n">numeric</span><span class="p">(</span><span class="n">u</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
</pre></div>
</div>
<p>When run, this prints:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="mi">0</span> <span class="mi">00</span><span class="n">e9</span> <span class="n">Ll</span> <span class="n">LATIN</span> <span class="n">SMALL</span> <span class="n">LETTER</span> <span class="n">E</span> <span class="n">WITH</span> <span class="n">ACUTE</span>
<span class="mi">1</span> <span class="mi">0</span><span class="n">bf2</span> <span class="n">No</span> <span class="n">TAMIL</span> <span class="n">NUMBER</span> <span class="n">ONE</span> <span class="n">THOUSAND</span>
<span class="mi">2</span> <span class="mi">0</span><span class="n">f84</span> <span class="n">Mn</span> <span class="n">TIBETAN</span> <span class="n">MARK</span> <span class="n">HALANTA</span>
<span class="mi">3</span> <span class="mi">1770</span> <span class="n">Lo</span> <span class="n">TAGBANWA</span> <span class="n">LETTER</span> <span class="n">SA</span>
<span class="mi">4</span> <span class="mi">33</span><span class="n">af</span> <span class="n">So</span> <span class="n">SQUARE</span> <span class="n">RAD</span> <span class="n">OVER</span> <span class="n">S</span> <span class="n">SQUARED</span>
<span class="mf">1000.0</span>
</pre></div>
</div>
<p>The category codes are abbreviations describing the nature of the character.
These are grouped into categories such as &#8220;Letter&#8221;, &#8220;Number&#8221;, &#8220;Punctuation&#8221;, or
&#8220;Symbol&#8221;, which in turn are broken up into subcategories.  To take the codes
from the above output, <tt class="docutils literal"><span class="pre">'Ll'</span></tt> means &#8216;Letter, lowercase&#8217;, <tt class="docutils literal"><span class="pre">'No'</span></tt> means
&#8220;Number, other&#8221;, <tt class="docutils literal"><span class="pre">'Mn'</span></tt> is &#8220;Mark, nonspacing&#8221;, and <tt class="docutils literal"><span class="pre">'So'</span></tt> is &#8220;Symbol,
other&#8221;.  See
&lt;<a class="reference external" href="http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values">http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values</a>&gt; for a
list of category codes.</p>
</div>
<div class="section" id="id2">
<h3>References<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">str</span></tt> type is described in the Python library reference at
<a class="reference external" href="../library/stdtypes.html#typesseq"><em>Sequence Types &#8212; str, bytes, bytearray, list, tuple, range</em></a>.</p>
<p>The documentation for the <a title="Access the Unicode Database." class="reference external" href="../library/unicodedata.html#module-unicodedata"><tt class="xref docutils literal"><span class="pre">unicodedata</span></tt></a> module.</p>
<p>The documentation for the <a title="Encode and decode data and streams." class="reference external" href="../library/codecs.html#module-codecs"><tt class="xref docutils literal"><span class="pre">codecs</span></tt></a> module.</p>
<p>Marc-André Lemburg gave a presentation at EuroPython 2002 titled &#8220;Python and
Unicode&#8221;.  A PDF version of his slides is available at
&lt;<a class="reference external" href="http://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf">http://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf</a>&gt;, and is an
excellent overview of the design of Python&#8217;s Unicode features (based on Python
2, where the Unicode string type is called <tt class="docutils literal"><span class="pre">unicode</span></tt> and literals start with
<tt class="docutils literal"><span class="pre">u</span></tt>).</p>
</div>
</div>
<div class="section" id="reading-and-writing-unicode-data">
<h2>Reading and Writing Unicode Data<a class="headerlink" href="#reading-and-writing-unicode-data" title="Permalink to this headline">¶</a></h2>
<p>Once you&#8217;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?</p>
<p>It&#8217;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.</p>
<p>Unicode data is usually converted to a particular encoding before it gets
written to disk or sent over a socket.  It&#8217;s possible to do all the work
yourself: open a file, read an 8-bit byte string from it, and convert the string
with <tt class="docutils literal"><span class="pre">str(bytes,</span> <span class="pre">encoding)</span></tt>.  However, the manual approach is not recommended.</p>
<p>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&#8217;d need to have both the encoded
string and its Unicode version in memory.)</p>
<p>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
done for you: the built-in <a title="open" class="reference external" href="../library/functions.html#open"><tt class="xref docutils literal"><span class="pre">open()</span></tt></a> function can return a file-like object
that assumes the file&#8217;s contents are in a specified encoding and accepts Unicode
parameters for methods such as <tt class="docutils literal"><span class="pre">.read()</span></tt> and <tt class="docutils literal"><span class="pre">.write()</span></tt>.  This works through
<a title="open" class="reference external" href="../library/functions.html#open"><tt class="xref docutils literal"><span class="pre">open()</span></tt></a>&#8216;s <em>encoding</em> and <em>errors</em> parameters which are interpreted just
like those in string objects&#8217; <tt class="xref docutils literal"><span class="pre">encode()</span></tt> and <tt class="xref docutils literal"><span class="pre">decode()</span></tt> methods.</p>
<p>Reading Unicode from a file is therefore simple:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&#39;unicode.rst&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s">&#39;utf-8&#39;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span>
    <span class="nb">print</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">line</span><span class="p">))</span>
</pre></div>
</div>
<p>It&#8217;s also possible to open files in update mode, allowing both reading and
writing:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&#39;test&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s">&#39;utf-8&#39;</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s">&#39;w+&#39;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;</span><span class="se">\u4500</span><span class="s"> blah blah blah</span><span class="se">\n</span><span class="s">&#39;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">readline</span><span class="p">()[:</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<p>The Unicode character U+FEFF is used as a byte-order mark (BOM), and is often
written as the first character of a file in order to assist with autodetection
of the file&#8217;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 &#8216;utf-16-le&#8217;
and &#8216;utf-16-be&#8217; for little-endian and big-endian encodings, that specify one
particular byte ordering and don&#8217;t skip the BOM.</p>
<p>In some areas, it is also convention to use a &#8220;BOM&#8221; 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
&#8216;utf-8-sig&#8217; codec to automatically skip the mark if present for reading such
files.</p>
<div class="section" id="unicode-filenames">
<h3>Unicode filenames<a class="headerlink" href="#unicode-filenames" title="Permalink to this headline">¶</a></h3>
<p>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
example, Mac OS X uses UTF-8 while Windows uses a configurable encoding; on
Windows, Python uses the name &#8220;mbcs&#8221; to refer to whatever the currently
configured encoding is.  On Unix systems, there will only be a filesystem
encoding if you&#8217;ve set the <tt class="docutils literal"><span class="pre">LANG</span></tt> or <tt class="docutils literal"><span class="pre">LC_CTYPE</span></tt> environment variables; if
you haven&#8217;t, the default encoding is ASCII.</p>
<p>The <a title="sys.getfilesystemencoding" class="reference external" href="../library/sys.html#sys.getfilesystemencoding"><tt class="xref docutils literal"><span class="pre">sys.getfilesystemencoding()</span></tt></a> function returns the encoding to use on
your current system, in case you want to do the encoding manually, but there&#8217;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:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="n">filename</span> <span class="o">=</span> <span class="s">&#39;filename</span><span class="se">\u4500</span><span class="s">abc&#39;</span>
<span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">&#39;w&#39;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;blah</span><span class="se">\n</span><span class="s">&#39;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<p>Functions in the <a title="Miscellaneous operating system interfaces." class="reference external" href="../library/os.html#module-os"><tt class="xref docutils literal"><span class="pre">os</span></tt></a> module such as <a title="os.stat" class="reference external" href="../library/os.html#os.stat"><tt class="xref docutils literal"><span class="pre">os.stat()</span></tt></a> will also accept Unicode
filenames.</p>
<p><a title="os.listdir" class="reference external" href="../library/os.html#os.listdir"><tt class="xref docutils literal"><span class="pre">os.listdir()</span></tt></a>, which returns filenames, raises an issue: should it return
the Unicode version of filenames, or should it return byte strings containing
the encoded versions?  <a title="os.listdir" class="reference external" href="../library/os.html#os.listdir"><tt class="xref docutils literal"><span class="pre">os.listdir()</span></tt></a> will do both, depending on whether you
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&#8217;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:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="n">fn</span> <span class="o">=</span> <span class="s">&#39;filename</span><span class="se">\u4500</span><span class="s">abc&#39;</span>
<span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="s">&#39;w&#39;</span><span class="p">)</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

<span class="kn">import</span> <span class="nn">os</span>
<span class="nb">print</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">b</span><span class="s">&#39;.&#39;</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">))</span>
</pre></div>
</div>
<p>will produce the following output:</p>
<div class="highlight-python3"><pre>amk:~$ python t.py
[b'.svn', b'filename\xe4\x94\x80abc', ...]
['.svn', 'filename\u4500abc', ...]</pre>
</div>
<p>The first list contains UTF-8-encoded filenames, and the second list contains
the Unicode versions.</p>
<p>Note that in most occasions, the Uniode APIs should be used.  The bytes APIs
should only be used on systems where undecodable file names can be present,
i.e. Unix systems.</p>
</div>
<div class="section" id="tips-for-writing-unicode-aware-programs">
<h3>Tips for Writing Unicode-aware Programs<a class="headerlink" href="#tips-for-writing-unicode-aware-programs" title="Permalink to this headline">¶</a></h3>
<p>This section provides some suggestions on writing software that deals with
Unicode.</p>
<p>The most important tip is:</p>
<blockquote>
Software should only work with Unicode strings internally, converting to a
particular encoding on output.</blockquote>
<p>If you attempt to write processing functions that accept both Unicode and byte
strings, you will find your program vulnerable to bugs wherever you combine the
two different kinds of strings.  There is no automatic encoding or decoding if
you do e.g. <tt class="docutils literal"><span class="pre">str</span> <span class="pre">+</span> <span class="pre">bytes</span></tt>, a <a title="exceptions.TypeError" class="reference external" href="../library/exceptions.html#exceptions.TypeError"><tt class="xref docutils literal"><span class="pre">TypeError</span></tt></a> is raised for this expression.</p>
<p>It&#8217;s easy to miss such problems if you only test your software with data that
doesn&#8217;t contain any accents; everything will seem to work, but there&#8217;s actually
a bug in your program waiting for the first user who attempts to use characters
&gt; 127.  A second tip, therefore, is:</p>
<blockquote>
Include characters &gt; 127 and, even better, characters &gt; 255 in your test
data.</blockquote>
<p>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&#8217;re doing
this, be careful to check the string once it&#8217;s in the form that will be used or
stored; it&#8217;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 <tt class="docutils literal"><span class="pre">'base64'</span></tt> that modify every single character.</p>
<p>For example, let&#8217;s say you have a content management system that takes a Unicode
filename, and you want to disallow paths with a &#8216;/&#8217; character.  You might write
this code:</p>
<div class="highlight-python3"><div class="highlight"><pre><span class="k">def</span> <span class="nf">read_file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
    <span class="k">if</span> <span class="s">&#39;/&#39;</span> <span class="ow">in</span> <span class="n">filename</span><span class="p">:</span>
        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">&quot;&#39;/&#39; not allowed in filenames&quot;</span><span class="p">)</span>
    <span class="n">unicode_name</span> <span class="o">=</span> <span class="n">filename</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
    <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">unicode_name</span><span class="p">,</span> <span class="s">&#39;r&#39;</span><span class="p">)</span>
    <span class="c"># ... return contents of file ...</span>
</pre></div>
</div>
<p>However, if an attacker could specify the <tt class="docutils literal"><span class="pre">'base64'</span></tt> encoding, they could pass
<tt class="docutils literal"><span class="pre">'L2V0Yy9wYXNzd2Q='</span></tt>, which is the base-64 encoded form of the string
<tt class="docutils literal"><span class="pre">'/etc/passwd'</span></tt>, to read a system file.  The above code looks for <tt class="docutils literal"><span class="pre">'/'</span></tt>
characters in the encoded form and misses the dangerous character in the
resulting decoded form.</p>
</div>
<div class="section" id="id3">
<h3>References<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>The PDF slides for Marc-André Lemburg&#8217;s presentation &#8220;Writing Unicode-aware
Applications in Python&#8221; are available at
&lt;<a class="reference external" href="http://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf">http://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf</a>&gt;
and discuss questions of character encodings as well as how to internationalize
and localize an application.</p>
</div>
</div>
<div class="section" id="revision-history-and-acknowledgements">
<h2>Revision History and Acknowledgements<a class="headerlink" href="#revision-history-and-acknowledgements" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
<p>Version 1.0: posted August 5 2005.</p>
<p>Version 1.01: posted August 7 2005.  Corrects factual and markup errors; adds
several links.</p>
<p>Version 1.02: posted August 16 2005.  Corrects factual errors.</p>
<p>Version 1.1: Feb-Nov 2008.  Updates the document with respect to Python 3 changes.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="../contents.html">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="">Unicode HOWTO</a><ul>
<li><a class="reference external" href="#introduction-to-unicode">Introduction to Unicode</a><ul>
<li><a class="reference external" href="#history-of-character-codes">History of Character Codes</a></li>
<li><a class="reference external" href="#definitions">Definitions</a></li>
<li><a class="reference external" href="#encodings">Encodings</a></li>
<li><a class="reference external" href="#references">References</a></li>
</ul>
</li>
<li><a class="reference external" href="#python-s-unicode-support">Python&#8217;s Unicode Support</a><ul>
<li><a class="reference external" href="#the-string-type">The String Type</a></li>
<li><a class="reference external" href="#converting-to-bytes">Converting to Bytes</a></li>
<li><a class="reference external" href="#unicode-literals-in-python-source-code">Unicode Literals in Python Source Code</a></li>
<li><a class="reference external" href="#unicode-properties">Unicode Properties</a></li>
<li><a class="reference external" href="#id2">References</a></li>
</ul>
</li>
<li><a class="reference external" href="#reading-and-writing-unicode-data">Reading and Writing Unicode Data</a><ul>
<li><a class="reference external" href="#unicode-filenames">Unicode filenames</a></li>
<li><a class="reference external" href="#tips-for-writing-unicode-aware-programs">Tips for Writing Unicode-aware Programs</a></li>
<li><a class="reference external" href="#id3">References</a></li>
</ul>
</li>
<li><a class="reference external" href="#revision-history-and-acknowledgements">Revision History and Acknowledgements</a></li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="sockets.html"
                                  title="previous chapter">Socket Programming HOWTO</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="urllib2.html"
                                  title="next chapter">HOWTO Fetch Internet Resources Using The urllib Package</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../_sources/howto/unicode.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="../search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="urllib2.html" title="HOWTO Fetch Internet Resources Using The urllib Package"
             >next</a> |</li>
        <li class="right" >
          <a href="sockets.html" title="Socket Programming HOWTO"
             >previous</a> |</li>
        <li><img src="../_static/py.png" alt=""
                 style="vertical-align: middle; margin-top: -1px"/></li>
        <li><a href="../index.html">Python v3.1.1 documentation</a> &raquo;</li>

          <li><a href="index.html" >Python HOWTOs</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
    &copy; <a href="../copyright.html">Copyright</a> 1990-2009, Python Software Foundation.
    <br />
    The Python Software Foundation is a non-profit corporation.  
    <a href="http://www.python.org/psf/donations/">Please donate.</a>
    <br />
    Last updated on Aug 16, 2009.
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
    </div>

  </body>
</html>