compound_stmts.rst 24.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
.. _compound:

*******************
Compound statements
*******************

.. index:: pair: compound; statement

Compound statements contain (groups of) other statements; they affect or control
the execution of those other statements in some way.  In general, compound
statements span multiple lines, although in simple incarnations a whole compound
statement may be contained in one line.

The :keyword:`if`, :keyword:`while` and :keyword:`for` statements implement
traditional control flow constructs.  :keyword:`try` specifies exception
16 17 18 19
handlers and/or cleanup code for a group of statements, while the
:keyword:`with` statement allows the execution of initialization and
finalization code around a block of code.  Function and class definitions are
also syntactically compound statements.
20 21 22 23 24 25 26 27 28 29 30 31 32 33

.. index::
   single: clause
   single: suite

Compound statements consist of one or more 'clauses.'  A clause consists of a
header and a 'suite.'  The clause headers of a particular compound statement are
all at the same indentation level. Each clause header begins with a uniquely
identifying keyword and ends with a colon.  A suite is a group of statements
controlled by a clause.  A suite can be one or more semicolon-separated simple
statements on the same line as the header, following the header's colon, or it
can be one or more indented statements on subsequent lines.  Only the latter
form of suite can contain nested compound statements; the following is illegal,
mostly because it wouldn't be clear to which :keyword:`if` clause a following
34
:keyword:`else` clause would belong::
35

36
   if test1: if test2: print(x)
37 38

Also note that the semicolon binds tighter than the colon in this context, so
39 40
that in the following example, either all or none of the :func:`print` calls are
executed::
41

42
   if x < y < z: print(x); print(y); print(z)
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

Summarizing:

.. productionlist::
   compound_stmt: `if_stmt`
                : | `while_stmt`
                : | `for_stmt`
                : | `try_stmt`
                : | `with_stmt`
                : | `funcdef`
                : | `classdef`
   suite: `stmt_list` NEWLINE | NEWLINE INDENT `statement`+ DEDENT
   statement: `stmt_list` NEWLINE | `compound_stmt`
   stmt_list: `simple_stmt` (";" `simple_stmt`)* [";"]

.. index::
   single: NEWLINE token
   single: DEDENT token
   pair: dangling; else

Note that statements always end in a ``NEWLINE`` possibly followed by a
64
``DEDENT``.  Also note that optional continuation clauses always begin with a
65 66 67 68 69 70 71 72 73
keyword that cannot start a statement, thus there are no ambiguities (the
'dangling :keyword:`else`' problem is solved in Python by requiring nested
:keyword:`if` statements to be indented).

The formatting of the grammar rules in the following sections places each clause
on a separate line for clarity.


.. _if:
74 75
.. _elif:
.. _else:
76 77 78 79

The :keyword:`if` statement
===========================

80 81 82 83
.. index::
   statement: if
   keyword: elif
   keyword: else
84 85
           keyword: elif
           keyword: else
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

The :keyword:`if` statement is used for conditional execution:

.. productionlist::
   if_stmt: "if" `expression` ":" `suite`
          : ( "elif" `expression` ":" `suite` )*
          : ["else" ":" `suite`]

It selects exactly one of the suites by evaluating the expressions one by one
until one is found to be true (see section :ref:`booleans` for the definition of
true and false); then that suite is executed (and no other part of the
:keyword:`if` statement is executed or evaluated).  If all expressions are
false, the suite of the :keyword:`else` clause, if present, is executed.


.. _while:

The :keyword:`while` statement
==============================

.. index::
   statement: while
108
   keyword: else
109
   pair: loop; statement
110
   keyword: else
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

The :keyword:`while` statement is used for repeated execution as long as an
expression is true:

.. productionlist::
   while_stmt: "while" `expression` ":" `suite`
             : ["else" ":" `suite`]

This repeatedly tests the expression and, if it is true, executes the first
suite; if the expression is false (which may be the first time it is tested) the
suite of the :keyword:`else` clause, if present, is executed and the loop
terminates.

