22

✏️ Editing: compound_stmts.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>8. Compound statements &#8212; Python 3.6.7 documentation</title>
 <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
 <script type="text/javascript" src="../_static/jquery.js"></script>
 <script type="text/javascript" src="../_static/underscore.js"></script>
 <script type="text/javascript" src="../_static/doctools.js"></script>
 <script type="text/javascript" src="../_static/sidebar.js"></script>
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.6.7 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="9. Top-level components" href="toplevel_components.html" />
 <link rel="prev" title="7. Simple statements" href="simple_stmts.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="https://docs.python.org/3/reference/compound_stmts.html" />
 
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="toplevel_components.html" title="9. Top-level components"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="simple_stmts.html" title="7. Simple statements"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">3.6.7 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">The Python Language Reference</a> &#187;</li>
 <li class="right">

<div class="inline-search" style="display: none" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 <script type="text/javascript">$('.inline-search').show(0);</script>
 |
 </li>

</ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <div class="section" id="compound-statements">
<h1>8. Compound statements<a class="headerlink" href="#compound-statements" title="Permalink to this headline">¶</a></h1>
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 <a class="reference internal" href="#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a>, <a class="reference internal" href="#while"><code class="xref std std-keyword docutils literal notranslate">while</code></a> and <a class="reference internal" href="#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a> statements implement
traditional control flow constructs. <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> specifies exception
handlers and/or cleanup code for a group of statements, while the
<a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement allows the execution of initialization and
finalization code around a block of code. Function and class definitions are
also syntactically compound statements.
A compound statement consists 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 a suite can contain nested compound statements; the following is illegal,
mostly because it wouldn’t be clear to which <a class="reference internal" href="#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a> clause a following
<a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause would belong:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>if test1: if test2: print(x)
</pre></div>
</div>
Also note that the semicolon binds tighter than the colon in this context, so
that in the following example, either all or none of the <a class="reference internal" href="../library/functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate">print()</code></a> calls are
executed:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>if x &lt; y &lt; z: print(x); print(y); print(z)
</pre></div>
</div>
Summarizing:
<pre>
compound_stmt ::= <a class="reference internal" href="#grammar-token-if_stmt"><code class="xref docutils literal notranslate">if_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-while_stmt"><code class="xref docutils literal notranslate">while_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-for_stmt"><code class="xref docutils literal notranslate">for_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-try_stmt"><code class="xref docutils literal notranslate">try_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-with_stmt"><code class="xref docutils literal notranslate">with_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-funcdef"><code class="xref docutils literal notranslate">funcdef</code></a>
 | <a class="reference internal" href="#grammar-token-classdef"><code class="xref docutils literal notranslate">classdef</code></a>
 | <a class="reference internal" href="#grammar-token-async_with_stmt"><code class="xref docutils literal notranslate">async_with_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-async_for_stmt"><code class="xref docutils literal notranslate">async_for_stmt</code></a>
 | <a class="reference internal" href="#grammar-token-async_funcdef"><code class="xref docutils literal notranslate">async_funcdef</code></a>
