|
1 |
|
2 .. _simple: |
|
3 |
|
4 ***************** |
|
5 Simple statements |
|
6 ***************** |
|
7 |
|
8 .. index:: pair: simple; statement |
|
9 |
|
10 Simple statements are comprised within a single logical line. Several simple |
|
11 statements may occur on a single line separated by semicolons. The syntax for |
|
12 simple statements is: |
|
13 |
|
14 .. productionlist:: |
|
15 simple_stmt: `expression_stmt` |
|
16 : | `assert_stmt` |
|
17 : | `assignment_stmt` |
|
18 : | `augmented_assignment_stmt` |
|
19 : | `pass_stmt` |
|
20 : | `del_stmt` |
|
21 : | `print_stmt` |
|
22 : | `return_stmt` |
|
23 : | `yield_stmt` |
|
24 : | `raise_stmt` |
|
25 : | `break_stmt` |
|
26 : | `continue_stmt` |
|
27 : | `import_stmt` |
|
28 : | `global_stmt` |
|
29 : | `exec_stmt` |
|
30 |
|
31 |
|
32 .. _exprstmts: |
|
33 |
|
34 Expression statements |
|
35 ===================== |
|
36 |
|
37 .. index:: |
|
38 pair: expression; statement |
|
39 pair: expression; list |
|
40 |
|
41 Expression statements are used (mostly interactively) to compute and write a |
|
42 value, or (usually) to call a procedure (a function that returns no meaningful |
|
43 result; in Python, procedures return the value ``None``). Other uses of |
|
44 expression statements are allowed and occasionally useful. The syntax for an |
|
45 expression statement is: |
|
46 |
|
47 .. productionlist:: |
|
48 expression_stmt: `expression_list` |
|
49 |
|
50 An expression statement evaluates the expression list (which may be a single |
|
51 expression). |
|
52 |
|
53 .. index:: |
|
54 builtin: repr |
|
55 object: None |
|
56 pair: string; conversion |
|
57 single: output |
|
58 pair: standard; output |
|
59 pair: writing; values |
|
60 pair: procedure; call |
|
61 |
|
62 In interactive mode, if the value is not ``None``, it is converted to a string |
|
63 using the built-in :func:`repr` function and the resulting string is written to |
|
64 standard output (see section :ref:`print`) on a line by itself. (Expression |
|
65 statements yielding ``None`` are not written, so that procedure calls do not |
|
66 cause any output.) |
|
67 |
|
68 |
|
69 .. _assignment: |
|
70 |
|
71 Assignment statements |
|
72 ===================== |
|
73 |
|
74 .. index:: |
|
75 pair: assignment; statement |
|
76 pair: binding; name |
|
77 pair: rebinding; name |
|
78 object: mutable |
|
79 pair: attribute; assignment |
|
80 |
|
81 Assignment statements are used to (re)bind names to values and to modify |
|
82 attributes or items of mutable objects: |
|
83 |
|
84 .. productionlist:: |
|
85 assignment_stmt: (`target_list` "=")+ (`expression_list` | `yield_expression`) |
|
86 target_list: `target` ("," `target`)* [","] |
|
87 target: `identifier` |
|
88 : | "(" `target_list` ")" |
|
89 : | "[" `target_list` "]" |
|
90 : | `attributeref` |
|
91 : | `subscription` |
|
92 : | `slicing` |
|
93 |
|
94 (See section :ref:`primaries` for the syntax definitions for the last three |
|
95 symbols.) |
|
96 |
|
97 .. index:: pair: expression; list |
|
98 |
|
99 An assignment statement evaluates the expression list (remember that this can be |
|
100 a single expression or a comma-separated list, the latter yielding a tuple) and |
|
101 assigns the single resulting object to each of the target lists, from left to |
|
102 right. |
|
103 |
|
104 .. index:: |
|
105 single: target |
|
106 pair: target; list |
|
107 |
|
108 Assignment is defined recursively depending on the form of the target (list). |
|
109 When a target is part of a mutable object (an attribute reference, subscription |
|
110 or slicing), the mutable object must ultimately perform the assignment and |
|
111 decide about its validity, and may raise an exception if the assignment is |
|
112 unacceptable. The rules observed by various types and the exceptions raised are |
|
113 given with the definition of the object types (see section :ref:`types`). |
|
114 |
|
115 .. index:: triple: target; list; assignment |
|
116 |
|
117 Assignment of an object to a target list is recursively defined as follows. |
|
118 |
|
119 * If the target list is a single target: The object is assigned to that target. |
|
120 |
|
121 * If the target list is a comma-separated list of targets: The object must be a |
|
122 sequence with the same number of items as there are targets in the target list, |
|
123 and the items are assigned, from left to right, to the corresponding targets. |
|
124 (This rule is relaxed as of Python 1.5; in earlier versions, the object had to |
|
125 be a tuple. Since strings are sequences, an assignment like ``a, b = "xy"`` is |
|
126 now legal as long as the string has the right length.) |
|
127 |
|
128 Assignment of an object to a single target is recursively defined as follows. |
|
129 |
|
130 * If the target is an identifier (name): |
|
131 |
|
132 .. index:: statement: global |
|
133 |
|
134 * If the name does not occur in a :keyword:`global` statement in the current |
|
135 code block: the name is bound to the object in the current local namespace. |
|
136 |
|
137 * Otherwise: the name is bound to the object in the current global namespace. |
|
138 |
|
139 .. index:: single: destructor |
|
140 |
|
141 The name is rebound if it was already bound. This may cause the reference count |
|
142 for the object previously bound to the name to reach zero, causing the object to |
|
143 be deallocated and its destructor (if it has one) to be called. |
|
144 |
|
145 * If the target is a target list enclosed in parentheses or in square brackets: |
|
146 The object must be a sequence with the same number of items as there are targets |
|
147 in the target list, and its items are assigned, from left to right, to the |
|
148 corresponding targets. |
|
149 |
|
150 .. index:: pair: attribute; assignment |
|
151 |
|
152 * If the target is an attribute reference: The primary expression in the |
|
153 reference is evaluated. It should yield an object with assignable attributes; |
|
154 if this is not the case, :exc:`TypeError` is raised. That object is then asked |
|
155 to assign the assigned object to the given attribute; if it cannot perform the |
|
156 assignment, it raises an exception (usually but not necessarily |
|
157 :exc:`AttributeError`). |
|
158 |
|
159 .. index:: |
|
160 pair: subscription; assignment |
|
161 object: mutable |
|
162 |
|
163 * If the target is a subscription: The primary expression in the reference is |
|
164 evaluated. It should yield either a mutable sequence object (such as a list) or |
|
165 a mapping object (such as a dictionary). Next, the subscript expression is |
|
166 evaluated. |
|
167 |
|
168 .. index:: |
|
169 object: sequence |
|
170 object: list |
|
171 |
|
172 If the primary is a mutable sequence object (such as a list), the subscript must |
|
173 yield a plain integer. If it is negative, the sequence's length is added to it. |
|
174 The resulting value must be a nonnegative integer less than the sequence's |
|
175 length, and the sequence is asked to assign the assigned object to its item with |
|
176 that index. If the index is out of range, :exc:`IndexError` is raised |
|
177 (assignment to a subscripted sequence cannot add new items to a list). |
|
178 |
|
179 .. index:: |
|
180 object: mapping |
|
181 object: dictionary |
|
182 |
|
183 If the primary is a mapping object (such as a dictionary), the subscript must |
|
184 have a type compatible with the mapping's key type, and the mapping is then |
|
185 asked to create a key/datum pair which maps the subscript to the assigned |
|
186 object. This can either replace an existing key/value pair with the same key |
|
187 value, or insert a new key/value pair (if no key with the same value existed). |
|
188 |
|
189 .. index:: pair: slicing; assignment |
|
190 |
|
191 * If the target is a slicing: The primary expression in the reference is |
|
192 evaluated. It should yield a mutable sequence object (such as a list). The |
|
193 assigned object should be a sequence object of the same type. Next, the lower |
|
194 and upper bound expressions are evaluated, insofar they are present; defaults |
|
195 are zero and the sequence's length. The bounds should evaluate to (small) |
|
196 integers. If either bound is negative, the sequence's length is added to it. |
|
197 The resulting bounds are clipped to lie between zero and the sequence's length, |
|
198 inclusive. Finally, the sequence object is asked to replace the slice with the |
|
199 items of the assigned sequence. The length of the slice may be different from |
|
200 the length of the assigned sequence, thus changing the length of the target |
|
201 sequence, if the object allows it. |
|
202 |
|
203 (In the current implementation, the syntax for targets is taken to be the same |
|
204 as for expressions, and invalid syntax is rejected during the code generation |
|
205 phase, causing less detailed error messages.) |
|
206 |
|
207 WARNING: Although the definition of assignment implies that overlaps between the |
|
208 left-hand side and the right-hand side are 'safe' (for example ``a, b = b, a`` |
|
209 swaps two variables), overlaps *within* the collection of assigned-to variables |
|
210 are not safe! For instance, the following program prints ``[0, 2]``:: |
|
211 |
|
212 x = [0, 1] |
|
213 i = 0 |
|
214 i, x[i] = 1, 2 |
|
215 print x |
|
216 |
|
217 |
|
218 .. _augassign: |
|
219 |
|
220 Augmented assignment statements |
|
221 ------------------------------- |
|
222 |
|
223 .. index:: |
|
224 pair: augmented; assignment |
|
225 single: statement; assignment, augmented |
|
226 |
|
227 Augmented assignment is the combination, in a single statement, of a binary |
|
228 operation and an assignment statement: |
|
229 |
|
230 .. productionlist:: |
|
231 augmented_assignment_stmt: `target` `augop` (`expression_list` | `yield_expression`) |
|
232 augop: "+=" | "-=" | "*=" | "/=" | "//=" | "%=" | "**=" |
|
233 : | ">>=" | "<<=" | "&=" | "^=" | "|=" |
|
234 |
|
235 (See section :ref:`primaries` for the syntax definitions for the last three |
|
236 symbols.) |
|
237 |
|
238 An augmented assignment evaluates the target (which, unlike normal assignment |
|
239 statements, cannot be an unpacking) and the expression list, performs the binary |
|
240 operation specific to the type of assignment on the two operands, and assigns |
|
241 the result to the original target. The target is only evaluated once. |
|
242 |
|
243 An augmented assignment expression like ``x += 1`` can be rewritten as ``x = x + |
|
244 1`` to achieve a similar, but not exactly equal effect. In the augmented |
|
245 version, ``x`` is only evaluated once. Also, when possible, the actual operation |
|
246 is performed *in-place*, meaning that rather than creating a new object and |
|
247 assigning that to the target, the old object is modified instead. |
|
248 |
|
249 With the exception of assigning to tuples and multiple targets in a single |
|
250 statement, the assignment done by augmented assignment statements is handled the |
|
251 same way as normal assignments. Similarly, with the exception of the possible |
|
252 *in-place* behavior, the binary operation performed by augmented assignment is |
|
253 the same as the normal binary operations. |
|
254 |
|
255 For targets which are attribute references, the initial value is retrieved with |
|
256 a :meth:`getattr` and the result is assigned with a :meth:`setattr`. Notice |
|
257 that the two methods do not necessarily refer to the same variable. When |
|
258 :meth:`getattr` refers to a class variable, :meth:`setattr` still writes to an |
|
259 instance variable. For example:: |
|
260 |
|
261 class A: |
|
262 x = 3 # class variable |
|
263 a = A() |
|
264 a.x += 1 # writes a.x as 4 leaving A.x as 3 |
|
265 |
|
266 |
|
267 .. _assert: |
|
268 |
|
269 The :keyword:`assert` statement |
|
270 =============================== |
|
271 |
|
272 .. index:: |
|
273 statement: assert |
|
274 pair: debugging; assertions |
|
275 |
|
276 Assert statements are a convenient way to insert debugging assertions into a |
|
277 program: |
|
278 |
|
279 .. productionlist:: |
|
280 assert_stmt: "assert" `expression` ["," `expression`] |
|
281 |
|
282 The simple form, ``assert expression``, is equivalent to :: |
|
283 |
|
284 if __debug__: |
|
285 if not expression: raise AssertionError |
|
286 |
|
287 The extended form, ``assert expression1, expression2``, is equivalent to :: |
|
288 |
|
289 if __debug__: |
|
290 if not expression1: raise AssertionError, expression2 |
|
291 |
|
292 .. index:: |
|
293 single: __debug__ |
|
294 exception: AssertionError |
|
295 |
|
296 These equivalences assume that :const:`__debug__` and :exc:`AssertionError` refer to |
|
297 the built-in variables with those names. In the current implementation, the |
|
298 built-in variable :const:`__debug__` is ``True`` under normal circumstances, |
|
299 ``False`` when optimization is requested (command line option -O). The current |
|
300 code generator emits no code for an assert statement when optimization is |
|
301 requested at compile time. Note that it is unnecessary to include the source |
|
302 code for the expression that failed in the error message; it will be displayed |
|
303 as part of the stack trace. |
|
304 |
|
305 Assignments to :const:`__debug__` are illegal. The value for the built-in variable |
|
306 is determined when the interpreter starts. |
|
307 |
|
308 |
|
309 .. _pass: |
|
310 |
|
311 The :keyword:`pass` statement |
|
312 ============================= |
|
313 |
|
314 .. index:: |
|
315 statement: pass |
|
316 pair: null; operation |
|
317 |
|
318 .. productionlist:: |
|
319 pass_stmt: "pass" |
|
320 |
|
321 :keyword:`pass` is a null operation --- when it is executed, nothing happens. |
|
322 It is useful as a placeholder when a statement is required syntactically, but no |
|
323 code needs to be executed, for example:: |
|
324 |
|
325 def f(arg): pass # a function that does nothing (yet) |
|
326 |
|
327 class C: pass # a class with no methods (yet) |
|
328 |
|
329 |
|
330 .. _del: |
|
331 |
|
332 The :keyword:`del` statement |
|
333 ============================ |
|
334 |
|
335 .. index:: |
|
336 statement: del |
|
337 pair: deletion; target |
|
338 triple: deletion; target; list |
|
339 |
|
340 .. productionlist:: |
|
341 del_stmt: "del" `target_list` |
|
342 |
|
343 Deletion is recursively defined very similar to the way assignment is defined. |
|
344 Rather that spelling it out in full details, here are some hints. |
|
345 |
|
346 Deletion of a target list recursively deletes each target, from left to right. |
|
347 |
|
348 .. index:: |
|
349 statement: global |
|
350 pair: unbinding; name |
|
351 |
|
352 Deletion of a name removes the binding of that name from the local or global |
|
353 namespace, depending on whether the name occurs in a :keyword:`global` statement |
|
354 in the same code block. If the name is unbound, a :exc:`NameError` exception |
|
355 will be raised. |
|
356 |
|
357 .. index:: pair: free; variable |
|
358 |
|
359 It is illegal to delete a name from the local namespace if it occurs as a free |
|
360 variable in a nested block. |
|
361 |
|
362 .. index:: pair: attribute; deletion |
|
363 |
|
364 Deletion of attribute references, subscriptions and slicings is passed to the |
|
365 primary object involved; deletion of a slicing is in general equivalent to |
|
366 assignment of an empty slice of the right type (but even this is determined by |
|
367 the sliced object). |
|
368 |
|
369 |
|
370 .. _print: |
|
371 |
|
372 The :keyword:`print` statement |
|
373 ============================== |
|
374 |
|
375 .. index:: statement: print |
|
376 |
|
377 .. productionlist:: |
|
378 print_stmt: "print" ([`expression` ("," `expression`)* [","]] |
|
379 : | ">>" `expression` [("," `expression`)+ [","]]) |
|
380 |
|
381 :keyword:`print` evaluates each expression in turn and writes the resulting |
|
382 object to standard output (see below). If an object is not a string, it is |
|
383 first converted to a string using the rules for string conversions. The |
|
384 (resulting or original) string is then written. A space is written before each |
|
385 object is (converted and) written, unless the output system believes it is |
|
386 positioned at the beginning of a line. This is the case (1) when no characters |
|
387 have yet been written to standard output, (2) when the last character written to |
|
388 standard output is ``'\n'``, or (3) when the last write operation on standard |
|
389 output was not a :keyword:`print` statement. (In some cases it may be |
|
390 functional to write an empty string to standard output for this reason.) |
|
391 |
|
392 .. note:: |
|
393 |
|
394 Objects which act like file objects but which are not the built-in file objects |
|
395 often do not properly emulate this aspect of the file object's behavior, so it |
|
396 is best not to rely on this. |
|
397 |
|
398 .. index:: |
|
399 single: output |
|
400 pair: writing; values |
|
401 pair: trailing; comma |
|
402 pair: newline; suppression |
|
403 |
|
404 A ``'\n'`` character is written at the end, unless the :keyword:`print` |
|
405 statement ends with a comma. This is the only action if the statement contains |
|
406 just the keyword :keyword:`print`. |
|
407 |
|
408 .. index:: |
|
409 pair: standard; output |
|
410 module: sys |
|
411 single: stdout (in module sys) |
|
412 exception: RuntimeError |
|
413 |
|
414 Standard output is defined as the file object named ``stdout`` in the built-in |
|
415 module :mod:`sys`. If no such object exists, or if it does not have a |
|
416 :meth:`write` method, a :exc:`RuntimeError` exception is raised. |
|
417 |
|
418 .. index:: single: extended print statement |
|
419 |
|
420 :keyword:`print` also has an extended form, defined by the second portion of the |
|
421 syntax described above. This form is sometimes referred to as ":keyword:`print` |
|
422 chevron." In this form, the first expression after the ``>>`` must evaluate to a |
|
423 "file-like" object, specifically an object that has a :meth:`write` method as |
|
424 described above. With this extended form, the subsequent expressions are |
|
425 printed to this file object. If the first expression evaluates to ``None``, |
|
426 then ``sys.stdout`` is used as the file for output. |
|
427 |
|
428 |
|
429 .. _return: |
|
430 |
|
431 The :keyword:`return` statement |
|
432 =============================== |
|
433 |
|
434 .. index:: |
|
435 statement: return |
|
436 pair: function; definition |
|
437 pair: class; definition |
|
438 |
|
439 .. productionlist:: |
|
440 return_stmt: "return" [`expression_list`] |
|
441 |
|
442 :keyword:`return` may only occur syntactically nested in a function definition, |
|
443 not within a nested class definition. |
|
444 |
|
445 If an expression list is present, it is evaluated, else ``None`` is substituted. |
|
446 |
|
447 :keyword:`return` leaves the current function call with the expression list (or |
|
448 ``None``) as return value. |
|
449 |
|
450 .. index:: keyword: finally |
|
451 |
|
452 When :keyword:`return` passes control out of a :keyword:`try` statement with a |
|
453 :keyword:`finally` clause, that :keyword:`finally` clause is executed before |
|
454 really leaving the function. |
|
455 |
|
456 In a generator function, the :keyword:`return` statement is not allowed to |
|
457 include an :token:`expression_list`. In that context, a bare :keyword:`return` |
|
458 indicates that the generator is done and will cause :exc:`StopIteration` to be |
|
459 raised. |
|
460 |
|
461 |
|
462 .. _yield: |
|
463 |
|
464 The :keyword:`yield` statement |
|
465 ============================== |
|
466 |
|
467 .. index:: |
|
468 statement: yield |
|
469 single: generator; function |
|
470 single: generator; iterator |
|
471 single: function; generator |
|
472 exception: StopIteration |
|
473 |
|
474 .. productionlist:: |
|
475 yield_stmt: `yield_expression` |
|
476 |
|
477 The :keyword:`yield` statement is only used when defining a generator function, |
|
478 and is only used in the body of the generator function. Using a :keyword:`yield` |
|
479 statement in a function definition is sufficient to cause that definition to |
|
480 create a generator function instead of a normal function. |
|
481 |
|
482 When a generator function is called, it returns an iterator known as a generator |
|
483 iterator, or more commonly, a generator. The body of the generator function is |
|
484 executed by calling the generator's :meth:`next` method repeatedly until it |
|
485 raises an exception. |
|
486 |
|
487 When a :keyword:`yield` statement is executed, the state of the generator is |
|
488 frozen and the value of :token:`expression_list` is returned to :meth:`next`'s |
|
489 caller. By "frozen" we mean that all local state is retained, including the |
|
490 current bindings of local variables, the instruction pointer, and the internal |
|
491 evaluation stack: enough information is saved so that the next time :meth:`next` |
|
492 is invoked, the function can proceed exactly as if the :keyword:`yield` |
|
493 statement were just another external call. |
|
494 |
|
495 As of Python version 2.5, the :keyword:`yield` statement is now allowed in the |
|
496 :keyword:`try` clause of a :keyword:`try` ... :keyword:`finally` construct. If |
|
497 the generator is not resumed before it is finalized (by reaching a zero |
|
498 reference count or by being garbage collected), the generator-iterator's |
|
499 :meth:`close` method will be called, allowing any pending :keyword:`finally` |
|
500 clauses to execute. |
|
501 |
|
502 .. note:: |
|
503 |
|
504 In Python 2.2, the :keyword:`yield` statement was only allowed when the |
|
505 ``generators`` feature has been enabled. This ``__future__`` |
|
506 import statement was used to enable the feature:: |
|
507 |
|
508 from __future__ import generators |
|
509 |
|
510 |
|
511 .. seealso:: |
|
512 |
|
513 :pep:`0255` - Simple Generators |
|
514 The proposal for adding generators and the :keyword:`yield` statement to Python. |
|
515 |
|
516 :pep:`0342` - Coroutines via Enhanced Generators |
|
517 The proposal that, among other generator enhancements, proposed allowing |
|
518 :keyword:`yield` to appear inside a :keyword:`try` ... :keyword:`finally` block. |
|
519 |
|
520 |
|
521 .. _raise: |
|
522 |
|
523 The :keyword:`raise` statement |
|
524 ============================== |
|
525 |
|
526 .. index:: |
|
527 statement: raise |
|
528 single: exception |
|
529 pair: raising; exception |
|
530 |
|
531 .. productionlist:: |
|
532 raise_stmt: "raise" [`expression` ["," `expression` ["," `expression`]]] |
|
533 |
|
534 If no expressions are present, :keyword:`raise` re-raises the last exception |
|
535 that was active in the current scope. If no exception is active in the current |
|
536 scope, a :exc:`TypeError` exception is raised indicating that this is an error |
|
537 (if running under IDLE, a :exc:`Queue.Empty` exception is raised instead). |
|
538 |
|
539 Otherwise, :keyword:`raise` evaluates the expressions to get three objects, |
|
540 using ``None`` as the value of omitted expressions. The first two objects are |
|
541 used to determine the *type* and *value* of the exception. |
|
542 |
|
543 If the first object is an instance, the type of the exception is the class of |
|
544 the instance, the instance itself is the value, and the second object must be |
|
545 ``None``. |
|
546 |
|
547 If the first object is a class, it becomes the type of the exception. The second |
|
548 object is used to determine the exception value: If it is an instance of the |
|
549 class, the instance becomes the exception value. If the second object is a |
|
550 tuple, it is used as the argument list for the class constructor; if it is |
|
551 ``None``, an empty argument list is used, and any other object is treated as a |
|
552 single argument to the constructor. The instance so created by calling the |
|
553 constructor is used as the exception value. |
|
554 |
|
555 .. index:: object: traceback |
|
556 |
|
557 If a third object is present and not ``None``, it must be a traceback object |
|
558 (see section :ref:`types`), and it is substituted instead of the current |
|
559 location as the place where the exception occurred. If the third object is |
|
560 present and not a traceback object or ``None``, a :exc:`TypeError` exception is |
|
561 raised. The three-expression form of :keyword:`raise` is useful to re-raise an |
|
562 exception transparently in an except clause, but :keyword:`raise` with no |
|
563 expressions should be preferred if the exception to be re-raised was the most |
|
564 recently active exception in the current scope. |
|
565 |
|
566 Additional information on exceptions can be found in section :ref:`exceptions`, |
|
567 and information about handling exceptions is in section :ref:`try`. |
|
568 |
|
569 |
|
570 .. _break: |
|
571 |
|
572 The :keyword:`break` statement |
|
573 ============================== |
|
574 |
|
575 .. index:: |
|
576 statement: break |
|
577 statement: for |
|
578 statement: while |
|
579 pair: loop; statement |
|
580 |
|
581 .. productionlist:: |
|
582 break_stmt: "break" |
|
583 |
|
584 :keyword:`break` may only occur syntactically nested in a :keyword:`for` or |
|
585 :keyword:`while` loop, but not nested in a function or class definition within |
|
586 that loop. |
|
587 |
|
588 .. index:: keyword: else |
|
589 |
|
590 It terminates the nearest enclosing loop, skipping the optional :keyword:`else` |
|
591 clause if the loop has one. |
|
592 |
|
593 .. index:: pair: loop control; target |
|
594 |
|
595 If a :keyword:`for` loop is terminated by :keyword:`break`, the loop control |
|
596 target keeps its current value. |
|
597 |
|
598 .. index:: keyword: finally |
|
599 |
|
600 When :keyword:`break` passes control out of a :keyword:`try` statement with a |
|
601 :keyword:`finally` clause, that :keyword:`finally` clause is executed before |
|
602 really leaving the loop. |
|
603 |
|
604 |
|
605 .. _continue: |
|
606 |
|
607 The :keyword:`continue` statement |
|
608 ================================= |
|
609 |
|
610 .. index:: |
|
611 statement: continue |
|
612 statement: for |
|
613 statement: while |
|
614 pair: loop; statement |
|
615 keyword: finally |
|
616 |
|
617 .. productionlist:: |
|
618 continue_stmt: "continue" |
|
619 |
|
620 :keyword:`continue` may only occur syntactically nested in a :keyword:`for` or |
|
621 :keyword:`while` loop, but not nested in a function or class definition or |
|
622 :keyword:`finally` clause within that loop. It continues with the next |
|
623 cycle of the nearest enclosing loop. |
|
624 |
|
625 When :keyword:`continue` passes control out of a :keyword:`try` statement with a |
|
626 :keyword:`finally` clause, that :keyword:`finally` clause is executed before |
|
627 really starting the next loop cycle. |
|
628 |
|
629 |
|
630 .. _import: |
|
631 .. _from: |
|
632 |
|
633 The :keyword:`import` statement |
|
634 =============================== |
|
635 |
|
636 .. index:: |
|
637 statement: import |
|
638 single: module; importing |
|
639 pair: name; binding |
|
640 keyword: from |
|
641 |
|
642 .. productionlist:: |
|
643 import_stmt: "import" `module` ["as" `name`] ( "," `module` ["as" `name`] )* |
|
644 : | "from" `relative_module` "import" `identifier` ["as" `name`] |
|
645 : ( "," `identifier` ["as" `name`] )* |
|
646 : | "from" `relative_module` "import" "(" `identifier` ["as" `name`] |
|
647 : ( "," `identifier` ["as" `name`] )* [","] ")" |
|
648 : | "from" `module` "import" "*" |
|
649 module: (`identifier` ".")* `identifier` |
|
650 relative_module: "."* `module` | "."+ |
|
651 name: `identifier` |
|
652 |
|
653 Import statements are executed in two steps: (1) find a module, and initialize |
|
654 it if necessary; (2) define a name or names in the local namespace (of the scope |
|
655 where the :keyword:`import` statement occurs). The first form (without |
|
656 :keyword:`from`) repeats these steps for each identifier in the list. The form |
|
657 with :keyword:`from` performs step (1) once, and then performs step (2) |
|
658 repeatedly. |
|
659 |
|
660 In this context, to "initialize" a built-in or extension module means to call an |
|
661 initialization function that the module must provide for the purpose (in the |
|
662 reference implementation, the function's name is obtained by prepending string |
|
663 "init" to the module's name); to "initialize" a Python-coded module means to |
|
664 execute the module's body. |
|
665 |
|
666 .. index:: |
|
667 single: modules (in module sys) |
|
668 single: sys.modules |
|
669 pair: module; name |
|
670 pair: built-in; module |
|
671 pair: user-defined; module |
|
672 module: sys |
|
673 pair: filename; extension |
|
674 triple: module; search; path |
|
675 |
|
676 The system maintains a table of modules that have been or are being initialized, |
|
677 indexed by module name. This table is accessible as ``sys.modules``. When a |
|
678 module name is found in this table, step (1) is finished. If not, a search for |
|
679 a module definition is started. When a module is found, it is loaded. Details |
|
680 of the module searching and loading process are implementation and platform |
|
681 specific. It generally involves searching for a "built-in" module with the |
|
682 given name and then searching a list of locations given as ``sys.path``. |
|
683 |
|
684 .. index:: |
|
685 pair: module; initialization |
|
686 exception: ImportError |
|
687 single: code block |
|
688 exception: SyntaxError |
|
689 |
|
690 If a built-in module is found, its built-in initialization code is executed and |
|
691 step (1) is finished. If no matching file is found, :exc:`ImportError` is |
|
692 raised. If a file is found, it is parsed, yielding an executable code block. If |
|
693 a syntax error occurs, :exc:`SyntaxError` is raised. Otherwise, an empty module |
|
694 of the given name is created and inserted in the module table, and then the code |
|
695 block is executed in the context of this module. Exceptions during this |
|
696 execution terminate step (1). |
|
697 |
|
698 When step (1) finishes without raising an exception, step (2) can begin. |
|
699 |
|
700 The first form of :keyword:`import` statement binds the module name in the local |
|
701 namespace to the module object, and then goes on to import the next identifier, |
|
702 if any. If the module name is followed by :keyword:`as`, the name following |
|
703 :keyword:`as` is used as the local name for the module. |
|
704 |
|
705 .. index:: |
|
706 pair: name; binding |
|
707 exception: ImportError |
|
708 |
|
709 The :keyword:`from` form does not bind the module name: it goes through the list |
|
710 of identifiers, looks each one of them up in the module found in step (1), and |
|
711 binds the name in the local namespace to the object thus found. As with the |
|
712 first form of :keyword:`import`, an alternate local name can be supplied by |
|
713 specifying ":keyword:`as` localname". If a name is not found, |
|
714 :exc:`ImportError` is raised. If the list of identifiers is replaced by a star |
|
715 (``'*'``), all public names defined in the module are bound in the local |
|
716 namespace of the :keyword:`import` statement.. |
|
717 |
|
718 .. index:: single: __all__ (optional module attribute) |
|
719 |
|
720 The *public names* defined by a module are determined by checking the module's |
|
721 namespace for a variable named ``__all__``; if defined, it must be a sequence of |
|
722 strings which are names defined or imported by that module. The names given in |
|
723 ``__all__`` are all considered public and are required to exist. If ``__all__`` |
|
724 is not defined, the set of public names includes all names found in the module's |
|
725 namespace which do not begin with an underscore character (``'_'``). |
|
726 ``__all__`` should contain the entire public API. It is intended to avoid |
|
727 accidentally exporting items that are not part of the API (such as library |
|
728 modules which were imported and used within the module). |
|
729 |
|
730 The :keyword:`from` form with ``*`` may only occur in a module scope. If the |
|
731 wild card form of import --- ``import *`` --- is used in a function and the |
|
732 function contains or is a nested block with free variables, the compiler will |
|
733 raise a :exc:`SyntaxError`. |
|
734 |
|
735 .. index:: |
|
736 keyword: from |
|
737 statement: from |
|
738 triple: hierarchical; module; names |
|
739 single: packages |
|
740 single: __init__.py |
|
741 |
|
742 **Hierarchical module names:** when the module names contains one or more dots, |
|
743 the module search path is carried out differently. The sequence of identifiers |
|
744 up to the last dot is used to find a "package"; the final identifier is then |
|
745 searched inside the package. A package is generally a subdirectory of a |
|
746 directory on ``sys.path`` that has a file :file:`__init__.py`. |
|
747 |
|
748 .. |
|
749 [XXX Can't be |
|
750 bothered to spell this out right now; see the URL |
|
751 http://www.python.org/doc/essays/packages.html for more details, also about how |
|
752 the module search works from inside a package.] |
|
753 |
|
754 .. index:: builtin: __import__ |
|
755 |
|
756 The built-in function :func:`__import__` is provided to support applications |
|
757 that determine which modules need to be loaded dynamically; refer to |
|
758 :ref:`built-in-funcs` for additional information. |
|
759 |
|
760 |
|
761 .. _future: |
|
762 |
|
763 Future statements |
|
764 ----------------- |
|
765 |
|
766 .. index:: pair: future; statement |
|
767 |
|
768 A :dfn:`future statement` is a directive to the compiler that a particular |
|
769 module should be compiled using syntax or semantics that will be available in a |
|
770 specified future release of Python. The future statement is intended to ease |
|
771 migration to future versions of Python that introduce incompatible changes to |
|
772 the language. It allows use of the new features on a per-module basis before |
|
773 the release in which the feature becomes standard. |
|
774 |
|
775 .. productionlist:: * |
|
776 future_statement: "from" "__future__" "import" feature ["as" name] |
|
777 : ("," feature ["as" name])* |
|
778 : | "from" "__future__" "import" "(" feature ["as" name] |
|
779 : ("," feature ["as" name])* [","] ")" |
|
780 feature: identifier |
|
781 name: identifier |
|
782 |
|
783 A future statement must appear near the top of the module. The only lines that |
|
784 can appear before a future statement are: |
|
785 |
|
786 * the module docstring (if any), |
|
787 * comments, |
|
788 * blank lines, and |
|
789 * other future statements. |
|
790 |
|
791 The features recognized by Python 2.6 are ``unicode_literals``, |
|
792 ``print_function``, ``absolute_import``, ``division``, ``generators``, |
|
793 ``nested_scopes`` and ``with_statement``. ``generators``, ``with_statement``, |
|
794 ``nested_scopes`` are redundant in Python version 2.6 and above because they are |
|
795 always enabled. |
|
796 |
|
797 A future statement is recognized and treated specially at compile time: Changes |
|
798 to the semantics of core constructs are often implemented by generating |
|
799 different code. It may even be the case that a new feature introduces new |
|
800 incompatible syntax (such as a new reserved word), in which case the compiler |
|
801 may need to parse the module differently. Such decisions cannot be pushed off |
|
802 until runtime. |
|
803 |
|
804 For any given release, the compiler knows which feature names have been defined, |
|
805 and raises a compile-time error if a future statement contains a feature not |
|
806 known to it. |
|
807 |
|
808 The direct runtime semantics are the same as for any import statement: there is |
|
809 a standard module :mod:`__future__`, described later, and it will be imported in |
|
810 the usual way at the time the future statement is executed. |
|
811 |
|
812 The interesting runtime semantics depend on the specific feature enabled by the |
|
813 future statement. |
|
814 |
|
815 Note that there is nothing special about the statement:: |
|
816 |
|
817 import __future__ [as name] |
|
818 |
|
819 That is not a future statement; it's an ordinary import statement with no |
|
820 special semantics or syntax restrictions. |
|
821 |
|
822 Code compiled by an :keyword:`exec` statement or calls to the builtin functions |
|
823 :func:`compile` and :func:`execfile` that occur in a module :mod:`M` containing |
|
824 a future statement will, by default, use the new syntax or semantics associated |
|
825 with the future statement. This can, starting with Python 2.2 be controlled by |
|
826 optional arguments to :func:`compile` --- see the documentation of that function |
|
827 for details. |
|
828 |
|
829 A future statement typed at an interactive interpreter prompt will take effect |
|
830 for the rest of the interpreter session. If an interpreter is started with the |
|
831 :option:`-i` option, is passed a script name to execute, and the script includes |
|
832 a future statement, it will be in effect in the interactive session started |
|
833 after the script is executed. |
|
834 |
|
835 |
|
836 .. _global: |
|
837 |
|
838 The :keyword:`global` statement |
|
839 =============================== |
|
840 |
|
841 .. index:: |
|
842 statement: global |
|
843 triple: global; name; binding |
|
844 |
|
845 .. productionlist:: |
|
846 global_stmt: "global" `identifier` ("," `identifier`)* |
|
847 |
|
848 The :keyword:`global` statement is a declaration which holds for the entire |
|
849 current code block. It means that the listed identifiers are to be interpreted |
|
850 as globals. It would be impossible to assign to a global variable without |
|
851 :keyword:`global`, although free variables may refer to globals without being |
|
852 declared global. |
|
853 |
|
854 Names listed in a :keyword:`global` statement must not be used in the same code |
|
855 block textually preceding that :keyword:`global` statement. |
|
856 |
|
857 Names listed in a :keyword:`global` statement must not be defined as formal |
|
858 parameters or in a :keyword:`for` loop control target, :keyword:`class` |
|
859 definition, function definition, or :keyword:`import` statement. |
|
860 |
|
861 (The current implementation does not enforce the latter two restrictions, but |
|
862 programs should not abuse this freedom, as future implementations may enforce |
|
863 them or silently change the meaning of the program.) |
|
864 |
|
865 .. index:: |
|
866 statement: exec |
|
867 builtin: eval |
|
868 builtin: execfile |
|
869 builtin: compile |
|
870 |
|
871 **Programmer's note:** the :keyword:`global` is a directive to the parser. It |
|
872 applies only to code parsed at the same time as the :keyword:`global` statement. |
|
873 In particular, a :keyword:`global` statement contained in an :keyword:`exec` |
|
874 statement does not affect the code block *containing* the :keyword:`exec` |
|
875 statement, and code contained in an :keyword:`exec` statement is unaffected by |
|
876 :keyword:`global` statements in the code containing the :keyword:`exec` |
|
877 statement. The same applies to the :func:`eval`, :func:`execfile` and |
|
878 :func:`compile` functions. |
|
879 |
|
880 |
|
881 .. _exec: |
|
882 |
|
883 The :keyword:`exec` statement |
|
884 ============================= |
|
885 |
|
886 .. index:: statement: exec |
|
887 |
|
888 .. productionlist:: |
|
889 exec_stmt: "exec" `or_expr` ["in" `expression` ["," `expression`]] |
|
890 |
|
891 This statement supports dynamic execution of Python code. The first expression |
|
892 should evaluate to either a string, an open file object, or a code object. If |
|
893 it is a string, the string is parsed as a suite of Python statements which is |
|
894 then executed (unless a syntax error occurs). If it is an open file, the file |
|
895 is parsed until EOF and executed. If it is a code object, it is simply |
|
896 executed. In all cases, the code that's executed is expected to be valid as |
|
897 file input (see section :ref:`file-input`). Be aware that the |
|
898 :keyword:`return` and :keyword:`yield` statements may not be used outside of |
|
899 function definitions even within the context of code passed to the |
|
900 :keyword:`exec` statement. |
|
901 |
|
902 In all cases, if the optional parts are omitted, the code is executed in the |
|
903 current scope. If only the first expression after :keyword:`in` is specified, |
|
904 it should be a dictionary, which will be used for both the global and the local |
|
905 variables. If two expressions are given, they are used for the global and local |
|
906 variables, respectively. If provided, *locals* can be any mapping object. |
|
907 |
|
908 .. versionchanged:: 2.4 |
|
909 Formerly, *locals* was required to be a dictionary. |
|
910 |
|
911 .. index:: |
|
912 single: __builtins__ |
|
913 module: __builtin__ |
|
914 |
|
915 As a side effect, an implementation may insert additional keys into the |
|
916 dictionaries given besides those corresponding to variable names set by the |
|
917 executed code. For example, the current implementation may add a reference to |
|
918 the dictionary of the built-in module :mod:`__builtin__` under the key |
|
919 ``__builtins__`` (!). |
|
920 |
|
921 .. index:: |
|
922 builtin: eval |
|
923 builtin: globals |
|
924 builtin: locals |
|
925 |
|
926 **Programmer's hints:** dynamic evaluation of expressions is supported by the |
|
927 built-in function :func:`eval`. The built-in functions :func:`globals` and |
|
928 :func:`locals` return the current global and local dictionary, respectively, |
|
929 which may be useful to pass around for use by :keyword:`exec`. |
|
930 |
|
931 |