blob: 29692406a1a970f67736afd6cff3f097539ea5fd [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}
65 \production{assert_statement}
66 {"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
303
Fred Drake011f6fc1999-04-14 12:52:14 +0000304\section{The \keyword{pass} statement \label{pass}}
Fred Drakef6669171998-05-06 19:52:49 +0000305\stindex{pass}
306
Fred Drakecb4638a2001-07-06 22:49:53 +0000307\begin{productionlist}
308 \production{pass_stmt}
309 {"pass"}
310\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000311
312\keyword{pass} is a null operation --- when it is executed, nothing
313happens. It is useful as a placeholder when a statement is
314required syntactically, but no code needs to be executed, for example:
315\indexii{null}{operation}
316
317\begin{verbatim}
318def f(arg): pass # a function that does nothing (yet)
319
320class C: pass # a class with no methods (yet)
321\end{verbatim}
322
Fred Drake2829f1c2001-06-23 05:27:20 +0000323
Fred Drake011f6fc1999-04-14 12:52:14 +0000324\section{The \keyword{del} statement \label{del}}
Fred Drakef6669171998-05-06 19:52:49 +0000325\stindex{del}
326
Fred Drakecb4638a2001-07-06 22:49:53 +0000327\begin{productionlist}
328 \production{del_stmt}
329 {"del" \token{target_list}}
330\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000331
332Deletion is recursively defined very similar to the way assignment is
333defined. Rather that spelling it out in full details, here are some
334hints.
335\indexii{deletion}{target}
336\indexiii{deletion}{target}{list}
337
338Deletion of a target list recursively deletes each target, from left
339to right.
340
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000341Deletion of a name removes the binding of that name
Guido van Rossum56c20131998-07-24 18:25:38 +0000342from the local or global namespace, depending on whether the name
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000343occurs in a \keyword{global} statement in the same code block. If the
344name is unbound, a \exception{NameError} exception will be raised.
Fred Drakef6669171998-05-06 19:52:49 +0000345\stindex{global}
346\indexii{unbinding}{name}
347
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000348It is illegal to delete a name from the local namespace if it occurs
349as a free variable\indexii{free}{varaible} in a nested block.
350
Fred Drakef6669171998-05-06 19:52:49 +0000351Deletion of attribute references, subscriptions and slicings
352is passed to the primary object involved; deletion of a slicing
353is in general equivalent to assignment of an empty slice of the
354right type (but even this is determined by the sliced object).
355\indexii{attribute}{deletion}
356
Fred Drake2829f1c2001-06-23 05:27:20 +0000357
Fred Drake011f6fc1999-04-14 12:52:14 +0000358\section{The \keyword{print} statement \label{print}}
Fred Drakef6669171998-05-06 19:52:49 +0000359\stindex{print}
360
Fred Drakecb4638a2001-07-06 22:49:53 +0000361\begin{productionlist}
362 \production{print_stmt}
Fred Drake53815882002-03-15 23:21:37 +0000363 {"print" ( \optional{\token{expression} ("," \token{expression})* \optional{","}}}
364 \productioncont{| ">\code{>}" \token{expression}
365 \optional{("," \token{expression})+ \optional{","}} )}
Fred Drakecb4638a2001-07-06 22:49:53 +0000366\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000367
Fred Draked4c33521998-10-01 20:39:47 +0000368\keyword{print} evaluates each expression in turn and writes the
369resulting object to standard output (see below). If an object is not
Fred Drakebe9d10e2001-06-23 06:16:52 +0000370a string, it is first converted to a string using the rules for string
Fred Drakef6669171998-05-06 19:52:49 +0000371conversions. The (resulting or original) string is then written. A
Fred Drakebe9d10e2001-06-23 06:16:52 +0000372space is written before each object is (converted and) written, unless
Fred Drakef6669171998-05-06 19:52:49 +0000373the output system believes it is positioned at the beginning of a
Guido van Rossum56c20131998-07-24 18:25:38 +0000374line. This is the case (1) when no characters have yet been written
375to standard output, (2) when the last character written to standard
Fred Draked4c33521998-10-01 20:39:47 +0000376output is \character{\e n}, or (3) when the last write operation on
377standard output was not a \keyword{print} statement. (In some cases
378it may be functional to write an empty string to standard output for
Fred Drakec2f496a2001-12-05 05:46:25 +0000379this reason.) \note{Objects which act like file objects but which are
380not the built-in file objects often do not properly emulate this
381aspect of the file object's behavior, so it is best not to rely on
382this.}
Fred Drakef6669171998-05-06 19:52:49 +0000383\index{output}
384\indexii{writing}{values}
385
Fred Draked4c33521998-10-01 20:39:47 +0000386A \character{\e n} character is written at the end, unless the
387\keyword{print} statement ends with a comma. This is the only action
388if the statement contains just the keyword \keyword{print}.
Fred Drakef6669171998-05-06 19:52:49 +0000389\indexii{trailing}{comma}
390\indexii{newline}{suppression}
391
Fred Drakedde91f01998-05-06 20:59:46 +0000392Standard output is defined as the file object named \code{stdout}
Guido van Rossum56c20131998-07-24 18:25:38 +0000393in the built-in module \module{sys}. If no such object exists, or if
394it does not have a \method{write()} method, a \exception{RuntimeError}
395exception is raised.
Fred Drakef6669171998-05-06 19:52:49 +0000396\indexii{standard}{output}
397\refbimodindex{sys}
Fred Drake2b3730e1998-11-25 17:40:00 +0000398\withsubitem{(in module sys)}{\ttindex{stdout}}
Fred Drakef6669171998-05-06 19:52:49 +0000399\exindex{RuntimeError}
400
Fred Drakecb4638a2001-07-06 22:49:53 +0000401\keyword{print} also has an extended\index{extended print statement}
402form, defined by the second portion of the syntax described above.
403This form is sometimes referred to as ``\keyword{print} chevron.''
Fred Drake62effc12001-04-13 15:55:25 +0000404In this form, the first expression after the \code{>}\code{>} must
Barry Warsaw8c0a2422000-08-21 15:45:16 +0000405evaluate to a ``file-like'' object, specifically an object that has a
Barry Warsaw33f785f2000-08-29 04:57:34 +0000406\method{write()} method as described above. With this extended form,
407the subsequent expressions are printed to this file object. If the
408first expression evaluates to \code{None}, then \code{sys.stdout} is
409used as the file for output.
Barry Warsaw8c0a2422000-08-21 15:45:16 +0000410
Fred Drake2829f1c2001-06-23 05:27:20 +0000411
Fred Drake011f6fc1999-04-14 12:52:14 +0000412\section{The \keyword{return} statement \label{return}}
Fred Drakef6669171998-05-06 19:52:49 +0000413\stindex{return}
414
Fred Drakecb4638a2001-07-06 22:49:53 +0000415\begin{productionlist}
416 \production{return_stmt}
417 {"return" [\token{expression_list}]}
418\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000419
420\keyword{return} may only occur syntactically nested in a function
421definition, not within a nested class definition.
422\indexii{function}{definition}
423\indexii{class}{definition}
424
Guido van Rossum56c20131998-07-24 18:25:38 +0000425If an expression list is present, it is evaluated, else \code{None}
Fred Drakef6669171998-05-06 19:52:49 +0000426is substituted.
427
Guido van Rossum56c20131998-07-24 18:25:38 +0000428\keyword{return} leaves the current function call with the expression
Fred Drakef6669171998-05-06 19:52:49 +0000429list (or \code{None}) as return value.
430
431When \keyword{return} passes control out of a \keyword{try} statement
Guido van Rossum56c20131998-07-24 18:25:38 +0000432with a \keyword{finally} clause, that \keyword{finally} clause is executed
Fred Drakef6669171998-05-06 19:52:49 +0000433before really leaving the function.
434\kwindex{finally}
435
Fred Drakee31e9ce2001-12-11 21:10:08 +0000436In a generator function, the \keyword{return} statement is not allowed
437to include an \grammartoken{expression_list}. In that context, a bare
438\keyword{return} indicates that the generator is done and will cause
439\exception{StopIteration} to be raised.
440
441
442\section{The \keyword{yield} statement \label{yield}}
443\stindex{yield}
444
445\begin{productionlist}
446 \production{yield_stmt}
447 {"yield" \token{expression_list}}
448\end{productionlist}
449
450\index{generator!function}
451\index{generator!iterator}
452\index{function!generator}
453\exindex{StopIteration}
454
455The \keyword{yield} statement is only used when defining a generator
456function, and is only used in the body of the generator function.
457Using a \keyword{yield} statement in a function definition is
458sufficient to cause that definition to create a generator function
459instead of a normal function.
460
461When a generator function is called, it returns an iterator known as a
462generator iterator, or more commonly, a generator. The body of the
463generator function is executed by calling the generator's
464\method{next()} method repeatedly until it raises an exception.
465
466When a \keyword{yield} statement is executed, the state of the
467generator is frozen and the value of \grammartoken{expression_list} is
468returned to \method{next()}'s caller. By ``frozen'' we mean that all
469local state is retained, including the current bindings of local
470variables, the instruction pointer, and the internal evaluation stack:
471enough information is saved so that the next time \method{next()} is
472invoked, the function can proceed exactly as if the \keyword{yield}
473statement were just another external call.
474
Fred Drake3a8e59e2001-12-11 21:58:35 +0000475The \keyword{yield} statement is not allowed in the \keyword{try}
476clause of a \keyword{try} ...\ \keyword{finally} construct. The
477difficulty is that there's no guarantee the generator will ever be
478resumed, hence no guarantee that the \keyword{finally} block will ever
479get executed.
Fred Drakee31e9ce2001-12-11 21:10:08 +0000480
Fred Drake08d752c2001-12-14 22:55:14 +0000481\begin{notice}
482In Python 2.2, the \keyword{yield} statement is only allowed
Fred Drake8d0645c2001-12-12 06:06:43 +0000483when the \code{generators} feature has been enabled. It will always
484be enabled in Python 2.3. This \code{__future__} import statment can
Fred Drake08d752c2001-12-14 22:55:14 +0000485be used to enable the feature:
Fred Drake8d0645c2001-12-12 06:06:43 +0000486
487\begin{verbatim}
488from __future__ import generators
489\end{verbatim}
Fred Drake08d752c2001-12-14 22:55:14 +0000490\end{notice}
Fred Drake8d0645c2001-12-12 06:06:43 +0000491
492
Fred Drakee31e9ce2001-12-11 21:10:08 +0000493\begin{seealso}
494 \seepep{0255}{Simple Generators}
495 {The proposal for adding generators and the \keyword{yield}
496 statement to Python.}
497\end{seealso}
498
Fred Drake2829f1c2001-06-23 05:27:20 +0000499
Fred Drake011f6fc1999-04-14 12:52:14 +0000500\section{The \keyword{raise} statement \label{raise}}
Fred Drakef6669171998-05-06 19:52:49 +0000501\stindex{raise}
502
Fred Drakecb4638a2001-07-06 22:49:53 +0000503\begin{productionlist}
504 \production{raise_stmt}
505 {"raise" [\token{expression} ["," \token{expression}
506 ["," \token{expression}]]]}
507\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000508
Guido van Rossum56c20131998-07-24 18:25:38 +0000509If no expressions are present, \keyword{raise} re-raises the last
510expression that was raised in the current scope.
511
Fred Drake011f6fc1999-04-14 12:52:14 +0000512Otherwise, \keyword{raise} evaluates its first expression, which must yield
Guido van Rossum56c20131998-07-24 18:25:38 +0000513a string, class, or instance object. If there is a second expression,
Fred Drakef6669171998-05-06 19:52:49 +0000514this is evaluated, else \code{None} is substituted. If the first
Guido van Rossumf5a80a41998-08-25 14:45:41 +0000515expression is a class object, then the second expression may be an
516instance of that class or one of its derivatives, and then that
517instance is raised. If the second expression is not such an instance,
518the given class is instantiated. The argument list for the
519instantiation is determined as follows: if the second expression is a
520tuple, it is used as the argument list; if it is \code{None}, the
521argument list is empty; otherwise, the argument list consists of a
522single argument which is the second expression. If the first
Guido van Rossum56c20131998-07-24 18:25:38 +0000523expression is an instance object, the second expression must be
Fred Drakef6669171998-05-06 19:52:49 +0000524\code{None}.
525\index{exception}
526\indexii{raising}{exception}
527
Guido van Rossumf5a80a41998-08-25 14:45:41 +0000528If the first object is a string, it then raises the exception
Fred Drakef6669171998-05-06 19:52:49 +0000529identified by the first object, with the second one (or \code{None})
Guido van Rossumf5a80a41998-08-25 14:45:41 +0000530as its parameter. If the first object is a class or instance,
531it raises the exception identified by the class of the instance
532determined in the previous step, with the instance as
533its parameter.
Fred Drakef6669171998-05-06 19:52:49 +0000534
Guido van Rossum56c20131998-07-24 18:25:38 +0000535If a third object is present, and it is not \code{None}, it should be
Fred Drakec2f496a2001-12-05 05:46:25 +0000536a traceback object (see section~\ref{traceback}), and it is
Fred Drakef6669171998-05-06 19:52:49 +0000537substituted instead of the current location as the place where the
538exception occurred. This is useful to re-raise an exception
539transparently in an except clause.
540\obindex{traceback}
541
Fred Drake2829f1c2001-06-23 05:27:20 +0000542
Fred Drake011f6fc1999-04-14 12:52:14 +0000543\section{The \keyword{break} statement \label{break}}
Fred Drakef6669171998-05-06 19:52:49 +0000544\stindex{break}
545
Fred Drakecb4638a2001-07-06 22:49:53 +0000546\begin{productionlist}
547 \production{break_stmt}
548 {"break"}
549\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000550
551\keyword{break} may only occur syntactically nested in a \keyword{for}
552or \keyword{while} loop, but not nested in a function or class definition
553within that loop.
554\stindex{for}
555\stindex{while}
556\indexii{loop}{statement}
557
558It terminates the nearest enclosing loop, skipping the optional
Guido van Rossum56c20131998-07-24 18:25:38 +0000559\keyword{else} clause if the loop has one.
Fred Drakef6669171998-05-06 19:52:49 +0000560\kwindex{else}
561
562If a \keyword{for} loop is terminated by \keyword{break}, the loop control
563target keeps its current value.
564\indexii{loop control}{target}
565
566When \keyword{break} passes control out of a \keyword{try} statement
Guido van Rossum56c20131998-07-24 18:25:38 +0000567with a \keyword{finally} clause, that \keyword{finally} clause is executed
Fred Drakef6669171998-05-06 19:52:49 +0000568before really leaving the loop.
569\kwindex{finally}
570
Fred Drake2829f1c2001-06-23 05:27:20 +0000571
Fred Drake011f6fc1999-04-14 12:52:14 +0000572\section{The \keyword{continue} statement \label{continue}}
Fred Drakef6669171998-05-06 19:52:49 +0000573\stindex{continue}
574
Fred Drakecb4638a2001-07-06 22:49:53 +0000575\begin{productionlist}
576 \production{continue_stmt}
577 {"continue"}
578\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000579
580\keyword{continue} may only occur syntactically nested in a \keyword{for} or
581\keyword{while} loop, but not nested in a function or class definition or
Guido van Rossum56c20131998-07-24 18:25:38 +0000582\keyword{try} statement within that loop.\footnote{It may
583occur within an \keyword{except} or \keyword{else} clause. The
Thomas Woutersf9b526d2000-07-16 19:05:38 +0000584restriction on occurring in the \keyword{try} clause is implementor's
Guido van Rossum56c20131998-07-24 18:25:38 +0000585laziness and will eventually be lifted.}
586It continues with the next cycle of the nearest enclosing loop.
Fred Drakef6669171998-05-06 19:52:49 +0000587\stindex{for}
588\stindex{while}
589\indexii{loop}{statement}
590\kwindex{finally}
591
Fred Drake2829f1c2001-06-23 05:27:20 +0000592
Fred Drake011f6fc1999-04-14 12:52:14 +0000593\section{The \keyword{import} statement \label{import}}
Fred Drakef6669171998-05-06 19:52:49 +0000594\stindex{import}
595
Fred Drakecb4638a2001-07-06 22:49:53 +0000596\begin{productionlist}
597 \production{import_stmt}
598 {"import" \token{module} ["as" \token{name}]
Fred Drake53815882002-03-15 23:21:37 +0000599 ( "," \token{module} ["as" \token{name}] )*}
600 \productioncont{| "from" \token{module} "import" \token{identifier}
601 ["as" \token{name}]}
602 \productioncont{ ( "," \token{identifier} ["as" \token{name}] )*}
603 \productioncont{| "from" \token{module} "import" "*"}
Fred Drakecb4638a2001-07-06 22:49:53 +0000604 \production{module}
605 {(\token{identifier} ".")* \token{identifier}}
606\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000607
608Import statements are executed in two steps: (1) find a module, and
609initialize it if necessary; (2) define a name or names in the local
Guido van Rossum56c20131998-07-24 18:25:38 +0000610namespace (of the scope where the \keyword{import} statement occurs).
Fred Drakef6669171998-05-06 19:52:49 +0000611The first form (without \keyword{from}) repeats these steps for each
Guido van Rossum56c20131998-07-24 18:25:38 +0000612identifier in the list. The form with \keyword{from} performs step
613(1) once, and then performs step (2) repeatedly.
Fred Drakef6669171998-05-06 19:52:49 +0000614\indexii{importing}{module}
615\indexii{name}{binding}
616\kwindex{from}
Guido van Rossumb1f97d61998-12-21 18:57:36 +0000617% XXX Need to define what ``initialize'' means here
Fred Drakef6669171998-05-06 19:52:49 +0000618
619The system maintains a table of modules that have been initialized,
Fred Drake191a2822000-07-06 00:50:42 +0000620indexed by module name. This table is
Guido van Rossum56c20131998-07-24 18:25:38 +0000621accessible as \code{sys.modules}. When a module name is found in
Fred Drakef6669171998-05-06 19:52:49 +0000622this table, step (1) is finished. If not, a search for a module
Guido van Rossum56c20131998-07-24 18:25:38 +0000623definition is started. When a module is found, it is loaded. Details
624of the module searching and loading process are implementation and
625platform specific. It generally involves searching for a ``built-in''
626module with the given name and then searching a list of locations
627given as \code{sys.path}.
Fred Drake2b3730e1998-11-25 17:40:00 +0000628\withsubitem{(in module sys)}{\ttindex{modules}}
Fred Drakef6669171998-05-06 19:52:49 +0000629\ttindex{sys.modules}
630\indexii{module}{name}
631\indexii{built-in}{module}
632\indexii{user-defined}{module}
633\refbimodindex{sys}
Fred Drakef6669171998-05-06 19:52:49 +0000634\indexii{filename}{extension}
Fred Drakedde91f01998-05-06 20:59:46 +0000635\indexiii{module}{search}{path}
Fred Drakef6669171998-05-06 19:52:49 +0000636
637If a built-in module is found, its built-in initialization code is
638executed and step (1) is finished. If no matching file is found,
639\exception{ImportError} is raised. If a file is found, it is parsed,
640yielding an executable code block. If a syntax error occurs,
641\exception{SyntaxError} is raised. Otherwise, an empty module of the given
642name is created and inserted in the module table, and then the code
643block is executed in the context of this module. Exceptions during
644this execution terminate step (1).
645\indexii{module}{initialization}
646\exindex{SyntaxError}
647\exindex{ImportError}
648\index{code block}
649
650When step (1) finishes without raising an exception, step (2) can
651begin.
652
Fred Drake859eb622001-03-06 07:34:00 +0000653The first form of \keyword{import} statement binds the module name in
654the local namespace to the module object, and then goes on to import
655the next identifier, if any. If the module name is followed by
656\keyword{as}, the name following \keyword{as} is used as the local
657name for the module. To avoid confusion, you cannot import modules
658with dotted names \keyword{as} a different local name. So \code{import
659module as m} is legal, but \code{import module.submod as s} is not.
660The latter should be written as \code{from module import submod as s};
Thomas Wouters8bad6122000-08-19 20:55:02 +0000661see below.
662
Thomas Wouters52152252000-08-17 22:55:00 +0000663The \keyword{from} form does not bind the module name: it goes through the
664list of identifiers, looks each one of them up in the module found in step
665(1), and binds the name in the local namespace to the object thus found.
Fred Draked68442b2000-09-21 22:01:36 +0000666As with the first form of \keyword{import}, an alternate local name can be
Thomas Wouters52152252000-08-17 22:55:00 +0000667supplied by specifying "\keyword{as} localname". If a name is not found,
Fred Drakef6669171998-05-06 19:52:49 +0000668\exception{ImportError} is raised. If the list of identifiers is replaced
Fred Drake08fd5152001-10-24 19:50:31 +0000669by a star (\character{*}), all public names defined in the module are
670bound in the local namespace of the \keyword{import} statement..
Fred Drakef6669171998-05-06 19:52:49 +0000671\indexii{name}{binding}
672\exindex{ImportError}
673
Fred Drake08fd5152001-10-24 19:50:31 +0000674The \emph{public names} defined by a module are determined by checking
675the module's namespace for a variable named \code{__all__}; if
676defined, it must be a sequence of strings which are names defined or
677imported by that module. The names given in \code{__all__} are all
678considered public and are required to exist. If \code{__all__} is not
679defined, the set of public names includes all names found in the
680module's namespace which do not begin with an underscore character
681(\character{_}).
682
Jeremy Hyltonf0c1f1b2002-04-01 21:19:44 +0000683The \keyword{from} form with \samp{*} may only occur in a module
684scope. If the wild card form of import --- \samp{import *} --- is
685used in a function and the function contains or is a nested block with
686free variables, the compiler will raise a \exception{SyntaxError}.
687
Fred Drakef6669171998-05-06 19:52:49 +0000688\kwindex{from}
Fred Drake2b3730e1998-11-25 17:40:00 +0000689\stindex{from}
Fred Drakef6669171998-05-06 19:52:49 +0000690
Fred Drake246837d1998-07-24 20:28:22 +0000691\strong{Hierarchical module names:}\indexiii{hierarchical}{module}{names}
Guido van Rossum56c20131998-07-24 18:25:38 +0000692when the module names contains one or more dots, the module search
693path is carried out differently. The sequence of identifiers up to
694the last dot is used to find a ``package''\index{packages}; the final
695identifier is then searched inside the package. A package is
696generally a subdirectory of a directory on \code{sys.path} that has a
697file \file{__init__.py}.\ttindex{__init__.py}
698%
699[XXX Can't be bothered to spell this out right now; see the URL
Fred Drake1a0b8721998-08-07 17:40:20 +0000700\url{http://www.python.org/doc/essays/packages.html} for more details, also
Guido van Rossum56c20131998-07-24 18:25:38 +0000701about how the module search works from inside a package.]
702
Fred Drake08fd5152001-10-24 19:50:31 +0000703The built-in function \function{__import__()} is provided to support
704applications that determine which modules need to be loaded
705dynamically; refer to \ulink{Built-in
706Functions}{../lib/built-in-funcs.html} in the
707\citetitle[../lib/lib.html]{Python Library Reference} for additional
708information.
Guido van Rossum56c20131998-07-24 18:25:38 +0000709\bifuncindex{__import__}
710
Fred Drake2829f1c2001-06-23 05:27:20 +0000711
Fred Drake011f6fc1999-04-14 12:52:14 +0000712\section{The \keyword{global} statement \label{global}}
Fred Drakef6669171998-05-06 19:52:49 +0000713\stindex{global}
714
Fred Drakecb4638a2001-07-06 22:49:53 +0000715\begin{productionlist}
716 \production{global_stmt}
717 {"global" \token{identifier} ("," \token{identifier})*}
718\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000719
720The \keyword{global} statement is a declaration which holds for the
721entire current code block. It means that the listed identifiers are to be
Jeremy Hyltonf3255c82002-04-01 21:25:32 +0000722interpreted as globals. It would be impossible to assign to a global
723variable without \keyword{global}, although free variables may refer
724to globals without being declared global.
Fred Drakef6669171998-05-06 19:52:49 +0000725\indexiii{global}{name}{binding}
726
727Names listed in a \keyword{global} statement must not be used in the same
Guido van Rossumb1f97d61998-12-21 18:57:36 +0000728code block textually preceding that \keyword{global} statement.
Fred Drakef6669171998-05-06 19:52:49 +0000729
730Names listed in a \keyword{global} statement must not be defined as formal
731parameters or in a \keyword{for} loop control target, \keyword{class}
732definition, function definition, or \keyword{import} statement.
733
734(The current implementation does not enforce the latter two
735restrictions, but programs should not abuse this freedom, as future
736implementations may enforce them or silently change the meaning of the
737program.)
738
Guido van Rossum56c20131998-07-24 18:25:38 +0000739\strong{Programmer's note:}
740the \keyword{global} is a directive to the parser. It
Fred Drakef6669171998-05-06 19:52:49 +0000741applies only to code parsed at the same time as the \keyword{global}
742statement. In particular, a \keyword{global} statement contained in an
Fred Drakedde91f01998-05-06 20:59:46 +0000743\keyword{exec} statement does not affect the code block \emph{containing}
Fred Drakef6669171998-05-06 19:52:49 +0000744the \keyword{exec} statement, and code contained in an \keyword{exec}
745statement is unaffected by \keyword{global} statements in the code
746containing the \keyword{exec} statement. The same applies to the
747\function{eval()}, \function{execfile()} and \function{compile()} functions.
748\stindex{exec}
749\bifuncindex{eval}
750\bifuncindex{execfile}
751\bifuncindex{compile}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000752
Fred Drake2829f1c2001-06-23 05:27:20 +0000753
Fred Drake011f6fc1999-04-14 12:52:14 +0000754\section{The \keyword{exec} statement \label{exec}}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000755\stindex{exec}
756
Fred Drakecb4638a2001-07-06 22:49:53 +0000757\begin{productionlist}
758 \production{exec_stmt}
759 {"exec" \token{expression}
760 ["in" \token{expression} ["," \token{expression}]]}
761\end{productionlist}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000762
763This statement supports dynamic execution of Python code. The first
764expression should evaluate to either a string, an open file object, or
765a code object. If it is a string, the string is parsed as a suite of
766Python statements which is then executed (unless a syntax error
Fred Drake93852ef2001-06-23 06:06:52 +0000767occurs). If it is an open file, the file is parsed until \EOF{} and
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000768executed. If it is a code object, it is simply executed.
769
770In all cases, if the optional parts are omitted, the code is executed
771in the current scope. If only the first expression after \keyword{in}
772is specified, it should be a dictionary, which will be used for both
773the global and the local variables. If two expressions are given,
774both must be dictionaries and they are used for the global and local
775variables, respectively.
776
777As a side effect, an implementation may insert additional keys into
778the dictionaries given besides those corresponding to variable names
779set by the executed code. For example, the current implementation
780may add a reference to the dictionary of the built-in module
781\module{__builtin__} under the key \code{__builtins__} (!).
782\ttindex{__builtins__}
783\refbimodindex{__builtin__}
784
Guido van Rossum56c20131998-07-24 18:25:38 +0000785\strong{Programmer's hints:}
786dynamic evaluation of expressions is supported by the built-in
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000787function \function{eval()}. The built-in functions
788\function{globals()} and \function{locals()} return the current global
789and local dictionary, respectively, which may be useful to pass around
790for use by \keyword{exec}.
791\bifuncindex{eval}
792\bifuncindex{globals}
793\bifuncindex{locals}
Greg Ward38c28e32000-04-27 18:32:02 +0000794
795Also, in the current implementation, multi-line compound statements must
796end with a newline:
797\code{exec "for v in seq:\e{}n\e{}tprint v\e{}n"} works, but
798\code{exec "for v in seq:\e{}n\e{}tprint v"} fails with
799\exception{SyntaxError}.
800\exindex{SyntaxError}
801
802