suite ::= <a class="reference internal" href="#grammar-token-stmt_list"><code class="xref docutils literal notranslate">stmt_list</code></a> NEWLINE | NEWLINE INDENT <a class="reference internal" href="#grammar-token-statement"><code class="xref docutils literal notranslate">statement</code></a>+ DEDENT
statement ::= <a class="reference internal" href="#grammar-token-stmt_list"><code class="xref docutils literal notranslate">stmt_list</code></a> NEWLINE | <a class="reference internal" href="#grammar-token-compound_stmt"><code class="xref docutils literal notranslate">compound_stmt</code></a>
stmt_list ::= <a class="reference internal" href="simple_stmts.html#grammar-token-simple_stmt"><code class="xref docutils literal notranslate">simple_stmt</code></a> (&quot;;&quot; <a class="reference internal" href="simple_stmts.html#grammar-token-simple_stmt"><code class="xref docutils literal notranslate">simple_stmt</code></a>)* [&quot;;&quot;]
</pre>
Note that statements always end in a <code class="docutils literal notranslate">NEWLINE</code> possibly followed by a
<code class="docutils literal notranslate">DEDENT</code>. Also note that optional continuation clauses always begin with a
keyword that cannot start a statement, thus there are no ambiguities (the
‘dangling <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a>’ problem is solved in Python by requiring nested
<a class="reference internal" href="#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a> statements to be indented).
The formatting of the grammar rules in the following sections places each clause
on a separate line for clarity.
<div class="section" id="the-if-statement">
<h2>8.1. The <a class="reference internal" href="#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a> statement<a class="headerlink" href="#the-if-statement" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a> statement is used for conditional execution:
<pre>
if_stmt ::= &quot;if&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a> &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
 (&quot;elif&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a> &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>)*
 [&quot;else&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>]
</pre>
It selects exactly one of the suites by evaluating the expressions one by one
until one is found to be true (see section <a class="reference internal" href="expressions.html#booleans">Boolean operations</a> for the definition of
true and false); then that suite is executed (and no other part of the
<a class="reference internal" href="#if"><code class="xref std std-keyword docutils literal notranslate">if</code></a> statement is executed or evaluated). If all expressions are
false, the suite of the <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause, if present, is executed.
</div>
<div class="section" id="the-while-statement">
<h2>8.2. The <a class="reference internal" href="#while"><code class="xref std std-keyword docutils literal notranslate">while</code></a> statement<a class="headerlink" href="#the-while-statement" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#while"><code class="xref std std-keyword docutils literal notranslate">while</code></a> statement is used for repeated execution as long as an
expression is true:
<pre>
while_stmt ::= &quot;while&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a> &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
 [&quot;else&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>]
</pre>
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 <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause, if present, is executed and the loop
terminates.
A <a class="reference internal" href="simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> statement executed in the first suite terminates the loop
without executing the <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause’s suite. A <a class="reference internal" href="simple_stmts.html#continue"><code class="xref std std-keyword docutils literal notranslate">continue</code></a>
statement executed in the first suite skips the rest of the suite and goes back
to testing the expression.
</div>
<div class="section" id="the-for-statement">
<h2>8.3. The <a class="reference internal" href="#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a> statement<a class="headerlink" href="#the-for-statement" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#for"><code class="xref std std-keyword docutils literal notranslate">for</code></a> statement is used to iterate over the elements of a sequence
(such as a string, tuple or list) or other iterable object:
<pre>
for_stmt ::= &quot;for&quot; <a class="reference internal" href="simple_stmts.html#grammar-token-target_list"><code class="xref docutils literal notranslate">target_list</code></a> &quot;in&quot; <a class="reference internal" href="expressions.html#grammar-token-expression_list"><code class="xref docutils literal notranslate">expression_list</code></a> &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
 [&quot;else&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>]
</pre>
The expression list is evaluated once; it should yield an iterable object. An
iterator is created for the result of the <code class="docutils literal notranslate">expression_list</code>. The suite is
then executed once for each item provided by the iterator, in the order returned
by the iterator. Each item in turn is assigned to the target list using the
standard rules for assignments (see <a class="reference internal" href="simple_stmts.html#assignment">Assignment statements</a>), and then the suite is
executed. When the items are exhausted (which is immediately when the sequence
is empty or an iterator raises a <a class="reference internal" href="../library/exceptions.html#StopIteration" title="StopIteration"><code class="xref py py-exc docutils literal notranslate">StopIteration</code></a> exception), the suite in
the <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause, if present, is executed, and the loop terminates.
A <a class="reference internal" href="simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> statement executed in the first suite terminates the loop
without executing the <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause’s suite. A <a class="reference internal" href="simple_stmts.html#continue"><code class="xref std std-keyword docutils literal notranslate">continue</code></a>
statement executed in the first suite skips the rest of the suite and continues
with the next item, or with the <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause if there is no next
item.
The for-loop makes assignments to the variables(s) in the target list.
This overwrites all previous assignments to those variables including
those made in the suite of the for-loop:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>for i in range(10):
 print(i)
 i = 5 # this will not affect the for-loop
 # because i will be overwritten with the next
 # index in the range
</pre></div>
</div>
Names in the target list are not deleted when the loop is finished, but if the
sequence is empty, they will not have been assigned to at all by the loop. Hint:
the built-in function <a class="reference internal" href="../library/stdtypes.html#range" title="range"><code class="xref py py-func docutils literal notranslate">range()</code></a> returns an iterator of integers suitable to
emulate the effect of Pascal’s <code class="docutils literal notranslate">for i := a to b do</code>; e.g., <code class="docutils literal notranslate">list(range(3))</code>
returns the list <code class="docutils literal notranslate">[0, 1, 2]</code>.
<div class="admonition note">
Note
There is a subtlety when the sequence is being modified by the loop (this can
only occur for mutable sequences, e.g. lists). An internal counter is used
to keep track of which item is used next, and this is incremented on each
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)
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.,
<div class="last highlight-python3 notranslate"><div class="highlight"><pre>for x in a[:]:
 if x &lt; 0: a.remove(x)