.. index::
   statement: break
   statement: continue

A :keyword:`break` statement executed in the first suite terminates the loop
without executing the :keyword:`else` clause's suite.  A :keyword:`continue`
statement executed in the first suite skips the rest of the suite and goes back
to testing the expression.


.. _for:

The :keyword:`for` statement
============================

.. index::
   statement: for
141 142 143
   keyword: in
   keyword: else
   pair: target; list
144
   pair: loop; statement
145 146 147
   keyword: in
   keyword: else
   pair: target; list
148
   object: sequence
149 150 151 152 153 154 155 156 157 158 159 160

The :keyword:`for` statement is used to iterate over the elements of a sequence
(such as a string, tuple or list) or other iterable object:

.. productionlist::
   for_stmt: "for" `target_list` "in" `expression_list` ":" `suite`
           : ["else" ":" `suite`]

The expression list is evaluated once; it should yield an iterable object.  An
iterator is created for the result of the ``expression_list``.  The suite is
then executed once for each item provided by the iterator, in the order of
ascending indices.  Each item in turn is assigned to the target list using the
161 162 163
standard rules for assignments (see :ref:`assignment`), and then the suite is
executed.  When the items are exhausted (which is immediately when the sequence
is empty or an iterator raises a :exc:`StopIteration` exception), the suite in
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
the :keyword:`else` clause, if present, is executed, and the loop terminates.

.. index::
   statement: break
   statement: continue

A :keyword:`break` statement executed in the first suite terminates the loop
without executing the :keyword:`else` clause's suite.  A :keyword:`continue`
statement executed in the first suite skips the rest of the suite and continues
with the next item, or with the :keyword:`else` clause if there was no next
item.

The suite may assign to the variable(s) in the target list; this does not affect
the next item assigned to it.

.. index::
   builtin: range

182 183 184
Names in the target list are not deleted when the loop is finished, but if the
sequence is empty, it will not have been assigned to at all by the loop.  Hint:
the built-in function :func:`range` returns an iterator of integers suitable to
185
emulate the effect of Pascal's ``for i := a to b do``; e.g., ``list(range(3))``
186
returns the list ``[0, 1, 2]``.
187

188
.. note::
189 190 191 192 193 194

   .. index::
      single: loop; over mutable sequence
      single: mutable sequence; loop over

   There is a subtlety when the sequence is being modified by the loop (this can
195 196
   only occur for mutable sequences, i.e. lists).  An internal counter is used
   to keep track of which item is used next, and this is incremented on each
197 198
   iteration.  When this counter has reached the length of the sequence the loop
   terminates.  This means that if the suite deletes the current (or a previous)
199 200 201 202 203 204
   item from the sequence, the next item will be skipped (since it gets the
   index of the current item which has already been treated).  Likewise, if the
   suite inserts an item in the sequence before the current item, the current
   item will be treated again the next time through the loop. This can lead to
   nasty bugs that can be avoided by making a temporary copy using a slice of
   the whole sequence, e.g., ::
205

206 207
      for x in a[:]:
          if x < 0: a.remove(x)
208 209 210


.. _try:
211 212
.. _except:
.. _finally:
213 214 215 216

The :keyword:`try` statement
============================

217 218 219 220
.. index::
   statement: try
   keyword: except
   keyword: finally
221
.. index:: keyword: except
222 223 224 225 226 227 228

The :keyword:`try` statement specifies exception handlers and/or cleanup code
for a group of statements:

.. productionlist::
   try_stmt: try1_stmt | try2_stmt
   try1_stmt: "try" ":" `suite`
229
            : ("except" [`expression` ["as" `target`]] ":" `suite`)+
230 231 232 233 234
            : ["else" ":" `suite`]
            : ["finally" ":" `suite`]
   try2_stmt: "try" ":" `suite`
            : "finally" ":" `suite`

235 236

