[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / html / python / ref / encodings.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="ref.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="ref.html" title='Python Reference Manual' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="explicit-joining.html" />
<link rel="prev" href="comments.html" />
<link rel="parent" href="line-structure.html" />
<link rel="next" href="explicit-joining.html" />
<meta name='aesop' content='information' />
<title>2.1.4 Encoding declarations</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2.1.3 Comments"
  href="comments.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="2.1 Line structure"
  href="line-structure.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2.1.5 Explicit line joining"
  href="explicit-joining.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="comments.html">2.1.3 Comments</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="line-structure.html">2.1 Line structure</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="explicit-joining.html">2.1.5 Explicit line joining</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION004140000000000000000"></A><A NAME="encodings"></A>
<a id='l2h-6' xml:id='l2h-6'></a>
<BR>
2.1.4 Encoding declarations
</H2>

<P>
If a comment in the first or second line of the Python script matches
the regular expression <tt class="regexp">coding[=:]&#92;s*([-&#92;w.]+)</tt>, this comment is
processed as an encoding declaration; the first group of this
expression names the encoding of the source code file. The recommended
forms of this expression are

<P>
<div class="verbatim"><pre>
# -*- coding: &lt;encoding-name&gt; -*-
</pre></div>

<P>
which is recognized also by GNU Emacs, and

<P>
<div class="verbatim"><pre>
# vim:fileencoding=&lt;encoding-name&gt;
</pre></div>

<P>
which is recognized by Bram Moolenaar's VIM. In addition, if the first
bytes of the file are the UTF-8 byte-order mark
(<code>'&#92;xef&#92;xbb&#92;xbf'</code>), the declared file encoding is UTF-8
(this is supported, among others, by Microsoft's <b class="program">notepad</b>).

<P>
If an encoding is declared, the encoding name must be recognized by
Python. The encoding is used for all lexical analysis, in particular to find
the end of a string, and to interpret the contents of Unicode literals.
String literals are converted to Unicode for syntactical analysis,
then converted back to their original encoding before interpretation
starts. The encoding declaration must appear on a line of its own.

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2.1.3 Comments"
  href="comments.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="2.1 Line structure"
  href="line-structure.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="2.1.5 Explicit line joining"
  href="explicit-joining.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="comments.html">2.1.3 Comments</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="line-structure.html">2.1 Line structure</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="explicit-joining.html">2.1.5 Explicit line joining</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="ref.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="ref.html" title='Python Reference Manual' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="explicit-joining.html" />
	13	<link rel="prev" href="comments.html" />
	14	<link rel="parent" href="line-structure.html" />
	15	<link rel="next" href="explicit-joining.html" />
	16	<meta name='aesop' content='information' />
	17	<title>2.1.4 Encoding declarations</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="2.1.3 Comments"
	25	href="comments.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="2.1 Line structure"
	28	href="line-structure.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="2.1.5 Explicit line joining"
	31	href="explicit-joining.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Reference Manual</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><img src='../icons/blank.png'
	38	border='0' height='32' alt='' width='32' /></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="comments.html">2.1.3 Comments</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="line-structure.html">2.1 Line structure</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="explicit-joining.html">2.1.5 Explicit line joining</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION004140000000000000000"></A><A NAME="encodings"></A>
	56	<a id='l2h-6' xml:id='l2h-6'></a>
	57	<BR>
	58	2.1.4 Encoding declarations
	59	</H2>
	60
	61	<P>
	62	If a comment in the first or second line of the Python script matches
	63	the regular expression <tt class="regexp">coding[=:]\s*([-\w.]+)</tt>, this comment is
	64	processed as an encoding declaration; the first group of this
65	expression names the encoding of the source code file. The recommended
66	forms of this expression are
67
68	<P>
69	<div class="verbatim"><pre>
70	# -- coding: <encoding-name> --
71	</pre></div>
72
73	<P>
74	which is recognized also by GNU Emacs, and
75
76	<P>
77	<div class="verbatim"><pre>
78	# vim:fileencoding=<encoding-name>
79	</pre></div>
80
81	<P>
82	which is recognized by Bram Moolenaar's VIM. In addition, if the first
83	bytes of the file are the UTF-8 byte-order mark
84	(<code>'\xef\xbb\xbf'</code>), the declared file encoding is UTF-8
85	(this is supported, among others, by Microsoft's <b class="program">notepad</b>).
86
87	<P>
88	If an encoding is declared, the encoding name must be recognized by
89	Python. The encoding is used for all lexical analysis, in particular to find
90	the end of a string, and to interpret the contents of Unicode literals.
91	String literals are converted to Unicode for syntactical analysis,
92	then converted back to their original encoding before interpretation
93	starts. The encoding declaration must appear on a line of its own.
94
95	<P>
96
97	<DIV CLASS="navigation">
98	<div class='online-navigation'>
99	<p></p><hr />
100	<table align="center" width="100%" cellpadding="0" cellspacing="2">
101	<tr>
102	<td class='online-navigation'><a rel="prev" title="2.1.3 Comments"
103	href="comments.html"><img src='../icons/previous.png'
104	border='0' height='32' alt='Previous Page' width='32' /></A></td>
105	<td class='online-navigation'><a rel="parent" title="2.1 Line structure"
106	href="line-structure.html"><img src='../icons/up.png'
107	border='0' height='32' alt='Up One Level' width='32' /></A></td>
108	<td class='online-navigation'><a rel="next" title="2.1.5 Explicit line joining"
109	href="explicit-joining.html"><img src='../icons/next.png'
110	border='0' height='32' alt='Next Page' width='32' /></A></td>
111	<td align="center" width="100%">Python Reference Manual</td>
112	<td class='online-navigation'><a rel="contents" title="Table of Contents"
113	href="contents.html"><img src='../icons/contents.png'
114	border='0' height='32' alt='Contents' width='32' /></A></td>
115	<td class='online-navigation'><img src='../icons/blank.png'
116	border='0' height='32' alt='' width='32' /></td>
117	<td class='online-navigation'><a rel="index" title="Index"
118	href="genindex.html"><img src='../icons/index.png'
119	border='0' height='32' alt='Index' width='32' /></A></td>
120	</tr></table>
121	<div class='online-navigation'>
122	<b class="navlabel">Previous:</b>
123	<a class="sectref" rel="prev" href="comments.html">2.1.3 Comments</A>
124	<b class="navlabel">Up:</b>
125	<a class="sectref" rel="parent" href="line-structure.html">2.1 Line structure</A>
126	<b class="navlabel">Next:</b>
127	<a class="sectref" rel="next" href="explicit-joining.html">2.1.5 Explicit line joining</A>
128	</div>
129	</div>
130	<hr />
131	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
132	</DIV>
133	<!--End of Navigation Panel-->
134	<ADDRESS>
135	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
136	</ADDRESS>
137	</BODY>
138	</HTML>