^^&&^^

Edit File: expressions.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="Content-Type" content="text/html; charset=utf-8" />
 
 <title>5. Expressions &mdash; Python 2.7.5 documentation</title>
 
 <link rel="stylesheet" href="../_static/default.css" type="text/css" />
 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
 <script type="text/javascript">
 var DOCUMENTATION_OPTIONS = {
 URL_ROOT: '../',
 VERSION: '2.7.5',
 COLLAPSE_INDEX: false,
 FILE_SUFFIX: '.html',
 HAS_SOURCE: true
 };
 </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 2.7.5 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="top" title="Python 2.7.5 documentation" href="../index.html" />
 <link rel="up" title="The Python Language Reference" href="index.html" />
 <link rel="next" title="6. Simple statements" href="simple_stmts.html" />
 <link rel="prev" title="4. Execution model" href="executionmodel.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head>
 <body>
 <div class="related">
 <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="simple_stmts.html" title="6. Simple statements"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="executionmodel.html" title="4. Execution model"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="http://www.python.org/">Python</a> &raquo;</li>
 <li>
 <a href="../index.html">Python 2.7.5 documentation</a> &raquo;
 </li>

<li><a href="index.html" accesskey="U">The Python Language Reference</a> &raquo;</li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body">
 
 <div class="section" id="expressions">