The :keyword:`except` clause(s) specify one or more exception handlers. When no
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
exception occurs in the :keyword:`try` clause, no exception handler is executed.
When an exception occurs in the :keyword:`try` suite, a search for an exception
handler is started.  This search inspects the except clauses in turn until one
is found that matches the exception.  An expression-less except clause, if
present, must be last; it matches any exception.  For an except clause with an
expression, that expression is evaluated, and the clause matches the exception
if the resulting object is "compatible" with the exception.  An object is
compatible with an exception if it is the class or a base class of the exception
object or a tuple containing an item compatible with the exception.

If no except clause matches the exception, the search for an exception handler
continues in the surrounding code and on the invocation stack.  [#]_

If the evaluation of an expression in the header of an except clause raises an
exception, the original search for a handler is canceled and a search starts for
the new exception in the surrounding code and on the call stack (it is treated
as if the entire :keyword:`try` statement raised the exception).

When a matching except clause is found, the exception is assigned to the target
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
specified after the :keyword:`as` keyword in that except clause, if present, and
the except clause's suite is executed.  All except clauses must have an
executable block.  When the end of this block is reached, execution continues
normally after the entire try statement.  (This means that if two nested
handlers exist for the same exception, and the exception occurs in the try
clause of the inner handler, the outer handler will not handle the exception.)

When an exception has been assigned using ``as target``, it is cleared at the
end of the except clause.  This is as if ::

   except E as N:
       foo

was translated to ::

   except E as N:
       try:
           foo
       finally:
           del N

277 278 279 280
This means the exception must be assigned to a different name to be able to
refer to it after the except clause.  Exceptions are cleared because with the
traceback attached to them, they form a reference cycle with the stack frame,
keeping all locals in that frame alive until the next garbage collection occurs.
281 282 283 284 285 286 287

.. index::
   module: sys
   object: traceback

Before an except clause's suite is executed, details about the exception are
stored in the :mod:`sys` module and can be access via :func:`sys.exc_info`.
288 289 290 291 292
:func:`sys.exc_info` returns a 3-tuple consisting of the exception class, the
exception instance and a traceback object (see section :ref:`types`) identifying
the point in the program where the exception occurred.  :func:`sys.exc_info`
values are restored to their previous values (before the call) when returning
from a function that handled an exception.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

.. index::
   keyword: else
   statement: return
   statement: break
   statement: continue

The optional :keyword:`else` clause is executed if and when control flows off
the end of the :keyword:`try` clause. [#]_ Exceptions in the :keyword:`else`
clause are not handled by the preceding :keyword:`except` clauses.

.. index:: keyword: finally

If :keyword:`finally` is present, it specifies a 'cleanup' handler.  The
:keyword:`try` clause is executed, including any :keyword:`except` and
:keyword:`else` clauses.  If an exception occurs in any of the clauses and is
not handled, the exception is temporarily saved. The :keyword:`finally` clause
310 311 312 313 314
is executed.  If there is a saved exception it is re-raised at the end of the
:keyword:`finally` clause.  If the :keyword:`finally` clause raises another
exception, the saved exception is set as the context of the new exception.
If the :keyword:`finally` clause executes a :keyword:`return` or :keyword:`break`
statement, the saved exception is discarded::
315 316 317 318 319 320 321 322 323 324 325 326

    def f():
        try:
            1/0
        finally:
            return 42

    >>> f()
    42

The exception information is not available to the program during execution of
the :keyword:`finally` clause.
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

.. index::
   statement: return
   statement: break
   statement: continue

When a :keyword:`return`, :keyword:`break` or :keyword:`continue` statement is
executed in the :keyword:`try` suite of a :keyword:`try`...\ :keyword:`finally`
statement, the :keyword:`finally` clause is also executed 'on the way out.' A
:keyword:`continue` statement is illegal in the :keyword:`finally` clause. (The
reason is a problem with the current implementation --- this restriction may be
lifted in the future).

Additional information on exceptions can be found in section :ref:`exceptions`,
and information on using the :keyword:`raise` statement to generate exceptions
may be found in section :ref:`raise`.


.. _with:
346
.. _as:
347 348 349 350 351 352 353

The :keyword:`with` statement
=============================

.. index:: statement: with

The :keyword:`with` statement is used to wrap the execution of a block with
354 355 356
methods defined by a context manager (see section :ref:`context-managers`).
This allows common :keyword:`try`...\ :keyword:`except`...\ :keyword:`finally`
usage patterns to be encapsulated for convenient reuse.
357 358

.. productionlist::
359 360
   with_stmt: "with" with_item ("," with_item)* ":" `suite`
   with_item: `expression` ["as" `target`]
361

362
The execution of the :keyword:`with` statement with one "item" proceeds as follows:
363

364 365
#. The context expression (the expression given in the :token:`with_item`) is
   evaluated to obtain a context manager.
366

367 368
#. The context manager's :meth:`__exit__` is loaded for later use.

369 370 371 372 373 374 375
#. The context manager's :meth:`__enter__` method is invoked.

#. If a target was included in the :keyword:`with` statement, the return value
   from :meth:`__enter__` is assigned to it.

   .. note::

376 377
      The :keyword:`with` statement guarantees that if the :meth:`__enter__`
      method returns without an error, then :meth:`__exit__` will always be
378 379 380
      called. Thus, if an error occurs during the assignment to the target list,
      it will be treated the same as an error occurring within the suite would
      be. See step 6 below.
381 382 383

#. The suite is executed.

384
#. The context manager's :meth:`__exit__` method is invoked.  If an exception
385 386 387 388 389
   caused the suite to be exited, its type, value, and traceback are passed as
   arguments to :meth:`__exit__`. Otherwise, three :const:`None` arguments are
   supplied.

   If the suite was exited due to an exception, and the return value from the
390
   :meth:`__exit__` method was false, the exception is reraised.  If the return
391 392 393
   value was true, the exception is suppressed, and execution continues with the
   statement following the :keyword:`with` statement.

394 395 396
   If the suite was exited for any reason other than an exception, the return
   value from :meth:`__exit__` is ignored, and execution proceeds at the normal
   location for the kind of exit that was taken.
397

398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
With more than one item, the context managers are processed as if multiple
:keyword:`with` statements were nested::

   with A() as a, B() as b:
       suite

is equivalent to ::

   with A() as a:
       with B() as b:
           suite

.. versionchanged:: 3.1
   Support for multiple context expressions.

413 414 415 416 417 418 419 420
.. seealso::

   :pep:`0343` - The "with" statement
      The specification, background, and examples for the Python :keyword:`with`
      statement.


.. _function:
421
.. _def:
422 423 424 425 426 427

Function definitions
====================

.. index::
   statement: def
428 429 430
   pair: function; definition
   pair: function; name
   pair: name; binding
431 432
   object: user-defined function
   object: function
433 434
   pair: function; name
   pair: name; binding
435 436 437 438 439

A function definition defines a user-defined function object (see section
:ref:`types`):

.. productionlist::
440
   funcdef: [`decorators`] "def" `funcname` "(" [`parameter_list`] ")" ["->" `expression`] ":" `suite`
441
   decorators: `decorator`+
442
   decorator: "@" `dotted_name` ["(" [`parameter_list` [","]] ")"] NEWLINE
443 444
   dotted_name: `identifier` ("." `identifier`)*
   parameter_list: (`defparameter` ",")*
445
                 : ( "*" [`parameter`] ("," `defparameter`)* ["," "**" `parameter`]
446 447 448 449 450 451 452 453 454 455 456 457 458 459
                 : | "**" `parameter`
                 : | `defparameter` [","] )
   parameter: `identifier` [":" `expression`]
   defparameter: `parameter` ["=" `expression`]
   funcname: `identifier`


A function definition is an executable statement.  Its execution binds the
function name in the current local namespace to a function object (a wrapper
around the executable code for the function).  This function object contains a
reference to the current global namespace as the global namespace to be used
when the function is called.

The function definition does not execute the function body; this gets executed
Georg Brandl's avatar
Georg Brandl committed
460
only when the function is called. [#]_
461

Christian Heimes's avatar
Christian Heimes committed
462 463 464
.. index::
  statement: @

465
A function definition may be wrapped by one or more :term:`decorator` expressions.
466 467 468 469
Decorator expressions are evaluated when the function is defined, in the scope
that contains the function definition.  The result must be a callable, which is
invoked with the function object as the only argument. The returned value is
bound to the function name instead of the function object.  Multiple decorators
470
are applied in nested fashion. For example, the following code ::
471 472 473 474 475

   @f1(arg)
   @f2
   def func(): pass

476
is equivalent to ::
477 478 479 480 481 482 483 484 485 486

   def func(): pass
   func = f1(arg)(f2(func))

.. index:: triple: default; parameter; value

When one or more parameters have the form *parameter* ``=`` *expression*, the
function is said to have "default parameter values."  For a parameter with a
default value, the corresponding argument may be omitted from a call, in which
case the parameter's default value is substituted.  If a parameter has a default
487 488
value, all following parameters up until the "``*``" must also have a default
value --- this is a syntactic restriction that is not expressed by the grammar.
489 490

**Default parameter values are evaluated when the function definition is
491
executed.** This means that the expression is evaluated once, when the function
Ezio Melotti's avatar
Ezio Melotti committed
492
is defined, and that the same "pre-computed" value is used for each call.  This
493 494 495
is especially important to understand when a default parameter is a mutable
object, such as a list or a dictionary: if the function modifies the object
(e.g. by appending an item to a list), the default value is in effect modified.
496
This is generally not what was intended.  A way around this is to use ``None``
497 498 499 500 501 502 503 504
as the default, and explicitly test for it in the body of the function, e.g.::

   def whats_on_the_telly(penguin=None):
       if penguin is None:
           penguin = []
       penguin.append("property of the zoo")
       return penguin

Christian Heimes's avatar
Christian Heimes committed
505 506 507 508 509
.. index::
  statement: *
  statement: **

Function call semantics are described in more detail in section :ref:`calls`. A
510 511 512 513 514 515 516 517 518 519 520 521
function call always assigns values to all parameters mentioned in the parameter
list, either from position arguments, from keyword arguments, or from default
values.  If the form "``*identifier``" is present, it is initialized to a tuple
receiving any excess positional parameters, defaulting to the empty tuple.  If
the form "``**identifier``" is present, it is initialized to a new dictionary
receiving any excess keyword arguments, defaulting to a new empty dictionary.
Parameters after "``*``" or "``*identifier``" are keyword-only parameters and
may only be passed used keyword arguments.

.. index:: pair: function; annotations

Parameters may have annotations of the form "``: expression``" following the
522 523 524
parameter name.  Any parameter may have an annotation even those of the form
``*identifier`` or ``**identifier``.  Functions may have "return" annotation of
the form "``-> expression``" after the parameter list.  These annotations can be
525
any valid Python expression and are evaluated when the function definition is
526 527 528
executed.  Annotations may be evaluated in a different order than they appear in
the source code.  The presence of annotations does not change the semantics of a
function.  The annotation values are available as values of a dictionary keyed
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
by the parameters' names in the :attr:`__annotations__` attribute of the
function object.

.. index:: pair: lambda; form

It is also possible to create anonymous functions (functions not bound to a
name), for immediate use in expressions.  This uses lambda forms, described in
section :ref:`lambda`.  Note that the lambda form is merely a shorthand for a
simplified function definition; a function defined in a ":keyword:`def`"
statement can be passed around or assigned to another name just like a function
defined by a lambda form.  The ":keyword:`def`" form is actually more powerful
since it allows the execution of multiple statements and annotations.

**Programmer's note:** Functions are first-class objects.  A "``def``" form
executed inside a function definition defines a local function that can be
returned or passed around.  Free variables used in the nested function can
access the local variables of the function containing the def.  See section
:ref:`naming` for details.

548 549 550 551 552
.. seealso::

   :pep:`3107` - Function Annotations
      The original specification for function annotations.

553 554 555 556 557 558 559

.. _class:

Class definitions
=================

.. index::
560
   object: class
561 562
   statement: class
   pair: class; definition
563 564 565
   pair: class; name
   pair: name; binding
   pair: execution; frame
566
   single: inheritance
Georg Brandl's avatar
Georg Brandl committed
567
   single: docstring
568 569 570 571

A class definition defines a class object (see section :ref:`types`):

.. productionlist::
572
   classdef: [`decorators`] "class" `classname` [`inheritance`] ":" `suite`
573
   inheritance: "(" [`parameter_list`] ")"
574 575
   classname: `identifier`

576 577 578
A class definition is an executable statement.  The inheritance list usually
gives a list of base classes (see :ref:`metaclasses` for more advanced uses), so
each item in the list should evaluate to a class object which allows
579 580 581 582 583 584 585 586 587 588
subclassing.  Classes without an inheritance list inherit, by default, from the
base class :class:`object`; hence, ::

   class Foo:
       pass

is equivalent to ::

   class Foo(object):
       pass
589 590 591 592 593 594 595 596 597 598 599

The class's suite is then executed in a new execution frame (see :ref:`naming`),
using a newly created local namespace and the original global namespace.
(Usually, the suite contains mostly function definitions.)  When the class's
suite finishes execution, its execution frame is discarded but its local
namespace is saved. [#]_ A class object is then created using the inheritance
list for the base classes and the saved local namespace for the attribute
dictionary.  The class name is bound to this class object in the original local
namespace.

Class creation can be customized heavily using :ref:`metaclasses <metaclasses>`.
600

601
Classes can also be decorated: just like when decorating functions, ::
602 603 604 605 606 607 608 609 610 611

   @f1(arg)
   @f2
   class Foo: pass

is equivalent to ::

   class Foo: pass
   Foo = f1(arg)(f2(Foo))

612 613 614 615
The evaluation rules for the decorator expressions are the same as for function
decorators.  The result must be a class object, which is then bound to the class
name.

616
**Programmer's note:** Variables defined in the class definition are class
617 618 619 620 621 622 623
attributes; they are shared by instances.  Instance attributes can be set in a
method with ``self.name = value``.  Both class and instance attributes are
accessible through the notation "``self.name``", and an instance attribute hides
a class attribute with the same name when accessed in this way.  Class
attributes can be used as defaults for instance attributes, but using mutable
values there can lead to unexpected results.  :ref:`Descriptors <descriptors>`
can be used to create instance variables with different implementation details.
Georg Brandl's avatar
Georg Brandl committed
624

625

626 627
.. seealso::

628
   :pep:`3115` - Metaclasses in Python 3
629 630 631
   :pep:`3129` - Class Decorators


632 633
.. rubric:: Footnotes

634 635 636
.. [#] The exception is propagated to the invocation stack unless
   there is a :keyword:`finally` clause which happens to raise another
   exception. That new exception causes the old one to be lost.
637

Georg Brandl's avatar
Georg Brandl committed
638 639 640
.. [#] Currently, control "flows off the end" except in the case of an exception
   or the execution of a :keyword:`return`, :keyword:`continue`, or
   :keyword:`break` statement.
Georg Brandl's avatar
Georg Brandl committed
641 642 643 644 645 646 647 648

.. [#] A string literal appearing as the first statement in the function body is
   transformed into the function's ``__doc__`` attribute and therefore the
   function's :term:`docstring`.

.. [#] A string literal appearing as the first statement in the class body is
   transformed into the namespace's ``__doc__`` item and therefore the class's
   :term:`docstring`.