</pre></div>
</div>
</div>
</div>
<div class="section" id="the-try-statement">
<h2>8.4. The <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> statement<a class="headerlink" href="#the-try-statement" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> statement specifies exception handlers and/or cleanup code
for a group of statements:
<pre>
try_stmt ::= <a class="reference internal" href="#grammar-token-try1_stmt"><code class="xref docutils literal notranslate">try1_stmt</code></a> | <a class="reference internal" href="#grammar-token-try2_stmt"><code class="xref docutils literal notranslate">try2_stmt</code></a>
try1_stmt ::= &quot;try&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
 (&quot;except&quot; [<a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a> [&quot;as&quot; <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><code class="xref docutils literal notranslate">identifier</code></a>]] &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>)+
 [&quot;else&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>]
 [&quot;finally&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>]
try2_stmt ::= &quot;try&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
 &quot;finally&quot; &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
</pre>
The <a class="reference internal" href="#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a> clause(s) specify one or more exception handlers. When no
exception occurs in the <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> clause, no exception handler is executed.
When an exception occurs in the <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> 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. <a class="footnote-reference" href="#id5" id="id1">[1]</a>
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 <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> statement raised the exception).
When a matching except clause is found, the exception is assigned to the target
specified after the <a class="reference internal" href="#as"><code class="xref std std-keyword docutils literal notranslate">as</code></a> 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 <code class="docutils literal notranslate">as target</code>, it is cleared at the
end of the except clause. This is as if
<div class="highlight-python3 notranslate"><div class="highlight"><pre>except E as N:
 foo
</pre></div>
</div>
was translated to
<div class="highlight-python3 notranslate"><div class="highlight"><pre>except E as N:
 try:
 foo
 finally:
 del N
</pre></div>
</div>
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.
Before an except clause’s suite is executed, details about the exception are
stored in the <a class="reference internal" href="../library/sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a> module and can be accessed via <a class="reference internal" href="../library/sys.html#sys.exc_info" title="sys.exc_info"><code class="xref py py-func docutils literal notranslate">sys.exc_info()</code></a>.
<a class="reference internal" href="../library/sys.html#sys.exc_info" title="sys.exc_info"><code class="xref py py-func docutils literal notranslate">sys.exc_info()</code></a> returns a 3-tuple consisting of the exception class, the
exception instance and a traceback object (see section <a class="reference internal" href="datamodel.html#types">The standard type hierarchy</a>) identifying
the point in the program where the exception occurred. <a class="reference internal" href="../library/sys.html#sys.exc_info" title="sys.exc_info"><code class="xref py py-func docutils literal notranslate">sys.exc_info()</code></a>
values are restored to their previous values (before the call) when returning
from a function that handled an exception.
The optional <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clause is executed if and when control flows off
the end of the <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> clause. <a class="footnote-reference" href="#id6" id="id2">[2]</a> Exceptions in the <a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a>
clause are not handled by the preceding <a class="reference internal" href="#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a> clauses.
If <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> is present, it specifies a ‘cleanup’ handler. The
<a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> clause is executed, including any <a class="reference internal" href="#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a> and
<a class="reference internal" href="#else"><code class="xref std std-keyword docutils literal notranslate">else</code></a> clauses. If an exception occurs in any of the clauses and is
not handled, the exception is temporarily saved. The <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause
is executed. If there is a saved exception it is re-raised at the end of the
<a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause. If the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause raises another
exception, the saved exception is set as the context of the new exception.
If the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause executes a <a class="reference internal" href="simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a> or <a class="reference internal" href="simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a>
statement, the saved exception is discarded:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; def f():
... try:
... 1/0
... finally:
... return 42
...
&gt;&gt;&gt; f()
42
</pre></div>
</div>
The exception information is not available to the program during execution of
the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause.
When a <a class="reference internal" href="simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a>, <a class="reference internal" href="simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> or <a class="reference internal" href="simple_stmts.html#continue"><code class="xref std std-keyword docutils literal notranslate">continue</code></a> statement is
executed in the <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> suite of a <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a>…<a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a>
statement, the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause is also executed ‘on the way out.’ A
<a class="reference internal" href="simple_stmts.html#continue"><code class="xref std std-keyword docutils literal notranslate">continue</code></a> statement is illegal in the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause. (The
reason is a problem with the current implementation — this restriction may be
lifted in the future).
The return value of a function is determined by the last <a class="reference internal" href="simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a>
statement executed. Since the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause always executes, a
<a class="reference internal" href="simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a> statement executed in the <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause will
always be the last one executed:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; def foo():
... try:
... return &#39;try&#39;
... finally:
... return &#39;finally&#39;
...
&gt;&gt;&gt; foo()
&#39;finally&#39;
</pre></div>
</div>
Additional information on exceptions can be found in section <a class="reference internal" href="executionmodel.html#exceptions">Exceptions</a>,
and information on using the <a class="reference internal" href="simple_stmts.html#raise"><code class="xref std std-keyword docutils literal notranslate">raise</code></a> statement to generate exceptions
may be found in section <a class="reference internal" href="simple_stmts.html#raise">The raise statement</a>.
</div>
<div class="section" id="the-with-statement">
<h2>8.5. The <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement<a class="headerlink" href="#the-with-statement" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement is used to wrap the execution of a block with
methods defined by a context manager (see section <a class="reference internal" href="datamodel.html#context-managers">With Statement Context Managers</a>).
This allows common <a class="reference internal" href="#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a>…<a class="reference internal" href="#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a>…<a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a>
usage patterns to be encapsulated for convenient reuse.
<pre>
with_stmt ::= &quot;with&quot; <a class="reference internal" href="#grammar-token-with_item"><code class="xref docutils literal notranslate">with_item</code></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-with_item"><code class="xref docutils literal notranslate">with_item</code></a>)* &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
with_item ::= <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a> [&quot;as&quot; <a class="reference internal" href="simple_stmts.html#grammar-token-target"><code class="xref docutils literal notranslate">target</code></a>]
</pre>
The execution of the <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement with one “item” proceeds as follows:
<ol class="arabic">
<li>The context expression (the expression given in the <a class="reference internal" href="#grammar-token-with_item"><code class="xref std std-token docutils literal notranslate">with_item</code></a>) is
evaluated to obtain a context manager.
</li>
<li>The context manager’s <a class="reference internal" href="datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">__exit__()</code></a> is loaded for later use.
</li>
<li>The context manager’s <a class="reference internal" href="datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate">__enter__()</code></a> method is invoked.
</li>
<li>If a target was included in the <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement, the return value
from <a class="reference internal" href="datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate">__enter__()</code></a> is assigned to it.
<div class="admonition note">
Note
The <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement guarantees that if the <a class="reference internal" href="datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate">__enter__()</code></a>
method returns without an error, then <a class="reference internal" href="datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">__exit__()</code></a> will always be
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.
</div>
</li>
<li>The suite is executed.
</li>
<li>The context manager’s <a class="reference internal" href="datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">__exit__()</code></a> method is invoked. If an exception
caused the suite to be exited, its type, value, and traceback are passed as
arguments to <a class="reference internal" href="datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">__exit__()</code></a>. Otherwise, three <a class="reference internal" href="../library/constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> arguments are
supplied.
If the suite was exited due to an exception, and the return value from the
<a class="reference internal" href="datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">__exit__()</code></a> method was false, the exception is reraised. If the return
value was true, the exception is suppressed, and execution continues with the
statement following the <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement.
If the suite was exited for any reason other than an exception, the return
value from <a class="reference internal" href="datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">__exit__()</code></a> is ignored, and execution proceeds at the normal
location for the kind of exit that was taken.
</li>
</ol>
With more than one item, the context managers are processed as if multiple
<a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statements were nested:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with A() as a, B() as b:
 suite
