blob: 04db0131ea62846106cd241a0d201ce13596a265 [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 Drake7a700b82004-01-01 05:43:53 +000051\obindex{None}
Fred Drakef6669171998-05-06 19:52:49 +000052\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
Johannes Gijsbersf4a70f32004-12-12 16:52:40 +000087built-in variable \code{__debug__} is \code{True} under normal
88circumstances, \code{False} when optimization is requested (command line
89option -O). The current code generator emits no code for an assert
90statement when optimization is requested at compile time. Note that it
91is unnecessary to include the source code for the expression that failed
92in the error message;
Guido van Rossum56c20131998-07-24 18:25:38 +000093it will be displayed as part of the stack trace.
94
Jeremy Hylton2c84fc82001-03-23 14:34:06 +000095Assignments to \code{__debug__} are illegal. The value for the
96built-in variable is determined when the interpreter starts.
Guido van Rossum56c20131998-07-24 18:25:38 +000097
Fred Drake2829f1c2001-06-23 05:27:20 +000098
Fred Drake011f6fc1999-04-14 12:52:14 +000099\section{Assignment statements \label{assignment}}
Fred Drakef6669171998-05-06 19:52:49 +0000100
Fred Drake011f6fc1999-04-14 12:52:14 +0000101Assignment statements\indexii{assignment}{statement} are used to
102(re)bind names to values and to modify attributes or items of mutable
103objects:
Fred Drakef6669171998-05-06 19:52:49 +0000104\indexii{binding}{name}
105\indexii{rebinding}{name}
106\obindex{mutable}
107\indexii{attribute}{assignment}
108
Fred Drakecb4638a2001-07-06 22:49:53 +0000109\begin{productionlist}
110 \production{assignment_stmt}
111 {(\token{target_list} "=")+ \token{expression_list}}
112 \production{target_list}
113 {\token{target} ("," \token{target})* [","]}
114 \production{target}
Fred Drake53815882002-03-15 23:21:37 +0000115 {\token{identifier}}
116 \productioncont{| "(" \token{target_list} ")"}
117 \productioncont{| "[" \token{target_list} "]"}
118 \productioncont{| \token{attributeref}}
119 \productioncont{| \token{subscription}}
120 \productioncont{| \token{slicing}}
Fred Drakecb4638a2001-07-06 22:49:53 +0000121\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000122
Fred Drakec2f496a2001-12-05 05:46:25 +0000123(See section~\ref{primaries} for the syntax definitions for the last
Fred Drakef6669171998-05-06 19:52:49 +0000124three symbols.)
125
126An assignment statement evaluates the expression list (remember that
127this can be a single expression or a comma-separated list, the latter
128yielding a tuple) and assigns the single resulting object to each of
129the target lists, from left to right.
130\indexii{expression}{list}
131
132Assignment is defined recursively depending on the form of the target
133(list). When a target is part of a mutable object (an attribute
134reference, subscription or slicing), the mutable object must
135ultimately perform the assignment and decide about its validity, and
136may raise an exception if the assignment is unacceptable. The rules
137observed by various types and the exceptions raised are given with the
Fred Drakec2f496a2001-12-05 05:46:25 +0000138definition of the object types (see section~\ref{types}).
Fred Drakef6669171998-05-06 19:52:49 +0000139\index{target}
140\indexii{target}{list}
141
142Assignment of an object to a target list is recursively defined as
143follows.
144\indexiii{target}{list}{assignment}
145
146\begin{itemize}
147\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000148If the target list is a single target: The object is assigned to that
Fred Drakef6669171998-05-06 19:52:49 +0000149target.
150
151\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000152If the target list is a comma-separated list of targets: The object
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000153must be a sequence with the same number of items as there are
Guido van Rossum56c20131998-07-24 18:25:38 +0000154targets in the target list, and the items are assigned, from left to
155right, to the corresponding targets. (This rule is relaxed as of
156Python 1.5; in earlier versions, the object had to be a tuple. Since
Fred Drake011f6fc1999-04-14 12:52:14 +0000157strings are sequences, an assignment like \samp{a, b = "xy"} is
Guido van Rossum56c20131998-07-24 18:25:38 +0000158now legal as long as the string has the right length.)
Fred Drakef6669171998-05-06 19:52:49 +0000159
160\end{itemize}
161
162Assignment of an object to a single target is recursively defined as
163follows.
164
165\begin{itemize} % nested
166
167\item
168If the target is an identifier (name):
169
170\begin{itemize}
171
172\item
173If the name does not occur in a \keyword{global} statement in the current
Guido van Rossum56c20131998-07-24 18:25:38 +0000174code block: the name is bound to the object in the current local
175namespace.
Fred Drakef6669171998-05-06 19:52:49 +0000176\stindex{global}
177
178\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000179Otherwise: the name is bound to the object in the current global
180namespace.
Fred Drakef6669171998-05-06 19:52:49 +0000181
182\end{itemize} % nested
183
Guido van Rossum56c20131998-07-24 18:25:38 +0000184The name is rebound if it was already bound. This may cause the
185reference count for the object previously bound to the name to reach
186zero, causing the object to be deallocated and its
187destructor\index{destructor} (if it has one) to be called.
Fred Drakef6669171998-05-06 19:52:49 +0000188
189\item
Guido van Rossum56c20131998-07-24 18:25:38 +0000190If the target is a target list enclosed in parentheses or in square
191brackets: The object must be a sequence with the same number of items
192as there are targets in the target list, and its items are assigned,
193from left to right, to the corresponding targets.
Fred Drakef6669171998-05-06 19:52:49 +0000194
195\item
196If the target is an attribute reference: The primary expression in the
197reference is evaluated. It should yield an object with assignable
198attributes; if this is not the case, \exception{TypeError} is raised. That
199object is then asked to assign the assigned object to the given
200attribute; if it cannot perform the assignment, it raises an exception
201(usually but not necessarily \exception{AttributeError}).
202\indexii{attribute}{assignment}
203
204\item
205If the target is a subscription: The primary expression in the
206reference is evaluated. It should yield either a mutable sequence
Raymond Hettingerb56b4942005-04-28 07:18:47 +0000207object (such as a list) or a mapping object (such as a dictionary). Next,
Guido van Rossum56c20131998-07-24 18:25:38 +0000208the subscript expression is evaluated.
Fred Drakef6669171998-05-06 19:52:49 +0000209\indexii{subscription}{assignment}
210\obindex{mutable}
211
Raymond Hettingerb56b4942005-04-28 07:18:47 +0000212If the primary is a mutable sequence object (such as a list), the subscript
Fred Drakef6669171998-05-06 19:52:49 +0000213must yield a plain integer. If it is negative, the sequence's length
214is added to it. The resulting value must be a nonnegative integer
215less than the sequence's length, and the sequence is asked to assign
216the assigned object to its item with that index. If the index is out
217of range, \exception{IndexError} is raised (assignment to a subscripted
218sequence cannot add new items to a list).
219\obindex{sequence}
220\obindex{list}
221
Raymond Hettingerb56b4942005-04-28 07:18:47 +0000222If the primary is a mapping object (such as a dictionary), the subscript must
Fred Drakef6669171998-05-06 19:52:49 +0000223have a type compatible with the mapping's key type, and the mapping is
224then asked to create a key/datum pair which maps the subscript to
225the assigned object. This can either replace an existing key/value
226pair with the same key value, or insert a new key/value pair (if no
227key with the same value existed).
228\obindex{mapping}
229\obindex{dictionary}
230
231\item
232If the target is a slicing: The primary expression in the reference is
Raymond Hettingerb56b4942005-04-28 07:18:47 +0000233evaluated. It should yield a mutable sequence object (such as a list). The
Fred Drakef6669171998-05-06 19:52:49 +0000234assigned object should be a sequence object of the same type. Next,
235the lower and upper bound expressions are evaluated, insofar they are
236present; defaults are zero and the sequence's length. The bounds
237should evaluate to (small) integers. If either bound is negative, the
238sequence's length is added to it. The resulting bounds are clipped to
239lie between zero and the sequence's length, inclusive. Finally, the
240sequence object is asked to replace the slice with the items of the
241assigned sequence. The length of the slice may be different from the
242length of the assigned sequence, thus changing the length of the
243target sequence, if the object allows it.
244\indexii{slicing}{assignment}
245
246\end{itemize}
Greg Ward38c28e32000-04-27 18:32:02 +0000247
Fred Drakef6669171998-05-06 19:52:49 +0000248(In the current implementation, the syntax for targets is taken
249to be the same as for expressions, and invalid syntax is rejected
250during the code generation phase, causing less detailed error
251messages.)
252
253WARNING: Although the definition of assignment implies that overlaps
Raymond Hettingerb56b4942005-04-28 07:18:47 +0000254between the left-hand side and the right-hand side are `safe' (for example
Fred Drake011f6fc1999-04-14 12:52:14 +0000255\samp{a, b = b, a} swaps two variables), overlaps \emph{within} the
Fred Drakef6669171998-05-06 19:52:49 +0000256collection of assigned-to variables are not safe! For instance, the
Fred Drake011f6fc1999-04-14 12:52:14 +0000257following program prints \samp{[0, 2]}:
Fred Drakef6669171998-05-06 19:52:49 +0000258
259\begin{verbatim}
260x = [0, 1]
261i = 0
262i, x[i] = 1, 2
263print x
264\end{verbatim}
265
266
Fred Drake53815882002-03-15 23:21:37 +0000267\subsection{Augmented assignment statements \label{augassign}}
Fred Drake31f55502000-09-12 20:32:18 +0000268
269Augmented assignment is the combination, in a single statement, of a binary
270operation and an assignment statement:
271\indexii{augmented}{assignment}
272\index{statement!assignment, augmented}
273
Fred Drakecb4638a2001-07-06 22:49:53 +0000274\begin{productionlist}
275 \production{augmented_assignment_stmt}
276 {\token{target} \token{augop} \token{expression_list}}
277 \production{augop}
Fred Drake53815882002-03-15 23:21:37 +0000278 {"+=" | "-=" | "*=" | "/=" | "\%=" | "**="}
Fred Drake2269d862004-11-11 06:14:05 +0000279 % The empty groups below prevent conversion to guillemets.
280 \productioncont{| ">{}>=" | "<{}<=" | "\&=" | "\textasciicircum=" | "|="}
Fred Drakecb4638a2001-07-06 22:49:53 +0000281\end{productionlist}
Fred Drake31f55502000-09-12 20:32:18 +0000282
Fred Drakec2f496a2001-12-05 05:46:25 +0000283(See section~\ref{primaries} for the syntax definitions for the last
Fred Drake31f55502000-09-12 20:32:18 +0000284three symbols.)
285
Fred Draked68442b2000-09-21 22:01:36 +0000286An augmented assignment evaluates the target (which, unlike normal
287assignment statements, cannot be an unpacking) and the expression
288list, performs the binary operation specific to the type of assignment
289on the two operands, and assigns the result to the original
290target. The target is only evaluated once.
Fred Drake31f55502000-09-12 20:32:18 +0000291
292An augmented assignment expression like \code{x += 1} can be rewritten as
293\code{x = x + 1} to achieve a similar, but not exactly equal effect. In the
294augmented version, \code{x} is only evaluated once. Also, when possible, the
295actual operation is performed \emph{in-place}, meaning that rather than
296creating a new object and assigning that to the target, the old object is
297modified instead.
298
299With the exception of assigning to tuples and multiple targets in a single
300statement, the assignment done by augmented assignment statements is handled
301the same way as normal assignments. Similarly, with the exception of the
Fred Drakec2f496a2001-12-05 05:46:25 +0000302possible \emph{in-place} behavior, the binary operation performed by
Fred Drake31f55502000-09-12 20:32:18 +0000303augmented assignment is the same as the normal binary operations.
304
Raymond Hettinger04e7e0c2002-06-25 13:36:41 +0000305For targets which are attribute references, the initial value is
306retrieved with a \method{getattr()} and the result is assigned with a
307\method{setattr()}. Notice that the two methods do not necessarily
308refer to the same variable. When \method{getattr()} refers to a class
309variable, \method{setattr()} still writes to an instance variable.
310For example:
311
312\begin{verbatim}
313class A:
314 x = 3 # class variable
315a = A()
316a.x += 1 # writes a.x as 4 leaving A.x as 3
317\end{verbatim}
318
Fred Drake31f55502000-09-12 20:32:18 +0000319
Fred Drake011f6fc1999-04-14 12:52:14 +0000320\section{The \keyword{pass} statement \label{pass}}
Fred Drakef6669171998-05-06 19:52:49 +0000321\stindex{pass}
322
Fred Drakecb4638a2001-07-06 22:49:53 +0000323\begin{productionlist}
324 \production{pass_stmt}
325 {"pass"}
326\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000327
328\keyword{pass} is a null operation --- when it is executed, nothing
329happens. It is useful as a placeholder when a statement is
330required syntactically, but no code needs to be executed, for example:
331\indexii{null}{operation}
332
333\begin{verbatim}
334def f(arg): pass # a function that does nothing (yet)
335
336class C: pass # a class with no methods (yet)
337\end{verbatim}
338
Fred Drake2829f1c2001-06-23 05:27:20 +0000339
Fred Drake011f6fc1999-04-14 12:52:14 +0000340\section{The \keyword{del} statement \label{del}}
Fred Drakef6669171998-05-06 19:52:49 +0000341\stindex{del}
342
Fred Drakecb4638a2001-07-06 22:49:53 +0000343\begin{productionlist}
344 \production{del_stmt}
345 {"del" \token{target_list}}
346\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000347
348Deletion is recursively defined very similar to the way assignment is
349defined. Rather that spelling it out in full details, here are some
350hints.
351\indexii{deletion}{target}
352\indexiii{deletion}{target}{list}
353
354Deletion of a target list recursively deletes each target, from left
355to right.
356
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000357Deletion of a name removes the binding of that name
Guido van Rossum56c20131998-07-24 18:25:38 +0000358from the local or global namespace, depending on whether the name
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000359occurs in a \keyword{global} statement in the same code block. If the
360name is unbound, a \exception{NameError} exception will be raised.
Fred Drakef6669171998-05-06 19:52:49 +0000361\stindex{global}
362\indexii{unbinding}{name}
363
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000364It is illegal to delete a name from the local namespace if it occurs
Michael W. Hudson495afea2002-06-17 12:51:57 +0000365as a free variable\indexii{free}{variable} in a nested block.
Jeremy Hyltond09ed682002-04-01 21:15:14 +0000366
Fred Drakef6669171998-05-06 19:52:49 +0000367Deletion of attribute references, subscriptions and slicings
368is passed to the primary object involved; deletion of a slicing
369is in general equivalent to assignment of an empty slice of the
370right type (but even this is determined by the sliced object).
371\indexii{attribute}{deletion}
372
Fred Drake2829f1c2001-06-23 05:27:20 +0000373
Fred Drake011f6fc1999-04-14 12:52:14 +0000374\section{The \keyword{print} statement \label{print}}
Fred Drakef6669171998-05-06 19:52:49 +0000375\stindex{print}
376
Fred Drakecb4638a2001-07-06 22:49:53 +0000377\begin{productionlist}
378 \production{print_stmt}
Fred Drake53815882002-03-15 23:21:37 +0000379 {"print" ( \optional{\token{expression} ("," \token{expression})* \optional{","}}}
Thomas Wouters477c8d52006-05-27 19:21:47 +0000380 \productioncont{| ">>" \token{expression}
Fred Drake53815882002-03-15 23:21:37 +0000381 \optional{("," \token{expression})+ \optional{","}} )}
Fred Drakecb4638a2001-07-06 22:49:53 +0000382\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000383
Fred Draked4c33521998-10-01 20:39:47 +0000384\keyword{print} evaluates each expression in turn and writes the
385resulting object to standard output (see below). If an object is not
Fred Drakebe9d10e2001-06-23 06:16:52 +0000386a string, it is first converted to a string using the rules for string
Fred Drakef6669171998-05-06 19:52:49 +0000387conversions. The (resulting or original) string is then written. A
Fred Drakebe9d10e2001-06-23 06:16:52 +0000388space is written before each object is (converted and) written, unless
Fred Drakef6669171998-05-06 19:52:49 +0000389the output system believes it is positioned at the beginning of a
Guido van Rossum56c20131998-07-24 18:25:38 +0000390line. This is the case (1) when no characters have yet been written
391to standard output, (2) when the last character written to standard
Fred Draked4c33521998-10-01 20:39:47 +0000392output is \character{\e n}, or (3) when the last write operation on
393standard output was not a \keyword{print} statement. (In some cases
394it may be functional to write an empty string to standard output for
Fred Drakec2f496a2001-12-05 05:46:25 +0000395this reason.) \note{Objects which act like file objects but which are
396not the built-in file objects often do not properly emulate this
397aspect of the file object's behavior, so it is best not to rely on
398this.}
Fred Drakef6669171998-05-06 19:52:49 +0000399\index{output}
400\indexii{writing}{values}
401
Fred Draked4c33521998-10-01 20:39:47 +0000402A \character{\e n} character is written at the end, unless the
403\keyword{print} statement ends with a comma. This is the only action
404if the statement contains just the keyword \keyword{print}.
Fred Drakef6669171998-05-06 19:52:49 +0000405\indexii{trailing}{comma}
406\indexii{newline}{suppression}
407
Fred Drakedde91f01998-05-06 20:59:46 +0000408Standard output is defined as the file object named \code{stdout}
Guido van Rossum56c20131998-07-24 18:25:38 +0000409in the built-in module \module{sys}. If no such object exists, or if
410it does not have a \method{write()} method, a \exception{RuntimeError}
411exception is raised.
Fred Drakef6669171998-05-06 19:52:49 +0000412\indexii{standard}{output}
413\refbimodindex{sys}
Fred Drake2b3730e1998-11-25 17:40:00 +0000414\withsubitem{(in module sys)}{\ttindex{stdout}}
Fred Drakef6669171998-05-06 19:52:49 +0000415\exindex{RuntimeError}
416
Fred Drakecb4638a2001-07-06 22:49:53 +0000417\keyword{print} also has an extended\index{extended print statement}
418form, defined by the second portion of the syntax described above.
419This form is sometimes referred to as ``\keyword{print} chevron.''
Thomas Wouters477c8d52006-05-27 19:21:47 +0000420In this form, the first expression after the \code{>>} must
Barry Warsaw8c0a2422000-08-21 15:45:16 +0000421evaluate to a ``file-like'' object, specifically an object that has a
Barry Warsaw33f785f2000-08-29 04:57:34 +0000422\method{write()} method as described above. With this extended form,
423the subsequent expressions are printed to this file object. If the
424first expression evaluates to \code{None}, then \code{sys.stdout} is
425used as the file for output.
Barry Warsaw8c0a2422000-08-21 15:45:16 +0000426
Fred Drake2829f1c2001-06-23 05:27:20 +0000427
Fred Drake011f6fc1999-04-14 12:52:14 +0000428\section{The \keyword{return} statement \label{return}}
Fred Drakef6669171998-05-06 19:52:49 +0000429\stindex{return}
430
Fred Drakecb4638a2001-07-06 22:49:53 +0000431\begin{productionlist}
432 \production{return_stmt}
433 {"return" [\token{expression_list}]}
434\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000435
436\keyword{return} may only occur syntactically nested in a function
437definition, not within a nested class definition.
438\indexii{function}{definition}
439\indexii{class}{definition}
440
Guido van Rossum56c20131998-07-24 18:25:38 +0000441If an expression list is present, it is evaluated, else \code{None}
Fred Drakef6669171998-05-06 19:52:49 +0000442is substituted.
443
Guido van Rossum56c20131998-07-24 18:25:38 +0000444\keyword{return} leaves the current function call with the expression
Fred Drakef6669171998-05-06 19:52:49 +0000445list (or \code{None}) as return value.
446
447When \keyword{return} passes control out of a \keyword{try} statement
Guido van Rossum56c20131998-07-24 18:25:38 +0000448with a \keyword{finally} clause, that \keyword{finally} clause is executed
Fred Drakef6669171998-05-06 19:52:49 +0000449before really leaving the function.
450\kwindex{finally}
451
Fred Drakee31e9ce2001-12-11 21:10:08 +0000452In a generator function, the \keyword{return} statement is not allowed
453to include an \grammartoken{expression_list}. In that context, a bare
454\keyword{return} indicates that the generator is done and will cause
455\exception{StopIteration} to be raised.
456
457
458\section{The \keyword{yield} statement \label{yield}}
459\stindex{yield}
460
461\begin{productionlist}
462 \production{yield_stmt}
463 {"yield" \token{expression_list}}
464\end{productionlist}
465
466\index{generator!function}
467\index{generator!iterator}
468\index{function!generator}
469\exindex{StopIteration}
470
471The \keyword{yield} statement is only used when defining a generator
472function, and is only used in the body of the generator function.
473Using a \keyword{yield} statement in a function definition is
474sufficient to cause that definition to create a generator function
475instead of a normal function.
476
477When a generator function is called, it returns an iterator known as a
478generator iterator, or more commonly, a generator. The body of the
479generator function is executed by calling the generator's
480\method{next()} method repeatedly until it raises an exception.
481
482When a \keyword{yield} statement is executed, the state of the
483generator is frozen and the value of \grammartoken{expression_list} is
484returned to \method{next()}'s caller. By ``frozen'' we mean that all
485local state is retained, including the current bindings of local
486variables, the instruction pointer, and the internal evaluation stack:
487enough information is saved so that the next time \method{next()} is
488invoked, the function can proceed exactly as if the \keyword{yield}
489statement were just another external call.
490
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000491As of Python version 2.5, the \keyword{yield} statement is now
492allowed in the \keyword{try} clause of a \keyword{try} ...\
493\keyword{finally} construct. If the generator is not resumed before
494it is finalized (by reaching a zero reference count or by being garbage
495collected), the generator-iterator's \method{close()} method will be
496called, allowing any pending \keyword{finally} clauses to execute.
Fred Drakee31e9ce2001-12-11 21:10:08 +0000497
Fred Drake08d752c2001-12-14 22:55:14 +0000498\begin{notice}
499In Python 2.2, the \keyword{yield} statement is only allowed
Fred Drake8d0645c2001-12-12 06:06:43 +0000500when the \code{generators} feature has been enabled. It will always
Raymond Hettinger68804312005-01-01 00:28:46 +0000501be enabled in Python 2.3. This \code{__future__} import statement can
Fred Drake08d752c2001-12-14 22:55:14 +0000502be used to enable the feature:
Fred Drake8d0645c2001-12-12 06:06:43 +0000503
504\begin{verbatim}
505from __future__ import generators
506\end{verbatim}
Fred Drake08d752c2001-12-14 22:55:14 +0000507\end{notice}
Fred Drake8d0645c2001-12-12 06:06:43 +0000508
509
Fred Drakee31e9ce2001-12-11 21:10:08 +0000510\begin{seealso}
511 \seepep{0255}{Simple Generators}
512 {The proposal for adding generators and the \keyword{yield}
513 statement to Python.}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000514
515 \seepep{0342}{Coroutines via Enhanced Generators}
516 {The proposal that, among other generator enhancements,
517 proposed allowing \keyword{yield} to appear inside a
518 \keyword{try} ... \keyword{finally} block.}
Fred Drakee31e9ce2001-12-11 21:10:08 +0000519\end{seealso}
520
Fred Drake2829f1c2001-06-23 05:27:20 +0000521
Fred Drake011f6fc1999-04-14 12:52:14 +0000522\section{The \keyword{raise} statement \label{raise}}
Fred Drakef6669171998-05-06 19:52:49 +0000523\stindex{raise}
524
Fred Drakecb4638a2001-07-06 22:49:53 +0000525\begin{productionlist}
526 \production{raise_stmt}
527 {"raise" [\token{expression} ["," \token{expression}
528 ["," \token{expression}]]]}
529\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000530
Guido van Rossum56c20131998-07-24 18:25:38 +0000531If no expressions are present, \keyword{raise} re-raises the last
Raymond Hettingerb56b4942005-04-28 07:18:47 +0000532exception that was active in the current scope. If no exception is
Raymond Hettingerbee0d462005-10-03 16:39:51 +0000533active in the current scope, a \exception{TypeError} exception is
534raised indicating that this is an error (if running under IDLE, a
Neal Norwitzc0d11252005-10-04 03:43:43 +0000535\exception{Queue.Empty} exception is raised instead).
Fred Drakef6669171998-05-06 19:52:49 +0000536\index{exception}
537\indexii{raising}{exception}
538
Fred Drake81932e22002-06-20 20:55:29 +0000539Otherwise, \keyword{raise} evaluates the expressions to get three
540objects, using \code{None} as the value of omitted expressions. The
541first two objects are used to determine the \emph{type} and
542\emph{value} of the exception.
Fred Drakef6669171998-05-06 19:52:49 +0000543
Fred Drake81932e22002-06-20 20:55:29 +0000544If the first object is an instance, the type of the exception is the
Fred Drake8bd62af2003-01-25 03:47:35 +0000545class of the instance, the instance itself is the value, and the
Fred Drake81932e22002-06-20 20:55:29 +0000546second object must be \code{None}.
547
548If the first object is a class, it becomes the type of the exception.
549The second object is used to determine the exception value: If it is
550an instance of the class, the instance becomes the exception value.
551If the second object is a tuple, it is used as the argument list for
552the class constructor; if it is \code{None}, an empty argument list is
553used, and any other object is treated as a single argument to the
554constructor. The instance so created by calling the constructor is
555used as the exception value.
556
Fred Drake81932e22002-06-20 20:55:29 +0000557If a third object is present and not \code{None}, it must be a
558traceback\obindex{traceback} object (see section~\ref{traceback}), and
559it is substituted instead of the current location as the place where
560the exception occurred. If the third object is present and not a
561traceback object or \code{None}, a \exception{TypeError} exception is
562raised. The three-expression form of \keyword{raise} is useful to
563re-raise an exception transparently in an except clause, but
564\keyword{raise} with no expressions should be preferred if the
565exception to be re-raised was the most recently active exception in
566the current scope.
567
Fred Drakee7097e02002-10-18 15:18:18 +0000568Additional information on exceptions can be found in
569section~\ref{exceptions}, and information about handling exceptions is
570in section~\ref{try}.
Fred Drakef6669171998-05-06 19:52:49 +0000571
Fred Drake2829f1c2001-06-23 05:27:20 +0000572
Fred Drake011f6fc1999-04-14 12:52:14 +0000573\section{The \keyword{break} statement \label{break}}
Fred Drakef6669171998-05-06 19:52:49 +0000574\stindex{break}
575
Fred Drakecb4638a2001-07-06 22:49:53 +0000576\begin{productionlist}
577 \production{break_stmt}
578 {"break"}
579\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000580
581\keyword{break} may only occur syntactically nested in a \keyword{for}
582or \keyword{while} loop, but not nested in a function or class definition
583within that loop.
584\stindex{for}
585\stindex{while}
586\indexii{loop}{statement}
587
588It terminates the nearest enclosing loop, skipping the optional
Guido van Rossum56c20131998-07-24 18:25:38 +0000589\keyword{else} clause if the loop has one.
Fred Drakef6669171998-05-06 19:52:49 +0000590\kwindex{else}
591
592If a \keyword{for} loop is terminated by \keyword{break}, the loop control
593target keeps its current value.
594\indexii{loop control}{target}
595
596When \keyword{break} passes control out of a \keyword{try} statement
Guido van Rossum56c20131998-07-24 18:25:38 +0000597with a \keyword{finally} clause, that \keyword{finally} clause is executed
Fred Drakef6669171998-05-06 19:52:49 +0000598before really leaving the loop.
599\kwindex{finally}
600
Fred Drake2829f1c2001-06-23 05:27:20 +0000601
Fred Drake011f6fc1999-04-14 12:52:14 +0000602\section{The \keyword{continue} statement \label{continue}}
Fred Drakef6669171998-05-06 19:52:49 +0000603\stindex{continue}
604
Fred Drakecb4638a2001-07-06 22:49:53 +0000605\begin{productionlist}
606 \production{continue_stmt}
607 {"continue"}
608\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000609
610\keyword{continue} may only occur syntactically nested in a \keyword{for} or
611\keyword{while} loop, but not nested in a function or class definition or
Neal Norwitz19f6b862005-10-04 03:37:29 +0000612\keyword{finally} statement within that loop.\footnote{It may
Guido van Rossum56c20131998-07-24 18:25:38 +0000613occur within an \keyword{except} or \keyword{else} clause. The
Thomas Woutersf9b526d2000-07-16 19:05:38 +0000614restriction on occurring in the \keyword{try} clause is implementor's
Guido van Rossum56c20131998-07-24 18:25:38 +0000615laziness and will eventually be lifted.}
616It continues with the next cycle of the nearest enclosing loop.
Fred Drakef6669171998-05-06 19:52:49 +0000617\stindex{for}
618\stindex{while}
619\indexii{loop}{statement}
620\kwindex{finally}
621
Fred Drake2829f1c2001-06-23 05:27:20 +0000622
Fred Drake011f6fc1999-04-14 12:52:14 +0000623\section{The \keyword{import} statement \label{import}}
Fred Drakef6669171998-05-06 19:52:49 +0000624\stindex{import}
Fred Drakeb3be52e2003-07-15 21:37:58 +0000625\index{module!importing}
626\indexii{name}{binding}
627\kwindex{from}
Fred Drakef6669171998-05-06 19:52:49 +0000628
Fred Drakecb4638a2001-07-06 22:49:53 +0000629\begin{productionlist}
630 \production{import_stmt}
631 {"import" \token{module} ["as" \token{name}]
Fred Drake53815882002-03-15 23:21:37 +0000632 ( "," \token{module} ["as" \token{name}] )*}
633 \productioncont{| "from" \token{module} "import" \token{identifier}
634 ["as" \token{name}]}
635 \productioncont{ ( "," \token{identifier} ["as" \token{name}] )*}
Anthony Baxter1a4ddae2004-08-31 10:07:13 +0000636 \productioncont{| "from" \token{module} "import" "(" \token{identifier}
637 ["as" \token{name}]}
638 \productioncont{ ( "," \token{identifier} ["as" \token{name}] )* [","] ")"}
Fred Drake53815882002-03-15 23:21:37 +0000639 \productioncont{| "from" \token{module} "import" "*"}
Fred Drakecb4638a2001-07-06 22:49:53 +0000640 \production{module}
641 {(\token{identifier} ".")* \token{identifier}}
642\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000643
644Import statements are executed in two steps: (1) find a module, and
645initialize it if necessary; (2) define a name or names in the local
Guido van Rossum56c20131998-07-24 18:25:38 +0000646namespace (of the scope where the \keyword{import} statement occurs).
Fred Drakef6669171998-05-06 19:52:49 +0000647The first form (without \keyword{from}) repeats these steps for each
Guido van Rossum56c20131998-07-24 18:25:38 +0000648identifier in the list. The form with \keyword{from} performs step
649(1) once, and then performs step (2) repeatedly.
Fred Drakef6669171998-05-06 19:52:49 +0000650
Raymond Hettingere701dcb2003-01-19 13:08:18 +0000651In this context, to ``initialize'' a built-in or extension module means to
652call an initialization function that the module must provide for the purpose
653(in the reference implementation, the function's name is obtained by
654prepending string ``init'' to the module's name); to ``initialize'' a
655Python-coded module means to execute the module's body.
656
657The system maintains a table of modules that have been or are being
658initialized,
Fred Drake191a2822000-07-06 00:50:42 +0000659indexed by module name. This table is
Guido van Rossum56c20131998-07-24 18:25:38 +0000660accessible as \code{sys.modules}. When a module name is found in
Fred Drakef6669171998-05-06 19:52:49 +0000661this table, step (1) is finished. If not, a search for a module
Guido van Rossum56c20131998-07-24 18:25:38 +0000662definition is started. When a module is found, it is loaded. Details
663of the module searching and loading process are implementation and
664platform specific. It generally involves searching for a ``built-in''
665module with the given name and then searching a list of locations
666given as \code{sys.path}.
Fred Drake2b3730e1998-11-25 17:40:00 +0000667\withsubitem{(in module sys)}{\ttindex{modules}}
Fred Drakef6669171998-05-06 19:52:49 +0000668\ttindex{sys.modules}
669\indexii{module}{name}
670\indexii{built-in}{module}
671\indexii{user-defined}{module}
672\refbimodindex{sys}
Fred Drakef6669171998-05-06 19:52:49 +0000673\indexii{filename}{extension}
Fred Drakedde91f01998-05-06 20:59:46 +0000674\indexiii{module}{search}{path}
Fred Drakef6669171998-05-06 19:52:49 +0000675
Fred Draked51ce7d2003-07-15 22:03:00 +0000676If a built-in module is found,\indexii{module}{initialization} its
677built-in initialization code is executed and step (1) is finished. If
678no matching file is found,
679\exception{ImportError}\exindex{ImportError} is raised.
680\index{code block}If a file is found, it is parsed,
Fred Drakef6669171998-05-06 19:52:49 +0000681yielding an executable code block. If a syntax error occurs,
Fred Draked51ce7d2003-07-15 22:03:00 +0000682\exception{SyntaxError}\exindex{SyntaxError} is raised. Otherwise, an
683empty module of the given name is created and inserted in the module
684table, and then the code block is executed in the context of this
685module. Exceptions during this execution terminate step (1).
Fred Drakef6669171998-05-06 19:52:49 +0000686
687When step (1) finishes without raising an exception, step (2) can
688begin.
689
Fred Drake859eb622001-03-06 07:34:00 +0000690The first form of \keyword{import} statement binds the module name in
691the local namespace to the module object, and then goes on to import
692the next identifier, if any. If the module name is followed by
693\keyword{as}, the name following \keyword{as} is used as the local
Martin v. Löwis13dd9d92003-01-16 11:30:08 +0000694name for the module.
Thomas Wouters8bad6122000-08-19 20:55:02 +0000695
Thomas Wouters52152252000-08-17 22:55:00 +0000696The \keyword{from} form does not bind the module name: it goes through the
697list of identifiers, looks each one of them up in the module found in step
698(1), and binds the name in the local namespace to the object thus found.
Fred Draked68442b2000-09-21 22:01:36 +0000699As with the first form of \keyword{import}, an alternate local name can be
Thomas Wouters52152252000-08-17 22:55:00 +0000700supplied by specifying "\keyword{as} localname". If a name is not found,
Fred Drakef6669171998-05-06 19:52:49 +0000701\exception{ImportError} is raised. If the list of identifiers is replaced
Fred Drake08fd5152001-10-24 19:50:31 +0000702by a star (\character{*}), all public names defined in the module are
703bound in the local namespace of the \keyword{import} statement..
Fred Drakef6669171998-05-06 19:52:49 +0000704\indexii{name}{binding}
705\exindex{ImportError}
706
Fred Drake08fd5152001-10-24 19:50:31 +0000707The \emph{public names} defined by a module are determined by checking
708the module's namespace for a variable named \code{__all__}; if
709defined, it must be a sequence of strings which are names defined or
710imported by that module. The names given in \code{__all__} are all
711considered public and are required to exist. If \code{__all__} is not
712defined, the set of public names includes all names found in the
713module's namespace which do not begin with an underscore character
Raymond Hettinger1772f172003-01-06 12:54:54 +0000714(\character{_}). \code{__all__} should contain the entire public API.
715It is intended to avoid accidentally exporting items that are not part
716of the API (such as library modules which were imported and used within
717the module).
Fred Drake27cae1f2002-12-07 16:00:00 +0000718\withsubitem{(optional module attribute)}{\ttindex{__all__}}
Fred Drake08fd5152001-10-24 19:50:31 +0000719
Jeremy Hyltonf0c1f1b2002-04-01 21:19:44 +0000720The \keyword{from} form with \samp{*} may only occur in a module
721scope. If the wild card form of import --- \samp{import *} --- is
722used in a function and the function contains or is a nested block with
723free variables, the compiler will raise a \exception{SyntaxError}.
724
Fred Drakef6669171998-05-06 19:52:49 +0000725\kwindex{from}
Fred Drake2b3730e1998-11-25 17:40:00 +0000726\stindex{from}
Fred Drakef6669171998-05-06 19:52:49 +0000727
Fred Drake246837d1998-07-24 20:28:22 +0000728\strong{Hierarchical module names:}\indexiii{hierarchical}{module}{names}
Guido van Rossum56c20131998-07-24 18:25:38 +0000729when the module names contains one or more dots, the module search
730path is carried out differently. The sequence of identifiers up to
731the last dot is used to find a ``package''\index{packages}; the final
732identifier is then searched inside the package. A package is
733generally a subdirectory of a directory on \code{sys.path} that has a
734file \file{__init__.py}.\ttindex{__init__.py}
735%
736[XXX Can't be bothered to spell this out right now; see the URL
Fred Drake1a0b8721998-08-07 17:40:20 +0000737\url{http://www.python.org/doc/essays/packages.html} for more details, also
Guido van Rossum56c20131998-07-24 18:25:38 +0000738about how the module search works from inside a package.]
739
Fred Drake08fd5152001-10-24 19:50:31 +0000740The built-in function \function{__import__()} is provided to support
741applications that determine which modules need to be loaded
742dynamically; refer to \ulink{Built-in
743Functions}{../lib/built-in-funcs.html} in the
744\citetitle[../lib/lib.html]{Python Library Reference} for additional
745information.
Guido van Rossum56c20131998-07-24 18:25:38 +0000746\bifuncindex{__import__}
747
Jeremy Hylton8bea5dc2003-05-21 21:43:00 +0000748\subsection{Future statements \label{future}}
749
750A \dfn{future statement}\indexii{future}{statement} is a directive to
751the compiler that a particular module should be compiled using syntax
752or semantics that will be available in a specified future release of
753Python. The future statement is intended to ease migration to future
754versions of Python that introduce incompatible changes to the
755language. It allows use of the new features on a per-module basis
756before the release in which the feature becomes standard.
757
758\begin{productionlist}[*]
759 \production{future_statement}
Anthony Baxter1a4ddae2004-08-31 10:07:13 +0000760 {"from" "__future__" "import" feature ["as" name] ("," feature ["as" name])*}
761 \productioncont{| "from" "__future__" "import" "(" feature ["as" name] ("," feature ["as" name])* [","] ")"}
Jeremy Hylton8bea5dc2003-05-21 21:43:00 +0000762 \production{feature}{identifier}
763 \production{name}{identifier}
764\end{productionlist}
765
766A future statement must appear near the top of the module. The only
767lines that can appear before a future statement are:
768
769\begin{itemize}
770
771\item the module docstring (if any),
772\item comments,
773\item blank lines, and
774\item other future statements.
775
776\end{itemize}
777
778The features recognized by Python 2.3 are \samp{generators},
779\samp{division} and \samp{nested_scopes}. \samp{generators} and
780\samp{nested_scopes} are redundant in 2.3 because they are always
781enabled.
782
783A future statement is recognized and treated specially at compile
784time: Changes to the semantics of core constructs are often
785implemented by generating different code. It may even be the case
786that a new feature introduces new incompatible syntax (such as a new
787reserved word), in which case the compiler may need to parse the
788module differently. Such decisions cannot be pushed off until
789runtime.
790
791For any given release, the compiler knows which feature names have been
792defined, and raises a compile-time error if a future statement contains
793a feature not known to it.
794
795The direct runtime semantics are the same as for any import statement:
796there is a standard module \module{__future__}, described later, and
797it will be imported in the usual way at the time the future statement
798is executed.
799
800The interesting runtime semantics depend on the specific feature
801enabled by the future statement.
802
803Note that there is nothing special about the statement:
804
805\begin{verbatim}
806import __future__ [as name]
807\end{verbatim}
808
809That is not a future statement; it's an ordinary import statement with
810no special semantics or syntax restrictions.
811
Thomas Wouters477c8d52006-05-27 19:21:47 +0000812Code compiled by an \keyword{exec} statement or calls to the builtin functions
Jeremy Hylton8bea5dc2003-05-21 21:43:00 +0000813\function{compile()} and \function{execfile()} that occur in a module
814\module{M} containing a future statement will, by default, use the new
815syntax or semantics associated with the future statement. This can,
816starting with Python 2.2 be controlled by optional arguments to
Thomas Wouters477c8d52006-05-27 19:21:47 +0000817\function{compile()} --- see the documentation of that function in the
818\citetitle[../lib/built-in-funcs.html]{Python Library Reference} for
819details.
Jeremy Hylton8bea5dc2003-05-21 21:43:00 +0000820
821A future statement typed at an interactive interpreter prompt will
822take effect for the rest of the interpreter session. If an
823interpreter is started with the \programopt{-i} option, is passed a
824script name to execute, and the script includes a future statement, it
825will be in effect in the interactive session started after the script
826is executed.
Fred Drake2829f1c2001-06-23 05:27:20 +0000827
Fred Drake011f6fc1999-04-14 12:52:14 +0000828\section{The \keyword{global} statement \label{global}}
Fred Drakef6669171998-05-06 19:52:49 +0000829\stindex{global}
830
Fred Drakecb4638a2001-07-06 22:49:53 +0000831\begin{productionlist}
832 \production{global_stmt}
833 {"global" \token{identifier} ("," \token{identifier})*}
834\end{productionlist}
Fred Drakef6669171998-05-06 19:52:49 +0000835
836The \keyword{global} statement is a declaration which holds for the
837entire current code block. It means that the listed identifiers are to be
Jeremy Hyltonf3255c82002-04-01 21:25:32 +0000838interpreted as globals. It would be impossible to assign to a global
839variable without \keyword{global}, although free variables may refer
840to globals without being declared global.
Fred Drakef6669171998-05-06 19:52:49 +0000841\indexiii{global}{name}{binding}
842
843Names listed in a \keyword{global} statement must not be used in the same
Guido van Rossumb1f97d61998-12-21 18:57:36 +0000844code block textually preceding that \keyword{global} statement.
Fred Drakef6669171998-05-06 19:52:49 +0000845
846Names listed in a \keyword{global} statement must not be defined as formal
847parameters or in a \keyword{for} loop control target, \keyword{class}
848definition, function definition, or \keyword{import} statement.
849
850(The current implementation does not enforce the latter two
851restrictions, but programs should not abuse this freedom, as future
852implementations may enforce them or silently change the meaning of the
853program.)
854
Guido van Rossum56c20131998-07-24 18:25:38 +0000855\strong{Programmer's note:}
856the \keyword{global} is a directive to the parser. It
Fred Drakef6669171998-05-06 19:52:49 +0000857applies only to code parsed at the same time as the \keyword{global}
858statement. In particular, a \keyword{global} statement contained in an
Fred Drakedde91f01998-05-06 20:59:46 +0000859\keyword{exec} statement does not affect the code block \emph{containing}
Fred Drakef6669171998-05-06 19:52:49 +0000860the \keyword{exec} statement, and code contained in an \keyword{exec}
861statement is unaffected by \keyword{global} statements in the code
862containing the \keyword{exec} statement. The same applies to the
863\function{eval()}, \function{execfile()} and \function{compile()} functions.
864\stindex{exec}
865\bifuncindex{eval}
866\bifuncindex{execfile}
867\bifuncindex{compile}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000868
Fred Drake2829f1c2001-06-23 05:27:20 +0000869
Fred Drake011f6fc1999-04-14 12:52:14 +0000870\section{The \keyword{exec} statement \label{exec}}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000871\stindex{exec}
872
Fred Drakecb4638a2001-07-06 22:49:53 +0000873\begin{productionlist}
874 \production{exec_stmt}
875 {"exec" \token{expression}
876 ["in" \token{expression} ["," \token{expression}]]}
877\end{productionlist}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000878
879This statement supports dynamic execution of Python code. The first
880expression should evaluate to either a string, an open file object, or
881a code object. If it is a string, the string is parsed as a suite of
882Python statements which is then executed (unless a syntax error
Fred Drake93852ef2001-06-23 06:06:52 +0000883occurs). If it is an open file, the file is parsed until \EOF{} and
Fred Drakeb6e1c112005-09-07 05:17:07 +0000884executed. If it is a code object, it is simply executed. In all
Fredrik Lundh5a49fae2006-02-02 21:58:55 +0000885cases, the code that's executed is expected to be valid as file
Fred Drakeb6e1c112005-09-07 05:17:07 +0000886input (see section~\ref{file-input}, ``File input''). Be aware that
887the \keyword{return} and \keyword{yield} statements may not be used
888outside of function definitions even within the context of code passed
889to the \keyword{exec} statement.
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000890
891In all cases, if the optional parts are omitted, the code is executed
892in the current scope. If only the first expression after \keyword{in}
893is specified, it should be a dictionary, which will be used for both
894the global and the local variables. If two expressions are given,
Raymond Hettinger70fcdb82004-08-03 05:17:58 +0000895they are used for the global and local variables, respectively.
896If provided, \var{locals} can be any mapping object.
897\versionchanged[formerly \var{locals} was required to be a dictionary]{2.4}
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000898
899As a side effect, an implementation may insert additional keys into
900the dictionaries given besides those corresponding to variable names
901set by the executed code. For example, the current implementation
902may add a reference to the dictionary of the built-in module
903\module{__builtin__} under the key \code{__builtins__} (!).
904\ttindex{__builtins__}
905\refbimodindex{__builtin__}
906
Guido van Rossum56c20131998-07-24 18:25:38 +0000907\strong{Programmer's hints:}
908dynamic evaluation of expressions is supported by the built-in
Guido van Rossum5f574aa1998-07-06 13:18:39 +0000909function \function{eval()}. The built-in functions
910\function{globals()} and \function{locals()} return the current global
911and local dictionary, respectively, which may be useful to pass around
912for use by \keyword{exec}.
913\bifuncindex{eval}
914\bifuncindex{globals}
915\bifuncindex{locals}
Greg Ward38c28e32000-04-27 18:32:02 +0000916
Greg Ward38c28e32000-04-27 18:32:02 +0000917
918