blob: e149710a5a12c99f9196620d4a1866fdb7055346 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001
2.. _simple:
3
4*****************
5Simple statements
6*****************
7
8.. index:: pair: simple; statement
9
10Simple statements are comprised within a single logical line. Several simple
11statements may occur on a single line separated by semicolons. The syntax for
12simple 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 : | `return_stmt`
22 : | `yield_stmt`
23 : | `raise_stmt`
24 : | `break_stmt`
25 : | `continue_stmt`
26 : | `import_stmt`
27 : | `global_stmt`
Georg Brandl02c30562007-09-07 17:52:53 +000028 : | `nonlocal_stmt`
Georg Brandl116aa622007-08-15 14:28:22 +000029
30
31.. _exprstmts:
32
33Expression statements
34=====================
35
Christian Heimesfaf2f632008-01-06 16:59:19 +000036.. index::
37 pair: expression; statement
38 pair: expression; list
Georg Brandl02c30562007-09-07 17:52:53 +000039.. index:: pair: expression; list
Georg Brandl116aa622007-08-15 14:28:22 +000040
41Expression statements are used (mostly interactively) to compute and write a
42value, or (usually) to call a procedure (a function that returns no meaningful
43result; in Python, procedures return the value ``None``). Other uses of
44expression statements are allowed and occasionally useful. The syntax for an
45expression statement is:
46
47.. productionlist::
48 expression_stmt: `expression_list`
49
Georg Brandl116aa622007-08-15 14:28:22 +000050An expression statement evaluates the expression list (which may be a single
51expression).
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
62In interactive mode, if the value is not ``None``, it is converted to a string
63using the built-in :func:`repr` function and the resulting string is written to
Georg Brandl02c30562007-09-07 17:52:53 +000064standard output on a line by itself (except if the result is ``None``, so that
65procedure calls do not cause any output.)
Georg Brandl116aa622007-08-15 14:28:22 +000066
Georg Brandl116aa622007-08-15 14:28:22 +000067.. _assignment:
68
69Assignment statements
70=====================
71
72.. index::
73 pair: assignment; statement
74 pair: binding; name
75 pair: rebinding; name
76 object: mutable
77 pair: attribute; assignment
78
79Assignment statements are used to (re)bind names to values and to modify
80attributes or items of mutable objects:
81
82.. productionlist::
83 assignment_stmt: (`target_list` "=")+ (`expression_list` | `yield_expression`)
84 target_list: `target` ("," `target`)* [","]
85 target: `identifier`
86 : | "(" `target_list` ")"
87 : | "[" `target_list` "]"
88 : | `attributeref`
89 : | `subscription`
90 : | `slicing`
Georg Brandl02c30562007-09-07 17:52:53 +000091 : | "*" `target`
Georg Brandl116aa622007-08-15 14:28:22 +000092
93(See section :ref:`primaries` for the syntax definitions for the last three
94symbols.)
95
Georg Brandl116aa622007-08-15 14:28:22 +000096An assignment statement evaluates the expression list (remember that this can be
97a single expression or a comma-separated list, the latter yielding a tuple) and
98assigns the single resulting object to each of the target lists, from left to
99right.
100
101.. index::
102 single: target
103 pair: target; list
104
105Assignment is defined recursively depending on the form of the target (list).
106When a target is part of a mutable object (an attribute reference, subscription
107or slicing), the mutable object must ultimately perform the assignment and
108decide about its validity, and may raise an exception if the assignment is
109unacceptable. The rules observed by various types and the exceptions raised are
110given with the definition of the object types (see section :ref:`types`).
111
112.. index:: triple: target; list; assignment
113
Georg Brandl02c30562007-09-07 17:52:53 +0000114Assignment of an object to a target list, optionally enclosed in parentheses or
115square brackets, is recursively defined as follows.
Georg Brandl116aa622007-08-15 14:28:22 +0000116
117* If the target list is a single target: The object is assigned to that target.
118
Georg Brandl02c30562007-09-07 17:52:53 +0000119* If the target list is a comma-separated list of targets:
120
121 * If the target list contains one target prefixed with an asterisk, called a
122 "starred" target: The object must be a sequence with at least as many items
123 as there are targets in the target list, minus one. The first items of the
124 sequence are assigned, from left to right, to the targets before the starred
125 target. The final items of the sequence are assigned to the targets after
126 the starred target. A list of the remaining items in the sequence is then
127 assigned to the starred target (the list can be empty).
128
129 * Else: The object must be a sequence with the same number of items as there
130 are targets in the target list, and the items are assigned, from left to
131 right, to the corresponding targets.
Georg Brandl116aa622007-08-15 14:28:22 +0000132
133Assignment of an object to a single target is recursively defined as follows.
134
135* If the target is an identifier (name):
136
Georg Brandl02c30562007-09-07 17:52:53 +0000137 * If the name does not occur in a :keyword:`global` or :keyword:`nonlocal`
138 statement in the current code block: the name is bound to the object in the
139 current local namespace.
Georg Brandl116aa622007-08-15 14:28:22 +0000140
Georg Brandl02c30562007-09-07 17:52:53 +0000141 * Otherwise: the name is bound to the object in the global namespace or the
142 outer namespace determined by :keyword:`nonlocal`, respectively.
Georg Brandl116aa622007-08-15 14:28:22 +0000143
Georg Brandl02c30562007-09-07 17:52:53 +0000144 The name is rebound if it was already bound. This may cause the reference
145 count for the object previously bound to the name to reach zero, causing the
146 object to be deallocated and its destructor (if it has one) to be called.
Georg Brandl116aa622007-08-15 14:28:22 +0000147
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000148 .. index:: single: destructor
149
150 The name is rebound if it was already bound. This may cause the reference count
151 for the object previously bound to the name to reach zero, causing the object to
152 be deallocated and its destructor (if it has one) to be called.
153
154* If the target is a target list enclosed in parentheses or in square brackets:
155 The object must be a sequence with the same number of items as there are targets
156 in the target list, and its items are assigned, from left to right, to the
157 corresponding targets.
158
159 .. index:: pair: attribute; assignment
160
Georg Brandl116aa622007-08-15 14:28:22 +0000161* If the target is an attribute reference: The primary expression in the
162 reference is evaluated. It should yield an object with assignable attributes;
Georg Brandl02c30562007-09-07 17:52:53 +0000163 if this is not the case, :exc:`TypeError` is raised. That object is then
164 asked to assign the assigned object to the given attribute; if it cannot
165 perform the assignment, it raises an exception (usually but not necessarily
Georg Brandl116aa622007-08-15 14:28:22 +0000166 :exc:`AttributeError`).
167
168 .. index::
169 pair: subscription; assignment
170 object: mutable
171
172* If the target is a subscription: The primary expression in the reference is
Georg Brandl02c30562007-09-07 17:52:53 +0000173 evaluated. It should yield either a mutable sequence object (such as a list)
174 or a mapping object (such as a dictionary). Next, the subscript expression is
Georg Brandl116aa622007-08-15 14:28:22 +0000175 evaluated.
176
177 .. index::
178 object: sequence
179 object: list
180
Georg Brandl02c30562007-09-07 17:52:53 +0000181 If the primary is a mutable sequence object (such as a list), the subscript
182 must yield an integer. If it is negative, the sequence's length is added to
183 it. The resulting value must be a nonnegative integer less than the
184 sequence's length, and the sequence is asked to assign the assigned object to
185 its item with that index. If the index is out of range, :exc:`IndexError` is
186 raised (assignment to a subscripted sequence cannot add new items to a list).
Georg Brandl116aa622007-08-15 14:28:22 +0000187
188 .. index::
189 object: mapping
190 object: dictionary
191
192 If the primary is a mapping object (such as a dictionary), the subscript must
193 have a type compatible with the mapping's key type, and the mapping is then
194 asked to create a key/datum pair which maps the subscript to the assigned
195 object. This can either replace an existing key/value pair with the same key
196 value, or insert a new key/value pair (if no key with the same value existed).
197
Georg Brandl02c30562007-09-07 17:52:53 +0000198 For user-defined objects, the :meth:`__setitem__` method is called with
199 appropriate arguments.
200
Georg Brandl116aa622007-08-15 14:28:22 +0000201 .. index:: pair: slicing; assignment
202
203* If the target is a slicing: The primary expression in the reference is
204 evaluated. It should yield a mutable sequence object (such as a list). The
205 assigned object should be a sequence object of the same type. Next, the lower
206 and upper bound expressions are evaluated, insofar they are present; defaults
Georg Brandl02c30562007-09-07 17:52:53 +0000207 are zero and the sequence's length. The bounds should evaluate to integers.
208 If either bound is negative, the sequence's length is added to it. The
209 resulting bounds are clipped to lie between zero and the sequence's length,
210 inclusive. Finally, the sequence object is asked to replace the slice with
211 the items of the assigned sequence. The length of the slice may be different
212 from the length of the assigned sequence, thus changing the length of the
213 target sequence, if the object allows it.
Georg Brandl116aa622007-08-15 14:28:22 +0000214
215(In the current implementation, the syntax for targets is taken to be the same
216as for expressions, and invalid syntax is rejected during the code generation
217phase, causing less detailed error messages.)
218
219WARNING: Although the definition of assignment implies that overlaps between the
220left-hand side and the right-hand side are 'safe' (for example ``a, b = b, a``
221swaps two variables), overlaps *within* the collection of assigned-to variables
222are not safe! For instance, the following program prints ``[0, 2]``::
223
224 x = [0, 1]
225 i = 0
226 i, x[i] = 1, 2
Georg Brandl6911e3c2007-09-04 07:15:32 +0000227 print(x)
Georg Brandl116aa622007-08-15 14:28:22 +0000228
229
Georg Brandl02c30562007-09-07 17:52:53 +0000230.. seealso::
231
232 :pep:`3132` - Extended Iterable Unpacking
233 The specification for the ``*target`` feature.
234
235
Georg Brandl116aa622007-08-15 14:28:22 +0000236.. _augassign:
237
238Augmented assignment statements
239-------------------------------
240
241.. index::
242 pair: augmented; assignment
243 single: statement; assignment, augmented
244
245Augmented assignment is the combination, in a single statement, of a binary
246operation and an assignment statement:
247
248.. productionlist::
249 augmented_assignment_stmt: `target` `augop` (`expression_list` | `yield_expression`)
250 augop: "+=" | "-=" | "*=" | "/=" | "%=" | "**="
251 : | ">>=" | "<<=" | "&=" | "^=" | "|="
252
253(See section :ref:`primaries` for the syntax definitions for the last three
254symbols.)
255
256An augmented assignment evaluates the target (which, unlike normal assignment
257statements, cannot be an unpacking) and the expression list, performs the binary
258operation specific to the type of assignment on the two operands, and assigns
259the result to the original target. The target is only evaluated once.
260
261An augmented assignment expression like ``x += 1`` can be rewritten as ``x = x +
2621`` to achieve a similar, but not exactly equal effect. In the augmented
263version, ``x`` is only evaluated once. Also, when possible, the actual operation
264is performed *in-place*, meaning that rather than creating a new object and
265assigning that to the target, the old object is modified instead.
266
267With the exception of assigning to tuples and multiple targets in a single
268statement, the assignment done by augmented assignment statements is handled the
269same way as normal assignments. Similarly, with the exception of the possible
270*in-place* behavior, the binary operation performed by augmented assignment is
271the same as the normal binary operations.
272
273For targets which are attribute references, the initial value is retrieved with
274a :meth:`getattr` and the result is assigned with a :meth:`setattr`. Notice
275that the two methods do not necessarily refer to the same variable. When
276:meth:`getattr` refers to a class variable, :meth:`setattr` still writes to an
277instance variable. For example::
278
279 class A:
280 x = 3 # class variable
281 a = A()
282 a.x += 1 # writes a.x as 4 leaving A.x as 3
283
284
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000285.. _assert:
286
287The :keyword:`assert` statement
288===============================
289
290.. index::
291 statement: assert
292 pair: debugging; assertions
293
294Assert statements are a convenient way to insert debugging assertions into a
295program:
296
297.. productionlist::
298 assert_stmt: "assert" `expression` ["," `expression`]
299
300The simple form, ``assert expression``, is equivalent to ::
301
302 if __debug__:
303 if not expression: raise AssertionError
304
305The extended form, ``assert expression1, expression2``, is equivalent to ::
306
307 if __debug__:
Georg Brandl18a499d2007-12-29 10:57:11 +0000308 if not expression1: raise AssertionError(expression2)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000309
310.. index::
311 single: __debug__
312 exception: AssertionError
313
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000314These equivalences assume that :const:`__debug__` and :exc:`AssertionError` refer to
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000315the built-in variables with those names. In the current implementation, the
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000316built-in variable :const:`__debug__` is ``True`` under normal circumstances,
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000317``False`` when optimization is requested (command line option -O). The current
318code generator emits no code for an assert statement when optimization is
319requested at compile time. Note that it is unnecessary to include the source
320code for the expression that failed in the error message; it will be displayed
321as part of the stack trace.
322
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000323Assignments to :const:`__debug__` are illegal. The value for the built-in variable
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000324is determined when the interpreter starts.
325
326
Georg Brandl116aa622007-08-15 14:28:22 +0000327.. _pass:
328
329The :keyword:`pass` statement
330=============================
331
Christian Heimesfaf2f632008-01-06 16:59:19 +0000332.. index::
333 statement: pass
334 pair: null; operation
Georg Brandl02c30562007-09-07 17:52:53 +0000335 pair: null; operation
Georg Brandl116aa622007-08-15 14:28:22 +0000336
337.. productionlist::
338 pass_stmt: "pass"
339
Georg Brandl116aa622007-08-15 14:28:22 +0000340:keyword:`pass` is a null operation --- when it is executed, nothing happens.
341It is useful as a placeholder when a statement is required syntactically, but no
342code needs to be executed, for example::
343
344 def f(arg): pass # a function that does nothing (yet)
345
346 class C: pass # a class with no methods (yet)
347
348
349.. _del:
350
351The :keyword:`del` statement
352============================
353
Christian Heimesfaf2f632008-01-06 16:59:19 +0000354.. index::
355 statement: del
356 pair: deletion; target
357 triple: deletion; target; list
Georg Brandl116aa622007-08-15 14:28:22 +0000358
359.. productionlist::
360 del_stmt: "del" `target_list`
361
Georg Brandl116aa622007-08-15 14:28:22 +0000362Deletion is recursively defined very similar to the way assignment is defined.
363Rather that spelling it out in full details, here are some hints.
364
365Deletion of a target list recursively deletes each target, from left to right.
366
367.. index::
368 statement: global
369 pair: unbinding; name
370
Georg Brandl02c30562007-09-07 17:52:53 +0000371Deletion of a name removes the binding of that name from the local or global
Georg Brandl116aa622007-08-15 14:28:22 +0000372namespace, depending on whether the name occurs in a :keyword:`global` statement
373in the same code block. If the name is unbound, a :exc:`NameError` exception
374will be raised.
375
376.. index:: pair: free; variable
377
378It is illegal to delete a name from the local namespace if it occurs as a free
379variable in a nested block.
380
381.. index:: pair: attribute; deletion
382
383Deletion of attribute references, subscriptions and slicings is passed to the
384primary object involved; deletion of a slicing is in general equivalent to
385assignment of an empty slice of the right type (but even this is determined by
386the sliced object).
387
388
389.. _return:
390
391The :keyword:`return` statement
392===============================
393
Christian Heimesfaf2f632008-01-06 16:59:19 +0000394.. index::
395 statement: return
396 pair: function; definition
397 pair: class; definition
Georg Brandl116aa622007-08-15 14:28:22 +0000398
399.. productionlist::
400 return_stmt: "return" [`expression_list`]
401
Georg Brandl116aa622007-08-15 14:28:22 +0000402:keyword:`return` may only occur syntactically nested in a function definition,
403not within a nested class definition.
404
405If an expression list is present, it is evaluated, else ``None`` is substituted.
406
407:keyword:`return` leaves the current function call with the expression list (or
408``None``) as return value.
409
410.. index:: keyword: finally
411
412When :keyword:`return` passes control out of a :keyword:`try` statement with a
413:keyword:`finally` clause, that :keyword:`finally` clause is executed before
414really leaving the function.
415
416In a generator function, the :keyword:`return` statement is not allowed to
417include an :token:`expression_list`. In that context, a bare :keyword:`return`
418indicates that the generator is done and will cause :exc:`StopIteration` to be
419raised.
420
421
422.. _yield:
423
424The :keyword:`yield` statement
425==============================
426
Christian Heimesfaf2f632008-01-06 16:59:19 +0000427.. index::
428 statement: yield
429 single: generator; function
430 single: generator; iterator
431 single: function; generator
432 exception: StopIteration
433
Georg Brandl116aa622007-08-15 14:28:22 +0000434.. productionlist::
435 yield_stmt: `yield_expression`
436
Christian Heimesfaf2f632008-01-06 16:59:19 +0000437The :keyword:`yield` statement is only used when defining a generator function,
438and is only used in the body of the generator function. Using a :keyword:`yield`
439statement in a function definition is sufficient to cause that definition to
440create a generator function instead of a normal function.
441>>>>>>> .merge-right.r59773
Georg Brandl116aa622007-08-15 14:28:22 +0000442
443.. _raise:
444
445The :keyword:`raise` statement
446==============================
447
Christian Heimesfaf2f632008-01-06 16:59:19 +0000448.. index::
449 statement: raise
450 single: exception
451 pair: raising; exception
Georg Brandl116aa622007-08-15 14:28:22 +0000452
453.. productionlist::
Christian Heimesfaf2f632008-01-06 16:59:19 +0000454 raise_stmt: "raise" [`expression` ["," `expression` ["," `expression`]]]
Georg Brandl116aa622007-08-15 14:28:22 +0000455
456If no expressions are present, :keyword:`raise` re-raises the last exception
457that was active in the current scope. If no exception is active in the current
458scope, a :exc:`TypeError` exception is raised indicating that this is an error
459(if running under IDLE, a :exc:`Queue.Empty` exception is raised instead).
460
Georg Brandl02c30562007-09-07 17:52:53 +0000461Otherwise, :keyword:`raise` evaluates the first expression as the exception
462object. It must be either a subclass or an instance of :class:`BaseException`.
463If it is a class, the exception instance will be obtained when needed by
464instantiating the class with no arguments.
Georg Brandl116aa622007-08-15 14:28:22 +0000465
Georg Brandl02c30562007-09-07 17:52:53 +0000466The :dfn:`type` of the exception is the exception instance's class, the
467:dfn:`value` is the instance itself.
Georg Brandl116aa622007-08-15 14:28:22 +0000468
469.. index:: object: traceback
470
Georg Brandl02c30562007-09-07 17:52:53 +0000471A traceback object is normally created automatically when an exception is raised
472and attached to it as the :attr:`__traceback__` attribute; however, you can set
473your own traceback using the :meth:`with_traceback` exception method, like so::
474
475 raise RuntimeError("foo occurred").with_traceback(tracebackobj)
476
477.. XXX document exception chaining
478
479The "from" clause is used for exception chaining, which is not documented yet.
Georg Brandl116aa622007-08-15 14:28:22 +0000480
481Additional information on exceptions can be found in section :ref:`exceptions`,
482and information about handling exceptions is in section :ref:`try`.
483
Georg Brandl02c30562007-09-07 17:52:53 +0000484.. seealso::
485
486 :pep:`3109` - Raising exceptions in Python 3000
487 Describes the differences in :keyword:`raise` statements between Python
488 2.x and 3.0.
489
Georg Brandl116aa622007-08-15 14:28:22 +0000490
491.. _break:
492
493The :keyword:`break` statement
494==============================
495
Christian Heimesfaf2f632008-01-06 16:59:19 +0000496.. index::
497 statement: break
498 statement: for
499 statement: while
500 pair: loop; statement
Georg Brandl116aa622007-08-15 14:28:22 +0000501
502.. productionlist::
503 break_stmt: "break"
504
Georg Brandl116aa622007-08-15 14:28:22 +0000505:keyword:`break` may only occur syntactically nested in a :keyword:`for` or
506:keyword:`while` loop, but not nested in a function or class definition within
507that loop.
508
509.. index:: keyword: else
Georg Brandl02c30562007-09-07 17:52:53 +0000510 pair: loop control; target
Georg Brandl116aa622007-08-15 14:28:22 +0000511
512It terminates the nearest enclosing loop, skipping the optional :keyword:`else`
513clause if the loop has one.
514
Georg Brandl116aa622007-08-15 14:28:22 +0000515If a :keyword:`for` loop is terminated by :keyword:`break`, the loop control
516target keeps its current value.
517
518.. index:: keyword: finally
519
520When :keyword:`break` passes control out of a :keyword:`try` statement with a
521:keyword:`finally` clause, that :keyword:`finally` clause is executed before
522really leaving the loop.
523
524
525.. _continue:
526
527The :keyword:`continue` statement
528=================================
529
Christian Heimesfaf2f632008-01-06 16:59:19 +0000530.. index::
531 statement: continue
532 statement: for
533 statement: while
534 pair: loop; statement
535 keyword: finally
Georg Brandl116aa622007-08-15 14:28:22 +0000536
537.. productionlist::
538 continue_stmt: "continue"
539
Georg Brandl116aa622007-08-15 14:28:22 +0000540:keyword:`continue` may only occur syntactically nested in a :keyword:`for` or
541:keyword:`while` loop, but not nested in a function or class definition or
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000542:keyword:`finally` clause within that loop. It continues with the next
Georg Brandl116aa622007-08-15 14:28:22 +0000543cycle of the nearest enclosing loop.
544
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000545When :keyword:`continue` passes control out of a :keyword:`try` statement with a
546:keyword:`finally` clause, that :keyword:`finally` clause is executed before
547really starting the next loop cycle.
548
Georg Brandl116aa622007-08-15 14:28:22 +0000549
550.. _import:
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000551.. _from:
Georg Brandl116aa622007-08-15 14:28:22 +0000552
553The :keyword:`import` statement
554===============================
555
556.. index::
557 statement: import
558 single: module; importing
559 pair: name; binding
560 keyword: from
561
562.. productionlist::
563 import_stmt: "import" `module` ["as" `name`] ( "," `module` ["as" `name`] )*
564 : | "from" `relative_module` "import" `identifier` ["as" `name`]
565 : ( "," `identifier` ["as" `name`] )*
566 : | "from" `relative_module` "import" "(" `identifier` ["as" `name`]
567 : ( "," `identifier` ["as" `name`] )* [","] ")"
568 : | "from" `module` "import" "*"
569 module: (`identifier` ".")* `identifier`
570 relative_module: "."* `module` | "."+
571 name: `identifier`
572
573Import statements are executed in two steps: (1) find a module, and initialize
574it if necessary; (2) define a name or names in the local namespace (of the scope
Georg Brandl02c30562007-09-07 17:52:53 +0000575where the :keyword:`import` statement occurs). The first form (without
Georg Brandl116aa622007-08-15 14:28:22 +0000576:keyword:`from`) repeats these steps for each identifier in the list. The form
577with :keyword:`from` performs step (1) once, and then performs step (2)
578repeatedly.
579
580In this context, to "initialize" a built-in or extension module means to call an
581initialization function that the module must provide for the purpose (in the
582reference implementation, the function's name is obtained by prepending string
583"init" to the module's name); to "initialize" a Python-coded module means to
584execute the module's body.
585
586.. index::
587 single: modules (in module sys)
588 single: sys.modules
589 pair: module; name
590 pair: built-in; module
591 pair: user-defined; module
Georg Brandl116aa622007-08-15 14:28:22 +0000592 pair: filename; extension
593 triple: module; search; path
Georg Brandl02c30562007-09-07 17:52:53 +0000594 module: sys
Georg Brandl116aa622007-08-15 14:28:22 +0000595
596The system maintains a table of modules that have been or are being initialized,
597indexed by module name. This table is accessible as ``sys.modules``. When a
598module name is found in this table, step (1) is finished. If not, a search for
599a module definition is started. When a module is found, it is loaded. Details
600of the module searching and loading process are implementation and platform
601specific. It generally involves searching for a "built-in" module with the
602given name and then searching a list of locations given as ``sys.path``.
603
604.. index::
605 pair: module; initialization
606 exception: ImportError
607 single: code block
608 exception: SyntaxError
609
610If a built-in module is found, its built-in initialization code is executed and
611step (1) is finished. If no matching file is found, :exc:`ImportError` is
612raised. If a file is found, it is parsed, yielding an executable code block. If
613a syntax error occurs, :exc:`SyntaxError` is raised. Otherwise, an empty module
614of the given name is created and inserted in the module table, and then the code
615block is executed in the context of this module. Exceptions during this
616execution terminate step (1).
617
618When step (1) finishes without raising an exception, step (2) can begin.
619
620The first form of :keyword:`import` statement binds the module name in the local
621namespace to the module object, and then goes on to import the next identifier,
622if any. If the module name is followed by :keyword:`as`, the name following
623:keyword:`as` is used as the local name for the module.
624
625.. index::
626 pair: name; binding
627 exception: ImportError
628
629The :keyword:`from` form does not bind the module name: it goes through the list
630of identifiers, looks each one of them up in the module found in step (1), and
631binds the name in the local namespace to the object thus found. As with the
632first form of :keyword:`import`, an alternate local name can be supplied by
633specifying ":keyword:`as` localname". If a name is not found,
634:exc:`ImportError` is raised. If the list of identifiers is replaced by a star
635(``'*'``), all public names defined in the module are bound in the local
636namespace of the :keyword:`import` statement..
637
638.. index:: single: __all__ (optional module attribute)
639
640The *public names* defined by a module are determined by checking the module's
641namespace for a variable named ``__all__``; if defined, it must be a sequence of
642strings which are names defined or imported by that module. The names given in
643``__all__`` are all considered public and are required to exist. If ``__all__``
644is not defined, the set of public names includes all names found in the module's
645namespace which do not begin with an underscore character (``'_'``).
646``__all__`` should contain the entire public API. It is intended to avoid
647accidentally exporting items that are not part of the API (such as library
648modules which were imported and used within the module).
649
650The :keyword:`from` form with ``*`` may only occur in a module scope. If the
651wild card form of import --- ``import *`` --- is used in a function and the
652function contains or is a nested block with free variables, the compiler will
653raise a :exc:`SyntaxError`.
654
655.. index::
656 keyword: from
Christian Heimesfaf2f632008-01-06 16:59:19 +0000657 statement: from
Georg Brandl116aa622007-08-15 14:28:22 +0000658 triple: hierarchical; module; names
659 single: packages
660 single: __init__.py
661
662**Hierarchical module names:** when the module names contains one or more dots,
663the module search path is carried out differently. The sequence of identifiers
664up to the last dot is used to find a "package"; the final identifier is then
665searched inside the package. A package is generally a subdirectory of a
666directory on ``sys.path`` that has a file :file:`__init__.py`. [XXX Can't be
667bothered to spell this out right now; see the URL
668http://www.python.org/doc/essays/packages.html for more details, also about how
669the module search works from inside a package.]
670
Georg Brandl116aa622007-08-15 14:28:22 +0000671.. index:: builtin: __import__
672
673The built-in function :func:`__import__` is provided to support applications
674that determine which modules need to be loaded dynamically; refer to
675:ref:`built-in-funcs` for additional information.
676
677
678.. _future:
679
680Future statements
681-----------------
682
683.. index:: pair: future; statement
684
685A :dfn:`future statement` is a directive to the compiler that a particular
686module should be compiled using syntax or semantics that will be available in a
687specified future release of Python. The future statement is intended to ease
688migration to future versions of Python that introduce incompatible changes to
689the language. It allows use of the new features on a per-module basis before
690the release in which the feature becomes standard.
691
692.. productionlist:: *
693 future_statement: "from" "__future__" "import" feature ["as" name]
694 : ("," feature ["as" name])*
695 : | "from" "__future__" "import" "(" feature ["as" name]
696 : ("," feature ["as" name])* [","] ")"
697 feature: identifier
698 name: identifier
699
700A future statement must appear near the top of the module. The only lines that
701can appear before a future statement are:
702
703* the module docstring (if any),
704* comments,
705* blank lines, and
706* other future statements.
707
Georg Brandl02c30562007-09-07 17:52:53 +0000708.. XXX change this if future is cleaned out
709
710The features recognized by Python 3.0 are ``absolute_import``, ``division``,
711``generators``, ``nested_scopes`` and ``with_statement``. They are all
712redundant because they are always enabled, and only kept for backwards
713compatibility.
Georg Brandl116aa622007-08-15 14:28:22 +0000714
715A future statement is recognized and treated specially at compile time: Changes
716to the semantics of core constructs are often implemented by generating
717different code. It may even be the case that a new feature introduces new
718incompatible syntax (such as a new reserved word), in which case the compiler
719may need to parse the module differently. Such decisions cannot be pushed off
720until runtime.
721
722For any given release, the compiler knows which feature names have been defined,
723and raises a compile-time error if a future statement contains a feature not
724known to it.
725
726The direct runtime semantics are the same as for any import statement: there is
727a standard module :mod:`__future__`, described later, and it will be imported in
728the usual way at the time the future statement is executed.
729
730The interesting runtime semantics depend on the specific feature enabled by the
731future statement.
732
733Note that there is nothing special about the statement::
734
735 import __future__ [as name]
736
737That is not a future statement; it's an ordinary import statement with no
738special semantics or syntax restrictions.
739
740Code compiled by calls to the builtin functions :func:`exec` and :func:`compile`
Georg Brandl02c30562007-09-07 17:52:53 +0000741that occur in a module :mod:`M` containing a future statement will, by default,
742use the new syntax or semantics associated with the future statement. This can
743be controlled by optional arguments to :func:`compile` --- see the documentation
744of that function for details.
Georg Brandl116aa622007-08-15 14:28:22 +0000745
746A future statement typed at an interactive interpreter prompt will take effect
747for the rest of the interpreter session. If an interpreter is started with the
748:option:`-i` option, is passed a script name to execute, and the script includes
749a future statement, it will be in effect in the interactive session started
750after the script is executed.
751
752
753.. _global:
754
755The :keyword:`global` statement
756===============================
757
Christian Heimesfaf2f632008-01-06 16:59:19 +0000758.. index::
759 statement: global
760 triple: global; name; binding
Georg Brandl116aa622007-08-15 14:28:22 +0000761
762.. productionlist::
763 global_stmt: "global" `identifier` ("," `identifier`)*
764
Georg Brandl116aa622007-08-15 14:28:22 +0000765The :keyword:`global` statement is a declaration which holds for the entire
766current code block. It means that the listed identifiers are to be interpreted
767as globals. It would be impossible to assign to a global variable without
768:keyword:`global`, although free variables may refer to globals without being
769declared global.
770
771Names listed in a :keyword:`global` statement must not be used in the same code
772block textually preceding that :keyword:`global` statement.
773
774Names listed in a :keyword:`global` statement must not be defined as formal
775parameters or in a :keyword:`for` loop control target, :keyword:`class`
776definition, function definition, or :keyword:`import` statement.
777
778(The current implementation does not enforce the latter two restrictions, but
779programs should not abuse this freedom, as future implementations may enforce
780them or silently change the meaning of the program.)
781
782.. index::
783 builtin: exec
784 builtin: eval
785 builtin: compile
786
787**Programmer's note:** the :keyword:`global` is a directive to the parser. It
788applies only to code parsed at the same time as the :keyword:`global` statement.
789In particular, a :keyword:`global` statement contained in a string or code
790object supplied to the builtin :func:`exec` function does not affect the code
791block *containing* the function call, and code contained in such a string is
792unaffected by :keyword:`global` statements in the code containing the function
793call. The same applies to the :func:`eval` and :func:`compile` functions.
794
Georg Brandl02c30562007-09-07 17:52:53 +0000795
796.. _nonlocal:
797
798The :keyword:`nonlocal` statement
799=================================
800
801.. index:: statement: nonlocal
802
803.. productionlist::
804 nonlocal_stmt: "nonlocal" `identifier` ("," `identifier`)*
805
Georg Brandlc5d98b42007-12-04 18:11:03 +0000806.. XXX add when implemented
807 : ["=" (`target_list` "=")+ `expression_list`]
808 : | "nonlocal" `identifier` `augop` `expression_list`
809
810The :keyword:`nonlocal` statement causes the listed identifiers to refer to
811previously bound variables in the nearest enclosing scope. This is important
812because the default behavior for binding is to search the local namespace
813first. The statement allows encapsulated code to rebind variables outside of
814the local scope besides the global (module) scope.
815
Georg Brandlc5d98b42007-12-04 18:11:03 +0000816.. XXX not implemented
817 The :keyword:`nonlocal` statement may prepend an assignment or augmented
818 assignment, but not an expression.
819
820Names listed in a :keyword:`nonlocal` statement, unlike to those listed in a
821:keyword:`global` statement, must refer to pre-existing bindings in an
822enclosing scope (the scope in which a new binding should be created cannot
823be determined unambiguously).
824
825Names listed in a :keyword:`nonlocal` statement must not collide with
826pre-existing bindings in the local scope.
827
828.. seealso::
829
830 :pep:`3104` - Access to Names in Outer Scopes
831 The specification for the :keyword:`nonlocal` statement.
Georg Brandl02c30562007-09-07 17:52:53 +0000832
833
Georg Brandl116aa622007-08-15 14:28:22 +0000834.. rubric:: Footnotes
835
836.. [#] It may occur within an :keyword:`except` or :keyword:`else` clause. The
Georg Brandlc5d98b42007-12-04 18:11:03 +0000837 restriction on occurring in the :keyword:`try` clause is implementor's
838 laziness and will eventually be lifted.