mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-12 15:09:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

- improve the explanation of the -*- coding: ... -*- marker

Browse source 
- fix a minor formatting nit that affected the typeset version
This commit is contained in:
Fred Drake 2004-10-25 16:03:49 +00:00
parent 95387a1895
commit afe73c02a9
1 changed files with 20 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/tut/tut.tex
View file

@ -1,5 +1,6 @@
\documentclass{manual} \documentclass{manual}
\usepackage[T1]{fontenc} \usepackage[T1]{fontenc}
\usepackage{textcomp}
% Things to do: % Things to do:
% Should really move the Python startup file info to an appendix % Should really move the Python startup file info to an appendix
@ -326,28 +327,41 @@ It is possible to use encodings different than \ASCII{} in Python source
files. The best way to do it is to put one more special comment line files. The best way to do it is to put one more special comment line
right after the \code{\#!} line to define the source file encoding: right after the \code{\#!} line to define the source file encoding:
\begin{verbatim} \begin{alltt}
# -*- coding: iso-8859-1 -*- # -*- coding: \var{encoding} -*-
\end{verbatim} \end{alltt}
With that declaration, all characters in the source file will be treated as With that declaration, all characters in the source file will be treated as
{}\code{iso-8859-1}, and it will be having the encoding \var{encoding}, and it will be
possible to directly write Unicode string literals in the selected possible to directly write Unicode string literals in the selected
encoding. The list of possible encodings can be found in the encoding. The list of possible encodings can be found in the
\citetitle[../lib/lib.html]{Python Library Reference}, in the section \citetitle[../lib/lib.html]{Python Library Reference}, in the section
on \ulink{\module{codecs}}{../lib/module-codecs.html}. on \ulink{\module{codecs}}{../lib/module-codecs.html}.
For example, to write Unicode literals including the Euro currency
symbol, the ISO-8859-15 encoding can be used, with the Euro symbol
having the ordinal value 164. This script will print the value 8364
(the Unicode codepoint corresponding to the Euro symbol) and then
exit:
\begin{alltt}
# -*- coding: iso-8859-15 -*-
currency = u"\texteuro"
print ord(currency)
\end{alltt}
If your editor supports saving files as \code{UTF-8} with a UTF-8 If your editor supports saving files as \code{UTF-8} with a UTF-8
\emph{byte order mark} (aka BOM), you can use that instead of an \emph{byte order mark} (aka BOM), you can use that instead of an
encoding declaration. IDLE supports this capability if encoding declaration. IDLE supports this capability if
\code{Options/General/Default Source Encoding/UTF-8} is set. Notice \code{Options/General/Default Source Encoding/UTF-8} is set. Notice
that this signature is not understood in older Python releases (2.2 that this signature is not understood in older Python releases (2.2
and earlier), and also not understood by the operating system for and earlier), and also not understood by the operating system for
\code{\#!} files. script files with \code{\#!} lines (only used on \UNIX{} systems).
By using UTF-8 (either through the signature or an encoding By using UTF-8 (either through the signature or an encoding
declaration), characters of most languages in the world can be used declaration), characters of most languages in the world can be used
simultaneously in string literals and comments. Using non-\ASCII simultaneously in string literals and comments. Using non-\ASCII{}
characters in identifiers is not supported. To display all these characters in identifiers is not supported. To display all these
characters properly, your editor must recognize that the file is characters properly, your editor must recognize that the file is
UTF-8, and it must use a font that supports all the characters in the UTF-8, and it must use a font that supports all the characters in the