</pre></div>
</div>
is equivalent to
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with A() as a:
 with B() as b:
 suite
</pre></div>
</div>
<div class="versionchanged">
Changed in version 3.1: Support for multiple context expressions.
</div>
<div class="admonition seealso">
See also
<dl class="last docutils">
<dt><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0343">PEP 343</a> - The “with” statement</dt>
<dd>The specification, background, and examples for the Python <a class="reference internal" href="#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
statement.</dd>
</dl>
</div>
</div>
<div class="section" id="function-definitions">
<h2>8.6. Function definitions<a class="headerlink" href="#function-definitions" title="Permalink to this headline">¶</a></h2>
A function definition defines a user-defined function object (see section
<a class="reference internal" href="datamodel.html#types">The standard type hierarchy</a>):
<pre>
funcdef ::= [<a class="reference internal" href="#grammar-token-decorators"><code class="xref docutils literal notranslate">decorators</code></a>] &quot;def&quot; <a class="reference internal" href="#grammar-token-funcname"><code class="xref docutils literal notranslate">funcname</code></a> &quot;(&quot; [<a class="reference internal" href="#grammar-token-parameter_list"><code class="xref docutils literal notranslate">parameter_list</code></a>] &quot;)&quot;
 [&quot;-&gt;&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a>] &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
