mirror of https://github.com/python/cpython
542 lines
20 KiB
TeX
542 lines
20 KiB
TeX
\chapter{Lexical analysis\label{lexical}}
|
|
|
|
A Python program is read by a \emph{parser}. Input to the parser is a
|
|
stream of \emph{tokens}, generated by the \emph{lexical analyzer}. This
|
|
chapter describes how the lexical analyzer breaks a file into tokens.
|
|
\index{lexical analysis}
|
|
\index{parser}
|
|
\index{token}
|
|
|
|
Python uses the 7-bit \ASCII{} character set for program text and string
|
|
literals. 8-bit characters may be used in string literals and comments
|
|
but their interpretation is platform dependent; the proper way to
|
|
insert 8-bit characters in string literals is by using octal or
|
|
hexadecimal escape sequences.
|
|
|
|
The run-time character set depends on the I/O devices connected to the
|
|
program but is generally a superset of \ASCII{}.
|
|
|
|
\strong{Future compatibility note:} It may be tempting to assume that the
|
|
character set for 8-bit characters is ISO Latin-1 (an \ASCII{}
|
|
superset that covers most western languages that use the Latin
|
|
alphabet), but it is possible that in the future Unicode text editors
|
|
will become common. These generally use the UTF-8 encoding, which is
|
|
also an \ASCII{} superset, but with very different use for the
|
|
characters with ordinals 128-255. While there is no consensus on this
|
|
subject yet, it is unwise to assume either Latin-1 or UTF-8, even
|
|
though the current implementation appears to favor Latin-1. This
|
|
applies both to the source character set and the run-time character
|
|
set.
|
|
|
|
\section{Line structure\label{line-structure}}
|
|
|
|
A Python program is divided into a number of \emph{logical lines}.
|
|
\index{line structure}
|
|
|
|
\subsection{Logical lines\label{logical}}
|
|
|
|
The end of
|
|
a logical line is represented by the token NEWLINE. Statements cannot
|
|
cross logical line boundaries except where NEWLINE is allowed by the
|
|
syntax (e.g., between statements in compound statements).
|
|
A logical line is constructed from one or more \emph{physical lines}
|
|
by following the explicit or implicit \emph{line joining} rules.
|
|
\index{logical line}
|
|
\index{physical line}
|
|
\index{line joining}
|
|
\index{NEWLINE token}
|
|
|
|
\subsection{Physical lines\label{physical}}
|
|
|
|
A physical line ends in whatever the current platform's convention is
|
|
for terminating lines. On \UNIX{}, this is the \ASCII{} LF (linefeed)
|
|
character. On DOS/Windows, it is the \ASCII{} sequence CR LF (return
|
|
followed by linefeed). On Macintosh, it is the \ASCII{} CR (return)
|
|
character.
|
|
|
|
\subsection{Comments\label{comments}}
|
|
|
|
A comment starts with a hash character (\code{\#}) that is not part of
|
|
a string literal, and ends at the end of the physical line. A comment
|
|
signifies the end of the logical line unless the implicit line joining
|
|
rules are invoked.
|
|
Comments are ignored by the syntax; they are not tokens.
|
|
\index{comment}
|
|
\index{hash character}
|
|
|
|
\subsection{Explicit line joining\label{explicit-joining}}
|
|
|
|
Two or more physical lines may be joined into logical lines using
|
|
backslash characters (\code{\e}), as follows: when a physical line ends
|
|
in a backslash that is not part of a string literal or comment, it is
|
|
joined with the following forming a single logical line, deleting the
|
|
backslash and the following end-of-line character. For example:
|
|
\index{physical line}
|
|
\index{line joining}
|
|
\index{line continuation}
|
|
\index{backslash character}
|
|
%
|
|
\begin{verbatim}
|
|
if 1900 < year < 2100 and 1 <= month <= 12 \
|
|
and 1 <= day <= 31 and 0 <= hour < 24 \
|
|
and 0 <= minute < 60 and 0 <= second < 60: # Looks like a valid date
|
|
return 1
|
|
\end{verbatim}
|
|
|
|
A line ending in a backslash cannot carry a comment. A backslash does
|
|
not continue a comment. A backslash does not continue a token except
|
|
for string literals (i.e., tokens other than string literals cannot be
|
|
split across physical lines using a backslash). A backslash is
|
|
illegal elsewhere on a line outside a string literal.
|
|
|
|
|
|
\subsection{Implicit line joining\label{implicit-joining}}
|
|
|
|
Expressions in parentheses, square brackets or curly braces can be
|
|
split over more than one physical line without using backslashes.
|
|
For example:
|
|
|
|
\begin{verbatim}
|
|
month_names = ['Januari', 'Februari', 'Maart', # These are the
|
|
'April', 'Mei', 'Juni', # Dutch names
|
|
'Juli', 'Augustus', 'September', # for the months
|
|
'Oktober', 'November', 'December'] # of the year
|
|
\end{verbatim}
|
|
|
|
Implicitly continued lines can carry comments. The indentation of the
|
|
continuation lines is not important. Blank continuation lines are
|
|
allowed. There is no NEWLINE token between implicit continuation
|
|
lines. Implicitly continued lines can also occur within triple-quoted
|
|
strings (see below); in that case they cannot carry comments.
|
|
|
|
|
|
\subsection{Blank lines \index{blank line}\label{blank-lines}}
|
|
|
|
A logical line that contains only spaces, tabs, formfeeds and possibly
|
|
a comment, is ignored (i.e., no NEWLINE token is generated). During
|
|
interactive input of statements, handling of a blank line may differ
|
|
depending on the implementation of the read-eval-print loop. In the
|
|
standard implementation, an entirely blank logical line (i.e.\ one
|
|
containing not even whitespace or a comment) terminates a multi-line
|
|
statement.
|
|
|
|
|
|
\subsection{Indentation\label{indentation}}
|
|
|
|
Leading whitespace (spaces and tabs) at the beginning of a logical
|
|
line is used to compute the indentation level of the line, which in
|
|
turn is used to determine the grouping of statements.
|
|
\index{indentation}
|
|
\index{whitespace}
|
|
\index{leading whitespace}
|
|
\index{space}
|
|
\index{tab}
|
|
\index{grouping}
|
|
\index{statement grouping}
|
|
|
|
First, tabs are replaced (from left to right) by one to eight spaces
|
|
such that the total number of characters up to and including the
|
|
replacement is a multiple of
|
|
eight (this is intended to be the same rule as used by \UNIX{}). The
|
|
total number of spaces preceding the first non-blank character then
|
|
determines the line's indentation. Indentation cannot be split over
|
|
multiple physical lines using backslashes; the whitespace up to the
|
|
first backslash determines the indentation.
|
|
|
|
\strong{Cross-platform compatibility note:} because of the nature of
|
|
text editors on non-UNIX platforms, it is unwise to use a mixture of
|
|
spaces and tabs for the indentation in a single source file.
|
|
|
|
A formfeed character may be present at the start of the line; it will
|
|
be ignored for the indentation calculations above. A formfeed
|
|
characters occurring elsewhere in the leading whitespace have an
|
|
undefined effect (for instance, they may reset the space count to
|
|
zero).
|
|
|
|
The indentation levels of consecutive lines are used to generate
|
|
INDENT and DEDENT tokens, using a stack, as follows.
|
|
\index{INDENT token}
|
|
\index{DEDENT token}
|
|
|
|
Before the first line of the file is read, a single zero is pushed on
|
|
the stack; this will never be popped off again. The numbers pushed on
|
|
the stack will always be strictly increasing from bottom to top. At
|
|
the beginning of each logical line, the line's indentation level is
|
|
compared to the top of the stack. If it is equal, nothing happens.
|
|
If it is larger, it is pushed on the stack, and one INDENT token is
|
|
generated. If it is smaller, it \emph{must} be one of the numbers
|
|
occurring on the stack; all numbers on the stack that are larger are
|
|
popped off, and for each number popped off a DEDENT token is
|
|
generated. At the end of the file, a DEDENT token is generated for
|
|
each number remaining on the stack that is larger than zero.
|
|
|
|
Here is an example of a correctly (though confusingly) indented piece
|
|
of Python code:
|
|
|
|
\begin{verbatim}
|
|
def perm(l):
|
|
# Compute the list of all permutations of l
|
|
if len(l) <= 1:
|
|
return [l]
|
|
r = []
|
|
for i in range(len(l)):
|
|
s = l[:i] + l[i+1:]
|
|
p = perm(s)
|
|
for x in p:
|
|
r.append(l[i:i+1] + x)
|
|
return r
|
|
\end{verbatim}
|
|
|
|
The following example shows various indentation errors:
|
|
|
|
\begin{verbatim}
|
|
def perm(l): # error: first line indented
|
|
for i in range(len(l)): # error: not indented
|
|
s = l[:i] + l[i+1:]
|
|
p = perm(l[:i] + l[i+1:]) # error: unexpected indent
|
|
for x in p:
|
|
r.append(l[i:i+1] + x)
|
|
return r # error: inconsistent dedent
|
|
\end{verbatim}
|
|
|
|
(Actually, the first three errors are detected by the parser; only the
|
|
last error is found by the lexical analyzer --- the indentation of
|
|
\code{return r} does not match a level popped off the stack.)
|
|
|
|
\subsection{Whitespace between tokens\label{whitespace}}
|
|
|
|
Except at the beginning of a logical line or in string literals, the
|
|
whitespace characters space, tab and formfeed can be used
|
|
interchangeably to separate tokens. Whitespace is needed between two
|
|
tokens only if their concatenation could otherwise be interpreted as a
|
|
different token (e.g., ab is one token, but a b is two tokens).
|
|
|
|
\section{Other tokens\label{other-tokens}}
|
|
|
|
Besides NEWLINE, INDENT and DEDENT, the following categories of tokens
|
|
exist: \emph{identifiers}, \emph{keywords}, \emph{literals},
|
|
\emph{operators}, and \emph{delimiters}.
|
|
Whitespace characters (other than line terminators, discussed earlier)
|
|
are not tokens, but serve to delimit tokens.
|
|
Where
|
|
ambiguity exists, a token comprises the longest possible string that
|
|
forms a legal token, when read from left to right.
|
|
|
|
\section{Identifiers and keywords\label{identifiers}}
|
|
|
|
Identifiers (also referred to as \emph{names}) are described by the following
|
|
lexical definitions:
|
|
\index{identifier}
|
|
\index{name}
|
|
|
|
\begin{verbatim}
|
|
identifier: (letter|"_") (letter|digit|"_")*
|
|
letter: lowercase | uppercase
|
|
lowercase: "a"..."z"
|
|
uppercase: "A"..."Z"
|
|
digit: "0"..."9"
|
|
\end{verbatim}
|
|
|
|
Identifiers are unlimited in length. Case is significant.
|
|
|
|
\subsection{Keywords\label{keywords}}
|
|
|
|
The following identifiers are used as reserved words, or
|
|
\emph{keywords} of the language, and cannot be used as ordinary
|
|
identifiers. They must be spelled exactly as written here:%
|
|
\index{keyword}%
|
|
\index{reserved word}
|
|
|
|
\begin{verbatim}
|
|
and del for is raise
|
|
assert elif from lambda return
|
|
break else global not try
|
|
class except if or while
|
|
continue exec import pass
|
|
def finally in print
|
|
\end{verbatim}
|
|
|
|
% When adding keywords, use reswords.py for reformatting
|
|
|
|
\subsection{Reserved classes of identifiers\label{id-classes}}
|
|
|
|
Certain classes of identifiers (besides keywords) have special
|
|
meanings. These are:
|
|
|
|
\begin{tableiii}{l|l|l}{code}{Form}{Meaning}{Notes}
|
|
\lineiii{_*}{Not imported by \samp{from \var{module} import *}}{(1)}
|
|
\lineiii{__*__}{System-defined name}{}
|
|
\lineiii{__*}{Class-private name mangling}{}
|
|
\end{tableiii}
|
|
|
|
(XXX need section references here.)
|
|
|
|
Note:
|
|
|
|
\begin{description}
|
|
\item[(1)] The special identifier \samp{_} is used in the interactive
|
|
interpreter to store the result of the last evaluation; it is stored
|
|
in the \module{__builtin__} module. When not in interactive mode,
|
|
\samp{_} has no special meaning and is not defined.
|
|
\end{description}
|
|
|
|
|
|
\section{Literals\label{literals}}
|
|
|
|
Literals are notations for constant values of some built-in types.
|
|
\index{literal}
|
|
\index{constant}
|
|
|
|
\subsection{String literals\label{strings}}
|
|
|
|
String literals are described by the following lexical definitions:
|
|
\index{string literal}
|
|
|
|
\begin{verbatim}
|
|
stringliteral: shortstring | longstring
|
|
shortstring: "'" shortstringitem* "'" | '"' shortstringitem* '"'
|
|
longstring: "'''" longstringitem* "'''" | '"""' longstringitem* '"""'
|
|
shortstringitem: shortstringchar | escapeseq
|
|
longstringitem: longstringchar | escapeseq
|
|
shortstringchar: <any ASCII character except "\" or newline or the quote>
|
|
longstringchar: <any ASCII character except "\">
|
|
escapeseq: "\" <any ASCII character>
|
|
\end{verbatim}
|
|
\index{ASCII@\ASCII{}}
|
|
|
|
In plain English: String literals can be enclosed in matching single
|
|
quotes (\code{'}) or double quotes (\code{"}). They can also be
|
|
enclosed in matching groups of three single or double quotes (these
|
|
are generally referred to as \emph{triple-quoted strings}). The
|
|
backslash (\code{\e}) character is used to escape characters that
|
|
otherwise have a special meaning, such as newline, backslash itself,
|
|
or the quote character. String literals may optionally be prefixed
|
|
with a letter `r' or `R'; such strings are called raw strings and use
|
|
different rules for backslash escape sequences.
|
|
\index{triple-quoted string}
|
|
\index{raw string}
|
|
|
|
In triple-quoted strings,
|
|
unescaped newlines and quotes are allowed (and are retained), except
|
|
that three unescaped quotes in a row terminate the string. (A
|
|
``quote'' is the character used to open the string, i.e. either
|
|
\code{'} or \code{"}.)
|
|
|
|
Unless an `r' or `R' prefix is present, escape sequences in strings
|
|
are interpreted according to rules similar
|
|
to those used by Standard \C{}. The recognized escape sequences are:
|
|
\index{physical line}
|
|
\index{escape sequence}
|
|
\index{Standard C}
|
|
\index{C}
|
|
|
|
\begin{tableii}{l|l}{code}{Escape Sequence}{Meaning}
|
|
\lineii{\e\var{newline}} {Ignored}
|
|
\lineii{\e\e} {Backslash (\code{\e})}
|
|
\lineii{\e'} {Single quote (\code{'})}
|
|
\lineii{\e"} {Double quote (\code{"})}
|
|
\lineii{\e a} {\ASCII{} Bell (BEL)}
|
|
\lineii{\e b} {\ASCII{} Backspace (BS)}
|
|
\lineii{\e f} {\ASCII{} Formfeed (FF)}
|
|
\lineii{\e n} {\ASCII{} Linefeed (LF)}
|
|
\lineii{\e r} {\ASCII{} Carriage Return (CR)}
|
|
\lineii{\e t} {\ASCII{} Horizontal Tab (TAB)}
|
|
\lineii{\e v} {\ASCII{} Vertical Tab (VT)}
|
|
\lineii{\e\var{ooo}} {\ASCII{} character with octal value \emph{ooo}}
|
|
\lineii{\e x\var{hh...}} {\ASCII{} character with hex value \emph{hh...}}
|
|
\end{tableii}
|
|
\index{ASCII@\ASCII{}}
|
|
|
|
In strict compatibility with Standard \C, up to three octal digits are
|
|
accepted, but an unlimited number of hex digits is taken to be part of
|
|
the hex escape (and then the lower 8 bits of the resulting hex number
|
|
are used in 8-bit implementations).
|
|
|
|
Unlike Standard \C{},
|
|
all unrecognized escape sequences are left in the string unchanged,
|
|
i.e., \emph{the backslash is left in the string.} (This behavior is
|
|
useful when debugging: if an escape sequence is mistyped, the
|
|
resulting output is more easily recognized as broken.)
|
|
\index{unrecognized escape sequence}
|
|
|
|
When an `r' or `R' prefix is present, backslashes are still used to
|
|
quote the following character, but \emph{all backslashes are left in
|
|
the string}. For example, the string literal \code{r"\e n"} consists
|
|
of two characters: a backslash and a lowercase `n'. String quotes can
|
|
be escaped with a backslash, but the backslash remains in the string;
|
|
for example, \code{r"\e""} is a valid string literal consisting of two
|
|
characters: a backslash and a double quote; \code{r"\e"} is not a value
|
|
string literal (even a raw string cannot end in an odd number of
|
|
backslashes). Specifically, \emph{a raw string cannot end in a single
|
|
backslash} (since the backslash would escape the following quote
|
|
character).
|
|
|
|
\subsection{String literal concatenation\label{string-catenation}}
|
|
|
|
Multiple adjacent string literals (delimited by whitespace), possibly
|
|
using different quoting conventions, are allowed, and their meaning is
|
|
the same as their concatenation. Thus, \code{"hello" 'world'} is
|
|
equivalent to \code{"helloworld"}. This feature can be used to reduce
|
|
the number of backslashes needed, to split long strings conveniently
|
|
across long lines, or even to add comments to parts of strings, for
|
|
example:
|
|
|
|
\begin{verbatim}
|
|
re.compile("[A-Za-z_]" # letter or underscore
|
|
"[A-Za-z0-9_]*" # letter, digit or underscore
|
|
)
|
|
\end{verbatim}
|
|
|
|
Note that this feature is defined at the syntactical level, but
|
|
implemented at compile time. The `+' operator must be used to
|
|
concatenate string expressions at run time. Also note that literal
|
|
concatenation can use different quoting styles for each component
|
|
(even mixing raw strings and triple quoted strings).
|
|
|
|
\subsection{Numeric literals\label{numbers}}
|
|
|
|
There are four types of numeric literals: plain integers, long
|
|
integers, floating point numbers, and imaginary numbers. There are no
|
|
complex literals (complex numbers can be formed by adding a real
|
|
number and an imaginary number).
|
|
\index{number}
|
|
\index{numeric literal}
|
|
\index{integer literal}
|
|
\index{plain integer literal}
|
|
\index{long integer literal}
|
|
\index{floating point literal}
|
|
\index{hexadecimal literal}
|
|
\index{octal literal}
|
|
\index{decimal literal}
|
|
\index{imaginary literal}
|
|
\index{complex literal}
|
|
|
|
Note that numeric literals do not include a sign; a phrase like
|
|
\code{-1} is actually an expression composed of the unary operator
|
|
`\code{-}' and the literal \code{1}.
|
|
|
|
\subsection{Integer and long integer literals\label{integers}}
|
|
|
|
Integer and long integer literals are described by the following
|
|
lexical definitions:
|
|
|
|
\begin{verbatim}
|
|
longinteger: integer ("l"|"L")
|
|
integer: decimalinteger | octinteger | hexinteger
|
|
decimalinteger: nonzerodigit digit* | "0"
|
|
octinteger: "0" octdigit+
|
|
hexinteger: "0" ("x"|"X") hexdigit+
|
|
nonzerodigit: "1"..."9"
|
|
octdigit: "0"..."7"
|
|
hexdigit: digit|"a"..."f"|"A"..."F"
|
|
\end{verbatim}
|
|
|
|
Although both lower case `l' and upper case `L' are allowed as suffix
|
|
for long integers, it is strongly recommended to always use `L', since
|
|
the letter `l' looks too much like the digit `1'.
|
|
|
|
Plain integer decimal literals must be at most 2147483647 (i.e., the
|
|
largest positive integer, using 32-bit arithmetic). Plain octal and
|
|
hexadecimal literals may be as large as 4294967295, but values larger
|
|
than 2147483647 are converted to a negative value by subtracting
|
|
4294967296. There is no limit for long integer literals apart from
|
|
what can be stored in available memory.
|
|
|
|
Some examples of plain and long integer literals:
|
|
|
|
\begin{verbatim}
|
|
7 2147483647 0177 0x80000000
|
|
3L 79228162514264337593543950336L 0377L 0x100000000L
|
|
\end{verbatim}
|
|
|
|
\subsection{Floating point literals\label{floating}}
|
|
|
|
Floating point literals are described by the following lexical
|
|
definitions:
|
|
|
|
\begin{verbatim}
|
|
floatnumber: pointfloat | exponentfloat
|
|
pointfloat: [intpart] fraction | intpart "."
|
|
exponentfloat: (nonzerodigit digit* | pointfloat) exponent
|
|
intpart: nonzerodigit digit* | "0"
|
|
fraction: "." digit+
|
|
exponent: ("e"|"E") ["+"|"-"] digit+
|
|
\end{verbatim}
|
|
|
|
Note that the integer part of a floating point number cannot look like
|
|
an octal integer.
|
|
The allowed range of floating point literals is
|
|
implementation-dependent.
|
|
Some examples of floating point literals:
|
|
|
|
\begin{verbatim}
|
|
3.14 10. .001 1e100 3.14e-10
|
|
\end{verbatim}
|
|
|
|
Note that numeric literals do not include a sign; a phrase like
|
|
\code{-1} is actually an expression composed of the operator
|
|
\code{-} and the literal \code{1}.
|
|
|
|
\subsection{Imaginary literals\label{imaginary}}
|
|
|
|
Imaginary literals are described by the following lexical definitions:
|
|
|
|
\begin{verbatim}
|
|
imagnumber: (floatnumber | intpart) ("j"|"J")
|
|
\end{verbatim}
|
|
|
|
An imaginary literals yields a complex number with a real part of
|
|
0.0. Complex numbers are represented as a pair of floating point
|
|
numbers and have the same restrictions on their range. To create a
|
|
complex number with a nonzero real part, add a floating point number
|
|
to it, e.g., \code{(3+4j)}. Some examples of imaginary literals:
|
|
|
|
\begin{verbatim}
|
|
3.14j 10.j 10j .001j 1e100j 3.14e-10j
|
|
\end{verbatim}
|
|
|
|
|
|
\section{Operators\label{operators}}
|
|
|
|
The following tokens are operators:
|
|
\index{operators}
|
|
|
|
\begin{verbatim}
|
|
+ - * ** / %
|
|
<< >> & | ^ ~
|
|
< > <= >= == != <>
|
|
\end{verbatim}
|
|
|
|
The comparison operators \code{<>} and \code{!=} are alternate
|
|
spellings of the same operator. \code{!=} is the preferred spelling;
|
|
\code{<>} is obsolescent.
|
|
|
|
\section{Delimiters\label{delimiters}}
|
|
|
|
The following tokens serve as delimiters in the grammar:
|
|
\index{delimiters}
|
|
|
|
\begin{verbatim}
|
|
( ) [ ] { }
|
|
, : . ` = ;
|
|
\end{verbatim}
|
|
|
|
The period can also occur in floating-point and imaginary literals. A
|
|
sequence of three periods has a special meaning as ellipses in slices.
|
|
|
|
The following printing ASCII characters have special meaning as part
|
|
of other tokens or are otherwise significant to the lexical analyzer:
|
|
|
|
\begin{verbatim}
|
|
' " # \
|
|
\end{verbatim}
|
|
|
|
The following printing \ASCII{} characters are not used in Python. Their
|
|
occurrence outside string literals and comments is an unconditional
|
|
error:
|
|
\index{ASCII@\ASCII{}}
|
|
|
|
\begin{verbatim}
|
|
@ $ ?
|
|
\end{verbatim}
|