<h1>5. Expressions<a class="headerlink" href="#expressions" title="Permalink to this headline">¶</a></h1>
This chapter explains the meaning of the elements of expressions in Python.
Syntax Notes: In this and the following chapters, extended BNF notation will
be used to describe syntax, not lexical analysis. When (one alternative of) a
syntax rule has the form
<pre>
name ::= <tt class="xref docutils literal">othername</tt>
</pre>
and no semantics are given, the semantics of this form of <tt class="docutils literal">name</tt> are the same
as for <tt class="docutils literal">othername</tt>.
<div class="section" id="arithmetic-conversions">
<h2>5.1. Arithmetic conversions<a class="headerlink" href="#arithmetic-conversions" title="Permalink to this headline">¶</a></h2>
When a description of an arithmetic operator below uses the phrase &#8220;the numeric
arguments are converted to a common type,&#8221; the arguments are coerced using the
coercion rules listed at <a class="reference internal" href="datamodel.html#coercion-rules">Coercion rules</a>. If both arguments are standard
numeric types, the following coercions are applied:
<ul class="simple">
<li>If either argument is a complex number, the other is converted to complex;</li>
<li>otherwise, if either argument is a floating point number, the other is
converted to floating point;</li>
<li>otherwise, if either argument is a long integer, the other is converted to
long integer;</li>
<li>otherwise, both must be plain integers and no conversion is necessary.</li>
</ul>
Some additional rules apply for certain operators (e.g., a string left argument
to the &#8216;%&#8217; operator). Extensions can define their own coercions.
</div>
<div class="section" id="atoms">
<h2>5.2. Atoms<a class="headerlink" href="#atoms" title="Permalink to this headline">¶</a></h2>
Atoms are the most basic elements of expressions. The simplest atoms are
identifiers or literals. Forms enclosed in reverse quotes or in parentheses,
brackets or braces are also categorized syntactically as atoms. The syntax for
atoms is:
<pre>
atom ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><tt class="xref docutils literal">identifier</tt></a> | <a class="reference internal" href="#grammar-token-literal"><tt class="xref docutils literal">literal</tt></a> | <a class="reference internal" href="#grammar-token-enclosure"><tt class="xref docutils literal">enclosure</tt></a>
enclosure ::= <a class="reference internal" href="#grammar-token-parenth_form"><tt class="xref docutils literal">parenth_form</tt></a> | <a class="reference internal" href="#grammar-token-list_display"><tt class="xref docutils literal">list_display</tt></a>
 | <a class="reference internal" href="#grammar-token-generator_expression"><tt class="xref docutils literal">generator_expression</tt></a> | <a class="reference internal" href="#grammar-token-dict_display"><tt class="xref docutils literal">dict_display</tt></a> | <a class="reference internal" href="#grammar-token-set_display"><tt class="xref docutils literal">set_display</tt></a>
 | <a class="reference internal" href="#grammar-token-string_conversion"><tt class="xref docutils literal">string_conversion</tt></a> | <a class="reference internal" href="#grammar-token-yield_atom"><tt class="xref docutils literal">yield_atom</tt></a>
</pre>
<div class="section" id="atom-identifiers">
<h3>5.2.1. Identifiers (Names)<a class="headerlink" href="#atom-identifiers" title="Permalink to this headline">¶</a></h3>
An identifier occurring as an atom is a name. See section <a class="reference internal" href="lexical_analysis.html#identifiers">Identifiers and keywords</a>
for lexical definition and section <a class="reference internal" href="executionmodel.html#naming">Naming and binding</a> for documentation of naming and
binding.
When the name is bound to an object, evaluation of the atom yields that object.
When a name is not bound, an attempt to evaluate it raises a <a class="reference internal" href="../library/exceptions.html#exceptions.NameError" title="exceptions.NameError"><tt class="xref py py-exc docutils literal">NameError</tt></a>
exception.
Private name mangling: When an identifier that textually occurs in a class
definition begins with two or more underscore characters and does not end in two
or more underscores, it is considered a private name of that class.
Private names are transformed to a longer form before code is generated for
them. The transformation inserts the class name, with leading underscores
removed and a single underscore inserted, in front of the name. For example,
the identifier <tt class="docutils literal">__spam</tt> occurring in a class named <tt class="docutils literal">Ham</tt> will be transformed
to <tt class="docutils literal">_Ham__spam</tt>. This transformation is independent of the syntactical
context in which the identifier is used. If the transformed name is extremely
long (longer than 255 characters), implementation defined truncation may happen.
If the class name consists only of underscores, no transformation is done.
</div>
<div class="section" id="literals">
<h3>5.2.2. Literals<a class="headerlink" href="#literals" title="Permalink to this headline">¶</a></h3>
Python supports string literals and various numeric literals:
<pre>
literal ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-stringliteral"><tt class="xref docutils literal">stringliteral</tt></a> | <a class="reference internal" href="lexical_analysis.html#grammar-token-integer"><tt class="xref docutils literal">integer</tt></a> | <a class="reference internal" href="lexical_analysis.html#grammar-token-longinteger"><tt class="xref docutils literal">longinteger</tt></a>
 | <a class="reference internal" href="lexical_analysis.html#grammar-token-floatnumber"><tt class="xref docutils literal">floatnumber</tt></a> | <a class="reference internal" href="lexical_analysis.html#grammar-token-imagnumber"><tt class="xref docutils literal">imagnumber</tt></a>
</pre>
Evaluation of a literal yields an object of the given type (string, integer,
long integer, floating point number, complex number) with the given value. The
value may be approximated in the case of floating point and imaginary (complex)
literals. See section <a class="reference internal" href="lexical_analysis.html#literals">Literals</a> for details.
All literals correspond to immutable data types, and hence the object&#8217;s identity
is less important than its value. Multiple evaluations of literals with the
same value (either the same occurrence in the program text or a different
occurrence) may obtain the same object or a different object with the same
value.
</div>
<div class="section" id="parenthesized-forms">
<h3>5.2.3. Parenthesized forms<a class="headerlink" href="#parenthesized-forms" title="Permalink to this headline">¶</a></h3>
A parenthesized form is an optional expression list enclosed in parentheses:
<pre>
parenth_form ::= &quot;(&quot; [<a class="reference internal" href="#grammar-token-expression_list"><tt class="xref docutils literal">expression_list</tt></a>] &quot;)&quot;
</pre>
A parenthesized expression list yields whatever that expression list yields: if
the list contains at least one comma, it yields a tuple; otherwise, it yields
the single expression that makes up the expression list.
An empty pair of parentheses yields an empty tuple object. Since tuples are
immutable, the rules for literals apply (i.e., two occurrences of the empty
tuple may or may not yield the same object).
Note that tuples are not formed by the parentheses, but rather by use of the
comma operator. The exception is the empty tuple, for which parentheses are
required &#8212; allowing unparenthesized &#8220;nothing&#8221; in expressions would cause
ambiguities and allow common typos to pass uncaught.
</div>
<div class="section" id="list-displays">
<h3>5.2.4. List displays<a class="headerlink" href="#list-displays" title="Permalink to this headline">¶</a></h3>
A list display is a possibly empty series of expressions enclosed in square
brackets:
<pre>
list_display ::= &quot;[&quot; [<a class="reference internal" href="#grammar-token-expression_list"><tt class="xref docutils literal">expression_list</tt></a> | <a class="reference internal" href="#grammar-token-list_comprehension"><tt class="xref docutils literal">list_comprehension</tt></a>] &quot;]&quot;
list_comprehension ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> <a class="reference internal" href="#grammar-token-list_for"><tt class="xref docutils literal">list_for</tt></a>
list_for ::= &quot;for&quot; <a class="reference internal" href="simple_stmts.html#grammar-token-target_list"><tt class="xref docutils literal">target_list</tt></a> &quot;in&quot; <a class="reference internal" href="#grammar-token-old_expression_list"><tt class="xref docutils literal">old_expression_list</tt></a> [<a class="reference internal" href="#grammar-token-list_iter"><tt class="xref docutils literal">list_iter</tt></a>]
old_expression_list ::= <a class="reference internal" href="#grammar-token-old_expression"><tt class="xref docutils literal">old_expression</tt></a> [(&quot;,&quot; <a class="reference internal" href="#grammar-token-old_expression"><tt class="xref docutils literal">old_expression</tt></a>)+ [&quot;,&quot;]]
old_expression ::= <a class="reference internal" href="#grammar-token-or_test"><tt class="xref docutils literal">or_test</tt></a> | <a class="reference internal" href="#grammar-token-old_lambda_form"><tt class="xref docutils literal">old_lambda_form</tt></a>
list_iter ::= <a class="reference internal" href="#grammar-token-list_for"><tt class="xref docutils literal">list_for</tt></a> | <a class="reference internal" href="#grammar-token-list_if"><tt class="xref docutils literal">list_if</tt></a>
list_if ::= &quot;if&quot; <a class="reference internal" href="#grammar-token-old_expression"><tt class="xref docutils literal">old_expression</tt></a> [<a class="reference internal" href="#grammar-token-list_iter"><tt class="xref docutils literal">list_iter</tt></a>]
</pre>
A list display yields a new list object. Its contents are specified by
providing either a list of expressions or a list comprehension. When a
comma-separated list of expressions is supplied, its elements are evaluated from
left to right and placed into the list object in that order. When a list
comprehension is supplied, it consists of a single expression followed by at
least one <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> clause and zero or more <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> or <a class="reference internal" href="compound_stmts.html#if"><tt class="xref std std-keyword docutils literal">if</tt></a>
clauses. In this case, the elements of the new list are those that would be
produced by considering each of the <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> or <a class="reference internal" href="compound_stmts.html#if"><tt class="xref std std-keyword docutils literal">if</tt></a> clauses a
block, nesting from left to right, and evaluating the expression to produce a
list element each time the innermost block is reached <a class="footnote-reference" href="#id20" id="id3">[1]</a>.
</div>
<div class="section" id="displays-for-sets-and-dictionaries">
<h3>5.2.5. Displays for sets and dictionaries<a class="headerlink" href="#displays-for-sets-and-dictionaries" title="Permalink to this headline">¶</a></h3>
For constructing a set or a dictionary Python provides special syntax
called &#8220;displays&#8221;, each of them in two flavors:
<ul class="simple">
<li>either the container contents are listed explicitly, or</li>
<li>they are computed via a set of looping and filtering instructions, called a
comprehension.</li>
</ul>
Common syntax elements for comprehensions are:
<pre>
comprehension ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> <a class="reference internal" href="#grammar-token-comp_for"><tt class="xref docutils literal">comp_for</tt></a>
comp_for ::= &quot;for&quot; <a class="reference internal" href="simple_stmts.html#grammar-token-target_list"><tt class="xref docutils literal">target_list</tt></a> &quot;in&quot; <a class="reference internal" href="#grammar-token-or_test"><tt class="xref docutils literal">or_test</tt></a> [<a class="reference internal" href="#grammar-token-comp_iter"><tt class="xref docutils literal">comp_iter</tt></a>]
comp_iter ::= <a class="reference internal" href="#grammar-token-comp_for"><tt class="xref docutils literal">comp_for</tt></a> | <a class="reference internal" href="#grammar-token-comp_if"><tt class="xref docutils literal">comp_if</tt></a>
comp_if ::= &quot;if&quot; <tt class="xref docutils literal">expression_nocond</tt> [<a class="reference internal" href="#grammar-token-comp_iter"><tt class="xref docutils literal">comp_iter</tt></a>]
</pre>
The comprehension consists of a single expression followed by at least one
<a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> clause and zero or more <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> or <a class="reference internal" href="compound_stmts.html#if"><tt class="xref std std-keyword docutils literal">if</tt></a> clauses.
In this case, the elements of the new container are those that would be produced
by considering each of the <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> or <a class="reference internal" href="compound_stmts.html#if"><tt class="xref std std-keyword docutils literal">if</tt></a> clauses a block,
nesting from left to right, and evaluating the expression to produce an element
each time the innermost block is reached.
Note that the comprehension is executed in a separate scope, so names assigned
to in the target list don&#8217;t &#8220;leak&#8221; in the enclosing scope.
</div>
<div class="section" id="generator-expressions">
<h3>5.2.6. Generator expressions<a class="headerlink" href="#generator-expressions" title="Permalink to this headline">¶</a></h3>
A generator expression is a compact generator notation in parentheses:
<pre>
generator_expression ::= &quot;(&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> <a class="reference internal" href="#grammar-token-comp_for"><tt class="xref docutils literal">comp_for</tt></a> &quot;)&quot;
</pre>
A generator expression yields a new generator object. Its syntax is the same as
for comprehensions, except that it is enclosed in parentheses instead of
brackets or curly braces.
Variables used in the generator expression are evaluated lazily when the
<tt class="xref py py-meth docutils literal">__next__()</tt> method is called for generator object (in the same fashion as
normal generators). However, the leftmost <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> clause is immediately
evaluated, so that an error produced by it can be seen before any other possible
error in the code that handles the generator expression. Subsequent
<a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> clauses cannot be evaluated immediately since they may depend on
the previous <a class="reference internal" href="compound_stmts.html#for"><tt class="xref std std-keyword docutils literal">for</tt></a> loop. For example: <tt class="docutils literal">(x*y for x in range(10) for y
in bar(x))</tt>.
The parentheses can be omitted on calls with only one argument. See section
<a class="reference internal" href="#calls">Calls</a> for the detail.
</div>
<div class="section" id="dictionary-displays">
<h3>5.2.7. Dictionary displays<a class="headerlink" href="#dictionary-displays" title="Permalink to this headline">¶</a></h3>
A dictionary display is a possibly empty series of key/datum pairs enclosed in
curly braces:
<pre>
dict_display ::= &quot;{&quot; [<a class="reference internal" href="#grammar-token-key_datum_list"><tt class="xref docutils literal">key_datum_list</tt></a> | <a class="reference internal" href="#grammar-token-dict_comprehension"><tt class="xref docutils literal">dict_comprehension</tt></a>] &quot;}&quot;
key_datum_list ::= <a class="reference internal" href="#grammar-token-key_datum"><tt class="xref docutils literal">key_datum</tt></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-key_datum"><tt class="xref docutils literal">key_datum</tt></a>)* [&quot;,&quot;]
key_datum ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> &quot;:&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
dict_comprehension ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> &quot;:&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> <a class="reference internal" href="#grammar-token-comp_for"><tt class="xref docutils literal">comp_for</tt></a>
</pre>
A dictionary display yields a new dictionary object.
If a comma-separated sequence of key/datum pairs is given, they are evaluated
from left to right to define the entries of the dictionary: each key object is
used as a key into the dictionary to store the corresponding datum. This means
that you can specify the same key multiple times in the key/datum list, and the
final dictionary&#8217;s value for that key will be the last one given.
A dict comprehension, in contrast to list and set comprehensions, needs two
expressions separated with a colon followed by the usual &#8220;for&#8221; and &#8220;if&#8221; clauses.
When the comprehension is run, the resulting key and value elements are inserted
in the new dictionary in the order they are produced.
Restrictions on the types of the key values are listed earlier in section
<a class="reference internal" href="datamodel.html#types">The standard type hierarchy</a>. (To summarize, the key type should be <a class="reference internal" href="../glossary.html#term-hashable">hashable</a>, which excludes
all mutable objects.) Clashes between duplicate keys are not detected; the last
datum (textually rightmost in the display) stored for a given key value
prevails.
</div>
<div class="section" id="set-displays">
<h3>5.2.8. Set displays<a class="headerlink" href="#set-displays" title="Permalink to this headline">¶</a></h3>
A set display is denoted by curly braces and distinguishable from dictionary
displays by the lack of colons separating keys and values:
<pre>
set_display ::= &quot;{&quot; (<a class="reference internal" href="#grammar-token-expression_list"><tt class="xref docutils literal">expression_list</tt></a> | <a class="reference internal" href="#grammar-token-comprehension"><tt class="xref docutils literal">comprehension</tt></a>) &quot;}&quot;
</pre>
A set display yields a new mutable set object, the contents being specified by
either a sequence of expressions or a comprehension. When a comma-separated
list of expressions is supplied, its elements are evaluated from left to right
and added to the set object. When a comprehension is supplied, the set is
constructed from the elements resulting from the comprehension.
An empty set cannot be constructed with <tt class="docutils literal">{}</tt>; this literal constructs an empty
dictionary.
</div>
<div class="section" id="string-conversions">
<h3>5.2.9. String conversions<a class="headerlink" href="#string-conversions" title="Permalink to this headline">¶</a></h3>
A string conversion is an expression list enclosed in reverse (a.k.a. backward)
quotes:
<pre>
string_conversion ::= &quot;`&quot; <a class="reference internal" href="#grammar-token-expression_list"><tt class="xref docutils literal">expression_list</tt></a> &quot;`&quot;
</pre>
A string conversion evaluates the contained expression list and converts the
resulting object into a string according to rules specific to its type.
If the object is a string, a number, <tt class="docutils literal">None</tt>, or a tuple, list or dictionary
containing only objects whose type is one of these, the resulting string is a
valid Python expression which can be passed to the built-in function
<a class="reference internal" href="../library/functions.html#eval" title="eval"><tt class="xref py py-func docutils literal">eval()</tt></a> to yield an expression with the same value (or an approximation, if
floating point numbers are involved).
(In particular, converting a string adds quotes around it and converts &#8220;funny&#8221;
characters to escape sequences that are safe to print.)
Recursive objects (for example, lists or dictionaries that contain a reference
to themselves, directly or indirectly) use <tt class="docutils literal">...</tt> to indicate a recursive
reference, and the result cannot be passed to <a class="reference internal" href="../library/functions.html#eval" title="eval"><tt class="xref py py-func docutils literal">eval()</tt></a> to get an equal value
(<a class="reference internal" href="../library/exceptions.html#exceptions.SyntaxError" title="exceptions.SyntaxError"><tt class="xref py py-exc docutils literal">SyntaxError</tt></a> will be raised instead).
The built-in function <a class="reference internal" href="../library/repr.html#module-repr" title="repr: Alternate repr() implementation with size limits."><tt class="xref py py-func docutils literal">repr()</tt></a> performs exactly the same conversion in its
argument as enclosing it in parentheses and reverse quotes does. The built-in
function <a class="reference internal" href="../library/functions.html#str" title="str"><tt class="xref py py-func docutils literal">str()</tt></a> performs a similar but more user-friendly conversion.
</div>
<div class="section" id="yield-expressions">
<h3>5.2.10. Yield expressions<a class="headerlink" href="#yield-expressions" title="Permalink to this headline">¶</a></h3>
<pre id="index-22">
yield_atom ::= &quot;(&quot; <a class="reference internal" href="#grammar-token-yield_expression"><tt class="xref docutils literal">yield_expression</tt></a> &quot;)&quot;
yield_expression ::= &quot;yield&quot; [<a class="reference internal" href="#grammar-token-expression_list"><tt class="xref docutils literal">expression_list</tt></a>]
</pre>

New in version 2.5.
The <a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression is only used when defining a generator function,
and can only be used in the body of a function definition. Using a
<a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression in a function definition is sufficient to cause that
definition to create a generator function instead of a normal function.
When a generator function is called, it returns an iterator known as a
generator. That generator then controls the execution of a generator function.
The execution starts when one of the generator&#8217;s methods is called. At that
time, the execution proceeds to the first <a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression, where it
is suspended again, returning the value of <a class="reference internal" href="#grammar-token-expression_list"><tt class="xref std std-token docutils literal">expression_list</tt></a> to
generator&#8217;s caller. By suspended we mean that all local state is retained,
including the current bindings of local variables, the instruction pointer, and
the internal evaluation stack. When the execution is resumed by calling one of
the generator&#8217;s methods, the function can proceed exactly as if the
<a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression was just another external call. The value of the
<a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression after resuming depends on the method which resumed
the execution.
All of this makes generator functions quite similar to coroutines; they yield
multiple times, they have more than one entry point and their execution can be
suspended. The only difference is that a generator function cannot control
where should the execution continue after it yields; the control is always
transferred to the generator&#8217;s caller.
<div class="section" id="generator-iterator-methods">
<h4>5.2.10.1. Generator-iterator methods<a class="headerlink" href="#generator-iterator-methods" title="Permalink to this headline">¶</a></h4>
This subsection describes the methods of a generator iterator. They can
be used to control the execution of a generator function.
Note that calling any of the generator methods below when the generator
is already executing raises a <a class="reference internal" href="../library/exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal">ValueError</tt></a> exception.
<dl class="method">
<dt id="generator.next">
<tt class="descclassname">generator.</tt><tt class="descname">next</tt><big>(</big><big>)</big><a class="headerlink" href="#generator.next" title="Permalink to this definition">¶</a></dt>
<dd>Starts the execution of a generator function or resumes it at the last executed
<a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression. When a generator function is resumed with a
<a class="reference internal" href="../library/functions.html#next" title="next"><tt class="xref py py-meth docutils literal">next()</tt></a> method, the current <a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression always evaluates to
<a class="reference internal" href="../library/constants.html#None" title="None"><tt class="xref py py-const docutils literal">None</tt></a>. The execution then continues to the next <a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a>
expression, where the generator is suspended again, and the value of the
<a class="reference internal" href="#grammar-token-expression_list"><tt class="xref std std-token docutils literal">expression_list</tt></a> is returned to <a class="reference internal" href="../library/functions.html#next" title="next"><tt class="xref py py-meth docutils literal">next()</tt></a>&#8216;s caller. If the generator
exits without yielding another value, a <a class="reference internal" href="../library/exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><tt class="xref py py-exc docutils literal">StopIteration</tt></a> exception is
raised.
</dd></dl>

<dl class="method">
<dt id="generator.send">
<tt class="descclassname">generator.</tt><tt class="descname">send</tt><big>(</big>value<big>)</big><a class="headerlink" href="#generator.send" title="Permalink to this definition">¶</a></dt>
<dd>Resumes the execution and &#8220;sends&#8221; a value into the generator function. The
<tt class="docutils literal">value</tt> argument becomes the result of the current <a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a>
expression. The <a class="reference internal" href="#generator.send" title="generator.send"><tt class="xref py py-meth docutils literal">send()</tt></a> method returns the next value yielded by the
generator, or raises <a class="reference internal" href="../library/exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><tt class="xref py py-exc docutils literal">StopIteration</tt></a> if the generator exits without
yielding another value. When <a class="reference internal" href="#generator.send" title="generator.send"><tt class="xref py py-meth docutils literal">send()</tt></a> is called to start the generator, it
must be called with <a class="reference internal" href="../library/constants.html#None" title="None"><tt class="xref py py-const docutils literal">None</tt></a> as the argument, because there is no
<a class="reference internal" href="simple_stmts.html#yield"><tt class="xref std std-keyword docutils literal">yield</tt></a> expression that could receive the value.
</dd></dl>

<dl class="method">
<dt id="generator.throw">
<tt class="descclassname">generator.</tt><tt class="descname">throw</tt><big>(</big>type[, value[, traceback]]<big>)</big><a class="headerlink" href="#generator.throw" title="Permalink to this definition">¶</a></dt>
<dd>Raises an exception of type <tt class="docutils literal">type</tt> at the point where generator was paused,
and returns the next value yielded by the generator function. If the generator
exits without yielding another value, a <a class="reference internal" href="../library/exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><tt class="xref py py-exc docutils literal">StopIteration</tt></a> exception is
raised. If the generator function does not catch the passed-in exception, or
raises a different exception, then that exception propagates to the caller.
</dd></dl>

<dl class="method">
<dt id="generator.close">
<tt class="descclassname">generator.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#generator.close" title="Permalink to this definition">¶</a></dt>
<dd>Raises a <a class="reference internal" href="../library/exceptions.html#exceptions.GeneratorExit" title="exceptions.GeneratorExit"><tt class="xref py py-exc docutils literal">GeneratorExit</tt></a> at the point where the generator function was
paused. If the generator function then raises <a class="reference internal" href="../library/exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><tt class="xref py py-exc docutils literal">StopIteration</tt></a> (by exiting
normally, or due to already being closed) or <a class="reference internal" href="../library/exceptions.html#exceptions.GeneratorExit" title="exceptions.GeneratorExit"><tt class="xref py py-exc docutils literal">GeneratorExit</tt></a> (by not
catching the exception), close returns to its caller. If the generator yields a
value, a <a class="reference internal" href="../library/exceptions.html#exceptions.RuntimeError" title="exceptions.RuntimeError"><tt class="xref py py-exc docutils literal">RuntimeError</tt></a> is raised. If the generator raises any other
exception, it is propagated to the caller. <a class="reference internal" href="#generator.close" title="generator.close"><tt class="xref py py-meth docutils literal">close()</tt></a> does nothing if the
generator has already exited due to an exception or normal exit.
</dd></dl>