decorators ::= <a class="reference internal" href="#grammar-token-decorator"><code class="xref docutils literal notranslate">decorator</code></a>+
decorator ::= &quot;&#64;&quot; <a class="reference internal" href="#grammar-token-dotted_name"><code class="xref docutils literal notranslate">dotted_name</code></a> [&quot;(&quot; [<a class="reference internal" href="expressions.html#grammar-token-argument_list"><code class="xref docutils literal notranslate">argument_list</code></a> [&quot;,&quot;]] &quot;)&quot;] NEWLINE
dotted_name ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><code class="xref docutils literal notranslate">identifier</code></a> (&quot;.&quot; <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><code class="xref docutils literal notranslate">identifier</code></a>)*
parameter_list ::= <a class="reference internal" href="#grammar-token-defparameter"><code class="xref docutils literal notranslate">defparameter</code></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-defparameter"><code class="xref docutils literal notranslate">defparameter</code></a>)* [&quot;,&quot; [<a class="reference internal" href="#grammar-token-parameter_list_starargs"><code class="xref docutils literal notranslate">parameter_list_starargs</code></a>]]
 | <a class="reference internal" href="#grammar-token-parameter_list_starargs"><code class="xref docutils literal notranslate">parameter_list_starargs</code></a>
parameter_list_starargs ::= &quot;*&quot; [<a class="reference internal" href="#grammar-token-parameter"><code class="xref docutils literal notranslate">parameter</code></a>] (&quot;,&quot; <a class="reference internal" href="#grammar-token-defparameter"><code class="xref docutils literal notranslate">defparameter</code></a>)* [&quot;,&quot; [&quot;**&quot; <a class="reference internal" href="#grammar-token-parameter"><code class="xref docutils literal notranslate">parameter</code></a> [&quot;,&quot;]]]
 | &quot;**&quot; <a class="reference internal" href="#grammar-token-parameter"><code class="xref docutils literal notranslate">parameter</code></a> [&quot;,&quot;]
parameter ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><code class="xref docutils literal notranslate">identifier</code></a> [&quot;:&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a>]
defparameter ::= <a class="reference internal" href="#grammar-token-parameter"><code class="xref docutils literal notranslate">parameter</code></a> [&quot;=&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a>]
funcname ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><code class="xref docutils literal notranslate">identifier</code></a>
</pre>
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
only when the function is called. <a class="footnote-reference" href="#id7" id="id3">[3]</a>
A function definition may be wrapped by one or more <a class="reference internal" href="../glossary.html#term-decorator">decorator</a> expressions.
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
are applied in nested fashion. For example, the following code
<div class="highlight-python3 notranslate"><div class="highlight"><pre>@f1(arg)
@f2
def func(): pass
</pre></div>
</div>
is roughly equivalent to
<div class="highlight-python3 notranslate"><div class="highlight"><pre>def func(): pass
func = f1(arg)(f2(func))
</pre></div>
</div>
except that the original function is not temporarily bound to the name <code class="docutils literal notranslate">func</code>.
When one or more <a class="reference internal" href="../glossary.html#term-parameter">parameters</a> have the form parameter <code class="docutils literal notranslate">=</code>
expression, the function is said to have “default parameter values.” For a
parameter with a default value, the corresponding <a class="reference internal" href="../glossary.html#term-argument">argument</a> may be
omitted from a call, in which
case the parameter’s default value is substituted. If a parameter has a default
value, all following parameters up until the “<code class="docutils literal notranslate">*</code>” must also have a default
value — this is a syntactic restriction that is not expressed by the grammar.
Default parameter values are evaluated from left to right when the function
definition is executed. This means that the expression is evaluated once, when
the function is defined, and that the same “pre-computed” value is used for each
call. This 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. This is generally not what was intended. A way around this is to use
<code class="docutils literal notranslate">None</code> as the default, and explicitly test for it in the body of the function,
e.g.:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>def whats_on_the_telly(penguin=None):
 if penguin is None:
 penguin = []
 penguin.append(&quot;property of the zoo&quot;)
 return penguin
