blob: ba9c182251554ba0d45b59d23e1bad231c8c4340 [file] [log] [blame]
Fred Drake011f6fc1999-04-14 12:52:14 +00001\chapter{Simple statements \label{simple}}
Fred Drakef6669171998-05-06 19:52:49 +00002\indexii{simple}{statement}
3
4Simple statements are comprised within a single logical line.
5Several simple statements may occur on a single line separated
6by semicolons. The syntax for simple statements is:
7
Fred Drakecb4638a2001-07-06 22:49:53 +00008\begin{productionlist}
Fred Drake53815882002-03-15 23:21:37 +00009 \production{simple_stmt}{\token{expression_stmt}}
10 \productioncont{| \token{assert_stmt}}
11 \productioncont{| \token{assignment_stmt}}
12 \productioncont{| \token{augmented_assignment_stmt}}
13 \productioncont{| \token{pass_stmt}}
14 \productioncont{| \token{del_stmt}}
15 \productioncont{| \token{print_stmt}}
16 \productioncont{| \token{return_stmt}}
17 \productioncont{| \token{yield_stmt}}
18 \productioncont{| \token{raise_stmt}}
19 \productioncont{| \token{break_stmt}}
20 \productioncont{| \token{continue_stmt}}
21 \productioncont{| \token{import_stmt}}
22 \productioncont{| \token{global_stmt}}
23 \productioncont{| \token{exec_stmt}}
Fred Drakecb4638a2001-07-06 22:49:53 +000024\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +000025
Fred Drake2829f1c2001-06-23 05:27:20 +000026
Fred Drake011f6fc1999-04-14 12:52:14 +000027\section{Expression statements \label{exprstmts}}
Fred Drakef6669171998-05-06 19:52:49 +000028\indexii{expression}{statement}
29
30Expression statements are used (mostly interactively) to compute and
31write a value, or (usually) to call a procedure (a function that
32returns no meaningful result; in Python, procedures return the value
Guido van Rossum56c20131998-07-24 18:25:38 +000033\code{None}). Other uses of expression statements are allowed and
34occasionally useful. The syntax for an expression statement is:
Fred Drakef6669171998-05-06 19:52:49 +000035
Fred Drakecb4638a2001-07-06 22:49:53 +000036\begin{productionlist}
37 \production{expression_stmt}
38 {\token{expression_list}}
39\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +000040
Guido van Rossum56c20131998-07-24 18:25:38 +000041An expression statement evaluates the expression list (which may be a
42single expression).
Fred Drakef6669171998-05-06 19:52:49 +000043\indexii{expression}{list}
44
45In interactive mode, if the value is not \code{None}, it is converted
Guido van Rossum56c20131998-07-24 18:25:38 +000046to a string using the built-in \function{repr()}\bifuncindex{repr}
47function and the resulting string is written to standard output (see
Fred Drakec2f496a2001-12-05 05:46:25 +000048section~\ref{print}) on a line by itself. (Expression statements
49yielding \code{None} are not written, so that procedure calls do not
50cause any output.)
Fred Drakef6669171998-05-06 19:52:49 +000051\ttindex{None}
52\indexii{string}{conversion}
53\index{output}
54\indexii{standard}{output}
55\indexii{writing}{values}
56\indexii{procedure}{call}
57
Fred Drake2829f1c2001-06-23 05:27:20 +000058
Fred Drake011f6fc1999-04-14 12:52:14 +000059\section{Assert statements \label{assert}}
Guido van Rossum56c20131998-07-24 18:25:38 +000060
Fred Drake011f6fc1999-04-14 12:52:14 +000061Assert statements\stindex{assert} are a convenient way to insert
62debugging assertions\indexii{debugging}{assertions} into a program:
Guido van Rossum56c20131998-07-24 18:25:38 +000063
Fred Drakecb4638a2001-07-06 22:49:53 +000064\begin{productionlist}
Fred Drake007fadd2003-03-31 14:53:03 +000065 \production{assert_stmt}
Fred Drakecb4638a2001-07-06 22:49:53 +000066 {"assert" \token{expression} ["," \token{expression}]}
67\end{productionlist}
Guido van Rossum56c20131998-07-24 18:25:38 +000068
Fred Drake011f6fc1999-04-14 12:52:14 +000069The simple form, \samp{assert expression}, is equivalent to
Guido van Rossum56c20131998-07-24 18:25:38 +000070
71\begin{verbatim}
72if __debug__:
73 if not expression: raise AssertionError
74\end{verbatim}
75
Fred Drake011f6fc1999-04-14 12:52:14 +000076The extended form, \samp{assert expression1, expression2}, is
Guido van Rossum56c20131998-07-24 18:25:38 +000077equivalent to
78
79\begin{verbatim}
80if __debug__:
81 if not expression1: raise AssertionError, expression2
82\end{verbatim}
83
84These equivalences assume that \code{__debug__}\ttindex{__debug__} and
Fred Drake011f6fc1999-04-14 12:52:14 +000085\exception{AssertionError}\exindex{AssertionError} refer to the built-in
Guido van Rossum56c20131998-07-24 18:25:38 +000086variables with those names. In the current implementation, the
87built-in variable \code{__debug__} is 1 under normal circumstances, 0
88when optimization is requested (command line option -O). The current
89code generator emits no code for an assert statement when optimization
90is requested at compile time. Note that it is unnecessary to include
91the source code for the expression that failed in the error message;
92it will be displayed as part of the stack trace.
93
Jeremy Hylton2c84fc82001-03-23 14:34:06 +000094Assignments to \code{__debug__} are illegal. The value for the
95built-in variable is determined when the interpreter starts.
Guido van Rossum56c20131998-07-24 18:25:38 +000096
Fred Drake2829f1c2001-06-23 05:27:20 +000097
Fred Drake011f6fc1999-04-14 12:52:14 +000098\section{Assignment statements \label{assignment}}
Fred Drakef6669171998-05-06 19:52:49 +000099
Fred Drake011f6fc1999-04-14 12:52:14 +0000100Assignment statements\indexii{assignment}{statement} are used to
101(re)bind names to values and to modify attributes or items of mutable
102objects:
Fred Drakef6669171998-05-06 19:52:49 +0000103\indexii{binding}{name}
104\indexii{rebinding}{name}
105\obindex{mutable}
106\indexii{attribute}{assignment}
107
Fred Drakecb4638a2001-07-06 22:49:53 +0000108\begin{productionlist}
109 \production{assignment_stmt}
110 {(\token{target_list} "=")+ \token{expression_list}}
111 \production{target_list}
112 {\token{target} ("," \token{target})* [","]}
113 \production{target}
Fred Drake53815882002-03-15 23:21:37 +0000114 {\token{identifier}}
115 \productioncont{| "(" \token{target_list} ")"}
116 \productioncont{| "[" \token{target_list} "]"}
117 \productioncont{| \token{attributeref}}
118 \productioncont{| \token{subscription}}
119 \productioncont{| \token{slicing}}
Fred Drakecb4638a2001-07-06 22:49:53 +0000120\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000121
Fred Drakec2f496a2001-12-05 05:46:25 +0000122(See section~\ref{primaries} for the syntax definitions for the last
Fred Drakef6669171998-05-06 19:52:49 +0000123three symbols.)
124
125An assignment statement evaluates the expression list (remember that
126this can be a single expression or a comma-separated list, the latter
127yielding a tuple) and assigns the single resulting object to each of
128the target lists, from left to right.
129\indexii{expression}{list}
130
131Assignment is defined recursively depending on the form of the target
132(list). When a target is part of a mutable object (an attribute
133reference, subscription or slicing), the mutable object must
134ultimately perform the assignment and decide about its validity, and
135may raise an exception if the assignment is unacceptable. The rules
136observed by various types and the exceptions raised are given with the
Fred Drakec2f496a2001-12-05 05:46:25 +0000137definition of the object types (see section~\ref{types}).
Fred Drakef6669171998-05-06 19:52:49 +0000138\index{target}
139\indexii{target}{list}
140
141Assignment of an object to a target list is recursively defined as
142follows.
143\indexiii{target}{list}{assignment}
144
145\begin{itemize}
146\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000147If the target list is a single target: The object is assigned to that
Fred Drakef6669171998-05-06 19:52:49 +0000148target.
149
150\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000151If the target list is a comma-separated list of targets: The object
152must be a sequence with the same number of items as the there are
153targets in the target list, and the items are assigned, from left to
154right, to the corresponding targets. (This rule is relaxed as of
155Python 1.5; in earlier versions, the object had to be a tuple. Since
Fred Drake011f6fc1999-04-14 12:52:14 +0000156strings are sequences, an assignment like \samp{a, b = "xy"} is
Guido van Rossum56c20131998-07-24 18:25:38 +0000157now legal as long as the string has the right length.)
Fred Drakef6669171998-05-06 19:52:49 +0000158
159\end{itemize}
160
161Assignment of an object to a single target is recursively defined as
162follows.
163
164\begin{itemize} % nested
165
166\item
167If the target is an identifier (name):
168
169\begin{itemize}
170
171\item
172If the name does not occur in a \keyword{global} statement in the current
Guido van Rossum56c20131998-07-24 18:25:38 +0000173code block: the name is bound to the object in the current local
174namespace.
Fred Drakef6669171998-05-06 19:52:49 +0000175\stindex{global}
176
177\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000178Otherwise: the name is bound to the object in the current global
179namespace.
Fred Drakef6669171998-05-06 19:52:49 +0000180
181\end{itemize} % nested
182
Guido van Rossum56c20131998-07-24 18:25:38 +0000183The name is rebound if it was already bound. This may cause the
184reference count for the object previously bound to the name to reach
185zero, causing the object to be deallocated and its
186destructor\index{destructor} (if it has one) to be called.
Fred Drakef6669171998-05-06 19:52:49 +0000187
188\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000189If the target is a target list enclosed in parentheses or in square
190brackets: The object must be a sequence with the same number of items
191as there are targets in the target list, and its items are assigned,
192from left to right, to the corresponding targets.
Fred Drakef6669171998-05-06 19:52:49 +0000193
194\item
195If the target is an attribute reference: The primary expression in the
196reference is evaluated. It should yield an object with assignable
197attributes; if this is not the case, \exception{TypeError} is raised. That
198object is then asked to assign the assigned object to the given
199attribute; if it cannot perform the assignment, it raises an exception
200(usually but not necessarily \exception{AttributeError}).
201\indexii{attribute}{assignment}
202
203\item
204If the target is a subscription: The primary expression in the
205reference is evaluated. It should yield either a mutable sequence
Guido van Rossum56c20131998-07-24 18:25:38 +0000206object (e.g., a list) or a mapping object (e.g., a dictionary). Next,
207the subscript expression is evaluated.
Fred Drakef6669171998-05-06 19:52:49 +0000208\indexii{subscription}{assignment}
209\obindex{mutable}
210
Guido van Rossum56c20131998-07-24 18:25:38 +0000211If the primary is a mutable sequence object (e.g., a list), the subscript
Fred Drakef6669171998-05-06 19:52:49 +0000212must yield a plain integer. If it is negative, the sequence's length
213is added to it. The resulting value must be a nonnegative integer
214less than the sequence's length, and the sequence is asked to assign
215the assigned object to its item with that index. If the index is out
216of range, \exception{IndexError} is raised (assignment to a subscripted
217sequence cannot add new items to a list).
218\obindex{sequence}
219\obindex{list}
220
Guido van Rossum56c20131998-07-24 18:25:38 +0000221If the primary is a mapping object (e.g., a dictionary), the subscript must
Fred Drakef6669171998-05-06 19:52:49 +0000222have a type compatible with the mapping's key type, and the mapping is
223then asked to create a key/datum pair which maps the subscript to
224the assigned object. This can either replace an existing key/value
225pair with the same key value, or insert a new key/value pair (if no
226key with the same value existed).
227\obindex{mapping}
228\obindex{dictionary}
229
230\item
231If the target is a slicing: The primary expression in the reference is
Guido van Rossum56c20131998-07-24 18:25:38 +0000232evaluated. It should yield a mutable sequence object (e.g., a list). The
Fred Drakef6669171998-05-06 19:52:49 +0000233assigned object should be a sequence object of the same type. Next,
234the lower and upper bound expressions are evaluated, insofar they are
235present; defaults are zero and the sequence's length. The bounds
236should evaluate to (small) integers. If either bound is negative, the
237sequence's length is added to it. The resulting bounds are clipped to
238lie between zero and the sequence's length, inclusive. Finally, the
239sequence object is asked to replace the slice with the items of the
240assigned sequence. The length of the slice may be different from the
241length of the assigned sequence, thus changing the length of the
242target sequence, if the object allows it.
243\indexii{slicing}{assignment}
244
245\end{itemize}
Greg Ward38c28e32000-04-27 18:32:02 +0000246
Fred Drakef6669171998-05-06 19:52:49 +0000247(In the current implementation, the syntax for targets is taken
248to be the same as for expressions, and invalid syntax is rejected
249during the code generation phase, causing less detailed error
250messages.)
251
252WARNING: Although the definition of assignment implies that overlaps
Guido van Rossum56c20131998-07-24 18:25:38 +0000253between the left-hand side and the right-hand side are `safe' (e.g.,
Fred Drake011f6fc1999-04-14 12:52:14 +0000254\samp{a, b = b, a} swaps two variables), overlaps \emph{within} the
Fred Drakef6669171998-05-06 19:52:49 +0000255collection of assigned-to variables are not safe! For instance, the
Fred Drake011f6fc1999-04-14 12:52:14 +0000256following program prints \samp{[0, 2]}:
Fred Drakef6669171998-05-06 19:52:49 +0000257
258\begin{verbatim}
259x = [0, 1]
260i = 0
261i, x[i] = 1, 2
262print x
263\end{verbatim}
264
265
Fred Drake53815882002-03-15 23:21:37 +0000266\subsection{Augmented assignment statements \label{augassign}}
Fred Drake31f55502000-09-12 20:32:18 +0000267
268Augmented assignment is the combination, in a single statement, of a binary
269operation and an assignment statement:
270\indexii{augmented}{assignment}
271\index{statement!assignment, augmented}
272
Fred Drakecb4638a2001-07-06 22:49:53 +0000273\begin{productionlist}
274 \production{augmented_assignment_stmt}
275 {\token{target} \token{augop} \token{expression_list}}
276 \production{augop}
Fred Drake53815882002-03-15 23:21:37 +0000277 {"+=" | "-=" | "*=" | "/=" | "\%=" | "**="}
278 \productioncont{| ">>=" | "<<=" | "\&=" | "\textasciicircum=" | "|="}
Fred Drakecb4638a2001-07-06 22:49:53 +0000279\end{productionlist}
Fred Drake31f55502000-09-12 20:32:18 +0000280
Fred Drakec2f496a2001-12-05 05:46:25 +0000281(See section~\ref{primaries} for the syntax definitions for the last
Fred Drake31f55502000-09-12 20:32:18 +0000282three symbols.)
283
Fred Draked68442b2000-09-21 22:01:36 +0000284An augmented assignment evaluates the target (which, unlike normal
285assignment statements, cannot be an unpacking) and the expression
286list, performs the binary operation specific to the type of assignment
287on the two operands, and assigns the result to the original
288target. The target is only evaluated once.
Fred Drake31f55502000-09-12 20:32:18 +0000289
290An augmented assignment expression like \code{x += 1} can be rewritten as
291\code{x = x + 1} to achieve a similar, but not exactly equal effect. In the
292augmented version, \code{x} is only evaluated once. Also, when possible, the
293actual operation is performed \emph{in-place}, meaning that rather than
294creating a new object and assigning that to the target, the old object is
295modified instead.
296
297With the exception of assigning to tuples and multiple targets in a single
298statement, the assignment done by augmented assignment statements is handled
299the same way as normal assignments. Similarly, with the exception of the
Fred Drakec2f496a2001-12-05 05:46:25 +0000300possible \emph{in-place} behavior, the binary operation performed by
Fred Drake31f55502000-09-12 20:32:18 +0000301augmented assignment is the same as the normal binary operations.
302
Raymond Hettinger04e7e0c2002-06-25 13:36:41 +0000303For targets which are attribute references, the initial value is
304retrieved with a \method{getattr()} and the result is assigned with a
305\method{setattr()}. Notice that the two methods do not necessarily
306refer to the same variable. When \method{getattr()} refers to a class
307variable, \method{setattr()} still writes to an instance variable.
308For example:
309
310\begin{verbatim}
311class A:
312 x = 3 # class variable
313a = A()
314a.x += 1 # writes a.x as 4 leaving A.x as 3
315\end{verbatim}
316
Fred Drake31f55502000-09-12 20:32:18 +0000317
Fred Drake011f6fc1999-04-14 12:52:14 +0000318\section{The \keyword{pass} statement \label{pass}}
Fred Drakef6669171998-05-06 19:52:49 +0000319\stindex{pass}
320
Fred Drakecb4638a2001-07-06 22:49:53 +0000321\begin{productionlist}
322 \production{pass_stmt}
323 {"pass"}
324\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000325
326\keyword{pass} is a null operation --- when it is executed, nothing
327happens. It is useful as a placeholder when a statement is
328required syntactically, but no code needs to be executed, for example:
329\indexii{null}{operation}
330
331\begin{verbatim}
332def f(arg): pass # a function that does nothing (yet)
333
334class C: pass # a class with no methods (yet)
335\end{verbatim}
336
Fred Drake2829f1c2001-06-23 05:27:20 +0000337
Fred Drake011f6fc1999-04-14 12:52:14 +0000338\section{The \keyword{del} statement \label{del}}
Fred Drakef6669171998-05-06 19:52:49 +0000339\stindex{del}
340
Fred Drakecb4638a2001-07-06 22:49:53 +0000341\begin{productionlist}
342 \production{del_stmt}
343 {"del" \token{target_list}}
344\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000345
346Deletion is recursively defined very similar to the way assignment is
347defined. Rather that spelling it out in full details, here are some
348hints.
349\indexii{deletion}{target}
350\indexiii{deletion}{target}{list}
351
352Deletion of a target list recursively deletes each target, from left
353to right.
354
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000355Deletion of a name removes the binding of that name
Guido van Rossum56c20131998-07-24 18:25:38 +0000356from the local or global namespace, depending on whether the name
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000357occurs in a \keyword{global} statement in the same code block. If the
358name is unbound, a \exception{NameError} exception will be raised.
Fred Drakef6669171998-05-06 19:52:49 +0000359\stindex{global}
360\indexii{unbinding}{name}
361
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000362It is illegal to delete a name from the local namespace if it occurs
Michael W. Hudson495afea2002-06-17 12:51:57 +0000363as a free variable\indexii{free}{variable} in a nested block.
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000364
Fred Drakef6669171998-05-06 19:52:49 +0000365Deletion of attribute references, subscriptions and slicings
366is passed to the primary object involved; deletion of a slicing
367is in general equivalent to assignment of an empty slice of the
368right type (but even this is determined by the sliced object).
369\indexii{attribute}{deletion}
370
Fred Drake2829f1c2001-06-23 05:27:20 +0000371
Fred Drake011f6fc1999-04-14 12:52:14 +0000372\section{The \keyword{print} statement \label{print}}
Fred Drakef6669171998-05-06 19:52:49 +0000373\stindex{print}
374
Fred Drakecb4638a2001-07-06 22:49:53 +0000375\begin{productionlist}
376 \production{print_stmt}
Fred Drake53815882002-03-15 23:21:37 +0000377 {"print" ( \optional{\token{expression} ("," \token{expression})* \optional{","}}}
378 \productioncont{| ">\code{>}" \token{expression}
379 \optional{("," \token{expression})+ \optional{","}} )}
Fred Drakecb4638a2001-07-06 22:49:53 +0000380\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000381
Fred Draked4c33521998-10-01 20:39:47 +0000382\keyword{print} evaluates each expression in turn and writes the
383resulting object to standard output (see below). If an object is not
Fred Drakebe9d10e2001-06-23 06:16:52 +0000384a string, it is first converted to a string using the rules for string
Fred Drakef6669171998-05-06 19:52:49 +0000385conversions. The (resulting or original) string is then written. A
Fred Drakebe9d10e2001-06-23 06:16:52 +0000386space is written before each object is (converted and) written, unless
Fred Drakef6669171998-05-06 19:52:49 +0000387the output system believes it is positioned at the beginning of a
Guido van Rossum56c20131998-07-24 18:25:38 +0000388line. This is the case (1) when no characters have yet been written
389to standard output, (2) when the last character written to standard
Fred Draked4c33521998-10-01 20:39:47 +0000390output is \character{\e n}, or (3) when the last write operation on
391standard output was not a \keyword{print} statement. (In some cases
392it may be functional to write an empty string to standard output for
Fred Drakec2f496a2001-12-05 05:46:25 +0000393this reason.) \note{Objects which act like file objects but which are
394not the built-in file objects often do not properly emulate this
395aspect of the file object's behavior, so it is best not to rely on
396this.}
Fred Drakef6669171998-05-06 19:52:49 +0000397\index{output}
398\indexii{writing}{values}
399
Fred Draked4c33521998-10-01 20:39:47 +0000400A \character{\e n} character is written at the end, unless the
401\keyword{print} statement ends with a comma. This is the only action
402if the statement contains just the keyword \keyword{print}.
Fred Drakef6669171998-05-06 19:52:49 +0000403\indexii{trailing}{comma}
404\indexii{newline}{suppression}
405
Fred Drakedde91f01998-05-06 20:59:46 +0000406Standard output is defined as the file object named \code{stdout}
Guido van Rossum56c20131998-07-24 18:25:38 +0000407in the built-in module \module{sys}. If no such object exists, or if
408it does not have a \method{write()} method, a \exception{RuntimeError}
409exception is raised.
Fred Drakef6669171998-05-06 19:52:49 +0000410\indexii{standard}{output}
411\refbimodindex{sys}
Fred Drake2b3730e1998-11-25 17:40:00 +0000412\withsubitem{(in module sys)}{\ttindex{stdout}}
Fred Drakef6669171998-05-06 19:52:49 +0000413\exindex{RuntimeError}
414
Fred Drakecb4638a2001-07-06 22:49:53 +0000415\keyword{print} also has an extended\index{extended print statement}
416form, defined by the second portion of the syntax described above.
417This form is sometimes referred to as ``\keyword{print} chevron.''
Fred Drake62effc12001-04-13 15:55:25 +0000418In this form, the first expression after the \code{>}\code{>} must
Barry Warsaw8c0a2422000-08-21 15:45:16 +0000419evaluate to a ``file-like'' object, specifically an object that has a
Barry Warsaw33f785f2000-08-29 04:57:34 +0000420\method{write()} method as described above. With this extended form,
421the subsequent expressions are printed to this file object. If the
422first expression evaluates to \code{None}, then \code{sys.stdout} is
423used as the file for output.
Barry Warsaw8c0a2422000-08-21 15:45:16 +0000424
Fred Drake2829f1c2001-06-23 05:27:20 +0000425
Fred Drake011f6fc1999-04-14 12:52:14 +0000426\section{The \keyword{return} statement \label{return}}
Fred Drakef6669171998-05-06 19:52:49 +0000427\stindex{return}
428
Fred Drakecb4638a2001-07-06 22:49:53 +0000429\begin{productionlist}
430 \production{return_stmt}
431 {"return" [\token{expression_list}]}
432\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000433
434\keyword{return} may only occur syntactically nested in a function
435definition, not within a nested class definition.
436\indexii{function}{definition}
437\indexii{class}{definition}
438
Guido van Rossum56c20131998-07-24 18:25:38 +0000439If an expression list is present, it is evaluated, else \code{None}
Fred Drakef6669171998-05-06 19:52:49 +0000440is substituted.
441
Guido van Rossum56c20131998-07-24 18:25:38 +0000442\keyword{return} leaves the current function call with the expression
Fred Drakef6669171998-05-06 19:52:49 +0000443list (or \code{None}) as return value.
444
445When \keyword{return} passes control out of a \keyword{try} statement
Guido van Rossum56c20131998-07-24 18:25:38 +0000446with a \keyword{finally} clause, that \keyword{finally} clause is executed
Fred Drakef6669171998-05-06 19:52:49 +0000447before really leaving the function.
448\kwindex{finally}
449
Fred Drakee31e9ce2001-12-11 21:10:08 +0000450In a generator function, the \keyword{return} statement is not allowed
451to include an \grammartoken{expression_list}. In that context, a bare
452\keyword{return} indicates that the generator is done and will cause
453\exception{StopIteration} to be raised.
454
455
456\section{The \keyword{yield} statement \label{yield}}
457\stindex{yield}
458
459\begin{productionlist}
460 \production{yield_stmt}
461 {"yield" \token{expression_list}}
462\end{productionlist}
463
464\index{generator!function}
465\index{generator!iterator}
466\index{function!generator}
467\exindex{StopIteration}
468
469The \keyword{yield} statement is only used when defining a generator
470function, and is only used in the body of the generator function.
471Using a \keyword{yield} statement in a function definition is
472sufficient to cause that definition to create a generator function
473instead of a normal function.
474
475When a generator function is called, it returns an iterator known as a
476generator iterator, or more commonly, a generator. The body of the
477generator function is executed by calling the generator's
478\method{next()} method repeatedly until it raises an exception.
479
480When a \keyword{yield} statement is executed, the state of the
481generator is frozen and the value of \grammartoken{expression_list} is
482returned to \method{next()}'s caller. By ``frozen'' we mean that all
483local state is retained, including the current bindings of local
484variables, the instruction pointer, and the internal evaluation stack:
485enough information is saved so that the next time \method{next()} is
486invoked, the function can proceed exactly as if the \keyword{yield}
487statement were just another external call.
488
Fred Drake3a8e59e2001-12-11 21:58:35 +0000489The \keyword{yield} statement is not allowed in the \keyword{try}
490clause of a \keyword{try} ...\ \keyword{finally} construct. The
491difficulty is that there's no guarantee the generator will ever be
492resumed, hence no guarantee that the \keyword{finally} block will ever
493get executed.
Fred Drakee31e9ce2001-12-11 21:10:08 +0000494
Fred Drake08d752c2001-12-14 22:55:14 +0000495\begin{notice}
496In Python 2.2, the \keyword{yield} statement is only allowed
Fred Drake8d0645c2001-12-12 06:06:43 +0000497when the \code{generators} feature has been enabled. It will always
498be enabled in Python 2.3. This \code{__future__} import statment can
Fred Drake08d752c2001-12-14 22:55:14 +0000499be used to enable the feature:
Fred Drake8d0645c2001-12-12 06:06:43 +0000500
501\begin{verbatim}
502from __future__ import generators
503\end{verbatim}
Fred Drake08d752c2001-12-14 22:55:14 +0000504\end{notice}
Fred Drake8d0645c2001-12-12 06:06:43 +0000505
506
Fred Drakee31e9ce2001-12-11 21:10:08 +0000507\begin{seealso}
508 \seepep{0255}{Simple Generators}
509 {The proposal for adding generators and the \keyword{yield}
510 statement to Python.}
511\end{seealso}
512
Fred Drake2829f1c2001-06-23 05:27:20 +0000513
Fred Drake011f6fc1999-04-14 12:52:14 +0000514\section{The \keyword{raise} statement \label{raise}}
Fred Drakef6669171998-05-06 19:52:49 +0000515\stindex{raise}
516
Fred Drakecb4638a2001-07-06 22:49:53 +0000517\begin{productionlist}
518 \production{raise_stmt}
519 {"raise" [\token{expression} ["," \token{expression}
520 ["," \token{expression}]]]}
521\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000522
Guido van Rossum56c20131998-07-24 18:25:38 +0000523If no expressions are present, \keyword{raise} re-raises the last
Fred Drake81932e22002-06-20 20:55:29 +0000524expression that was active in the current scope. If no exception has
525been active in the current scope, an exception is raised that
526indicates indicates that this is the error.
Fred Drakef6669171998-05-06 19:52:49 +0000527\index{exception}
528\indexii{raising}{exception}
529
Fred Drake81932e22002-06-20 20:55:29 +0000530Otherwise, \keyword{raise} evaluates the expressions to get three
531objects, using \code{None} as the value of omitted expressions. The
532first two objects are used to determine the \emph{type} and
533\emph{value} of the exception.
Fred Drakef6669171998-05-06 19:52:49 +0000534
Fred Drake81932e22002-06-20 20:55:29 +0000535If the first object is an instance, the type of the exception is the
Fred Drake8bd62af2003-01-25 03:47:35 +0000536class of the instance, the instance itself is the value, and the
Fred Drake81932e22002-06-20 20:55:29 +0000537second object must be \code{None}.
538
539If the first object is a class, it becomes the type of the exception.
540The second object is used to determine the exception value: If it is
541an instance of the class, the instance becomes the exception value.
542If the second object is a tuple, it is used as the argument list for
543the class constructor; if it is \code{None}, an empty argument list is
544used, and any other object is treated as a single argument to the
545constructor. The instance so created by calling the constructor is
546used as the exception value.
547
548If the first object is a string, the string object is the exception
549type, and the second object becomes the exception value.
550
551If a third object is present and not \code{None}, it must be a
552traceback\obindex{traceback} object (see section~\ref{traceback}), and
553it is substituted instead of the current location as the place where
554the exception occurred. If the third object is present and not a
555traceback object or \code{None}, a \exception{TypeError} exception is
556raised. The three-expression form of \keyword{raise} is useful to
557re-raise an exception transparently in an except clause, but
558\keyword{raise} with no expressions should be preferred if the
559exception to be re-raised was the most recently active exception in
560the current scope.
561
Fred Drakee7097e02002-10-18 15:18:18 +0000562Additional information on exceptions can be found in
563section~\ref{exceptions}, and information about handling exceptions is
564in section~\ref{try}.
Fred Drakef6669171998-05-06 19:52:49 +0000565
Fred Drake2829f1c2001-06-23 05:27:20 +0000566
Fred Drake011f6fc1999-04-14 12:52:14 +0000567\section{The \keyword{break} statement \label{break}}
Fred Drakef6669171998-05-06 19:52:49 +0000568\stindex{break}
569
Fred Drakecb4638a2001-07-06 22:49:53 +0000570\begin{productionlist}
571 \production{break_stmt}
572 {"break"}
573\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000574
575\keyword{break} may only occur syntactically nested in a \keyword{for}
576or \keyword{while} loop, but not nested in a function or class definition
577within that loop.
578\stindex{for}
579\stindex{while}
580\indexii{loop}{statement}
581
582It terminates the nearest enclosing loop, skipping the optional
Guido van Rossum56c20131998-07-24 18:25:38 +0000583\keyword{else} clause if the loop has one.
Fred Drakef6669171998-05-06 19:52:49 +0000584\kwindex{else}
585
586If a \keyword{for} loop is terminated by \keyword{break}, the loop control
587target keeps its current value.
588\indexii{loop control}{target}
589
590When \keyword{break} passes control out of a \keyword{try} statement
Guido van Rossum56c20131998-07-24 18:25:38 +0000591with a \keyword{finally} clause, that \keyword{finally} clause is executed
Fred Drakef6669171998-05-06 19:52:49 +0000592before really leaving the loop.
593\kwindex{finally}
594
Fred Drake2829f1c2001-06-23 05:27:20 +0000595
Fred Drake011f6fc1999-04-14 12:52:14 +0000596\section{The \keyword{continue} statement \label{continue}}
Fred Drakef6669171998-05-06 19:52:49 +0000597\stindex{continue}
598
Fred Drakecb4638a2001-07-06 22:49:53 +0000599\begin{productionlist}
600 \production{continue_stmt}
601 {"continue"}
602\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000603
604\keyword{continue} may only occur syntactically nested in a \keyword{for} or
605\keyword{while} loop, but not nested in a function or class definition or
Guido van Rossum56c20131998-07-24 18:25:38 +0000606\keyword{try} statement within that loop.\footnote{It may
607occur within an \keyword{except} or \keyword{else} clause. The
Thomas Woutersf9b526d2000-07-16 19:05:38 +0000608restriction on occurring in the \keyword{try} clause is implementor's
Guido van Rossum56c20131998-07-24 18:25:38 +0000609laziness and will eventually be lifted.}
610It continues with the next cycle of the nearest enclosing loop.
Fred Drakef6669171998-05-06 19:52:49 +0000611\stindex{for}
612\stindex{while}
613\indexii{loop}{statement}
614\kwindex{finally}
615
Fred Drake2829f1c2001-06-23 05:27:20 +0000616
Fred Drake011f6fc1999-04-14 12:52:14 +0000617\section{The \keyword{import} statement \label{import}}
Fred Drakef6669171998-05-06 19:52:49 +0000618\stindex{import}
619
Fred Drakecb4638a2001-07-06 22:49:53 +0000620\begin{productionlist}
621 \production{import_stmt}
622 {"import" \token{module} ["as" \token{name}]
Fred Drake53815882002-03-15 23:21:37 +0000623 ( "," \token{module} ["as" \token{name}] )*}
624 \productioncont{| "from" \token{module} "import" \token{identifier}
625 ["as" \token{name}]}
626 \productioncont{ ( "," \token{identifier} ["as" \token{name}] )*}
627 \productioncont{| "from" \token{module} "import" "*"}
Fred Drakecb4638a2001-07-06 22:49:53 +0000628 \production{module}
629 {(\token{identifier} ".")* \token{identifier}}
630\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000631
632Import statements are executed in two steps: (1) find a module, and
633initialize it if necessary; (2) define a name or names in the local
Guido van Rossum56c20131998-07-24 18:25:38 +0000634namespace (of the scope where the \keyword{import} statement occurs).
Fred Drakef6669171998-05-06 19:52:49 +0000635The first form (without \keyword{from}) repeats these steps for each
Guido van Rossum56c20131998-07-24 18:25:38 +0000636identifier in the list. The form with \keyword{from} performs step
637(1) once, and then performs step (2) repeatedly.
Fred Drakef6669171998-05-06 19:52:49 +0000638\indexii{importing}{module}
639\indexii{name}{binding}
640\kwindex{from}
641
Raymond Hettingere701dcb2003-01-19 13:08:18 +0000642In this context, to ``initialize'' a built-in or extension module means to
643call an initialization function that the module must provide for the purpose
644(in the reference implementation, the function's name is obtained by
645prepending string ``init'' to the module's name); to ``initialize'' a
646Python-coded module means to execute the module's body.
647
648The system maintains a table of modules that have been or are being
649initialized,
Fred Drake191a2822000-07-06 00:50:42 +0000650indexed by module name. This table is
Guido van Rossum56c20131998-07-24 18:25:38 +0000651accessible as \code{sys.modules}. When a module name is found in
Fred Drakef6669171998-05-06 19:52:49 +0000652this table, step (1) is finished. If not, a search for a module
Guido van Rossum56c20131998-07-24 18:25:38 +0000653definition is started. When a module is found, it is loaded. Details
654of the module searching and loading process are implementation and
655platform specific. It generally involves searching for a ``built-in''
656module with the given name and then searching a list of locations
657given as \code{sys.path}.
Fred Drake2b3730e1998-11-25 17:40:00 +0000658\withsubitem{(in module sys)}{\ttindex{modules}}
Fred Drakef6669171998-05-06 19:52:49 +0000659\ttindex{sys.modules}
660\indexii{module}{name}
661\indexii{built-in}{module}
662\indexii{user-defined}{module}
663\refbimodindex{sys}
Fred Drakef6669171998-05-06 19:52:49 +0000664\indexii{filename}{extension}
Fred Drakedde91f01998-05-06 20:59:46 +0000665\indexiii{module}{search}{path}
Fred Drakef6669171998-05-06 19:52:49 +0000666
667If a built-in module is found, its built-in initialization code is
668executed and step (1) is finished. If no matching file is found,
669\exception{ImportError} is raised. If a file is found, it is parsed,
670yielding an executable code block. If a syntax error occurs,
671\exception{SyntaxError} is raised. Otherwise, an empty module of the given
672name is created and inserted in the module table, and then the code
673block is executed in the context of this module. Exceptions during
674this execution terminate step (1).
675\indexii{module}{initialization}
676\exindex{SyntaxError}
677\exindex{ImportError}
678\index{code block}
679
680When step (1) finishes without raising an exception, step (2) can
681begin.
682
Fred Drake859eb622001-03-06 07:34:00 +0000683The first form of \keyword{import} statement binds the module name in
684the local namespace to the module object, and then goes on to import
685the next identifier, if any. If the module name is followed by
686\keyword{as}, the name following \keyword{as} is used as the local
Martin v. Löwis13dd9d92003-01-16 11:30:08 +0000687name for the module.
Thomas Wouters8bad6122000-08-19 20:55:02 +0000688
Thomas Wouters52152252000-08-17 22:55:00 +0000689The \keyword{from} form does not bind the module name: it goes through the
690list of identifiers, looks each one of them up in the module found in step
691(1), and binds the name in the local namespace to the object thus found.
Fred Draked68442b2000-09-21 22:01:36 +0000692As with the first form of \keyword{import}, an alternate local name can be
Thomas Wouters52152252000-08-17 22:55:00 +0000693supplied by specifying "\keyword{as} localname". If a name is not found,
Fred Drakef6669171998-05-06 19:52:49 +0000694\exception{ImportError} is raised. If the list of identifiers is replaced
Fred Drake08fd5152001-10-24 19:50:31 +0000695by a star (\character{*}), all public names defined in the module are
696bound in the local namespace of the \keyword{import} statement..
Fred Drakef6669171998-05-06 19:52:49 +0000697\indexii{name}{binding}
698\exindex{ImportError}
699
Fred Drake08fd5152001-10-24 19:50:31 +0000700The \emph{public names} defined by a module are determined by checking
701the module's namespace for a variable named \code{__all__}; if
702defined, it must be a sequence of strings which are names defined or
703imported by that module. The names given in \code{__all__} are all
704considered public and are required to exist. If \code{__all__} is not
705defined, the set of public names includes all names found in the
706module's namespace which do not begin with an underscore character
Raymond Hettinger1772f172003-01-06 12:54:54 +0000707(\character{_}). \code{__all__} should contain the entire public API.
708It is intended to avoid accidentally exporting items that are not part
709of the API (such as library modules which were imported and used within
710the module).
Fred Drake27cae1f2002-12-07 16:00:00 +0000711\withsubitem{(optional module attribute)}{\ttindex{__all__}}
Fred Drake08fd5152001-10-24 19:50:31 +0000712
Jeremy Hyltonf0c1f1b2002-04-01 21:19:44 +0000713The \keyword{from} form with \samp{*} may only occur in a module
714scope. If the wild card form of import --- \samp{import *} --- is
715used in a function and the function contains or is a nested block with
716free variables, the compiler will raise a \exception{SyntaxError}.
717
Fred Drakef6669171998-05-06 19:52:49 +0000718\kwindex{from}
Fred Drake2b3730e1998-11-25 17:40:00 +0000719\stindex{from}
Fred Drakef6669171998-05-06 19:52:49 +0000720
Fred Drake246837d1998-07-24 20:28:22 +0000721\strong{Hierarchical module names:}\indexiii{hierarchical}{module}{names}
Guido van Rossum56c20131998-07-24 18:25:38 +0000722when the module names contains one or more dots, the module search
723path is carried out differently. The sequence of identifiers up to
724the last dot is used to find a ``package''\index{packages}; the final
725identifier is then searched inside the package. A package is
726generally a subdirectory of a directory on \code{sys.path} that has a
727file \file{__init__.py}.\ttindex{__init__.py}
728%
729[XXX Can't be bothered to spell this out right now; see the URL
Fred Drake1a0b8721998-08-07 17:40:20 +0000730\url{http://www.python.org/doc/essays/packages.html} for more details, also
Guido van Rossum56c20131998-07-24 18:25:38 +0000731about how the module search works from inside a package.]
732
Fred Drake08fd5152001-10-24 19:50:31 +0000733The built-in function \function{__import__()} is provided to support
734applications that determine which modules need to be loaded
735dynamically; refer to \ulink{Built-in
736Functions}{../lib/built-in-funcs.html} in the
737\citetitle[../lib/lib.html]{Python Library Reference} for additional
738information.
Guido van Rossum56c20131998-07-24 18:25:38 +0000739\bifuncindex{__import__}
740
Fred Drake2829f1c2001-06-23 05:27:20 +0000741
Fred Drake011f6fc1999-04-14 12:52:14 +0000742\section{The \keyword{global} statement \label{global}}
Fred Drakef6669171998-05-06 19:52:49 +0000743\stindex{global}
744
Fred Drakecb4638a2001-07-06 22:49:53 +0000745\begin{productionlist}
746 \production{global_stmt}
747 {"global" \token{identifier} ("," \token{identifier})*}
748\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000749
750The \keyword{global} statement is a declaration which holds for the
751entire current code block. It means that the listed identifiers are to be
Jeremy Hyltonf3255c82002-04-01 21:25:32 +0000752interpreted as globals. It would be impossible to assign to a global
753variable without \keyword{global}, although free variables may refer
754to globals without being declared global.
Fred Drakef6669171998-05-06 19:52:49 +0000755\indexiii{global}{name}{binding}
756
757Names listed in a \keyword{global} statement must not be used in the same
Guido van Rossumb1f97d61998-12-21 18:57:36 +0000758code block textually preceding that \keyword{global} statement.
Fred Drakef6669171998-05-06 19:52:49 +0000759
760Names listed in a \keyword{global} statement must not be defined as formal
761parameters or in a \keyword{for} loop control target, \keyword{class}
762definition, function definition, or \keyword{import} statement.
763
764(The current implementation does not enforce the latter two
765restrictions, but programs should not abuse this freedom, as future
766implementations may enforce them or silently change the meaning of the
767program.)
768
Guido van Rossum56c20131998-07-24 18:25:38 +0000769\strong{Programmer's note:}
770the \keyword{global} is a directive to the parser. It
Fred Drakef6669171998-05-06 19:52:49 +0000771applies only to code parsed at the same time as the \keyword{global}
772statement. In particular, a \keyword{global} statement contained in an
Fred Drakedde91f01998-05-06 20:59:46 +0000773\keyword{exec} statement does not affect the code block \emph{containing}
Fred Drakef6669171998-05-06 19:52:49 +0000774the \keyword{exec} statement, and code contained in an \keyword{exec}
775statement is unaffected by \keyword{global} statements in the code
776containing the \keyword{exec} statement. The same applies to the
777\function{eval()}, \function{execfile()} and \function{compile()} functions.
778\stindex{exec}
779\bifuncindex{eval}
780\bifuncindex{execfile}
781\bifuncindex{compile}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000782
Fred Drake2829f1c2001-06-23 05:27:20 +0000783
Fred Drake011f6fc1999-04-14 12:52:14 +0000784\section{The \keyword{exec} statement \label{exec}}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000785\stindex{exec}
786
Fred Drakecb4638a2001-07-06 22:49:53 +0000787\begin{productionlist}
788 \production{exec_stmt}
789 {"exec" \token{expression}
790 ["in" \token{expression} ["," \token{expression}]]}
791\end{productionlist}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000792
793This statement supports dynamic execution of Python code. The first
794expression should evaluate to either a string, an open file object, or
795a code object. If it is a string, the string is parsed as a suite of
796Python statements which is then executed (unless a syntax error
Fred Drake93852ef2001-06-23 06:06:52 +0000797occurs). If it is an open file, the file is parsed until \EOF{} and
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000798executed. If it is a code object, it is simply executed.
799
800In all cases, if the optional parts are omitted, the code is executed
801in the current scope. If only the first expression after \keyword{in}
802is specified, it should be a dictionary, which will be used for both
803the global and the local variables. If two expressions are given,
804both must be dictionaries and they are used for the global and local
805variables, respectively.
806
807As a side effect, an implementation may insert additional keys into
808the dictionaries given besides those corresponding to variable names
809set by the executed code. For example, the current implementation
810may add a reference to the dictionary of the built-in module
811\module{__builtin__} under the key \code{__builtins__} (!).
812\ttindex{__builtins__}
813\refbimodindex{__builtin__}
814
Guido van Rossum56c20131998-07-24 18:25:38 +0000815\strong{Programmer's hints:}
816dynamic evaluation of expressions is supported by the built-in
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000817function \function{eval()}. The built-in functions
818\function{globals()} and \function{locals()} return the current global
819and local dictionary, respectively, which may be useful to pass around
820for use by \keyword{exec}.
821\bifuncindex{eval}
822\bifuncindex{globals}
823\bifuncindex{locals}
Greg Ward38c28e32000-04-27 18:32:02 +0000824
825Also, in the current implementation, multi-line compound statements must
826end with a newline:
827\code{exec "for v in seq:\e{}n\e{}tprint v\e{}n"} works, but
828\code{exec "for v in seq:\e{}n\e{}tprint v"} fails with
829\exception{SyntaxError}.
830\exindex{SyntaxError}
831
832