Here is a simple example that demonstrates the behavior of generators and
generator functions:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; def echo(value=None):
... print &quot;Execution starts when &#39;next()&#39; is called for the first time.&quot;
... try:
... while True:
... try:
... value = (yield value)
... except Exception, e:
... value = e
... finally:
... print &quot;Don&#39;t forget to clean up when &#39;close()&#39; is called.&quot;
...
&gt;&gt;&gt; generator = echo(1)
&gt;&gt;&gt; print generator.next()
Execution starts when &#39;next()&#39; is called for the first time.
1
&gt;&gt;&gt; print generator.next()
None
&gt;&gt;&gt; print generator.send(2)
2
&gt;&gt;&gt; generator.throw(TypeError, &quot;spam&quot;)
TypeError(&#39;spam&#39;,)
&gt;&gt;&gt; generator.close()
Don&#39;t forget to clean up when &#39;close()&#39; is called.
</pre></div>
</div>
<div class="admonition-see-also admonition seealso">
See also
<dl class="last docutils">
<dt><a class="pep reference external" href="http://www.python.org/dev/peps/pep-0342">PEP 0342</a> - Coroutines via Enhanced Generators</dt>
<dd>The proposal to enhance the API and syntax of generators, making them usable as
simple coroutines.</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section" id="primaries">
<h2>5.3. Primaries<a class="headerlink" href="#primaries" title="Permalink to this headline">¶</a></h2>
Primaries represent the most tightly bound operations of the language. Their
syntax is:
<pre>
primary ::= <a class="reference internal" href="#grammar-token-atom"><tt class="xref docutils literal">atom</tt></a> | <a class="reference internal" href="#grammar-token-attributeref"><tt class="xref docutils literal">attributeref</tt></a> | <a class="reference internal" href="#grammar-token-subscription"><tt class="xref docutils literal">subscription</tt></a> | <a class="reference internal" href="#grammar-token-slicing"><tt class="xref docutils literal">slicing</tt></a> | <a class="reference internal" href="#grammar-token-call"><tt class="xref docutils literal">call</tt></a>
</pre>
<div class="section" id="attribute-references">
<h3>5.3.1. Attribute references<a class="headerlink" href="#attribute-references" title="Permalink to this headline">¶</a></h3>
An attribute reference is a primary followed by a period and a name:
<pre>
attributeref ::= <a class="reference internal" href="#grammar-token-primary"><tt class="xref docutils literal">primary</tt></a> &quot;.&quot; <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><tt class="xref docutils literal">identifier</tt></a>
</pre>
The primary must evaluate to an object of a type that supports attribute
references, e.g., a module, list, or an instance. This object is then asked to
produce the attribute whose name is the identifier. If this attribute is not
available, the exception <a class="reference internal" href="../library/exceptions.html#exceptions.AttributeError" title="exceptions.AttributeError"><tt class="xref py py-exc docutils literal">AttributeError</tt></a> is raised. Otherwise, the type
and value of the object produced is determined by the object. Multiple
evaluations of the same attribute reference may yield different objects.
</div>
<div class="section" id="subscriptions">
<h3>5.3.2. Subscriptions<a class="headerlink" href="#subscriptions" title="Permalink to this headline">¶</a></h3>
A subscription selects an item of a sequence (string, tuple or list) or mapping
(dictionary) object:
<pre>
subscription ::= <a class="reference internal" href="#grammar-token-primary"><tt class="xref docutils literal">primary</tt></a> &quot;[&quot; <a class="reference internal" href="#grammar-token-expression_list"><tt class="xref docutils literal">expression_list</tt></a> &quot;]&quot;
</pre>
The primary must evaluate to an object of a sequence or mapping type.
If the primary is a mapping, the expression list must evaluate to an object
whose value is one of the keys of the mapping, and the subscription selects the
value in the mapping that corresponds to that key. (The expression list is a
tuple except if it has exactly one item.)
If the primary is a sequence, the expression (list) must evaluate to a plain
integer. If this value is negative, the length of the sequence is added to it
(so that, e.g., <tt class="docutils literal">x[-1]</tt> selects the last item of <tt class="docutils literal">x</tt>.) The resulting value
must be a nonnegative integer less than the number of items in the sequence, and
the subscription selects the item whose index is that value (counting from
zero).
A string&#8217;s items are characters. A character is not a separate data type but a
string of exactly one character.
</div>
<div class="section" id="slicings">
<h3>5.3.3. Slicings<a class="headerlink" href="#slicings" title="Permalink to this headline">¶</a></h3>
A slicing selects a range of items in a sequence object (e.g., a string, tuple
or list). Slicings may be used as expressions or as targets in assignment or
<a class="reference internal" href="simple_stmts.html#del"><tt class="xref std std-keyword docutils literal">del</tt></a> statements. The syntax for a slicing:
<pre>
slicing ::= <a class="reference internal" href="#grammar-token-simple_slicing"><tt class="xref docutils literal">simple_slicing</tt></a> | <a class="reference internal" href="#grammar-token-extended_slicing"><tt class="xref docutils literal">extended_slicing</tt></a>
simple_slicing ::= <a class="reference internal" href="#grammar-token-primary"><tt class="xref docutils literal">primary</tt></a> &quot;[&quot; <a class="reference internal" href="#grammar-token-short_slice"><tt class="xref docutils literal">short_slice</tt></a> &quot;]&quot;
extended_slicing ::= <a class="reference internal" href="#grammar-token-primary"><tt class="xref docutils literal">primary</tt></a> &quot;[&quot; <a class="reference internal" href="#grammar-token-slice_list"><tt class="xref docutils literal">slice_list</tt></a> &quot;]&quot;
slice_list ::= <a class="reference internal" href="#grammar-token-slice_item"><tt class="xref docutils literal">slice_item</tt></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-slice_item"><tt class="xref docutils literal">slice_item</tt></a>)* [&quot;,&quot;]
slice_item ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> | <a class="reference internal" href="#grammar-token-proper_slice"><tt class="xref docutils literal">proper_slice</tt></a> | <a class="reference internal" href="#grammar-token-ellipsis"><tt class="xref docutils literal">ellipsis</tt></a>
proper_slice ::= <a class="reference internal" href="#grammar-token-short_slice"><tt class="xref docutils literal">short_slice</tt></a> | <a class="reference internal" href="#grammar-token-long_slice"><tt class="xref docutils literal">long_slice</tt></a>
short_slice ::= [<a class="reference internal" href="#grammar-token-lower_bound"><tt class="xref docutils literal">lower_bound</tt></a>] &quot;:&quot; [<a class="reference internal" href="#grammar-token-upper_bound"><tt class="xref docutils literal">upper_bound</tt></a>]
long_slice ::= <a class="reference internal" href="#grammar-token-short_slice"><tt class="xref docutils literal">short_slice</tt></a> &quot;:&quot; [<a class="reference internal" href="#grammar-token-stride"><tt class="xref docutils literal">stride</tt></a>]
lower_bound ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
upper_bound ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
stride ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
ellipsis ::= &quot;...&quot;
</pre>
There is ambiguity in the formal syntax here: anything that looks like an
expression list also looks like a slice list, so any subscription can be
interpreted as a slicing. Rather than further complicating the syntax, this is
disambiguated by defining that in this case the interpretation as a subscription
takes priority over the interpretation as a slicing (this is the case if the
slice list contains no proper slice nor ellipses). Similarly, when the slice
list has exactly one short slice and no trailing comma, the interpretation as a
simple slicing takes priority over that as an extended slicing.
The semantics for a simple slicing are as follows. The primary must evaluate to
a sequence object. The lower and upper bound expressions, if present, must
evaluate to plain integers; defaults are zero and the <tt class="docutils literal">sys.maxint</tt>,
respectively. If either bound is negative, the sequence&#8217;s length is added to
it. The slicing now selects all items with index k such that <tt class="docutils literal">i &lt;= k &lt; j</tt>
where i and j are the specified lower and upper bounds. This may be an
empty sequence. It is not an error if i or j lie outside the range of valid
indexes (such items don&#8217;t exist so they aren&#8217;t selected).
The semantics for an extended slicing are as follows. The primary must evaluate
to a mapping object, and it is indexed with a key that is constructed from the
slice list, as follows. If the slice list contains at least one comma, the key
is a tuple containing the conversion of the slice items; otherwise, the
conversion of the lone slice item is the key. The conversion of a slice item
that is an expression is that expression. The conversion of an ellipsis slice
item is the built-in <tt class="docutils literal">Ellipsis</tt> object. The conversion of a proper slice is a
slice object (see section <a class="reference internal" href="datamodel.html#types">The standard type hierarchy</a>) whose <tt class="xref py py-attr docutils literal">start</tt>, <tt class="xref py py-attr docutils literal">stop</tt> and
<tt class="xref py py-attr docutils literal">step</tt> attributes are the values of the expressions given as lower bound,
upper bound and stride, respectively, substituting <tt class="docutils literal">None</tt> for missing
expressions.
</div>
<div class="section" id="calls">
<h3>5.3.4. Calls<a class="headerlink" href="#calls" title="Permalink to this headline">¶</a></h3>
A call calls a callable object (e.g., a <a class="reference internal" href="../glossary.html#term-function">function</a>) with a possibly empty
series of <a class="reference internal" href="../glossary.html#term-argument">arguments</a>:
<pre>
call ::= <a class="reference internal" href="#grammar-token-primary"><tt class="xref docutils literal">primary</tt></a> &quot;(&quot; [<a class="reference internal" href="#grammar-token-argument_list"><tt class="xref docutils literal">argument_list</tt></a> [&quot;,&quot;]
 | <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> <tt class="xref docutils literal">genexpr_for</tt>] &quot;)&quot;
argument_list ::= <a class="reference internal" href="#grammar-token-positional_arguments"><tt class="xref docutils literal">positional_arguments</tt></a> [&quot;,&quot; <a class="reference internal" href="#grammar-token-keyword_arguments"><tt class="xref docutils literal">keyword_arguments</tt></a>]
 [&quot;,&quot; &quot;*&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>] [&quot;,&quot; <a class="reference internal" href="#grammar-token-keyword_arguments"><tt class="xref docutils literal">keyword_arguments</tt></a>]
 [&quot;,&quot; &quot;**&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>]
 | <a class="reference internal" href="#grammar-token-keyword_arguments"><tt class="xref docutils literal">keyword_arguments</tt></a> [&quot;,&quot; &quot;*&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>]
 [&quot;,&quot; &quot;**&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>]
 | &quot;*&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> [&quot;,&quot; &quot;*&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>] [&quot;,&quot; &quot;**&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>]
 | &quot;**&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
positional_arguments ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>)*
keyword_arguments ::= <a class="reference internal" href="#grammar-token-keyword_item"><tt class="xref docutils literal">keyword_item</tt></a> (&quot;,&quot; <a class="reference internal" href="#grammar-token-keyword_item"><tt class="xref docutils literal">keyword_item</tt></a>)*
keyword_item ::= <a class="reference internal" href="lexical_analysis.html#grammar-token-identifier"><tt class="xref docutils literal">identifier</tt></a> &quot;=&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
</pre>
A trailing comma may be present after the positional and keyword arguments but
does not affect the semantics.
The primary must evaluate to a callable object (user-defined functions, built-in
functions, methods of built-in objects, class objects, methods of class
instances, and certain class instances themselves are callable; extensions may
define additional callable object types). All argument expressions are
evaluated before the call is attempted. Please refer to section <a class="reference internal" href="compound_stmts.html#function">Function definitions</a>
for the syntax of formal <a class="reference internal" href="../glossary.html#term-parameter">parameter</a> lists.
If keyword arguments are present, they are first converted to positional
arguments, as follows. First, a list of unfilled slots is created for the
formal parameters. If there are N positional arguments, they are placed in the
first N slots. Next, for each keyword argument, the identifier is used to
determine the corresponding slot (if the identifier is the same as the first
formal parameter name, the first slot is used, and so on). If the slot is
already filled, a <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal">TypeError</tt></a> exception is raised. Otherwise, the value of
the argument is placed in the slot, filling it (even if the expression is
<tt class="docutils literal">None</tt>, it fills the slot). When all arguments have been processed, the slots
that are still unfilled are filled with the corresponding default value from the
function definition. (Default values are calculated, once, when the function is
defined; thus, a mutable object such as a list or dictionary used as default
value will be shared by all calls that don&#8217;t specify an argument value for the
corresponding slot; this should usually be avoided.) If there are any unfilled
slots for which no default value is specified, a <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal">TypeError</tt></a> exception is
raised. Otherwise, the list of filled slots is used as the argument list for
the call.
<div class="impl-detail compound">
CPython implementation detail: An implementation may provide built-in functions whose positional parameters
do not have names, even if they are &#8216;named&#8217; for the purpose of documentation,
and which therefore cannot be supplied by keyword. In CPython, this is the
case for functions implemented in C that use <a class="reference internal" href="../c-api/arg.html#PyArg_ParseTuple" title="PyArg_ParseTuple"><tt class="xref c c-func docutils literal">PyArg_ParseTuple()</tt></a> to
parse their arguments.
</div>
If there are more positional arguments than there are formal parameter slots, a
<a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal">TypeError</tt></a> exception is raised, unless a formal parameter using the syntax
<tt class="docutils literal">*identifier</tt> is present; in this case, that formal parameter receives a tuple
containing the excess positional arguments (or an empty tuple if there were no
excess positional arguments).
If any keyword argument does not correspond to a formal parameter name, a
<a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal">TypeError</tt></a> exception is raised, unless a formal parameter using the syntax
<tt class="docutils literal">**identifier</tt> is present; in this case, that formal parameter receives a
dictionary containing the excess keyword arguments (using the keywords as keys
and the argument values as corresponding values), or a (new) empty dictionary if
there were no excess keyword arguments.
If the syntax <tt class="docutils literal">*expression</tt> appears in the function call, <tt class="docutils literal">expression</tt> must
evaluate to an iterable. Elements from this iterable are treated as if they
were additional positional arguments; if there are positional arguments
x1, ..., xN, and <tt class="docutils literal">expression</tt> evaluates to a sequence y1, ..., yM, this
is equivalent to a call with M+N positional arguments x1, ..., xN, y1,
..., yM.
A consequence of this is that although the <tt class="docutils literal">*expression</tt> syntax may appear
after some keyword arguments, it is processed before the keyword arguments
(and the <tt class="docutils literal">**expression</tt> argument, if any &#8211; see below). So:
<div class="highlight-python"><div class="highlight"><pre>&gt;&gt;&gt; def f(a, b):
... print a, b
...
&gt;&gt;&gt; f(b=1, *(2,))
2 1
&gt;&gt;&gt; f(a=1, *(2,))
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in ?
TypeError: f() got multiple values for keyword argument &#39;a&#39;
&gt;&gt;&gt; f(1, *(2,))
1 2
</pre></div>
</div>
It is unusual for both keyword arguments and the <tt class="docutils literal">*expression</tt> syntax to be
used in the same call, so in practice this confusion does not arise.
If the syntax <tt class="docutils literal">**expression</tt> appears in the function call, <tt class="docutils literal">expression</tt> must
evaluate to a mapping, the contents of which are treated as additional keyword
arguments. In the case of a keyword appearing in both <tt class="docutils literal">expression</tt> and as an
explicit keyword argument, a <a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal">TypeError</tt></a> exception is raised.
Formal parameters using the syntax <tt class="docutils literal">*identifier</tt> or <tt class="docutils literal">**identifier</tt> cannot be
used as positional argument slots or as keyword argument names. Formal
parameters using the syntax <tt class="docutils literal">(sublist)</tt> cannot be used as keyword argument
names; the outermost sublist corresponds to a single unnamed argument slot, and
the argument value is assigned to the sublist using the usual tuple assignment
rules after all other parameter processing is done.
A call always returns some value, possibly <tt class="docutils literal">None</tt>, unless it raises an
exception. How this value is computed depends on the type of the callable
object.
If it is&#8212;
<dl class="docutils">
<dt>a user-defined function:</dt>
<dd>The code block for the function is executed, passing it the argument list. The
first thing the code block will do is bind the formal parameters to the
arguments; this is described in section <a class="reference internal" href="compound_stmts.html#function">Function definitions</a>. When the code block
executes a <a class="reference internal" href="simple_stmts.html#return"><tt class="xref std std-keyword docutils literal">return</tt></a> statement, this specifies the return value of the
function call.
</dd>
<dt>a built-in function or method:</dt>
<dd>The result is up to the interpreter; see <a class="reference internal" href="../library/functions.html#built-in-funcs">Built-in Functions</a> for the
descriptions of built-in functions and methods.
</dd>
<dt>a class object:</dt>
<dd>A new instance of that class is returned.
</dd>
<dt>a class instance method:</dt>
<dd>The corresponding user-defined function is called, with an argument list that is
one longer than the argument list of the call: the instance becomes the first
argument.
</dd>
<dt>a class instance:</dt>
<dd>The class must define a <a class="reference internal" href="datamodel.html#object.__call__" title="object.__call__"><tt class="xref py py-meth docutils literal">__call__()</tt></a> method; the effect is then the same as
if that method was called.
</dd>
</dl>
</div>
</div>
<div class="section" id="the-power-operator">
<h2>5.4. The power operator<a class="headerlink" href="#the-power-operator" title="Permalink to this headline">¶</a></h2>
The power operator binds more tightly than unary operators on its left; it binds
less tightly than unary operators on its right. The syntax is:
<pre>
power ::= <a class="reference internal" href="#grammar-token-primary"><tt class="xref docutils literal">primary</tt></a> [&quot;**&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a>]
</pre>
Thus, in an unparenthesized sequence of power and unary operators, the operators
are evaluated from right to left (this does not constrain the evaluation order
for the operands): <tt class="docutils literal">-1**2</tt> results in <tt class="docutils literal">-1</tt>.
The power operator has the same semantics as the built-in <a class="reference internal" href="../library/functions.html#pow" title="pow"><tt class="xref py py-func docutils literal">pow()</tt></a> function,
when called with two arguments: it yields its left argument raised to the power
of its right argument. The numeric arguments are first converted to a common
type. The result type is that of the arguments after coercion.
With mixed operand types, the coercion rules for binary arithmetic operators
apply. For int and long int operands, the result has the same type as the
operands (after coercion) unless the second argument is negative; in that case,
all arguments are converted to float and a float result is delivered. For
example, <tt class="docutils literal">10**2</tt> returns <tt class="docutils literal">100</tt>, but <tt class="docutils literal">10**-2</tt> returns <tt class="docutils literal">0.01</tt>. (This last
feature was added in Python 2.2. In Python 2.1 and before, if both arguments
were of integer types and the second argument was negative, an exception was
raised).
Raising <tt class="docutils literal">0.0</tt> to a negative power results in a <a class="reference internal" href="../library/exceptions.html#exceptions.ZeroDivisionError" title="exceptions.ZeroDivisionError"><tt class="xref py py-exc docutils literal">ZeroDivisionError</tt></a>.
Raising a negative number to a fractional power results in a <a class="reference internal" href="../library/exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal">ValueError</tt></a>.
</div>
<div class="section" id="unary-arithmetic-and-bitwise-operations">
<h2>5.5. Unary arithmetic and bitwise operations<a class="headerlink" href="#unary-arithmetic-and-bitwise-operations" title="Permalink to this headline">¶</a></h2>
All unary arithmetic and bitwise operations have the same priority:
<pre>
u_expr ::= <a class="reference internal" href="#grammar-token-power"><tt class="xref docutils literal">power</tt></a> | &quot;-&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a> | &quot;+&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a> | &quot;~&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a>
</pre>
The unary <tt class="docutils literal">-</tt> (minus) operator yields the negation of its numeric argument.
The unary <tt class="docutils literal">+</tt> (plus) operator yields its numeric argument unchanged.
The unary <tt class="docutils literal">~</tt> (invert) operator yields the bitwise inversion of its plain or
long integer argument. The bitwise inversion of <tt class="docutils literal">x</tt> is defined as
<tt class="docutils literal">-(x+1)</tt>. It only applies to integral numbers.
In all three cases, if the argument does not have the proper type, a
<a class="reference internal" href="../library/exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal">TypeError</tt></a> exception is raised.
</div>
<div class="section" id="binary-arithmetic-operations">
<h2>5.6. Binary arithmetic operations<a class="headerlink" href="#binary-arithmetic-operations" title="Permalink to this headline">¶</a></h2>
The binary arithmetic operations have the conventional priority levels. Note
that some of these operations also apply to certain non-numeric types. Apart
from the power operator, there are only two levels, one for multiplicative
operators and one for additive operators:
<pre>
m_expr ::= <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a> | <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a> &quot;*&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a> | <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a> &quot;//&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a> | <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a> &quot;/&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a>
 | <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a> &quot;%&quot; <a class="reference internal" href="#grammar-token-u_expr"><tt class="xref docutils literal">u_expr</tt></a>
a_expr ::= <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a> | <a class="reference internal" href="#grammar-token-a_expr"><tt class="xref docutils literal">a_expr</tt></a> &quot;+&quot; <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a> | <a class="reference internal" href="#grammar-token-a_expr"><tt class="xref docutils literal">a_expr</tt></a> &quot;-&quot; <a class="reference internal" href="#grammar-token-m_expr"><tt class="xref docutils literal">m_expr</tt></a>
</pre>
The <tt class="docutils literal">*</tt> (multiplication) operator yields the product of its arguments. The
arguments must either both be numbers, or one argument must be an integer (plain
or long) and the other must be a sequence. In the former case, the numbers are
converted to a common type and then multiplied together. In the latter case,
sequence repetition is performed; a negative repetition factor yields an empty
sequence.
The <tt class="docutils literal">/</tt> (division) and <tt class="docutils literal">//</tt> (floor division) operators yield the quotient of
their arguments. The numeric arguments are first converted to a common type.
Plain or long integer division yields an integer of the same type; the result is
that of mathematical division with the &#8216;floor&#8217; function applied to the result.
Division by zero raises the <a class="reference internal" href="../library/exceptions.html#exceptions.ZeroDivisionError" title="exceptions.ZeroDivisionError"><tt class="xref py py-exc docutils literal">ZeroDivisionError</tt></a> exception.
The <tt class="docutils literal">%</tt> (modulo) operator yields the remainder from the division of the first
argument by the second. The numeric arguments are first converted to a common
type. A zero right argument raises the <a class="reference internal" href="../library/exceptions.html#exceptions.ZeroDivisionError" title="exceptions.ZeroDivisionError"><tt class="xref py py-exc docutils literal">ZeroDivisionError</tt></a> exception. The
arguments may be floating point numbers, e.g., <tt class="docutils literal">3.14%0.7</tt> equals <tt class="docutils literal">0.34</tt>
(since <tt class="docutils literal">3.14</tt> equals <tt class="docutils literal">4*0.7 + 0.34</tt>.) The modulo operator always yields a
result with the same sign as its second operand (or zero); the absolute value of
the result is strictly smaller than the absolute value of the second operand
<a class="footnote-reference" href="#id21" id="id10">[2]</a>.
The integer division and modulo operators are connected by the following
identity: <tt class="docutils literal">x == (x/y)*y + (x%y)</tt>. Integer division and modulo are also
connected with the built-in function <a class="reference internal" href="../library/functions.html#divmod" title="divmod"><tt class="xref py py-func docutils literal">divmod()</tt></a>: <tt class="docutils literal">divmod(x, y) == (x/y,
x%y)</tt>. These identities don&#8217;t hold for floating point numbers; there similar
identities hold approximately where <tt class="docutils literal">x/y</tt> is replaced by <tt class="docutils literal">floor(x/y)</tt> or
<tt class="docutils literal">floor(x/y) - 1</tt> <a class="footnote-reference" href="#id22" id="id11">[3]</a>.
In addition to performing the modulo operation on numbers, the <tt class="docutils literal">%</tt> operator is
also overloaded by string and unicode objects to perform string formatting (also
known as interpolation). The syntax for string formatting is described in the
Python Library Reference, section <a class="reference internal" href="../library/stdtypes.html#string-formatting">String Formatting Operations</a>.

Deprecated since version 2.3: The floor division operator, the modulo operator, and the <a class="reference internal" href="../library/functions.html#divmod" title="divmod"><tt class="xref py py-func docutils literal">divmod()</tt></a>
function are no longer defined for complex numbers. Instead, convert to a
floating point number using the <a class="reference internal" href="../library/functions.html#abs" title="abs"><tt class="xref py py-func docutils literal">abs()</tt></a> function if appropriate.
The <tt class="docutils literal">+</tt> (addition) operator yields the sum of its arguments. The arguments
must either both be numbers or both sequences of the same type. In the former
case, the numbers are converted to a common type and then added together. In
the latter case, the sequences are concatenated.
The <tt class="docutils literal">-</tt> (subtraction) operator yields the difference of its arguments. The
numeric arguments are first converted to a common type.
</div>
<div class="section" id="shifting-operations">
<h2>5.7. Shifting operations<a class="headerlink" href="#shifting-operations" title="Permalink to this headline">¶</a></h2>
The shifting operations have lower priority than the arithmetic operations:
<pre>
shift_expr ::= <a class="reference internal" href="#grammar-token-a_expr"><tt class="xref docutils literal">a_expr</tt></a> | <a class="reference internal" href="#grammar-token-shift_expr"><tt class="xref docutils literal">shift_expr</tt></a> ( &quot;&lt;&lt;&quot; | &quot;&gt;&gt;&quot; ) <a class="reference internal" href="#grammar-token-a_expr"><tt class="xref docutils literal">a_expr</tt></a>
</pre>
These operators accept plain or long integers as arguments. The arguments are
converted to a common type. They shift the first argument to the left or right
by the number of bits given by the second argument.
A right shift by n bits is defined as division by <tt class="docutils literal">pow(2, n)</tt>. A left shift
by n bits is defined as multiplication with <tt class="docutils literal">pow(2, n)</tt>. Negative shift
counts raise a <a class="reference internal" href="../library/exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal">ValueError</tt></a> exception.
<div class="admonition note">
Note
In the current implementation, the right-hand operand is required
to be at most <a class="reference internal" href="../library/sys.html#sys.maxsize" title="sys.maxsize"><tt class="xref py py-attr docutils literal">sys.maxsize</tt></a>. If the right-hand operand is larger than
<a class="reference internal" href="../library/sys.html#sys.maxsize" title="sys.maxsize"><tt class="xref py py-attr docutils literal">sys.maxsize</tt></a> an <a class="reference internal" href="../library/exceptions.html#exceptions.OverflowError" title="exceptions.OverflowError"><tt class="xref py py-exc docutils literal">OverflowError</tt></a> exception is raised.
</div>
</div>
<div class="section" id="binary-bitwise-operations">
<h2>5.8. Binary bitwise operations<a class="headerlink" href="#binary-bitwise-operations" title="Permalink to this headline">¶</a></h2>
Each of the three bitwise operations has a different priority level:
<pre>
and_expr ::= <a class="reference internal" href="#grammar-token-shift_expr"><tt class="xref docutils literal">shift_expr</tt></a> | <a class="reference internal" href="#grammar-token-and_expr"><tt class="xref docutils literal">and_expr</tt></a> &quot;&amp;&quot; <a class="reference internal" href="#grammar-token-shift_expr"><tt class="xref docutils literal">shift_expr</tt></a>
xor_expr ::= <a class="reference internal" href="#grammar-token-and_expr"><tt class="xref docutils literal">and_expr</tt></a> | <a class="reference internal" href="#grammar-token-xor_expr"><tt class="xref docutils literal">xor_expr</tt></a> &quot;^&quot; <a class="reference internal" href="#grammar-token-and_expr"><tt class="xref docutils literal">and_expr</tt></a>
or_expr ::= <a class="reference internal" href="#grammar-token-xor_expr"><tt class="xref docutils literal">xor_expr</tt></a> | <a class="reference internal" href="#grammar-token-or_expr"><tt class="xref docutils literal">or_expr</tt></a> &quot;|&quot; <a class="reference internal" href="#grammar-token-xor_expr"><tt class="xref docutils literal">xor_expr</tt></a>
</pre>
The <tt class="docutils literal">&amp;</tt> operator yields the bitwise AND of its arguments, which must be plain
or long integers. The arguments are converted to a common type.
The <tt class="docutils literal">^</tt> operator yields the bitwise XOR (exclusive OR) of its arguments, which
must be plain or long integers. The arguments are converted to a common type.
The <tt class="docutils literal">|</tt> operator yields the bitwise (inclusive) OR of its arguments, which
must be plain or long integers. The arguments are converted to a common type.
</div>
<div class="section" id="not-in">
<h2>5.9. Comparisons<a class="headerlink" href="#not-in" title="Permalink to this headline">¶</a></h2>
Unlike C, all comparison operations in Python have the same priority, which is
lower than that of any arithmetic, shifting or bitwise operation. Also unlike
C, expressions like <tt class="docutils literal">a &lt; b &lt; c</tt> have the interpretation that is conventional
in mathematics:
<pre>
comparison ::= <a class="reference internal" href="#grammar-token-or_expr"><tt class="xref docutils literal">or_expr</tt></a> ( <a class="reference internal" href="#grammar-token-comp_operator"><tt class="xref docutils literal">comp_operator</tt></a> <a class="reference internal" href="#grammar-token-or_expr"><tt class="xref docutils literal">or_expr</tt></a> )*
comp_operator ::= &quot;&lt;&quot; | &quot;&gt;&quot; | &quot;==&quot; | &quot;&gt;=&quot; | &quot;&lt;=&quot; | &quot;&lt;&gt;&quot; | &quot;!=&quot;
 | &quot;is&quot; [&quot;not&quot;] | [&quot;not&quot;] &quot;in&quot;
</pre>
Comparisons yield boolean values: <tt class="docutils literal">True</tt> or <tt class="docutils literal">False</tt>.
Comparisons can be chained arbitrarily, e.g., <tt class="docutils literal">x &lt; y &lt;= z</tt> is equivalent to
<tt class="docutils literal">x &lt; y and y &lt;= z</tt>, except that <tt class="docutils literal">y</tt> is evaluated only once (but in both
cases <tt class="docutils literal">z</tt> is not evaluated at all when <tt class="docutils literal">x &lt; y</tt> is found to be false).
Formally, if a, b, c, ..., y, z are expressions and op1, op2, ...,
opN are comparison operators, then <tt class="docutils literal">a op1 b op2 c ... y opN z</tt> is equivalent
to <tt class="docutils literal">a op1 b and b op2 c and ... y opN z</tt>, except that each expression is
evaluated at most once.
Note that <tt class="docutils literal">a op1 b op2 c</tt> doesn&#8217;t imply any kind of comparison between a and
c, so that, e.g., <tt class="docutils literal">x &lt; y &gt; z</tt> is perfectly legal (though perhaps not
pretty).
The forms <tt class="docutils literal">&lt;&gt;</tt> and <tt class="docutils literal">!=</tt> are equivalent; for consistency with C, <tt class="docutils literal">!=</tt> is
preferred; where <tt class="docutils literal">!=</tt> is mentioned below <tt class="docutils literal">&lt;&gt;</tt> is also accepted. The <tt class="docutils literal">&lt;&gt;</tt>
spelling is considered obsolescent.
The operators <tt class="docutils literal">&lt;</tt>, <tt class="docutils literal">&gt;</tt>, <tt class="docutils literal">==</tt>, <tt class="docutils literal">&gt;=</tt>, <tt class="docutils literal">&lt;=</tt>, and <tt class="docutils literal">!=</tt> compare the
values of two objects. The objects need not have the same type. If both are
numbers, they are converted to a common type. Otherwise, objects of different
types always compare unequal, and are ordered consistently but arbitrarily.
You can control comparison behavior of objects of non-built-in types by defining
a <tt class="docutils literal">__cmp__</tt> method or rich comparison methods like <tt class="docutils literal">__gt__</tt>, described in
section <a class="reference internal" href="datamodel.html#specialnames">Special method names</a>.
(This unusual definition of comparison was used to simplify the definition of
operations like sorting and the <a class="reference internal" href="#in"><tt class="xref std std-keyword docutils literal">in</tt></a> and <a class="reference internal" href="#not-in"><tt class="xref std std-keyword docutils literal">not in</tt></a> operators.
In the future, the comparison rules for objects of different types are likely to
change.)
Comparison of objects of the same type depends on the type:
<ul>
<li>Numbers are compared arithmetically.
</li>
<li>Strings are compared lexicographically using the numeric equivalents (the
result of the built-in function <a class="reference internal" href="../library/functions.html#ord" title="ord"><tt class="xref py py-func docutils literal">ord()</tt></a>) of their characters. Unicode and
8-bit strings are fully interoperable in this behavior. <a class="footnote-reference" href="#id23" id="id13">[4]</a>
</li>
<li>Tuples and lists are compared lexicographically using comparison of
corresponding elements. This means that to compare equal, each element must
compare equal and the two sequences must be of the same type and have the same
length.
If not equal, the sequences are ordered the same as their first differing
elements. For example, <tt class="docutils literal">cmp([1,2,x], [1,2,y])</tt> returns the same as
<tt class="docutils literal">cmp(x,y)</tt>. If the corresponding element does not exist, the shorter sequence
is ordered first (for example, <tt class="docutils literal">[1,2] &lt; [1,2,3]</tt>).
</li>
<li>Mappings (dictionaries) compare equal if and only if their sorted (key, value)
lists compare equal. <a class="footnote-reference" href="#id24" id="id14">[5]</a> Outcomes other than equality are resolved
consistently, but are not otherwise defined. <a class="footnote-reference" href="#id25" id="id15">[6]</a>
</li>
<li>Most other objects of built-in types compare unequal unless they are the same
object; the choice whether one object is considered smaller or larger than
another one is made arbitrarily but consistently within one execution of a
program.
</li>
</ul>
The operators <a class="reference internal" href="#in"><tt class="xref std std-keyword docutils literal">in</tt></a> and <a class="reference internal" href="#not-in"><tt class="xref std std-keyword docutils literal">not in</tt></a> test for collection
membership. <tt class="docutils literal">x in s</tt> evaluates to true if x is a member of the collection
s, and false otherwise. <tt class="docutils literal">x not in s</tt> returns the negation of <tt class="docutils literal">x in s</tt>.
The collection membership test has traditionally been bound to sequences; an
object is a member of a collection if the collection is a sequence and contains
an element equal to that object. However, it make sense for many other object
types to support membership tests without being a sequence. In particular,
dictionaries (for keys) and sets support membership testing.
For the list and tuple types, <tt class="docutils literal">x in y</tt> is true if and only if there exists an
index i such that <tt class="docutils literal">x == y[i]</tt> is true.
For the Unicode and string types, <tt class="docutils literal">x in y</tt> is true if and only if x is a
substring of y. An equivalent test is <tt class="docutils literal">y.find(x) != -1</tt>. Note, x and y
need not be the same type; consequently, <tt class="docutils literal">u'ab' in 'abc'</tt> will return
<tt class="docutils literal">True</tt>. Empty strings are always considered to be a substring of any other
string, so <tt class="docutils literal">&quot;&quot; in &quot;abc&quot;</tt> will return <tt class="docutils literal">True</tt>.

Changed in version 2.3: Previously, x was required to be a string of length <tt class="docutils literal">1</tt>.
For user-defined classes which define the <a class="reference internal" href="datamodel.html#object.__contains__" title="object.__contains__"><tt class="xref py py-meth docutils literal">__contains__()</tt></a> method, <tt class="docutils literal">x in
y</tt> is true if and only if <tt class="docutils literal">y.__contains__(x)</tt> is true.
For user-defined classes which do not define <a class="reference internal" href="datamodel.html#object.__contains__" title="object.__contains__"><tt class="xref py py-meth docutils literal">__contains__()</tt></a> but do define
<a class="reference internal" href="datamodel.html#object.__iter__" title="object.__iter__"><tt class="xref py py-meth docutils literal">__iter__()</tt></a>, <tt class="docutils literal">x in y</tt> is true if some value <tt class="docutils literal">z</tt> with <tt class="docutils literal">x == z</tt> is
produced while iterating over <tt class="docutils literal">y</tt>. If an exception is raised during the
iteration, it is as if <a class="reference internal" href="#in"><tt class="xref std std-keyword docutils literal">in</tt></a> raised that exception.
Lastly, the old-style iteration protocol is tried: if a class defines
<a class="reference internal" href="datamodel.html#object.__getitem__" title="object.__getitem__"><tt class="xref py py-meth docutils literal">__getitem__()</tt></a>, <tt class="docutils literal">x in y</tt> is true if and only if there is a non-negative
integer index i such that <tt class="docutils literal">x == y[i]</tt>, and all lower integer indices do not
raise <a class="reference internal" href="../library/exceptions.html#exceptions.IndexError" title="exceptions.IndexError"><tt class="xref py py-exc docutils literal">IndexError</tt></a> exception. (If any other exception is raised, it is as
if <a class="reference internal" href="#in"><tt class="xref std std-keyword docutils literal">in</tt></a> raised that exception).
The operator <a class="reference internal" href="#not-in"><tt class="xref std std-keyword docutils literal">not in</tt></a> is defined to have the inverse true value of
<a class="reference internal" href="#in"><tt class="xref std std-keyword docutils literal">in</tt></a>.
The operators <a class="reference internal" href="#is"><tt class="xref std std-keyword docutils literal">is</tt></a> and <a class="reference internal" href="#is-not"><tt class="xref std std-keyword docutils literal">is not</tt></a> test for object identity: <tt class="docutils literal">x
is y</tt> is true if and only if x and y are the same object. <tt class="docutils literal">x is not y</tt>
yields the inverse truth value. <a class="footnote-reference" href="#id26" id="id16">[7]</a>
</div>
<div class="section" id="boolean-operations">
<h2>5.10. Boolean operations<a class="headerlink" href="#boolean-operations" title="Permalink to this headline">¶</a></h2>
<pre id="index-69">
or_test ::= <a class="reference internal" href="#grammar-token-and_test"><tt class="xref docutils literal">and_test</tt></a> | <a class="reference internal" href="#grammar-token-or_test"><tt class="xref docutils literal">or_test</tt></a> &quot;or&quot; <a class="reference internal" href="#grammar-token-and_test"><tt class="xref docutils literal">and_test</tt></a>
and_test ::= <a class="reference internal" href="#grammar-token-not_test"><tt class="xref docutils literal">not_test</tt></a> | <a class="reference internal" href="#grammar-token-and_test"><tt class="xref docutils literal">and_test</tt></a> &quot;and&quot; <a class="reference internal" href="#grammar-token-not_test"><tt class="xref docutils literal">not_test</tt></a>
not_test ::= <a class="reference internal" href="#grammar-token-comparison"><tt class="xref docutils literal">comparison</tt></a> | &quot;not&quot; <a class="reference internal" href="#grammar-token-not_test"><tt class="xref docutils literal">not_test</tt></a>
</pre>
In the context of Boolean operations, and also when expressions are used by
control flow statements, the following values are interpreted as false:
<tt class="docutils literal">False</tt>, <tt class="docutils literal">None</tt>, numeric zero of all types, and empty strings and containers
(including strings, tuples, lists, dictionaries, sets and frozensets). All
other values are interpreted as true. (See the <a class="reference internal" href="datamodel.html#object.__nonzero__" title="object.__nonzero__"><tt class="xref py py-meth docutils literal">__nonzero__()</tt></a>
special method for a way to change this.)
The operator <a class="reference internal" href="#not"><tt class="xref std std-keyword docutils literal">not</tt></a> yields <tt class="docutils literal">True</tt> if its argument is false, <tt class="docutils literal">False</tt>
otherwise.
The expression <tt class="docutils literal">x and y</tt> first evaluates x; if x is false, its value is
returned; otherwise, y is evaluated and the resulting value is returned.
The expression <tt class="docutils literal">x or y</tt> first evaluates x; if x is true, its value is
returned; otherwise, y is evaluated and the resulting value is returned.
(Note that neither <a class="reference internal" href="#and"><tt class="xref std std-keyword docutils literal">and</tt></a> nor <a class="reference internal" href="#or"><tt class="xref std std-keyword docutils literal">or</tt></a> restrict the value and type
they return to <tt class="docutils literal">False</tt> and <tt class="docutils literal">True</tt>, but rather return the last evaluated
argument. This is sometimes useful, e.g., if <tt class="docutils literal">s</tt> is a string that should be
replaced by a default value if it is empty, the expression <tt class="docutils literal">s or 'foo'</tt> yields
the desired value. Because <a class="reference internal" href="#not"><tt class="xref std std-keyword docutils literal">not</tt></a> has to invent a value anyway, it does
not bother to return a value of the same type as its argument, so e.g., <tt class="docutils literal">not
'foo'</tt> yields <tt class="docutils literal">False</tt>, not <tt class="docutils literal">''</tt>.)
</div>
<div class="section" id="conditional-expressions">
<h2>5.11. Conditional Expressions<a class="headerlink" href="#conditional-expressions" title="Permalink to this headline">¶</a></h2>

New in version 2.5.
<pre id="index-73">
conditional_expression ::= <a class="reference internal" href="#grammar-token-or_test"><tt class="xref docutils literal">or_test</tt></a> [&quot;if&quot; <a class="reference internal" href="#grammar-token-or_test"><tt class="xref docutils literal">or_test</tt></a> &quot;else&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>]
expression ::= <a class="reference internal" href="#grammar-token-conditional_expression"><tt class="xref docutils literal">conditional_expression</tt></a> | <a class="reference internal" href="#grammar-token-lambda_form"><tt class="xref docutils literal">lambda_form</tt></a>
</pre>
Conditional expressions (sometimes called a &#8220;ternary operator&#8221;) have the lowest
priority of all Python operations.
The expression <tt class="docutils literal">x if C else y</tt> first evaluates the condition, C (not x);
if C is true, x is evaluated and its value is returned; otherwise, y is
evaluated and its value is returned.
See <a class="pep reference external" href="http://www.python.org/dev/peps/pep-0308">PEP 308</a> for more details about conditional expressions.
</div>
<div class="section" id="lambda">
<h2>5.12. Lambdas<a class="headerlink" href="#lambda" title="Permalink to this headline">¶</a></h2>
<pre id="index-75">
lambda_form ::= &quot;lambda&quot; [<a class="reference internal" href="compound_stmts.html#grammar-token-parameter_list"><tt class="xref docutils literal">parameter_list</tt></a>]: <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a>
old_lambda_form ::= &quot;lambda&quot; [<a class="reference internal" href="compound_stmts.html#grammar-token-parameter_list"><tt class="xref docutils literal">parameter_list</tt></a>]: <a class="reference internal" href="#grammar-token-old_expression"><tt class="xref docutils literal">old_expression</tt></a>
</pre>
Lambda forms (lambda expressions) have the same syntactic position as
expressions. They are a shorthand to create anonymous functions; the expression
<tt class="docutils literal">lambda arguments: expression</tt> yields a function object. The unnamed object
behaves like a function object defined with
<div class="highlight-python"><div class="highlight"><pre>def name(arguments):
 return expression
</pre></div>
</div>
See section <a class="reference internal" href="compound_stmts.html#function">Function definitions</a> for the syntax of parameter lists. Note that
functions created with lambda forms cannot contain statements.
</div>
<div class="section" id="expression-lists">
<h2>5.13. Expression lists<a class="headerlink" href="#expression-lists" title="Permalink to this headline">¶</a></h2>
<pre id="index-76">
expression_list ::= <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> ( &quot;,&quot; <a class="reference internal" href="#grammar-token-expression"><tt class="xref docutils literal">expression</tt></a> )* [&quot;,&quot;]
</pre>
An expression list containing at least one comma yields a tuple. The length of
the tuple is the number of expressions in the list. The expressions are
evaluated from left to right.
The trailing comma is required only to create a single tuple (a.k.a. a
singleton); it is optional in all other cases. A single expression without a
trailing comma doesn&#8217;t create a tuple, but rather yields the value of that
expression. (To create an empty tuple, use an empty pair of parentheses:
<tt class="docutils literal">()</tt>.)
</div>
<div class="section" id="evaluation-order">
<h2>5.14. Evaluation order<a class="headerlink" href="#evaluation-order" title="Permalink to this headline">¶</a></h2>
Python evaluates expressions from left to right. Notice that while evaluating an
assignment, the right-hand side is evaluated before the left-hand side.
In the following lines, expressions will be evaluated in the arithmetic order of
their suffixes:
<div class="highlight-python"><div class="highlight"><pre>expr1, expr2, expr3, expr4
(expr1, expr2, expr3, expr4)
{expr1: expr2, expr3: expr4}
expr1 + expr2 * (expr3 - expr4)
expr1(expr2, expr3, *expr4, **expr5)
expr3, expr4 = expr1, expr2
</pre></div>
</div>
</div>
<div class="section" id="operator-precedence">
<h2>5.15. Operator precedence<a class="headerlink" href="#operator-precedence" title="Permalink to this headline">¶</a></h2>
The following table summarizes the operator precedences in Python, from lowest
precedence (least binding) to highest precedence (most binding). Operators in
the same box have the same precedence. Unless the syntax is explicitly given,
operators are binary. Operators in the same box group left to right (except for
comparisons, including tests, which all have the same precedence and chain from
left to right &#8212; see section <a class="reference internal" href="#comparisons">Comparisons</a> &#8212; and exponentiation, which
groups from right to left).
<table border="1" class="docutils">
<colgroup>
<col width="56%" />
<col width="44%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Operator</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="#lambda"><tt class="xref std std-keyword docutils literal">lambda</tt></a></td>
<td>Lambda expression</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="compound_stmts.html#if"><tt class="xref std std-keyword docutils literal">if</tt></a> &#8211; <a class="reference internal" href="compound_stmts.html#else"><tt class="xref std std-keyword docutils literal">else</tt></a></td>
<td>Conditional expression</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#or"><tt class="xref std std-keyword docutils literal">or</tt></a></td>
<td>Boolean OR</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#and"><tt class="xref std std-keyword docutils literal">and</tt></a></td>
<td>Boolean AND</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#not"><tt class="xref std std-keyword docutils literal">not</tt></a> <tt class="docutils literal">x</tt></td>
<td>Boolean NOT</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#in"><tt class="xref std std-keyword docutils literal">in</tt></a>, <a class="reference internal" href="#not-in"><tt class="xref std std-keyword docutils literal">not in</tt></a>,
<a class="reference internal" href="#is"><tt class="xref std std-keyword docutils literal">is</tt></a>, <a class="reference internal" href="#is-not"><tt class="xref std std-keyword docutils literal">is not</tt></a>, <tt class="docutils literal">&lt;</tt>,
<tt class="docutils literal">&lt;=</tt>, <tt class="docutils literal">&gt;</tt>, <tt class="docutils literal">&gt;=</tt>, <tt class="docutils literal">&lt;&gt;</tt>, <tt class="docutils literal">!=</tt>, <tt class="docutils literal">==</tt></td>
<td>Comparisons, including membership
tests and identity tests</td>
</tr>
<tr class="row-even"><td><tt class="docutils literal">|</tt></td>
<td>Bitwise OR</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal">^</tt></td>
<td>Bitwise XOR</td>
</tr>
<tr class="row-even"><td><tt class="docutils literal">&amp;</tt></td>
<td>Bitwise AND</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal">&lt;&lt;</tt>, <tt class="docutils literal">&gt;&gt;</tt></td>
<td>Shifts</td>
</tr>
<tr class="row-even"><td><tt class="docutils literal">+</tt>, <tt class="docutils literal">-</tt></td>
<td>Addition and subtraction</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal">*</tt>, <tt class="docutils literal">/</tt>, <tt class="docutils literal">//</tt>, <tt class="docutils literal">%</tt></td>
<td>Multiplication, division, remainder
<a class="footnote-reference" href="#id27" id="id18">[8]</a></td>
</tr>
<tr class="row-even"><td><tt class="docutils literal">+x</tt>, <tt class="docutils literal">-x</tt>, <tt class="docutils literal">~x</tt></td>
<td>Positive, negative, bitwise NOT</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal">**</tt></td>
<td>Exponentiation <a class="footnote-reference" href="#id28" id="id19">[9]</a></td>
</tr>
<tr class="row-even"><td><tt class="docutils literal">x[index]</tt>, <tt class="docutils literal">x[index:index]</tt>,
<tt class="docutils literal">x(arguments...)</tt>, <tt class="docutils literal">x.attribute</tt></td>
<td>Subscription, slicing,
call, attribute reference</td>
</tr>
<tr class="row-odd"><td><tt class="docutils literal">(expressions...)</tt>,
<tt class="docutils literal">[expressions...]</tt>,
<tt class="docutils literal">{key: value...}</tt>,
<tt class="docutils literal">`expressions...`</tt></td>
<td>Binding or tuple display,
list display,
dictionary display,
string conversion</td>
</tr>
</tbody>
</table>
Footnotes
<table class="docutils footnote" frame="void" id="id20" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3">[1]</a></td><td>In Python 2.3 and later releases, a list comprehension &#8220;leaks&#8221; the control
variables of each <tt class="docutils literal">for</tt> it contains into the containing scope. However, this
behavior is deprecated, and relying on it will not work in Python 3.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id21" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id10">[2]</a></td><td>While <tt class="docutils literal">abs(x%y) &lt; abs(y)</tt> is true mathematically, for floats it may not be
true numerically due to roundoff. For example, and assuming a platform on which
a Python float is an IEEE 754 double-precision number, in order that <tt class="docutils literal">-1e-100 %
1e100</tt> have the same sign as <tt class="docutils literal">1e100</tt>, the computed result is <tt class="docutils literal">-1e-100 +
1e100</tt>, which is numerically exactly equal to <tt class="docutils literal">1e100</tt>. The function
<a class="reference internal" href="../library/math.html#math.fmod" title="math.fmod"><tt class="xref py py-func docutils literal">math.fmod()</tt></a> returns a result whose sign matches the sign of the
first argument instead, and so returns <tt class="docutils literal">-1e-100</tt> in this case. Which approach
is more appropriate depends on the application.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id22" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id11">[3]</a></td><td>If x is very close to an exact integer multiple of y, it&#8217;s possible for
<tt class="docutils literal">floor(x/y)</tt> to be one larger than <tt class="docutils literal">(x-x%y)/y</tt> due to rounding. In such
cases, Python returns the latter result, in order to preserve that
<tt class="docutils literal">divmod(x,y)[0] * y + x % y</tt> be very close to <tt class="docutils literal">x</tt>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id23" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id13">[4]</a></td><td>While comparisons between unicode strings make sense at the byte
level, they may be counter-intuitive to users. For example, the
strings <tt class="docutils literal">u&quot;\u00C7&quot;</tt> and <tt class="docutils literal">u&quot;\u0043\u0327&quot;</tt> compare differently,
even though they both represent the same unicode character (LATIN
CAPITAL LETTER C WITH CEDILLA). To compare strings in a human
recognizable way, compare using <a class="reference internal" href="../library/unicodedata.html#unicodedata.normalize" title="unicodedata.normalize"><tt class="xref py py-func docutils literal">unicodedata.normalize()</tt></a>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id24" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id14">[5]</a></td><td>The implementation computes this efficiently, without constructing lists or
sorting.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id25" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id15">[6]</a></td><td>Earlier versions of Python used lexicographic comparison of the sorted (key,
value) lists, but this was very expensive for the common case of comparing for
equality. An even earlier version of Python compared dictionaries by identity
only, but this caused surprises because people expected to be able to test a
dictionary for emptiness by comparing it to <tt class="docutils literal">{}</tt>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id26" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id16">[7]</a></td><td>Due to automatic garbage-collection, free lists, and the dynamic nature of
descriptors, you may notice seemingly unusual behaviour in certain uses of
the <a class="reference internal" href="#is"><tt class="xref std std-keyword docutils literal">is</tt></a> operator, like those involving comparisons between instance
methods, or constants. Check their documentation for more info.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id27" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id18">[8]</a></td><td>The <tt class="docutils literal">%</tt> operator is also used for string formatting; the same
precedence applies.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id28" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id19">[9]</a></td><td>The power operator <tt class="docutils literal">**</tt> binds less tightly than an arithmetic or
bitwise unary operator on its right, that is, <tt class="docutils literal">2**-1</tt> is <tt class="docutils literal">0.5</tt>.</td></tr>
</tbody>
</table>
</div>
</div>

</div>
 </div>
 </div>
 <div class="sphinxsidebar">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table Of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">5. Expressions</a><ul>
<li><a class="reference internal" href="#arithmetic-conversions">5.1. Arithmetic conversions</a></li>
<li><a class="reference internal" href="#atoms">5.2. Atoms</a><ul>
<li><a class="reference internal" href="#atom-identifiers">5.2.1. Identifiers (Names)</a></li>
<li><a class="reference internal" href="#literals">5.2.2. Literals</a></li>
<li><a class="reference internal" href="#parenthesized-forms">5.2.3. Parenthesized forms</a></li>
<li><a class="reference internal" href="#list-displays">5.2.4. List displays</a></li>
<li><a class="reference internal" href="#displays-for-sets-and-dictionaries">5.2.5. Displays for sets and dictionaries</a></li>
<li><a class="reference internal" href="#generator-expressions">5.2.6. Generator expressions</a></li>
<li><a class="reference internal" href="#dictionary-displays">5.2.7. Dictionary displays</a></li>
<li><a class="reference internal" href="#set-displays">5.2.8. Set displays</a></li>
<li><a class="reference internal" href="#string-conversions">5.2.9. String conversions</a></li>
<li><a class="reference internal" href="#yield-expressions">5.2.10. Yield expressions</a><ul>
<li><a class="reference internal" href="#generator-iterator-methods">5.2.10.1. Generator-iterator methods</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#primaries">5.3. Primaries</a><ul>
<li><a class="reference internal" href="#attribute-references">5.3.1. Attribute references</a></li>
<li><a class="reference internal" href="#subscriptions">5.3.2. Subscriptions</a></li>
<li><a class="reference internal" href="#slicings">5.3.3. Slicings</a></li>
<li><a class="reference internal" href="#calls">5.3.4. Calls</a></li>
</ul>
</li>
<li><a class="reference internal" href="#the-power-operator">5.4. The power operator</a></li>
<li><a class="reference internal" href="#unary-arithmetic-and-bitwise-operations">5.5. Unary arithmetic and bitwise operations</a></li>
<li><a class="reference internal" href="#binary-arithmetic-operations">5.6. Binary arithmetic operations</a></li>
<li><a class="reference internal" href="#shifting-operations">5.7. Shifting operations</a></li>
<li><a class="reference internal" href="#binary-bitwise-operations">5.8. Binary bitwise operations</a></li>
<li><a class="reference internal" href="#not-in">5.9. Comparisons</a></li>
<li><a class="reference internal" href="#boolean-operations">5.10. Boolean operations</a></li>
<li><a class="reference internal" href="#conditional-expressions">5.11. Conditional Expressions</a></li>
<li><a class="reference internal" href="#lambda">5.12. Lambdas</a></li>
<li><a class="reference internal" href="#expression-lists">5.13. Expression lists</a></li>
<li><a class="reference internal" href="#evaluation-order">5.14. Evaluation order</a></li>
<li><a class="reference internal" href="#operator-precedence">5.15. Operator precedence</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="executionmodel.html"
 title="previous chapter">4. Execution model</a>
 <h4>Next topic</h4>
 <a href="simple_stmts.html"
 title="next chapter">6. Simple statements</a>
<h3>This Page</h3>
<ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li><a href="../_sources/reference/expressions.txt"
 rel="nofollow">Show Source</a></li>
</ul>

<div id="searchbox" style="display: none">
 <h3>Quick search</h3>
 <form class="search" action="../search.html" method="get">
 <input 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>
 
 Enter search terms or a module, class or function name.
 
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related">
 <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="simple_stmts.html" title="6. Simple statements"
 >next</a> |</li>
 <li class="right" >
 <a href="executionmodel.html" title="4. Execution model"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="http://www.python.org/">Python</a> &raquo;</li>
 <li>
 <a href="../index.html">Python 2.7.5 documentation</a> &raquo;
 </li>

<li><a href="index.html" >The Python Language Reference</a> &raquo;</li> 
 </ul>
 </div>
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="http://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on Oct 13, 2020.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
 </div>

</body>
</html>