</pre></div>
</div>
Function call semantics are described in more detail in section <a class="reference internal" href="expressions.html#calls">Calls</a>. A
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 “<code class="docutils literal notranslate">*identifier</code>” is present, it is initialized to a tuple
receiving any excess positional parameters, defaulting to the empty tuple.
If the form “<code class="docutils literal notranslate">**identifier</code>” is present, it is initialized to a new
ordered mapping receiving any excess keyword arguments, defaulting to a
new empty mapping of the same type. Parameters after “<code class="docutils literal notranslate">*</code>” or
“<code class="docutils literal notranslate">*identifier</code>” are keyword-only parameters and may only be passed
used keyword arguments.
Parameters may have annotations of the form “<code class="docutils literal notranslate">: expression</code>” following the
parameter name. Any parameter may have an annotation even those of the form
<code class="docutils literal notranslate">*identifier</code> or <code class="docutils literal notranslate">**identifier</code>. Functions may have “return” annotation of
the form “<code class="docutils literal notranslate">-&gt; expression</code>” after the parameter list. These annotations can be
any valid Python expression and are evaluated when the function definition is
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
by the parameters’ names in the <code class="xref py py-attr docutils literal notranslate">__annotations__</code> attribute of the
function object.
It is also possible to create anonymous functions (functions not bound to a
name), for immediate use in expressions. This uses lambda expressions, described in
section <a class="reference internal" href="expressions.html#lambda">Lambdas</a>. Note that the lambda expression is merely a shorthand for a
simplified function definition; a function defined in a “<a class="reference internal" href="#def"><code class="xref std std-keyword docutils literal notranslate">def</code></a>”
statement can be passed around or assigned to another name just like a function
defined by a lambda expression. The “<a class="reference internal" href="#def"><code class="xref std std-keyword docutils literal notranslate">def</code></a>” form is actually more powerful
since it allows the execution of multiple statements and annotations.
Programmer’s note: Functions are first-class objects. A “<code class="docutils literal notranslate">def</code>” statement
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
<a class="reference internal" href="executionmodel.html#naming">Naming and binding</a> for details.
<div class="admonition seealso">
See also
<dl class="last docutils">
<dt><a class="pep reference external" href="https://www.python.org/dev/peps/pep-3107">PEP 3107</a> - Function Annotations</dt>
<dd>The original specification for function annotations.</dd>
</dl>
</div>
</div>
<div class="section" id="class-definitions">
<h2>8.7. Class definitions<a class="headerlink" href="#class-definitions" title="Permalink to this headline">¶</a></h2>
A class definition defines a class object (see section <a class="reference internal" href="datamodel.html#types">The standard type hierarchy</a>):
<pre>
classdef ::= [<a class="reference internal" href="#grammar-token-decorators"><code class="xref docutils literal notranslate">decorators</code></a>] &quot;class&quot; <a class="reference internal" href="#grammar-token-classname"><code class="xref docutils literal notranslate">classname</code></a> [<a class="reference internal" href="#grammar-token-inheritance"><code class="xref docutils literal notranslate">inheritance</code></a>] &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
inheritance ::= &quot;(&quot; [<a class="reference internal" href="expressions.html#grammar-token-argument_list"><code class="xref docutils literal notranslate">argument_list</code></a>] &quot;)&quot;
classname ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><code class="xref docutils literal notranslate">identifier</code></a>
</pre>
A class definition is an executable statement. The inheritance list usually
gives a list of base classes (see <a class="reference internal" href="datamodel.html#metaclasses">Metaclasses</a> for more advanced uses), so
each item in the list should evaluate to a class object which allows
subclassing. Classes without an inheritance list inherit, by default, from the
base class <a class="reference internal" href="../library/functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a>; hence,
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class Foo:
 pass
</pre></div>
</div>
is equivalent to
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class Foo(object):
 pass
</pre></div>
</div>
The class’s suite is then executed in a new execution frame (see <a class="reference internal" href="executionmodel.html#naming">Naming and binding</a>),
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="footnote-reference" href="#id8" id="id4">[4]</a> 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.
The order in which attributes are defined in the class body is preserved
in the new class’s <code class="docutils literal notranslate">__dict__</code>. Note that this is reliable only right
after the class is created and only for classes that were defined using
the definition syntax.
Class creation can be customized heavily using <a class="reference internal" href="datamodel.html#metaclasses">metaclasses</a>.
Classes can also be decorated: just like when decorating functions,
<div class="highlight-python3 notranslate"><div class="highlight"><pre>@f1(arg)
@f2
class Foo: pass
</pre></div>
</div>
is roughly equivalent to
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class Foo: pass
Foo = f1(arg)(f2(Foo))
</pre></div>
</div>
The evaluation rules for the decorator expressions are the same as for function
decorators. The result is then bound to the class name.
Programmer’s note: Variables defined in the class definition are class
attributes; they are shared by instances. Instance attributes can be set in a
method with <code class="docutils literal notranslate">self.name = value</code>. Both class and instance attributes are
accessible through the notation “<code class="docutils literal notranslate">self.name</code>”, 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. <a class="reference internal" href="datamodel.html#descriptors">Descriptors</a>
can be used to create instance variables with different implementation details.
<div class="admonition seealso">
See also
<a class="pep reference external" href="https://www.python.org/dev/peps/pep-3115">PEP 3115</a> - Metaclasses in Python 3
<a class="pep reference external" href="https://www.python.org/dev/peps/pep-3129">PEP 3129</a> - Class Decorators
</div>
</div>
<div class="section" id="coroutines">
<h2>8.8. Coroutines<a class="headerlink" href="#coroutines" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 3.5.
</div>
<div class="section" id="coroutine-function-definition">
<h3>8.8.1. Coroutine function definition<a class="headerlink" href="#coroutine-function-definition" title="Permalink to this headline">¶</a></h3>
<pre>
async_funcdef ::= [<a class="reference internal" href="#grammar-token-decorators"><code class="xref docutils literal notranslate">decorators</code></a>] &quot;async&quot; &quot;def&quot; <a class="reference internal" href="#grammar-token-funcname"><code class="xref docutils literal notranslate">funcname</code></a> &quot;(&quot; [<a class="reference internal" href="#grammar-token-parameter_list"><code class="xref docutils literal notranslate">parameter_list</code></a>] &quot;)&quot;
 [&quot;-&gt;&quot; <a class="reference internal" href="expressions.html#grammar-token-expression"><code class="xref docutils literal notranslate">expression</code></a>] &quot;:&quot; <a class="reference internal" href="#grammar-token-suite"><code class="xref docutils literal notranslate">suite</code></a>
</pre>
Execution of Python coroutines can be suspended and resumed at many points
(see <a class="reference internal" href="../glossary.html#term-coroutine">coroutine</a>). In the body of a coroutine, any <code class="docutils literal notranslate">await</code> and
<code class="docutils literal notranslate">async</code> identifiers become reserved keywords; <a class="reference internal" href="expressions.html#await"><code class="xref std std-keyword docutils literal notranslate">await</code></a> expressions,
<a class="reference internal" href="#async-for"><code class="xref std std-keyword docutils literal notranslate">async for</code></a> and <a class="reference internal" href="#async-with"><code class="xref std std-keyword docutils literal notranslate">async with</code></a> can only be used in
coroutine bodies.
Functions defined with <code class="docutils literal notranslate">async def</code> syntax are always coroutine functions,
even if they do not contain <code class="docutils literal notranslate">await</code> or <code class="docutils literal notranslate">async</code> keywords.
It is a <a class="reference internal" href="../library/exceptions.html#SyntaxError" title="SyntaxError"><code class="xref py py-exc docutils literal notranslate">SyntaxError</code></a> to use <code class="docutils literal notranslate">yield from</code> expressions in
<code class="docutils literal notranslate">async def</code> coroutines.
An example of a coroutine function:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>async def func(param1, param2):
 do_stuff()
 await some_coroutine()
</pre></div>
</div>
</div>
<div class="section" id="the-async-for-statement">
<h3>8.8.2. The <a class="reference internal" href="#async-for"><code class="xref std std-keyword docutils literal notranslate">async for</code></a> statement<a class="headerlink" href="#the-async-for-statement" title="Permalink to this headline">¶</a></h3>
<pre>
async_for_stmt ::= &quot;async&quot; <a class="reference internal" href="#grammar-token-for_stmt"><code class="xref docutils literal notranslate">for_stmt</code></a>
</pre>
An <a class="reference internal" href="../glossary.html#term-asynchronous-iterable">asynchronous iterable</a> is able to call asynchronous code in its
iter implementation, and <a class="reference internal" href="../glossary.html#term-asynchronous-iterator">asynchronous iterator</a> can call asynchronous
code in its next method.
The <code class="docutils literal notranslate">async for</code> statement allows convenient iteration over asynchronous
iterators.
The following code:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>async for TARGET in ITER:
 BLOCK
else:
 BLOCK2
</pre></div>
</div>
Is semantically equivalent to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>iter = (ITER)
iter = type(iter).__aiter__(iter)
running = True
while running:
 try:
 TARGET = await type(iter).__anext__(iter)
 except StopAsyncIteration:
 running = False
 else:
 BLOCK
else:
 BLOCK2
</pre></div>
</div>
See also <a class="reference internal" href="datamodel.html#object.__aiter__" title="object.__aiter__"><code class="xref py py-meth docutils literal notranslate">__aiter__()</code></a> and <a class="reference internal" href="datamodel.html#object.__anext__" title="object.__anext__"><code class="xref py py-meth docutils literal notranslate">__anext__()</code></a> for details.
It is a <a class="reference internal" href="../library/exceptions.html#SyntaxError" title="SyntaxError"><code class="xref py py-exc docutils literal notranslate">SyntaxError</code></a> to use <code class="docutils literal notranslate">async for</code> statement outside of an
<a class="reference internal" href="#async-def"><code class="xref std std-keyword docutils literal notranslate">async def</code></a> function.
</div>
<div class="section" id="the-async-with-statement">
<h3>8.8.3. The <a class="reference internal" href="#async-with"><code class="xref std std-keyword docutils literal notranslate">async with</code></a> statement<a class="headerlink" href="#the-async-with-statement" title="Permalink to this headline">¶</a></h3>
<pre>
async_with_stmt ::= &quot;async&quot; <a class="reference internal" href="#grammar-token-with_stmt"><code class="xref docutils literal notranslate">with_stmt</code></a>
</pre>
An <a class="reference internal" href="../glossary.html#term-asynchronous-context-manager">asynchronous context manager</a> is a <a class="reference internal" href="../glossary.html#term-context-manager">context manager</a> that is
able to suspend execution in its enter and exit methods.
The following code:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>async with EXPR as VAR:
 BLOCK
</pre></div>
</div>
Is semantically equivalent to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>mgr = (EXPR)
aexit = type(mgr).__aexit__
aenter = type(mgr).__aenter__(mgr)

VAR = await aenter
try:
 BLOCK
except:
 if not await aexit(mgr, *sys.exc_info()):
 raise
else:
 await aexit(mgr, None, None, None)
</pre></div>
</div>
See also <a class="reference internal" href="datamodel.html#object.__aenter__" title="object.__aenter__"><code class="xref py py-meth docutils literal notranslate">__aenter__()</code></a> and <a class="reference internal" href="datamodel.html#object.__aexit__" title="object.__aexit__"><code class="xref py py-meth docutils literal notranslate">__aexit__()</code></a> for details.
It is a <a class="reference internal" href="../library/exceptions.html#SyntaxError" title="SyntaxError"><code class="xref py py-exc docutils literal notranslate">SyntaxError</code></a> to use <code class="docutils literal notranslate">async with</code> statement outside of an
<a class="reference internal" href="#async-def"><code class="xref std std-keyword docutils literal notranslate">async def</code></a> function.
<div class="admonition seealso">
See also
<a class="pep reference external" href="https://www.python.org/dev/peps/pep-0492">PEP 492</a> - Coroutines with async and await syntax
</div>
Footnotes
<table class="docutils footnote" frame="void" id="id5" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>The exception is propagated to the invocation stack unless
there is a <a class="reference internal" href="#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> clause which happens to raise another
exception. That new exception causes the old one to be lost.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Currently, control “flows off the end” except in the case of an exception
or the execution of a <a class="reference internal" href="simple_stmts.html#return"><code class="xref std std-keyword docutils literal notranslate">return</code></a>, <a class="reference internal" href="simple_stmts.html#continue"><code class="xref std std-keyword docutils literal notranslate">continue</code></a>, or
<a class="reference internal" href="simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> statement.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3">[3]</a></td><td>A string literal appearing as the first statement in the function body is
transformed into the function’s <code class="docutils literal notranslate">__doc__</code> attribute and therefore the
function’s <a class="reference internal" href="../glossary.html#term-docstring">docstring</a>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id4">[4]</a></td><td>A string literal appearing as the first statement in the class body is
transformed into the namespace’s <code class="docutils literal notranslate">__doc__</code> item and therefore the class’s
<a class="reference internal" href="../glossary.html#term-docstring">docstring</a>.</td></tr>
</tbody>
</table>
</div>
</div>
</div>

</div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table Of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">8. Compound statements</a><ul>
<li><a class="reference internal" href="#the-if-statement">8.1. The <code class="docutils literal notranslate">if</code> statement</a></li>
<li><a class="reference internal" href="#the-while-statement">8.2. The <code class="docutils literal notranslate">while</code> statement</a></li>
<li><a class="reference internal" href="#the-for-statement">8.3. The <code class="docutils literal notranslate">for</code> statement</a></li>
<li><a class="reference internal" href="#the-try-statement">8.4. The <code class="docutils literal notranslate">try</code> statement</a></li>
<li><a class="reference internal" href="#the-with-statement">8.5. The <code class="docutils literal notranslate">with</code> statement</a></li>
<li><a class="reference internal" href="#function-definitions">8.6. Function definitions</a></li>
<li><a class="reference internal" href="#class-definitions">8.7. Class definitions</a></li>
<li><a class="reference internal" href="#coroutines">8.8. Coroutines</a><ul>
<li><a class="reference internal" href="#coroutine-function-definition">8.8.1. Coroutine function definition</a></li>
<li><a class="reference internal" href="#the-async-for-statement">8.8.2. The <code class="docutils literal notranslate">async for</code> statement</a></li>
<li><a class="reference internal" href="#the-async-with-statement">8.8.3. The <code class="docutils literal notranslate">async with</code> statement</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="simple_stmts.html"
 title="previous chapter">7. Simple statements</a>
 <h4>Next topic</h4>
 <a href="toplevel_components.html"
 title="next chapter">9. Top-level components</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.6/Doc/reference/compound_stmts.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="toplevel_components.html" title="9. Top-level components"
 >next</a> |</li>
 <li class="right" >
 <a href="simple_stmts.html" title="7. Simple statements"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">3.6.7 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Language Reference</a> &#187;</li>
 <li class="right">

</ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on Dec 18, 2023.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6.
 </div>

</body>
</html>

MR SKB