OwlCyberSecurity - MANAGER
Edit File: stdtypes.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>5. Built-in Types — Python 2.7.18 documentation</title> <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/language_data.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.18 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="6. Built-in Exceptions" href="exceptions.html" /> <link rel="prev" title="4. Built-in Constants" href="constants.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/stdtypes.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;"> This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>. You should install the python3 and python3-doc packages and read the <a href="file:///usr/share/doc/python3-doc/html/library/stdtypes.html"> Python documentation for the Python3 version packaged in this release</a>. </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" 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="exceptions.html" title="6. Built-in Exceptions" accesskey="N">next</a> |</li> <li class="right" > <a href="constants.html" title="4. Built-in Constants" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.18 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">The Python Standard Library</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="built-in-types"> <span id="bltin-types"></span><h1>5. Built-in Types<a class="headerlink" href="#built-in-types" title="Permalink to this headline">¶</a></h1> <p>The following sections describe the standard types that are built into the interpreter.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Historically (until release 2.2), Python’s built-in types have differed from user-defined types because it was not possible to use the built-in types as the basis for object-oriented inheritance. This limitation no longer exists.</p> </div> <p id="index-0">The principal built-in types are numerics, sequences, mappings, files, classes, instances and exceptions.</p> <p id="index-1">Some operations are supported by several object types; in particular, practically all objects can be compared, tested for truth value, and converted to a string (with the <a class="reference internal" href="functions.html#func-repr"><span class="std std-ref">repr()</span></a> function or the slightly different <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-func docutils literal notranslate"><span class="pre">str()</span></code></a> function). The latter function is implicitly used when an object is written by the <a class="reference internal" href="functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate"><span class="pre">print()</span></code></a> function.</p> <div class="section" id="truth-value-testing"> <span id="truth"></span><h2>5.1. Truth Value Testing<a class="headerlink" href="#truth-value-testing" title="Permalink to this headline">¶</a></h2> <p id="index-2">Any object can be tested for truth value, for use in an <a class="reference internal" href="../reference/compound_stmts.html#if"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">if</span></code></a> or <a class="reference internal" href="../reference/compound_stmts.html#while"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">while</span></code></a> condition or as operand of the Boolean operations below. The following values are considered false:</p> <blockquote> <div></div></blockquote> <ul id="index-3"> <li><p class="first"><code class="docutils literal notranslate"><span class="pre">None</span></code></p> </li> <li id="index-4"><p class="first"><code class="docutils literal notranslate"><span class="pre">False</span></code></p> </li> <li><p class="first">zero of any numeric type, for example, <code class="docutils literal notranslate"><span class="pre">0</span></code>, <code class="docutils literal notranslate"><span class="pre">0L</span></code>, <code class="docutils literal notranslate"><span class="pre">0.0</span></code>, <code class="docutils literal notranslate"><span class="pre">0j</span></code>.</p> </li> <li><p class="first">any empty sequence, for example, <code class="docutils literal notranslate"><span class="pre">''</span></code>, <code class="docutils literal notranslate"><span class="pre">()</span></code>, <code class="docutils literal notranslate"><span class="pre">[]</span></code>.</p> </li> <li><p class="first">any empty mapping, for example, <code class="docutils literal notranslate"><span class="pre">{}</span></code>.</p> </li> <li><p class="first">instances of user-defined classes, if the class defines a <a class="reference internal" href="../reference/datamodel.html#object.__nonzero__" title="object.__nonzero__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__nonzero__()</span></code></a> or <a class="reference internal" href="../reference/datamodel.html#object.__len__" title="object.__len__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__len__()</span></code></a> method, when that method returns the integer zero or <a class="reference internal" href="functions.html#bool" title="bool"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> value <code class="docutils literal notranslate"><span class="pre">False</span></code>. <a class="footnote-reference" href="#id12" id="id1">[1]</a></p> </li> </ul> <p id="index-5">All other values are considered true — so objects of many types are always true.</p> <p id="index-6">Operations and built-in functions that have a Boolean result always return <code class="docutils literal notranslate"><span class="pre">0</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code> for false and <code class="docutils literal notranslate"><span class="pre">1</span></code> or <code class="docutils literal notranslate"><span class="pre">True</span></code> for true, unless otherwise stated. (Important exception: the Boolean operations <code class="docutils literal notranslate"><span class="pre">or</span></code> and <code class="docutils literal notranslate"><span class="pre">and</span></code> always return one of their operands.)</p> </div> <div class="section" id="boolean-operations-and-or-not"> <span id="boolean"></span><h2>5.2. Boolean Operations — <a class="reference internal" href="../reference/expressions.html#and"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">and</span></code></a>, <a class="reference internal" href="../reference/expressions.html#or"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">or</span></code></a>, <a class="reference internal" href="../reference/expressions.html#not"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">not</span></code></a><a class="headerlink" href="#boolean-operations-and-or-not" title="Permalink to this headline">¶</a></h2> <p id="index-7">These are the Boolean operations, ordered by ascending priority:</p> <table border="1" class="docutils"> <colgroup> <col width="25%" /> <col width="62%" /> <col width="13%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Result</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">or</span> <span class="pre">y</span></code></td> <td>if <em>x</em> is false, then <em>y</em>, else <em>x</em></td> <td>(1)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">and</span> <span class="pre">y</span></code></td> <td>if <em>x</em> is false, then <em>x</em>, else <em>y</em></td> <td>(2)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">x</span></code></td> <td>if <em>x</em> is false, then <code class="docutils literal notranslate"><span class="pre">True</span></code>, else <code class="docutils literal notranslate"><span class="pre">False</span></code></td> <td>(3)</td> </tr> </tbody> </table> <p id="index-8">Notes:</p> <ol class="arabic simple"> <li>This is a short-circuit operator, so it only evaluates the second argument if the first one is false.</li> <li>This is a short-circuit operator, so it only evaluates the second argument if the first one is true.</li> <li><code class="docutils literal notranslate"><span class="pre">not</span></code> has a lower priority than non-Boolean operators, so <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">a</span> <span class="pre">==</span> <span class="pre">b</span></code> is interpreted as <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">(a</span> <span class="pre">==</span> <span class="pre">b)</span></code>, and <code class="docutils literal notranslate"><span class="pre">a</span> <span class="pre">==</span> <span class="pre">not</span> <span class="pre">b</span></code> is a syntax error.</li> </ol> </div> <div class="section" id="comparisons"> <span id="stdcomparisons"></span><h2>5.3. Comparisons<a class="headerlink" href="#comparisons" title="Permalink to this headline">¶</a></h2> <p id="index-9">Comparison operations are supported by all objects. They all have the same priority (which is higher than that of the Boolean operations). Comparisons can be chained arbitrarily; for example, <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre"><</span> <span class="pre">y</span> <span class="pre"><=</span> <span class="pre">z</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre"><</span> <span class="pre">y</span> <span class="pre">and</span> <span class="pre">y</span> <span class="pre"><=</span> <span class="pre">z</span></code>, except that <em>y</em> is evaluated only once (but in both cases <em>z</em> is not evaluated at all when <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre"><</span> <span class="pre">y</span></code> is found to be false).</p> <p>This table summarizes the comparison operations:</p> <table border="1" class="docutils"> <colgroup> <col width="27%" /> <col width="57%" /> <col width="16%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Meaning</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre"><</span></code></td> <td>strictly less than</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre"><=</span></code></td> <td>less than or equal</td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">></span></code></td> <td>strictly greater than</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>=</span></code></td> <td>greater than or equal</td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">==</span></code></td> <td>equal</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">!=</span></code></td> <td>not equal</td> <td>(1)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">is</span></code></td> <td>object identity</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">is</span> <span class="pre">not</span></code></td> <td>negated object identity</td> <td> </td> </tr> </tbody> </table> <p>Notes:</p> <ol class="arabic simple"> <li><code class="docutils literal notranslate"><span class="pre">!=</span></code> can also be written <code class="docutils literal notranslate"><span class="pre"><></span></code>, but this is an obsolete usage kept for backwards compatibility only. New code should always use <code class="docutils literal notranslate"><span class="pre">!=</span></code>.</li> </ol> <p id="index-10">Objects of different types, except different numeric types and different string types, never compare equal; such objects are ordered consistently but arbitrarily (so that sorting a heterogeneous array yields a consistent result). Furthermore, some types (for example, file objects) support only a degenerate notion of comparison where any two objects of that type are unequal. Again, such objects are ordered arbitrarily but consistently. The <code class="docutils literal notranslate"><span class="pre"><</span></code>, <code class="docutils literal notranslate"><span class="pre"><=</span></code>, <code class="docutils literal notranslate"><span class="pre">></span></code> and <code class="docutils literal notranslate"><span class="pre">>=</span></code> operators will raise a <a class="reference internal" href="exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> exception when any operand is a complex number.</p> <p id="index-11">Non-identical instances of a class normally compare as non-equal unless the class defines the <a class="reference internal" href="../reference/datamodel.html#object.__eq__" title="object.__eq__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__eq__()</span></code></a> method or the <a class="reference internal" href="../reference/datamodel.html#object.__cmp__" title="object.__cmp__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__cmp__()</span></code></a> method.</p> <p>Instances of a class cannot be ordered with respect to other instances of the same class, or other types of object, unless the class defines either enough of the rich comparison methods (<a class="reference internal" href="../reference/datamodel.html#object.__lt__" title="object.__lt__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__lt__()</span></code></a>, <a class="reference internal" href="../reference/datamodel.html#object.__le__" title="object.__le__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__le__()</span></code></a>, <a class="reference internal" href="../reference/datamodel.html#object.__gt__" title="object.__gt__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__gt__()</span></code></a>, and <a class="reference internal" href="../reference/datamodel.html#object.__ge__" title="object.__ge__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__ge__()</span></code></a>) or the <a class="reference internal" href="../reference/datamodel.html#object.__cmp__" title="object.__cmp__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__cmp__()</span></code></a> method.</p> <div class="impl-detail compound"> <p><strong>CPython implementation detail:</strong> Objects of different types except numbers are ordered by their type names; objects of the same types that don’t support proper comparison are ordered by their address.</p> </div> <p id="index-12">Two more operations with the same syntactic priority, <code class="docutils literal notranslate"><span class="pre">in</span></code> and <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code>, are supported only by sequence types (below).</p> </div> <div class="section" id="numeric-types-int-float-long-complex"> <span id="typesnumeric"></span><h2>5.4. Numeric Types — <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference internal" href="functions.html#float" title="float"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>, <a class="reference internal" href="functions.html#long" title="long"><code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code></a>, <a class="reference internal" href="functions.html#complex" title="complex"><code class="xref py py-class docutils literal notranslate"><span class="pre">complex</span></code></a><a class="headerlink" href="#numeric-types-int-float-long-complex" title="Permalink to this headline">¶</a></h2> <p id="index-13">There are four distinct numeric types: <em class="dfn">plain integers</em>, <em class="dfn">long integers</em>, <em class="dfn">floating point numbers</em>, and <em class="dfn">complex numbers</em>. In addition, Booleans are a subtype of plain integers. Plain integers (also just called <em class="dfn">integers</em>) are implemented using <code class="xref c c-type docutils literal notranslate"><span class="pre">long</span></code> in C, which gives them at least 32 bits of precision (<code class="docutils literal notranslate"><span class="pre">sys.maxint</span></code> is always set to the maximum plain integer value for the current platform, the minimum value is <code class="docutils literal notranslate"><span class="pre">-sys.maxint</span> <span class="pre">-</span> <span class="pre">1</span></code>). Long integers have unlimited precision. Floating point numbers are usually implemented using <code class="xref c c-type docutils literal notranslate"><span class="pre">double</span></code> in C; information about the precision and internal representation of floating point numbers for the machine on which your program is running is available in <a class="reference internal" href="sys.html#sys.float_info" title="sys.float_info"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.float_info</span></code></a>. Complex numbers have a real and imaginary part, which are each a floating point number. To extract these parts from a complex number <em>z</em>, use <code class="docutils literal notranslate"><span class="pre">z.real</span></code> and <code class="docutils literal notranslate"><span class="pre">z.imag</span></code>. (The standard library includes additional numeric types, <a class="reference internal" href="fractions.html#module-fractions" title="fractions: Rational numbers."><code class="xref py py-mod docutils literal notranslate"><span class="pre">fractions</span></code></a> that hold rationals, and <a class="reference internal" href="decimal.html#module-decimal" title="decimal: Implementation of the General Decimal Arithmetic Specification."><code class="xref py py-mod docutils literal notranslate"><span class="pre">decimal</span></code></a> that hold floating-point numbers with user-definable precision.)</p> <p id="index-14">Numbers are created by numeric literals or as the result of built-in functions and operators. Unadorned integer literals (including binary, hex, and octal numbers) yield plain integers unless the value they denote is too large to be represented as a plain integer, in which case they yield a long integer. Integer literals with an <code class="docutils literal notranslate"><span class="pre">'L'</span></code> or <code class="docutils literal notranslate"><span class="pre">'l'</span></code> suffix yield long integers (<code class="docutils literal notranslate"><span class="pre">'L'</span></code> is preferred because <code class="docutils literal notranslate"><span class="pre">1l</span></code> looks too much like eleven!). Numeric literals containing a decimal point or an exponent sign yield floating point numbers. Appending <code class="docutils literal notranslate"><span class="pre">'j'</span></code> or <code class="docutils literal notranslate"><span class="pre">'J'</span></code> to a numeric literal yields an imaginary number (a complex number with a zero real part) which you can add to an integer or float to get a complex number with real and imaginary parts.</p> <p id="index-15">Python fully supports mixed arithmetic: when a binary arithmetic operator has operands of different numeric types, the operand with the “narrower” type is widened to that of the other, where plain integer is narrower than long integer is narrower than floating point is narrower than complex. Comparisons between numbers of mixed type use the same rule. <a class="footnote-reference" href="#id13" id="id2">[2]</a> The constructors <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-func docutils literal notranslate"><span class="pre">int()</span></code></a>, <a class="reference internal" href="functions.html#long" title="long"><code class="xref py py-func docutils literal notranslate"><span class="pre">long()</span></code></a>, <a class="reference internal" href="functions.html#float" title="float"><code class="xref py py-func docutils literal notranslate"><span class="pre">float()</span></code></a>, and <a class="reference internal" href="functions.html#complex" title="complex"><code class="xref py py-func docutils literal notranslate"><span class="pre">complex()</span></code></a> can be used to produce numbers of a specific type.</p> <p>All built-in numeric types support the following operations. See <a class="reference internal" href="../reference/expressions.html#power"><span class="std std-ref">The power operator</span></a> and later sections for the operators’ priorities.</p> <table border="1" class="docutils"> <colgroup> <col width="33%" /> <col width="54%" /> <col width="13%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Result</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">+</span> <span class="pre">y</span></code></td> <td>sum of <em>x</em> and <em>y</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">-</span> <span class="pre">y</span></code></td> <td>difference of <em>x</em> and <em>y</em></td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">*</span> <span class="pre">y</span></code></td> <td>product of <em>x</em> and <em>y</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">/</span> <span class="pre">y</span></code></td> <td>quotient of <em>x</em> and <em>y</em></td> <td>(1)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">//</span> <span class="pre">y</span></code></td> <td>(floored) quotient of <em>x</em> and <em>y</em></td> <td>(4)(5)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">%</span> <span class="pre">y</span></code></td> <td>remainder of <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">/</span> <span class="pre">y</span></code></td> <td>(4)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">-x</span></code></td> <td><em>x</em> negated</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">+x</span></code></td> <td><em>x</em> unchanged</td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">abs(x)</span></code></td> <td>absolute value or magnitude of <em>x</em></td> <td>(3)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">int(x)</span></code></td> <td><em>x</em> converted to integer</td> <td>(2)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">long(x)</span></code></td> <td><em>x</em> converted to long integer</td> <td>(2)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">float(x)</span></code></td> <td><em>x</em> converted to floating point</td> <td>(6)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">complex(re,im)</span></code></td> <td>a complex number with real part <em>re</em>, imaginary part <em>im</em>. <em>im</em> defaults to zero.</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">c.conjugate()</span></code></td> <td>conjugate of the complex number <em>c</em>. (Identity on real numbers)</td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">divmod(x,</span> <span class="pre">y)</span></code></td> <td>the pair <code class="docutils literal notranslate"><span class="pre">(x</span> <span class="pre">//</span> <span class="pre">y,</span> <span class="pre">x</span> <span class="pre">%</span> <span class="pre">y)</span></code></td> <td>(3)(4)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">pow(x,</span> <span class="pre">y)</span></code></td> <td><em>x</em> to the power <em>y</em></td> <td>(3)(7)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">**</span> <span class="pre">y</span></code></td> <td><em>x</em> to the power <em>y</em></td> <td>(7)</td> </tr> </tbody> </table> <p id="index-16">Notes:</p> <ol class="arabic"> <li><p id="index-17">For (plain or long) integer division, the result is an integer. The result is always rounded towards minus infinity: 1/2 is 0, (-1)/2 is -1, 1/(-2) is -1, and (-1)/(-2) is 0. Note that the result is a long integer if either operand is a long integer, regardless of the numeric value.</p> </li> <li><p id="index-18">Conversion from floats using <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-func docutils literal notranslate"><span class="pre">int()</span></code></a> or <a class="reference internal" href="functions.html#long" title="long"><code class="xref py py-func docutils literal notranslate"><span class="pre">long()</span></code></a> truncates toward zero like the related function, <a class="reference internal" href="math.html#math.trunc" title="math.trunc"><code class="xref py py-func docutils literal notranslate"><span class="pre">math.trunc()</span></code></a>. Use the function <a class="reference internal" href="math.html#math.floor" title="math.floor"><code class="xref py py-func docutils literal notranslate"><span class="pre">math.floor()</span></code></a> to round downward and <a class="reference internal" href="math.html#math.ceil" title="math.ceil"><code class="xref py py-func docutils literal notranslate"><span class="pre">math.ceil()</span></code></a> to round upward.</p> </li> <li><p class="first">See <a class="reference internal" href="functions.html#built-in-funcs"><span class="std std-ref">Built-in Functions</span></a> for a full description.</p> </li> <li><div class="first deprecated"> <p><span class="versionmodified">Deprecated since version 2.3: </span>The floor division operator, the modulo operator, and the <a class="reference internal" href="functions.html#divmod" title="divmod"><code class="xref py py-func docutils literal notranslate"><span class="pre">divmod()</span></code></a> function are no longer defined for complex numbers. Instead, convert to a floating point number using the <a class="reference internal" href="functions.html#abs" title="abs"><code class="xref py py-func docutils literal notranslate"><span class="pre">abs()</span></code></a> function if appropriate.</p> </div> </li> <li><p class="first">Also referred to as integer division. The resultant value is a whole integer, though the result’s type is not necessarily int.</p> </li> <li><p class="first">float also accepts the strings “nan” and “inf” with an optional prefix “+” or “-” for Not a Number (NaN) and positive or negative infinity.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </li> <li><p class="first">Python defines <code class="docutils literal notranslate"><span class="pre">pow(0,</span> <span class="pre">0)</span></code> and <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre">**</span> <span class="pre">0</span></code> to be <code class="docutils literal notranslate"><span class="pre">1</span></code>, as is common for programming languages.</p> </li> </ol> <p>All <a class="reference internal" href="numbers.html#numbers.Real" title="numbers.Real"><code class="xref py py-class docutils literal notranslate"><span class="pre">numbers.Real</span></code></a> types (<a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference internal" href="functions.html#long" title="long"><code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code></a>, and <a class="reference internal" href="functions.html#float" title="float"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>) also include the following operations:</p> <table border="1" class="docutils"> <colgroup> <col width="31%" /> <col width="69%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Result</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><a class="reference internal" href="math.html#math.trunc" title="math.trunc"><code class="xref py py-func docutils literal notranslate"><span class="pre">math.trunc(x)</span></code></a></td> <td><em>x</em> truncated to <a class="reference internal" href="numbers.html#numbers.Integral" title="numbers.Integral"><code class="xref py py-class docutils literal notranslate"><span class="pre">Integral</span></code></a></td> </tr> <tr class="row-odd"><td><a class="reference internal" href="functions.html#round" title="round"><code class="xref py py-func docutils literal notranslate"><span class="pre">round(x[,</span> <span class="pre">n])</span></code></a></td> <td><em>x</em> rounded to <em>n</em> digits, rounding ties away from zero. If <em>n</em> is omitted, it defaults to 0.</td> </tr> <tr class="row-even"><td><a class="reference internal" href="math.html#math.floor" title="math.floor"><code class="xref py py-func docutils literal notranslate"><span class="pre">math.floor(x)</span></code></a></td> <td>the greatest integer as a float <= <em>x</em></td> </tr> <tr class="row-odd"><td><a class="reference internal" href="math.html#math.ceil" title="math.ceil"><code class="xref py py-func docutils literal notranslate"><span class="pre">math.ceil(x)</span></code></a></td> <td>the least integer as a float >= <em>x</em></td> </tr> </tbody> </table> <div class="section" id="bitwise-operations-on-integer-types"> <span id="bitstring-ops"></span><h3>5.4.1. Bitwise Operations on Integer Types<a class="headerlink" href="#bitwise-operations-on-integer-types" title="Permalink to this headline">¶</a></h3> <p id="index-19">Bitwise operations only make sense for integers. Negative numbers are treated as their 2’s complement value (this assumes a sufficiently large number of bits that no overflow occurs during the operation).</p> <p>The priorities of the binary bitwise operations are all lower than the numeric operations and higher than the comparisons; the unary operation <code class="docutils literal notranslate"><span class="pre">~</span></code> has the same priority as the other unary numeric operations (<code class="docutils literal notranslate"><span class="pre">+</span></code> and <code class="docutils literal notranslate"><span class="pre">-</span></code>).</p> <p>This table lists the bitwise operations sorted in ascending priority:</p> <table border="1" class="docutils"> <colgroup> <col width="22%" /> <col width="59%" /> <col width="19%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Result</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">|</span> <span class="pre">y</span></code></td> <td>bitwise <em class="dfn">or</em> of <em>x</em> and <em>y</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">^</span> <span class="pre">y</span></code></td> <td>bitwise <em class="dfn">exclusive or</em> of <em>x</em> and <em>y</em></td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">&</span> <span class="pre">y</span></code></td> <td>bitwise <em class="dfn">and</em> of <em>x</em> and <em>y</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre"><<</span> <span class="pre">n</span></code></td> <td><em>x</em> shifted left by <em>n</em> bits</td> <td>(1)(2)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">>></span> <span class="pre">n</span></code></td> <td><em>x</em> shifted right by <em>n</em> bits</td> <td>(1)(3)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">~x</span></code></td> <td>the bits of <em>x</em> inverted</td> <td> </td> </tr> </tbody> </table> <p>Notes:</p> <ol class="arabic simple"> <li>Negative shift counts are illegal and cause a <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> to be raised.</li> <li>A left shift by <em>n</em> bits is equivalent to multiplication by <code class="docutils literal notranslate"><span class="pre">pow(2,</span> <span class="pre">n)</span></code>. A long integer is returned if the result exceeds the range of plain integers.</li> <li>A right shift by <em>n</em> bits is equivalent to division by <code class="docutils literal notranslate"><span class="pre">pow(2,</span> <span class="pre">n)</span></code>.</li> </ol> </div> <div class="section" id="additional-methods-on-integer-types"> <h3>5.4.2. Additional Methods on Integer Types<a class="headerlink" href="#additional-methods-on-integer-types" title="Permalink to this headline">¶</a></h3> <p>The integer types implement the <a class="reference internal" href="numbers.html#numbers.Integral" title="numbers.Integral"><code class="xref py py-class docutils literal notranslate"><span class="pre">numbers.Integral</span></code></a> <a class="reference internal" href="../glossary.html#term-abstract-base-class"><span class="xref std std-term">abstract base class</span></a>. In addition, they provide one more method:</p> <dl class="method"> <dt id="int.bit_length"> <code class="descclassname">int.</code><code class="descname">bit_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#int.bit_length" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="long.bit_length"> <code class="descclassname">long.</code><code class="descname">bit_length</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#long.bit_length" title="Permalink to this definition">¶</a></dt> <dd><p>Return the number of bits necessary to represent an integer in binary, excluding the sign and leading zeros:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">n</span> <span class="o">=</span> <span class="o">-</span><span class="mi">37</span> <span class="gp">>>> </span><span class="nb">bin</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="go">'-0b100101'</span> <span class="gp">>>> </span><span class="n">n</span><span class="o">.</span><span class="n">bit_length</span><span class="p">()</span> <span class="go">6</span> </pre></div> </div> <p>More precisely, if <code class="docutils literal notranslate"><span class="pre">x</span></code> is nonzero, then <code class="docutils literal notranslate"><span class="pre">x.bit_length()</span></code> is the unique positive integer <code class="docutils literal notranslate"><span class="pre">k</span></code> such that <code class="docutils literal notranslate"><span class="pre">2**(k-1)</span> <span class="pre"><=</span> <span class="pre">abs(x)</span> <span class="pre"><</span> <span class="pre">2**k</span></code>. Equivalently, when <code class="docutils literal notranslate"><span class="pre">abs(x)</span></code> is small enough to have a correctly rounded logarithm, then <code class="docutils literal notranslate"><span class="pre">k</span> <span class="pre">=</span> <span class="pre">1</span> <span class="pre">+</span> <span class="pre">int(log(abs(x),</span> <span class="pre">2))</span></code>. If <code class="docutils literal notranslate"><span class="pre">x</span></code> is zero, then <code class="docutils literal notranslate"><span class="pre">x.bit_length()</span></code> returns <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p> <p>Equivalent to:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">bit_length</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="n">s</span> <span class="o">=</span> <span class="nb">bin</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="c1"># binary representation: bin(-37) --> '-0b100101'</span> <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">'-0b'</span><span class="p">)</span> <span class="c1"># remove leading zeros and minus sign</span> <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="c1"># len('100101') --> 6</span> </pre></div> </div> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> </dd></dl> </div> <div class="section" id="additional-methods-on-float"> <h3>5.4.3. Additional Methods on Float<a class="headerlink" href="#additional-methods-on-float" title="Permalink to this headline">¶</a></h3> <p>The float type implements the <a class="reference internal" href="numbers.html#numbers.Real" title="numbers.Real"><code class="xref py py-class docutils literal notranslate"><span class="pre">numbers.Real</span></code></a> <a class="reference internal" href="../glossary.html#term-abstract-base-class"><span class="xref std std-term">abstract base class</span></a>. float also has the following additional methods.</p> <dl class="method"> <dt id="float.as_integer_ratio"> <code class="descclassname">float.</code><code class="descname">as_integer_ratio</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#float.as_integer_ratio" title="Permalink to this definition">¶</a></dt> <dd><p>Return a pair of integers whose ratio is exactly equal to the original float and with a positive denominator. Raises <a class="reference internal" href="exceptions.html#exceptions.OverflowError" title="exceptions.OverflowError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OverflowError</span></code></a> on infinities and a <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> on NaNs.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <dl class="method"> <dt id="float.is_integer"> <code class="descclassname">float.</code><code class="descname">is_integer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#float.is_integer" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the float instance is finite with integral value, and <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="p">(</span><span class="o">-</span><span class="mf">2.0</span><span class="p">)</span><span class="o">.</span><span class="n">is_integer</span><span class="p">()</span> <span class="go">True</span> <span class="gp">>>> </span><span class="p">(</span><span class="mf">3.2</span><span class="p">)</span><span class="o">.</span><span class="n">is_integer</span><span class="p">()</span> <span class="go">False</span> </pre></div> </div> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <p>Two methods support conversion to and from hexadecimal strings. Since Python’s floats are stored internally as binary numbers, converting a float to or from a <em>decimal</em> string usually involves a small rounding error. In contrast, hexadecimal strings allow exact representation and specification of floating-point numbers. This can be useful when debugging, and in numerical work.</p> <dl class="method"> <dt id="float.hex"> <code class="descclassname">float.</code><code class="descname">hex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#float.hex" title="Permalink to this definition">¶</a></dt> <dd><p>Return a representation of a floating-point number as a hexadecimal string. For finite floating-point numbers, this representation will always include a leading <code class="docutils literal notranslate"><span class="pre">0x</span></code> and a trailing <code class="docutils literal notranslate"><span class="pre">p</span></code> and exponent.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <dl class="method"> <dt id="float.fromhex"> <code class="descclassname">float.</code><code class="descname">fromhex</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#float.fromhex" title="Permalink to this definition">¶</a></dt> <dd><p>Class method to return the float represented by a hexadecimal string <em>s</em>. The string <em>s</em> may have leading and trailing whitespace.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <p>Note that <a class="reference internal" href="#float.hex" title="float.hex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">float.hex()</span></code></a> is an instance method, while <a class="reference internal" href="#float.fromhex" title="float.fromhex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">float.fromhex()</span></code></a> is a class method.</p> <p>A hexadecimal string takes the form:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">sign</span><span class="p">]</span> <span class="p">[</span><span class="s1">'0x'</span><span class="p">]</span> <span class="n">integer</span> <span class="p">[</span><span class="s1">'.'</span> <span class="n">fraction</span><span class="p">]</span> <span class="p">[</span><span class="s1">'p'</span> <span class="n">exponent</span><span class="p">]</span> </pre></div> </div> <p>where the optional <code class="docutils literal notranslate"><span class="pre">sign</span></code> may by either <code class="docutils literal notranslate"><span class="pre">+</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code>, <code class="docutils literal notranslate"><span class="pre">integer</span></code> and <code class="docutils literal notranslate"><span class="pre">fraction</span></code> are strings of hexadecimal digits, and <code class="docutils literal notranslate"><span class="pre">exponent</span></code> is a decimal integer with an optional leading sign. Case is not significant, and there must be at least one hexadecimal digit in either the integer or the fraction. This syntax is similar to the syntax specified in section 6.4.4.2 of the C99 standard, and also to the syntax used in Java 1.5 onwards. In particular, the output of <a class="reference internal" href="#float.hex" title="float.hex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">float.hex()</span></code></a> is usable as a hexadecimal floating-point literal in C or Java code, and hexadecimal strings produced by C’s <code class="docutils literal notranslate"><span class="pre">%a</span></code> format character or Java’s <code class="docutils literal notranslate"><span class="pre">Double.toHexString</span></code> are accepted by <a class="reference internal" href="#float.fromhex" title="float.fromhex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">float.fromhex()</span></code></a>.</p> <p>Note that the exponent is written in decimal rather than hexadecimal, and that it gives the power of 2 by which to multiply the coefficient. For example, the hexadecimal string <code class="docutils literal notranslate"><span class="pre">0x3.a7p10</span></code> represents the floating-point number <code class="docutils literal notranslate"><span class="pre">(3</span> <span class="pre">+</span> <span class="pre">10./16</span> <span class="pre">+</span> <span class="pre">7./16**2)</span> <span class="pre">*</span> <span class="pre">2.0**10</span></code>, or <code class="docutils literal notranslate"><span class="pre">3740.0</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">float</span><span class="o">.</span><span class="n">fromhex</span><span class="p">(</span><span class="s1">'0x3.a7p10'</span><span class="p">)</span> <span class="go">3740.0</span> </pre></div> </div> <p>Applying the reverse conversion to <code class="docutils literal notranslate"><span class="pre">3740.0</span></code> gives a different hexadecimal string representing the same number:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">float</span><span class="o">.</span><span class="n">hex</span><span class="p">(</span><span class="mf">3740.0</span><span class="p">)</span> <span class="go">'0x1.d380000000000p+11'</span> </pre></div> </div> </div> </div> <div class="section" id="iterator-types"> <span id="typeiter"></span><h2>5.5. Iterator Types<a class="headerlink" href="#iterator-types" title="Permalink to this headline">¶</a></h2> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> <p id="index-20">Python supports a concept of iteration over containers. This is implemented using two distinct methods; these are used to allow user-defined classes to support iteration. Sequences, described below in more detail, always support the iteration methods.</p> <p>One method needs to be defined for container objects to provide iteration support:</p> <dl class="method"> <dt id="container.__iter__"> <code class="descclassname">container.</code><code class="descname">__iter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#container.__iter__" title="Permalink to this definition">¶</a></dt> <dd><p>Return an iterator object. The object is required to support the iterator protocol described below. If a container supports different types of iteration, additional methods can be provided to specifically request iterators for those iteration types. (An example of an object supporting multiple forms of iteration would be a tree structure which supports both breadth-first and depth-first traversal.) This method corresponds to the <a class="reference internal" href="../c-api/typeobj.html#c.PyTypeObject.tp_iter" title="PyTypeObject.tp_iter"><code class="xref c c-member docutils literal notranslate"><span class="pre">tp_iter</span></code></a> slot of the type structure for Python objects in the Python/C API.</p> </dd></dl> <p>The iterator objects themselves are required to support the following two methods, which together form the <em class="dfn">iterator protocol</em>:</p> <dl class="method"> <dt id="iterator.__iter__"> <code class="descclassname">iterator.</code><code class="descname">__iter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#iterator.__iter__" title="Permalink to this definition">¶</a></dt> <dd><p>Return the iterator object itself. This is required to allow both containers and iterators to be used with the <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">for</span></code></a> and <a class="reference internal" href="../reference/expressions.html#in"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">in</span></code></a> statements. This method corresponds to the <a class="reference internal" href="../c-api/typeobj.html#c.PyTypeObject.tp_iter" title="PyTypeObject.tp_iter"><code class="xref c c-member docutils literal notranslate"><span class="pre">tp_iter</span></code></a> slot of the type structure for Python objects in the Python/C API.</p> </dd></dl> <dl class="method"> <dt id="iterator.next"> <code class="descclassname">iterator.</code><code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#iterator.next" title="Permalink to this definition">¶</a></dt> <dd><p>Return the next item from the container. If there are no further items, raise the <a class="reference internal" href="exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><code class="xref py py-exc docutils literal notranslate"><span class="pre">StopIteration</span></code></a> exception. This method corresponds to the <a class="reference internal" href="../c-api/typeobj.html#c.PyTypeObject.tp_iternext" title="PyTypeObject.tp_iternext"><code class="xref c c-member docutils literal notranslate"><span class="pre">tp_iternext</span></code></a> slot of the type structure for Python objects in the Python/C API.</p> </dd></dl> <p>Python defines several iterator objects to support iteration over general and specific sequence types, dictionaries, and other more specialized forms. The specific types are not important beyond their implementation of the iterator protocol.</p> <p>The intention of the protocol is that once an iterator’s <a class="reference internal" href="#iterator.next" title="iterator.next"><code class="xref py py-meth docutils literal notranslate"><span class="pre">next()</span></code></a> method raises <a class="reference internal" href="exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><code class="xref py py-exc docutils literal notranslate"><span class="pre">StopIteration</span></code></a>, it will continue to do so on subsequent calls. Implementations that do not obey this property are deemed broken. (This constraint was added in Python 2.3; in Python 2.2, various iterators are broken according to this rule.)</p> <div class="section" id="generator-types"> <span id="id3"></span><h3>5.5.1. Generator Types<a class="headerlink" href="#generator-types" title="Permalink to this headline">¶</a></h3> <p>Python’s <a class="reference internal" href="../glossary.html#term-generator"><span class="xref std std-term">generator</span></a>s provide a convenient way to implement the iterator protocol. If a container object’s <a class="reference internal" href="../reference/datamodel.html#object.__iter__" title="object.__iter__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__iter__()</span></code></a> method is implemented as a generator, it will automatically return an iterator object (technically, a generator object) supplying the <a class="reference internal" href="#iterator.__iter__" title="iterator.__iter__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__iter__()</span></code></a> and <a class="reference internal" href="#iterator.next" title="iterator.next"><code class="xref py py-meth docutils literal notranslate"><span class="pre">next()</span></code></a> methods. More information about generators can be found in <a class="reference internal" href="../reference/expressions.html#yieldexpr"><span class="std std-ref">the documentation for the yield expression</span></a>.</p> </div> </div> <div class="section" id="sequence-types-str-unicode-list-tuple-bytearray-buffer-xrange"> <span id="typesseq"></span><h2>5.6. Sequence Types — <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-class docutils literal notranslate"><span class="pre">unicode</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>, <a class="reference internal" href="functions.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>, <a class="reference internal" href="functions.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a>, <a class="reference internal" href="functions.html#buffer" title="buffer"><code class="xref py py-class docutils literal notranslate"><span class="pre">buffer</span></code></a>, <a class="reference internal" href="functions.html#xrange" title="xrange"><code class="xref py py-class docutils literal notranslate"><span class="pre">xrange</span></code></a><a class="headerlink" href="#sequence-types-str-unicode-list-tuple-bytearray-buffer-xrange" title="Permalink to this headline">¶</a></h2> <p>There are seven sequence types: strings, Unicode strings, lists, tuples, bytearrays, buffers, and xrange objects.</p> <p>For other containers see the built in <a class="reference internal" href="#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> and <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> classes, and the <a class="reference internal" href="collections.html#module-collections" title="collections: High-performance datatypes"><code class="xref py py-mod docutils literal notranslate"><span class="pre">collections</span></code></a> module.</p> <p id="index-21">String literals are written in single or double quotes: <code class="docutils literal notranslate"><span class="pre">'xyzzy'</span></code>, <code class="docutils literal notranslate"><span class="pre">"frobozz"</span></code>. See <a class="reference internal" href="../reference/lexical_analysis.html#strings"><span class="std std-ref">String literals</span></a> for more about string literals. Unicode strings are much like strings, but are specified in the syntax using a preceding <code class="docutils literal notranslate"><span class="pre">'u'</span></code> character: <code class="docutils literal notranslate"><span class="pre">u'abc'</span></code>, <code class="docutils literal notranslate"><span class="pre">u"def"</span></code>. In addition to the functionality described here, there are also string-specific methods described in the <a class="reference internal" href="#string-methods"><span class="std std-ref">String Methods</span></a> section. Lists are constructed with square brackets, separating items with commas: <code class="docutils literal notranslate"><span class="pre">[a,</span> <span class="pre">b,</span> <span class="pre">c]</span></code>. Tuples are constructed by the comma operator (not within square brackets), with or without enclosing parentheses, but an empty tuple must have the enclosing parentheses, such as <code class="docutils literal notranslate"><span class="pre">a,</span> <span class="pre">b,</span> <span class="pre">c</span></code> or <code class="docutils literal notranslate"><span class="pre">()</span></code>. A single item tuple must have a trailing comma, such as <code class="docutils literal notranslate"><span class="pre">(d,)</span></code>.</p> <p>Bytearray objects are created with the built-in function <a class="reference internal" href="functions.html#bytearray" title="bytearray"><code class="xref py py-func docutils literal notranslate"><span class="pre">bytearray()</span></code></a>.</p> <p>Buffer objects are not directly supported by Python syntax, but can be created by calling the built-in function <a class="reference internal" href="functions.html#buffer" title="buffer"><code class="xref py py-func docutils literal notranslate"><span class="pre">buffer()</span></code></a>. They don’t support concatenation or repetition.</p> <p>Objects of type xrange are similar to buffers in that there is no specific syntax to create them, but they are created using the <a class="reference internal" href="functions.html#xrange" title="xrange"><code class="xref py py-func docutils literal notranslate"><span class="pre">xrange()</span></code></a> function. They don’t support slicing, concatenation or repetition, and using <code class="docutils literal notranslate"><span class="pre">in</span></code>, <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code>, <a class="reference internal" href="functions.html#min" title="min"><code class="xref py py-func docutils literal notranslate"><span class="pre">min()</span></code></a> or <a class="reference internal" href="functions.html#max" title="max"><code class="xref py py-func docutils literal notranslate"><span class="pre">max()</span></code></a> on them is inefficient.</p> <p>Most sequence types support the following operations. The <code class="docutils literal notranslate"><span class="pre">in</span></code> and <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code> operations have the same priorities as the comparison operations. The <code class="docutils literal notranslate"><span class="pre">+</span></code> and <code class="docutils literal notranslate"><span class="pre">*</span></code> operations have the same priority as the corresponding numeric operations. <a class="footnote-reference" href="#id14" id="id4">[3]</a> Additional methods are provided for <a class="reference internal" href="#typesseq-mutable"><span class="std std-ref">Mutable Sequence Types</span></a>.</p> <p>This table lists the sequence operations sorted in ascending priority. In the table, <em>s</em> and <em>t</em> are sequences of the same type; <em>n</em>, <em>i</em> and <em>j</em> are integers:</p> <table border="1" class="docutils"> <colgroup> <col width="30%" /> <col width="53%" /> <col width="17%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Result</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">in</span> <span class="pre">s</span></code></td> <td><code class="docutils literal notranslate"><span class="pre">True</span></code> if an item of <em>s</em> is equal to <em>x</em>, else <code class="docutils literal notranslate"><span class="pre">False</span></code></td> <td>(1)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">not</span> <span class="pre">in</span> <span class="pre">s</span></code></td> <td><code class="docutils literal notranslate"><span class="pre">False</span></code> if an item of <em>s</em> is equal to <em>x</em>, else <code class="docutils literal notranslate"><span class="pre">True</span></code></td> <td>(1)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">+</span> <span class="pre">t</span></code></td> <td>the concatenation of <em>s</em> and <em>t</em></td> <td>(6)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">*</span> <span class="pre">n,</span> <span class="pre">n</span> <span class="pre">*</span> <span class="pre">s</span></code></td> <td>equivalent to adding <em>s</em> to itself <em>n</em> times</td> <td>(2)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s[i]</span></code></td> <td><em>i</em>th item of <em>s</em>, origin 0</td> <td>(3)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s[i:j]</span></code></td> <td>slice of <em>s</em> from <em>i</em> to <em>j</em></td> <td>(3)(4)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s[i:j:k]</span></code></td> <td>slice of <em>s</em> from <em>i</em> to <em>j</em> with step <em>k</em></td> <td>(3)(5)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">len(s)</span></code></td> <td>length of <em>s</em></td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">min(s)</span></code></td> <td>smallest item of <em>s</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">max(s)</span></code></td> <td>largest item of <em>s</em></td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s.index(x)</span></code></td> <td>index of the first occurrence of <em>x</em> in <em>s</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s.count(x)</span></code></td> <td>total number of occurrences of <em>x</em> in <em>s</em></td> <td> </td> </tr> </tbody> </table> <p>Sequence types also support comparisons. In particular, tuples and lists are compared lexicographically by comparing corresponding elements. This means that to compare equal, every element must compare equal and the two sequences must be of the same type and have the same length. (For full details see <a class="reference internal" href="../reference/expressions.html#comparisons"><span class="std std-ref">Comparisons</span></a> in the language reference.)</p> <p id="index-22">Notes:</p> <ol class="arabic"> <li><p class="first">When <em>s</em> is a string or Unicode string object the <code class="docutils literal notranslate"><span class="pre">in</span></code> and <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">in</span></code> operations act like a substring test. In Python versions before 2.3, <em>x</em> had to be a string of length 1. In Python 2.3 and beyond, <em>x</em> may be a string of any length.</p> </li> <li><p class="first">Values of <em>n</em> less than <code class="docutils literal notranslate"><span class="pre">0</span></code> are treated as <code class="docutils literal notranslate"><span class="pre">0</span></code> (which yields an empty sequence of the same type as <em>s</em>). Note that items in the sequence <em>s</em> are not copied; they are referenced multiple times. This often haunts new Python programmers; consider:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">lists</span> <span class="o">=</span> <span class="p">[[]]</span> <span class="o">*</span> <span class="mi">3</span> <span class="gp">>>> </span><span class="n">lists</span> <span class="go">[[], [], []]</span> <span class="gp">>>> </span><span class="n">lists</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">lists</span> <span class="go">[[3], [3], [3]]</span> </pre></div> </div> <p>What has happened is that <code class="docutils literal notranslate"><span class="pre">[[]]</span></code> is a one-element list containing an empty list, so all three elements of <code class="docutils literal notranslate"><span class="pre">[[]]</span> <span class="pre">*</span> <span class="pre">3</span></code> are references to this single empty list. Modifying any of the elements of <code class="docutils literal notranslate"><span class="pre">lists</span></code> modifies this single list. You can create a list of different lists this way:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">lists</span> <span class="o">=</span> <span class="p">[[]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">)]</span> <span class="gp">>>> </span><span class="n">lists</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">lists</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">lists</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="mi">7</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">lists</span> <span class="go">[[3], [5], [7]]</span> </pre></div> </div> <p>Further explanation is available in the FAQ entry <a class="reference internal" href="../faq/programming.html#faq-multidimensional-list"><span class="std std-ref">How do I create a multidimensional list?</span></a>.</p> </li> <li><p class="first">If <em>i</em> or <em>j</em> is negative, the index is relative to the end of sequence <em>s</em>: <code class="docutils literal notranslate"><span class="pre">len(s)</span> <span class="pre">+</span> <span class="pre">i</span></code> or <code class="docutils literal notranslate"><span class="pre">len(s)</span> <span class="pre">+</span> <span class="pre">j</span></code> is substituted. But note that <code class="docutils literal notranslate"><span class="pre">-0</span></code> is still <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p> </li> <li><p class="first">The slice of <em>s</em> from <em>i</em> to <em>j</em> is defined as the sequence of items with index <em>k</em> such that <code class="docutils literal notranslate"><span class="pre">i</span> <span class="pre"><=</span> <span class="pre">k</span> <span class="pre"><</span> <span class="pre">j</span></code>. If <em>i</em> or <em>j</em> is greater than <code class="docutils literal notranslate"><span class="pre">len(s)</span></code>, use <code class="docutils literal notranslate"><span class="pre">len(s)</span></code>. If <em>i</em> is omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, use <code class="docutils literal notranslate"><span class="pre">0</span></code>. If <em>j</em> is omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, use <code class="docutils literal notranslate"><span class="pre">len(s)</span></code>. If <em>i</em> is greater than or equal to <em>j</em>, the slice is empty.</p> </li> <li><p class="first">The slice of <em>s</em> from <em>i</em> to <em>j</em> with step <em>k</em> is defined as the sequence of items with index <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">i</span> <span class="pre">+</span> <span class="pre">n*k</span></code> such that <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre"><=</span> <span class="pre">n</span> <span class="pre"><</span> <span class="pre">(j-i)/k</span></code>. In other words, the indices are <code class="docutils literal notranslate"><span class="pre">i</span></code>, <code class="docutils literal notranslate"><span class="pre">i+k</span></code>, <code class="docutils literal notranslate"><span class="pre">i+2*k</span></code>, <code class="docutils literal notranslate"><span class="pre">i+3*k</span></code> and so on, stopping when <em>j</em> is reached (but never including <em>j</em>). When <em>k</em> is positive, <em>i</em> and <em>j</em> are reduced to <code class="docutils literal notranslate"><span class="pre">len(s)</span></code> if they are greater. When <em>k</em> is negative, <em>i</em> and <em>j</em> are reduced to <code class="docutils literal notranslate"><span class="pre">len(s)</span> <span class="pre">-</span> <span class="pre">1</span></code> if they are greater. If <em>i</em> or <em>j</em> are omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, they become “end” values (which end depends on the sign of <em>k</em>). Note, <em>k</em> cannot be zero. If <em>k</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, it is treated like <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p> </li> <li><div class="impl-detail first compound"> <p><strong>CPython implementation detail:</strong> If <em>s</em> and <em>t</em> are both strings, some Python implementations such as CPython can usually perform an in-place optimization for assignments of the form <code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">=</span> <span class="pre">s</span> <span class="pre">+</span> <span class="pre">t</span></code> or <code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">+=</span> <span class="pre">t</span></code>. When applicable, this optimization makes quadratic run-time much less likely. This optimization is both version and implementation dependent. For performance sensitive code, it is preferable to use the <a class="reference internal" href="#str.join" title="str.join"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str.join()</span></code></a> method which assures consistent linear concatenation performance across versions and implementations.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.4: </span>Formerly, string concatenation never occurred in-place.</p> </div> </li> </ol> <div class="section" id="string-methods"> <span id="id5"></span><h3>5.6.1. String Methods<a class="headerlink" href="#string-methods" title="Permalink to this headline">¶</a></h3> <p id="index-23">Below are listed the string methods which both 8-bit strings and Unicode objects support. Some of them are also available on <a class="reference internal" href="functions.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> objects.</p> <p>In addition, Python’s strings support the sequence type methods described in the <a class="reference internal" href="#typesseq"><span class="std std-ref">Sequence Types — str, unicode, list, tuple, bytearray, buffer, xrange</span></a> section. To output formatted strings use template strings or the <code class="docutils literal notranslate"><span class="pre">%</span></code> operator described in the <a class="reference internal" href="#string-formatting"><span class="std std-ref">String Formatting Operations</span></a> section. Also, see the <a class="reference internal" href="re.html#module-re" title="re: Regular expression operations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code></a> module for string functions based on regular expressions.</p> <dl class="method"> <dt id="str.capitalize"> <code class="descclassname">str.</code><code class="descname">capitalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.capitalize" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with its first character capitalized and the rest lowercased.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.center"> <code class="descclassname">str.</code><code class="descname">center</code><span class="sig-paren">(</span><em>width</em><span class="optional">[</span>, <em>fillchar</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.center" title="Permalink to this definition">¶</a></dt> <dd><p>Return centered in a string of length <em>width</em>. Padding is done using the specified <em>fillchar</em> (default is a space).</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.4: </span>Support for the <em>fillchar</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="str.count"> <code class="descclassname">str.</code><code class="descname">count</code><span class="sig-paren">(</span><em>sub</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.count" title="Permalink to this definition">¶</a></dt> <dd><p>Return the number of non-overlapping occurrences of substring <em>sub</em> in the range [<em>start</em>, <em>end</em>]. Optional arguments <em>start</em> and <em>end</em> are interpreted as in slice notation.</p> </dd></dl> <dl class="method"> <dt id="str.decode"> <code class="descclassname">str.</code><code class="descname">decode</code><span class="sig-paren">(</span><span class="optional">[</span><em>encoding</em><span class="optional">[</span>, <em>errors</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.decode" title="Permalink to this definition">¶</a></dt> <dd><p>Decodes the string using the codec registered for <em>encoding</em>. <em>encoding</em> defaults to the default string encoding. <em>errors</em> may be given to set a different error handling scheme. The default is <code class="docutils literal notranslate"><span class="pre">'strict'</span></code>, meaning that encoding errors raise <a class="reference internal" href="exceptions.html#exceptions.UnicodeError" title="exceptions.UnicodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeError</span></code></a>. Other possible values are <code class="docutils literal notranslate"><span class="pre">'ignore'</span></code>, <code class="docutils literal notranslate"><span class="pre">'replace'</span></code> and any other name registered via <a class="reference internal" href="codecs.html#codecs.register_error" title="codecs.register_error"><code class="xref py py-func docutils literal notranslate"><span class="pre">codecs.register_error()</span></code></a>, see section <a class="reference internal" href="codecs.html#codec-base-classes"><span class="std std-ref">Codec Base Classes</span></a>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.3: </span>Support for other error handling schemes added.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.7: </span>Support for keyword arguments added.</p> </div> </dd></dl> <dl class="method"> <dt id="str.encode"> <code class="descclassname">str.</code><code class="descname">encode</code><span class="sig-paren">(</span><span class="optional">[</span><em>encoding</em><span class="optional">[</span>, <em>errors</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.encode" title="Permalink to this definition">¶</a></dt> <dd><p>Return an encoded version of the string. Default encoding is the current default string encoding. <em>errors</em> may be given to set a different error handling scheme. The default for <em>errors</em> is <code class="docutils literal notranslate"><span class="pre">'strict'</span></code>, meaning that encoding errors raise a <a class="reference internal" href="exceptions.html#exceptions.UnicodeError" title="exceptions.UnicodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">UnicodeError</span></code></a>. Other possible values are <code class="docutils literal notranslate"><span class="pre">'ignore'</span></code>, <code class="docutils literal notranslate"><span class="pre">'replace'</span></code>, <code class="docutils literal notranslate"><span class="pre">'xmlcharrefreplace'</span></code>, <code class="docutils literal notranslate"><span class="pre">'backslashreplace'</span></code> and any other name registered via <a class="reference internal" href="codecs.html#codecs.register_error" title="codecs.register_error"><code class="xref py py-func docutils literal notranslate"><span class="pre">codecs.register_error()</span></code></a>, see section <a class="reference internal" href="codecs.html#codec-base-classes"><span class="std std-ref">Codec Base Classes</span></a>. For a list of possible encodings, see section <a class="reference internal" href="codecs.html#standard-encodings"><span class="std std-ref">Standard Encodings</span></a>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.0.</span></p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.3: </span>Support for <code class="docutils literal notranslate"><span class="pre">'xmlcharrefreplace'</span></code> and <code class="docutils literal notranslate"><span class="pre">'backslashreplace'</span></code> and other error handling schemes added.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.7: </span>Support for keyword arguments added.</p> </div> </dd></dl> <dl class="method"> <dt id="str.endswith"> <code class="descclassname">str.</code><code class="descname">endswith</code><span class="sig-paren">(</span><em>suffix</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.endswith" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the string ends with the specified <em>suffix</em>, otherwise return <code class="docutils literal notranslate"><span class="pre">False</span></code>. <em>suffix</em> can also be a tuple of suffixes to look for. With optional <em>start</em>, test beginning at that position. With optional <em>end</em>, stop comparing at that position.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.5: </span>Accept tuples as <em>suffix</em>.</p> </div> </dd></dl> <dl class="method"> <dt id="str.expandtabs"> <code class="descclassname">str.</code><code class="descname">expandtabs</code><span class="sig-paren">(</span><span class="optional">[</span><em>tabsize</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.expandtabs" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string where all tab characters are replaced by one or more spaces, depending on the current column and the given tab size. Tab positions occur every <em>tabsize</em> characters (default is 8, giving tab positions at columns 0, 8, 16 and so on). To expand the string, the current column is set to zero and the string is examined character by character. If the character is a tab (<code class="docutils literal notranslate"><span class="pre">\t</span></code>), one or more space characters are inserted in the result until the current column is equal to the next tab position. (The tab character itself is not copied.) If the character is a newline (<code class="docutils literal notranslate"><span class="pre">\n</span></code>) or return (<code class="docutils literal notranslate"><span class="pre">\r</span></code>), it is copied and the current column is reset to zero. Any other character is copied unchanged and the current column is incremented by one regardless of how the character is represented when printed.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">'01</span><span class="se">\t</span><span class="s1">012</span><span class="se">\t</span><span class="s1">0123</span><span class="se">\t</span><span class="s1">01234'</span><span class="o">.</span><span class="n">expandtabs</span><span class="p">()</span> <span class="go">'01 012 0123 01234'</span> <span class="gp">>>> </span><span class="s1">'01</span><span class="se">\t</span><span class="s1">012</span><span class="se">\t</span><span class="s1">0123</span><span class="se">\t</span><span class="s1">01234'</span><span class="o">.</span><span class="n">expandtabs</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span> <span class="go">'01 012 0123 01234'</span> </pre></div> </div> </dd></dl> <dl class="method"> <dt id="str.find"> <code class="descclassname">str.</code><code class="descname">find</code><span class="sig-paren">(</span><em>sub</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.find" title="Permalink to this definition">¶</a></dt> <dd><p>Return the lowest index in the string where substring <em>sub</em> is found within the slice <code class="docutils literal notranslate"><span class="pre">s[start:end]</span></code>. Optional arguments <em>start</em> and <em>end</em> are interpreted as in slice notation. Return <code class="docutils literal notranslate"><span class="pre">-1</span></code> if <em>sub</em> is not found.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p>The <a class="reference internal" href="#str.find" title="str.find"><code class="xref py py-meth docutils literal notranslate"><span class="pre">find()</span></code></a> method should be used only if you need to know the position of <em>sub</em>. To check if <em>sub</em> is a substring or not, use the <a class="reference internal" href="../reference/expressions.html#in"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">in</span></code></a> operator:</p> <div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">'Py'</span> <span class="ow">in</span> <span class="s1">'Python'</span> <span class="go">True</span> </pre></div> </div> </div> </dd></dl> <dl class="method"> <dt id="str.format"> <code class="descclassname">str.</code><code class="descname">format</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#str.format" title="Permalink to this definition">¶</a></dt> <dd><p>Perform a string formatting operation. The string on which this method is called can contain literal text or replacement fields delimited by braces <code class="docutils literal notranslate"><span class="pre">{}</span></code>. Each replacement field contains either the numeric index of a positional argument, or the name of a keyword argument. Returns a copy of the string where each replacement field is replaced with the string value of the corresponding argument.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s2">"The sum of 1 + 2 is </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="mi">1</span><span class="o">+</span><span class="mi">2</span><span class="p">)</span> <span class="go">'The sum of 1 + 2 is 3'</span> </pre></div> </div> <p>See <a class="reference internal" href="string.html#formatstrings"><span class="std std-ref">Format String Syntax</span></a> for a description of the various formatting options that can be specified in format strings.</p> <p>This method of string formatting is the new standard in Python 3, and should be preferred to the <code class="docutils literal notranslate"><span class="pre">%</span></code> formatting described in <a class="reference internal" href="#string-formatting"><span class="std std-ref">String Formatting Operations</span></a> in new code.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <dl class="method"> <dt id="str.index"> <code class="descclassname">str.</code><code class="descname">index</code><span class="sig-paren">(</span><em>sub</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.index" title="Permalink to this definition">¶</a></dt> <dd><p>Like <a class="reference internal" href="#str.find" title="str.find"><code class="xref py py-meth docutils literal notranslate"><span class="pre">find()</span></code></a>, but raise <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> when the substring is not found.</p> </dd></dl> <dl class="method"> <dt id="str.isalnum"> <code class="descclassname">str.</code><code class="descname">isalnum</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.isalnum" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if all characters in the string are alphanumeric and there is at least one character, false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.isalpha"> <code class="descclassname">str.</code><code class="descname">isalpha</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.isalpha" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if all characters in the string are alphabetic and there is at least one character, false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.isdigit"> <code class="descclassname">str.</code><code class="descname">isdigit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.isdigit" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if all characters in the string are digits and there is at least one character, false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.islower"> <code class="descclassname">str.</code><code class="descname">islower</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.islower" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if all cased characters <a class="footnote-reference" href="#id15" id="id6">[4]</a> in the string are lowercase and there is at least one cased character, false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.isspace"> <code class="descclassname">str.</code><code class="descname">isspace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.isspace" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if there are only whitespace characters in the string and there is at least one character, false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.istitle"> <code class="descclassname">str.</code><code class="descname">istitle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.istitle" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if the string is a titlecased string and there is at least one character, for example uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.isupper"> <code class="descclassname">str.</code><code class="descname">isupper</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.isupper" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if all cased characters <a class="footnote-reference" href="#id15" id="id7">[4]</a> in the string are uppercase and there is at least one cased character, false otherwise.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.join"> <code class="descclassname">str.</code><code class="descname">join</code><span class="sig-paren">(</span><em>iterable</em><span class="sig-paren">)</span><a class="headerlink" href="#str.join" title="Permalink to this definition">¶</a></dt> <dd><p>Return a string which is the concatenation of the strings in <em>iterable</em>. If there is any Unicode object in <em>iterable</em>, return a Unicode instead. A <a class="reference internal" href="exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> will be raised if there are any non-string or non Unicode object values in <em>iterable</em>. The separator between elements is the string providing this method.</p> </dd></dl> <dl class="method"> <dt id="str.ljust"> <code class="descclassname">str.</code><code class="descname">ljust</code><span class="sig-paren">(</span><em>width</em><span class="optional">[</span>, <em>fillchar</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.ljust" title="Permalink to this definition">¶</a></dt> <dd><p>Return the string left justified in a string of length <em>width</em>. Padding is done using the specified <em>fillchar</em> (default is a space). The original string is returned if <em>width</em> is less than or equal to <code class="docutils literal notranslate"><span class="pre">len(s)</span></code>.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.4: </span>Support for the <em>fillchar</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="str.lower"> <code class="descclassname">str.</code><code class="descname">lower</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.lower" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with all the cased characters <a class="footnote-reference" href="#id15" id="id8">[4]</a> converted to lowercase.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.lstrip"> <code class="descclassname">str.</code><code class="descname">lstrip</code><span class="sig-paren">(</span><span class="optional">[</span><em>chars</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.lstrip" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with leading characters removed. The <em>chars</em> argument is a string specifying the set of characters to be removed. If omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, the <em>chars</em> argument defaults to removing whitespace. The <em>chars</em> argument is not a prefix; rather, all combinations of its values are stripped:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">' spacious '</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span> <span class="go">'spacious '</span> <span class="gp">>>> </span><span class="s1">'www.example.com'</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">'cmowz.'</span><span class="p">)</span> <span class="go">'example.com'</span> </pre></div> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.2.2: </span>Support for the <em>chars</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="str.partition"> <code class="descclassname">str.</code><code class="descname">partition</code><span class="sig-paren">(</span><em>sep</em><span class="sig-paren">)</span><a class="headerlink" href="#str.partition" title="Permalink to this definition">¶</a></dt> <dd><p>Split the string at the first occurrence of <em>sep</em>, and return a 3-tuple containing the part before the separator, the separator itself, and the part after the separator. If the separator is not found, return a 3-tuple containing the string itself, followed by two empty strings.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.5.</span></p> </div> </dd></dl> <dl class="method"> <dt id="str.replace"> <code class="descclassname">str.</code><code class="descname">replace</code><span class="sig-paren">(</span><em>old</em>, <em>new</em><span class="optional">[</span>, <em>count</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.replace" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with all occurrences of substring <em>old</em> replaced by <em>new</em>. If the optional argument <em>count</em> is given, only the first <em>count</em> occurrences are replaced.</p> </dd></dl> <dl class="method"> <dt id="str.rfind"> <code class="descclassname">str.</code><code class="descname">rfind</code><span class="sig-paren">(</span><em>sub</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.rfind" title="Permalink to this definition">¶</a></dt> <dd><p>Return the highest index in the string where substring <em>sub</em> is found, such that <em>sub</em> is contained within <code class="docutils literal notranslate"><span class="pre">s[start:end]</span></code>. Optional arguments <em>start</em> and <em>end</em> are interpreted as in slice notation. Return <code class="docutils literal notranslate"><span class="pre">-1</span></code> on failure.</p> </dd></dl> <dl class="method"> <dt id="str.rindex"> <code class="descclassname">str.</code><code class="descname">rindex</code><span class="sig-paren">(</span><em>sub</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.rindex" title="Permalink to this definition">¶</a></dt> <dd><p>Like <a class="reference internal" href="#str.rfind" title="str.rfind"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rfind()</span></code></a> but raises <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> when the substring <em>sub</em> is not found.</p> </dd></dl> <dl class="method"> <dt id="str.rjust"> <code class="descclassname">str.</code><code class="descname">rjust</code><span class="sig-paren">(</span><em>width</em><span class="optional">[</span>, <em>fillchar</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.rjust" title="Permalink to this definition">¶</a></dt> <dd><p>Return the string right justified in a string of length <em>width</em>. Padding is done using the specified <em>fillchar</em> (default is a space). The original string is returned if <em>width</em> is less than or equal to <code class="docutils literal notranslate"><span class="pre">len(s)</span></code>.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.4: </span>Support for the <em>fillchar</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="str.rpartition"> <code class="descclassname">str.</code><code class="descname">rpartition</code><span class="sig-paren">(</span><em>sep</em><span class="sig-paren">)</span><a class="headerlink" href="#str.rpartition" title="Permalink to this definition">¶</a></dt> <dd><p>Split the string at the last occurrence of <em>sep</em>, and return a 3-tuple containing the part before the separator, the separator itself, and the part after the separator. If the separator is not found, return a 3-tuple containing two empty strings, followed by the string itself.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.5.</span></p> </div> </dd></dl> <dl class="method"> <dt id="str.rsplit"> <code class="descclassname">str.</code><code class="descname">rsplit</code><span class="sig-paren">(</span><span class="optional">[</span><em>sep</em><span class="optional">[</span>, <em>maxsplit</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.rsplit" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of the words in the string, using <em>sep</em> as the delimiter string. If <em>maxsplit</em> is given, at most <em>maxsplit</em> splits are done, the <em>rightmost</em> ones. If <em>sep</em> is not specified or <code class="docutils literal notranslate"><span class="pre">None</span></code>, any whitespace string is a separator. Except for splitting from the right, <a class="reference internal" href="#str.rsplit" title="str.rsplit"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rsplit()</span></code></a> behaves like <a class="reference internal" href="#str.split" title="str.split"><code class="xref py py-meth docutils literal notranslate"><span class="pre">split()</span></code></a> which is described in detail below.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.4.</span></p> </div> </dd></dl> <dl class="method"> <dt id="str.rstrip"> <code class="descclassname">str.</code><code class="descname">rstrip</code><span class="sig-paren">(</span><span class="optional">[</span><em>chars</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.rstrip" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with trailing characters removed. The <em>chars</em> argument is a string specifying the set of characters to be removed. If omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, the <em>chars</em> argument defaults to removing whitespace. The <em>chars</em> argument is not a suffix; rather, all combinations of its values are stripped:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">' spacious '</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span> <span class="go">' spacious'</span> <span class="gp">>>> </span><span class="s1">'mississippi'</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s1">'ipz'</span><span class="p">)</span> <span class="go">'mississ'</span> </pre></div> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.2.2: </span>Support for the <em>chars</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="str.split"> <code class="descclassname">str.</code><code class="descname">split</code><span class="sig-paren">(</span><span class="optional">[</span><em>sep</em><span class="optional">[</span>, <em>maxsplit</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.split" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of the words in the string, using <em>sep</em> as the delimiter string. If <em>maxsplit</em> is given, at most <em>maxsplit</em> splits are done (thus, the list will have at most <code class="docutils literal notranslate"><span class="pre">maxsplit+1</span></code> elements). If <em>maxsplit</em> is not specified or <code class="docutils literal notranslate"><span class="pre">-1</span></code>, then there is no limit on the number of splits (all possible splits are made).</p> <p>If <em>sep</em> is given, consecutive delimiters are not grouped together and are deemed to delimit empty strings (for example, <code class="docutils literal notranslate"><span class="pre">'1,,2'.split(',')</span></code> returns <code class="docutils literal notranslate"><span class="pre">['1',</span> <span class="pre">'',</span> <span class="pre">'2']</span></code>). The <em>sep</em> argument may consist of multiple characters (for example, <code class="docutils literal notranslate"><span class="pre">'1<>2<>3'.split('<>')</span></code> returns <code class="docutils literal notranslate"><span class="pre">['1',</span> <span class="pre">'2',</span> <span class="pre">'3']</span></code>). Splitting an empty string with a specified separator returns <code class="docutils literal notranslate"><span class="pre">['']</span></code>.</p> <p>If <em>sep</em> is not specified or is <code class="docutils literal notranslate"><span class="pre">None</span></code>, a different splitting algorithm is applied: runs of consecutive whitespace are regarded as a single separator, and the result will contain no empty strings at the start or end if the string has leading or trailing whitespace. Consequently, splitting an empty string or a string consisting of just whitespace with a <code class="docutils literal notranslate"><span class="pre">None</span></code> separator returns <code class="docutils literal notranslate"><span class="pre">[]</span></code>.</p> <p>For example, <code class="docutils literal notranslate"><span class="pre">'</span> <span class="pre">1</span>  <span class="pre">2</span>   <span class="pre">3</span>  <span class="pre">'.split()</span></code> returns <code class="docutils literal notranslate"><span class="pre">['1',</span> <span class="pre">'2',</span> <span class="pre">'3']</span></code>, and <code class="docutils literal notranslate"><span class="pre">'</span>  <span class="pre">1</span>  <span class="pre">2</span>   <span class="pre">3</span>  <span class="pre">'.split(None,</span> <span class="pre">1)</span></code> returns <code class="docutils literal notranslate"><span class="pre">['1',</span> <span class="pre">'2</span>   <span class="pre">3</span>  <span class="pre">']</span></code>.</p> </dd></dl> <span class="target" id="index-24"></span><dl class="method"> <dt id="str.splitlines"> <code class="descclassname">str.</code><code class="descname">splitlines</code><span class="sig-paren">(</span><span class="optional">[</span><em>keepends</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.splitlines" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of the lines in the string, breaking at line boundaries. This method uses the <a class="reference internal" href="../glossary.html#term-universal-newlines"><span class="xref std std-term">universal newlines</span></a> approach to splitting lines. Line breaks are not included in the resulting list unless <em>keepends</em> is given and true.</p> <p>Python recognizes <code class="docutils literal notranslate"><span class="pre">"\r"</span></code>, <code class="docutils literal notranslate"><span class="pre">"\n"</span></code>, and <code class="docutils literal notranslate"><span class="pre">"\r\n"</span></code> as line boundaries for 8-bit strings.</p> <p>For example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">'ab c</span><span class="se">\n\n</span><span class="s1">de fg</span><span class="se">\r</span><span class="s1">kl</span><span class="se">\r\n</span><span class="s1">'</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span> <span class="go">['ab c', '', 'de fg', 'kl']</span> <span class="gp">>>> </span><span class="s1">'ab c</span><span class="se">\n\n</span><span class="s1">de fg</span><span class="se">\r</span><span class="s1">kl</span><span class="se">\r\n</span><span class="s1">'</span><span class="o">.</span><span class="n">splitlines</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span> <span class="go">['ab c\n', '\n', 'de fg\r', 'kl\r\n']</span> </pre></div> </div> <p>Unlike <a class="reference internal" href="#str.split" title="str.split"><code class="xref py py-meth docutils literal notranslate"><span class="pre">split()</span></code></a> when a delimiter string <em>sep</em> is given, this method returns an empty list for the empty string, and a terminal line break does not result in an extra line:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s2">""</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span> <span class="go">[]</span> <span class="gp">>>> </span><span class="s2">"One line</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span> <span class="go">['One line']</span> </pre></div> </div> <p>For comparison, <code class="docutils literal notranslate"><span class="pre">split('\n')</span></code> gives:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">''</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> <span class="go">['']</span> <span class="gp">>>> </span><span class="s1">'Two lines</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> <span class="go">['Two lines', '']</span> </pre></div> </div> </dd></dl> <dl class="method"> <dt id="unicode.splitlines"> <code class="descclassname">unicode.</code><code class="descname">splitlines</code><span class="sig-paren">(</span><span class="optional">[</span><em>keepends</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#unicode.splitlines" title="Permalink to this definition">¶</a></dt> <dd><p>Return a list of the lines in the string, like <a class="reference internal" href="#str.splitlines" title="str.splitlines"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str.splitlines()</span></code></a>. However, the Unicode method splits on the following line boundaries, which are a superset of the <a class="reference internal" href="../glossary.html#term-universal-newlines"><span class="xref std std-term">universal newlines</span></a> recognized for 8-bit strings.</p> <table border="1" class="docutils"> <colgroup> <col width="44%" /> <col width="56%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Representation</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">\n</span></code></td> <td>Line Feed</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">\r</span></code></td> <td>Carriage Return</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">\r\n</span></code></td> <td>Carriage Return + Line Feed</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">\v</span></code> or <code class="docutils literal notranslate"><span class="pre">\x0b</span></code></td> <td>Line Tabulation</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">\f</span></code> or <code class="docutils literal notranslate"><span class="pre">\x0c</span></code></td> <td>Form Feed</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">\x1c</span></code></td> <td>File Separator</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">\x1d</span></code></td> <td>Group Separator</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">\x1e</span></code></td> <td>Record Separator</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">\x85</span></code></td> <td>Next Line (C1 Control Code)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">\u2028</span></code></td> <td>Line Separator</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">\u2029</span></code></td> <td>Paragraph Separator</td> </tr> </tbody> </table> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.7: </span><code class="docutils literal notranslate"><span class="pre">\v</span></code> and <code class="docutils literal notranslate"><span class="pre">\f</span></code> added to list of line boundaries.</p> </div> </dd></dl> <dl class="method"> <dt id="str.startswith"> <code class="descclassname">str.</code><code class="descname">startswith</code><span class="sig-paren">(</span><em>prefix</em><span class="optional">[</span>, <em>start</em><span class="optional">[</span>, <em>end</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.startswith" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if string starts with the <em>prefix</em>, otherwise return <code class="docutils literal notranslate"><span class="pre">False</span></code>. <em>prefix</em> can also be a tuple of prefixes to look for. With optional <em>start</em>, test string beginning at that position. With optional <em>end</em>, stop comparing string at that position.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.5: </span>Accept tuples as <em>prefix</em>.</p> </div> </dd></dl> <dl class="method"> <dt id="str.strip"> <code class="descclassname">str.</code><code class="descname">strip</code><span class="sig-paren">(</span><span class="optional">[</span><em>chars</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.strip" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with the leading and trailing characters removed. The <em>chars</em> argument is a string specifying the set of characters to be removed. If omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, the <em>chars</em> argument defaults to removing whitespace. The <em>chars</em> argument is not a prefix or suffix; rather, all combinations of its values are stripped:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">' spacious '</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="go">'spacious'</span> <span class="gp">>>> </span><span class="s1">'www.example.com'</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'cmowz.'</span><span class="p">)</span> <span class="go">'example'</span> </pre></div> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.2.2: </span>Support for the <em>chars</em> argument.</p> </div> </dd></dl> <dl class="method"> <dt id="str.swapcase"> <code class="descclassname">str.</code><code class="descname">swapcase</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.swapcase" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with uppercase characters converted to lowercase and vice versa.</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.title"> <code class="descclassname">str.</code><code class="descname">title</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.title" title="Permalink to this definition">¶</a></dt> <dd><p>Return a titlecased version of the string where words start with an uppercase character and the remaining characters are lowercase.</p> <p>The algorithm uses a simple language-independent definition of a word as groups of consecutive letters. The definition works in many contexts but it means that apostrophes in contractions and possessives form word boundaries, which may not be the desired result:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s2">"they're bill's friends from the UK"</span><span class="o">.</span><span class="n">title</span><span class="p">()</span> <span class="go">"They'Re Bill'S Friends From The Uk"</span> </pre></div> </div> <p>A workaround for apostrophes can be constructed using regular expressions:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">re</span> <span class="gp">>>> </span><span class="k">def</span> <span class="nf">titlecase</span><span class="p">(</span><span class="n">s</span><span class="p">):</span> <span class="gp">... </span> <span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"[A-Za-z]+('[A-Za-z]+)?"</span><span class="p">,</span> <span class="gp">... </span> <span class="k">lambda</span> <span class="n">mo</span><span class="p">:</span> <span class="n">mo</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">+</span> <span class="gp">... </span> <span class="n">mo</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)[</span><span class="mi">1</span><span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="gp">... </span> <span class="n">s</span><span class="p">)</span> <span class="gp">...</span> <span class="gp">>>> </span><span class="n">titlecase</span><span class="p">(</span><span class="s2">"they're bill's friends."</span><span class="p">)</span> <span class="go">"They're Bill's Friends."</span> </pre></div> </div> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.translate"> <code class="descclassname">str.</code><code class="descname">translate</code><span class="sig-paren">(</span><em>table</em><span class="optional">[</span>, <em>deletechars</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#str.translate" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string where all characters occurring in the optional argument <em>deletechars</em> are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256.</p> <p>You can use the <a class="reference internal" href="string.html#string.maketrans" title="string.maketrans"><code class="xref py py-func docutils literal notranslate"><span class="pre">maketrans()</span></code></a> helper function in the <a class="reference internal" href="string.html#module-string" title="string: Common string operations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">string</span></code></a> module to create a translation table. For string objects, set the <em>table</em> argument to <code class="docutils literal notranslate"><span class="pre">None</span></code> for translations that only delete characters:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="s1">'read this short text'</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">'aeiou'</span><span class="p">)</span> <span class="go">'rd ths shrt txt'</span> </pre></div> </div> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6: </span>Support for a <code class="docutils literal notranslate"><span class="pre">None</span></code> <em>table</em> argument.</p> </div> <p>For Unicode objects, the <a class="reference internal" href="#str.translate" title="str.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a> method does not accept the optional <em>deletechars</em> argument. Instead, it returns a copy of the <em>s</em> where all characters have been mapped through the given translation table which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or <code class="docutils literal notranslate"><span class="pre">None</span></code>. Unmapped characters are left untouched. Characters mapped to <code class="docutils literal notranslate"><span class="pre">None</span></code> are deleted. Note, a more flexible approach is to create a custom character mapping codec using the <a class="reference internal" href="codecs.html#module-codecs" title="codecs: Encode and decode data and streams."><code class="xref py py-mod docutils literal notranslate"><span class="pre">codecs</span></code></a> module (see <code class="xref py py-mod docutils literal notranslate"><span class="pre">encodings.cp1251</span></code> for an example).</p> </dd></dl> <dl class="method"> <dt id="str.upper"> <code class="descclassname">str.</code><code class="descname">upper</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#str.upper" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the string with all the cased characters <a class="footnote-reference" href="#id15" id="id9">[4]</a> converted to uppercase. Note that <code class="docutils literal notranslate"><span class="pre">s.upper().isupper()</span></code> might be <code class="docutils literal notranslate"><span class="pre">False</span></code> if <code class="docutils literal notranslate"><span class="pre">s</span></code> contains uncased characters or if the Unicode category of the resulting character(s) is not “Lu” (Letter, uppercase), but e.g. “Lt” (Letter, titlecase).</p> <p>For 8-bit strings, this method is locale-dependent.</p> </dd></dl> <dl class="method"> <dt id="str.zfill"> <code class="descclassname">str.</code><code class="descname">zfill</code><span class="sig-paren">(</span><em>width</em><span class="sig-paren">)</span><a class="headerlink" href="#str.zfill" title="Permalink to this definition">¶</a></dt> <dd><p>Return the numeric string left filled with zeros in a string of length <em>width</em>. A sign prefix is handled correctly. The original string is returned if <em>width</em> is less than or equal to <code class="docutils literal notranslate"><span class="pre">len(s)</span></code>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.2.</span></p> </div> </dd></dl> <p>The following methods are present only on unicode objects:</p> <dl class="method"> <dt id="unicode.isnumeric"> <code class="descclassname">unicode.</code><code class="descname">isnumeric</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unicode.isnumeric" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if there are only numeric characters in S, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise. Numeric characters include digit characters, and all characters that have the Unicode numeric value property, e.g. U+2155, VULGAR FRACTION ONE FIFTH.</p> </dd></dl> <dl class="method"> <dt id="unicode.isdecimal"> <code class="descclassname">unicode.</code><code class="descname">isdecimal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#unicode.isdecimal" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if there are only decimal characters in S, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise. Decimal characters include digit characters, and all characters that can be used to form decimal-radix numbers, e.g. U+0660, ARABIC-INDIC DIGIT ZERO.</p> </dd></dl> </div> <div class="section" id="string-formatting-operations"> <span id="string-formatting"></span><h3>5.6.2. String Formatting Operations<a class="headerlink" href="#string-formatting-operations" title="Permalink to this headline">¶</a></h3> <p id="index-25">String and Unicode objects have one unique built-in operation: the <code class="docutils literal notranslate"><span class="pre">%</span></code> operator (modulo). This is also known as the string <em>formatting</em> or <em>interpolation</em> operator. Given <code class="docutils literal notranslate"><span class="pre">format</span> <span class="pre">%</span> <span class="pre">values</span></code> (where <em>format</em> is a string or Unicode object), <code class="docutils literal notranslate"><span class="pre">%</span></code> conversion specifications in <em>format</em> are replaced with zero or more elements of <em>values</em>. The effect is similar to the using <code class="xref c c-func docutils literal notranslate"><span class="pre">sprintf()</span></code> in the C language. If <em>format</em> is a Unicode object, or if any of the objects being converted using the <code class="docutils literal notranslate"><span class="pre">%s</span></code> conversion are Unicode objects, the result will also be a Unicode object.</p> <p>If <em>format</em> requires a single argument, <em>values</em> may be a single non-tuple object. <a class="footnote-reference" href="#id16" id="id10">[5]</a> Otherwise, <em>values</em> must be a tuple with exactly the number of items specified by the format string, or a single mapping object (for example, a dictionary).</p> <p>A conversion specifier contains two or more characters and has the following components, which must occur in this order:</p> <ol class="arabic simple"> <li>The <code class="docutils literal notranslate"><span class="pre">'%'</span></code> character, which marks the start of the specifier.</li> <li>Mapping key (optional), consisting of a parenthesised sequence of characters (for example, <code class="docutils literal notranslate"><span class="pre">(somename)</span></code>).</li> <li>Conversion flags (optional), which affect the result of some conversion types.</li> <li>Minimum field width (optional). If specified as an <code class="docutils literal notranslate"><span class="pre">'*'</span></code> (asterisk), the actual width is read from the next element of the tuple in <em>values</em>, and the object to convert comes after the minimum field width and optional precision.</li> <li>Precision (optional), given as a <code class="docutils literal notranslate"><span class="pre">'.'</span></code> (dot) followed by the precision. If specified as <code class="docutils literal notranslate"><span class="pre">'*'</span></code> (an asterisk), the actual width is read from the next element of the tuple in <em>values</em>, and the value to convert comes after the precision.</li> <li>Length modifier (optional).</li> <li>Conversion type.</li> </ol> <p>When the right argument is a dictionary (or other mapping type), then the formats in the string <em>must</em> include a parenthesised mapping key into that dictionary inserted immediately after the <code class="docutils literal notranslate"><span class="pre">'%'</span></code> character. The mapping key selects the value to be formatted from the mapping. For example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span> <span class="s1">'</span><span class="si">%(language)s</span><span class="s1"> has </span><span class="si">%(number)03d</span><span class="s1"> quote types.'</span> <span class="o">%</span> \ <span class="gp">... </span> <span class="p">{</span><span class="s2">"language"</span><span class="p">:</span> <span class="s2">"Python"</span><span class="p">,</span> <span class="s2">"number"</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span> <span class="go">Python has 002 quote types.</span> </pre></div> </div> <p>In this case no <code class="docutils literal notranslate"><span class="pre">*</span></code> specifiers may occur in a format (since they require a sequential parameter list).</p> <p>The conversion flag characters are:</p> <table border="1" class="docutils"> <colgroup> <col width="12%" /> <col width="88%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Flag</th> <th class="head">Meaning</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'#'</span></code></td> <td>The value conversion will use the “alternate form” (where defined below).</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'0'</span></code></td> <td>The conversion will be zero padded for numeric values.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'-'</span></code></td> <td>The converted value is left adjusted (overrides the <code class="docutils literal notranslate"><span class="pre">'0'</span></code> conversion if both are given).</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'</span> <span class="pre">'</span></code></td> <td>(a space) A blank should be left before a positive number (or empty string) produced by a signed conversion.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'+'</span></code></td> <td>A sign character (<code class="docutils literal notranslate"><span class="pre">'+'</span></code> or <code class="docutils literal notranslate"><span class="pre">'-'</span></code>) will precede the conversion (overrides a “space” flag).</td> </tr> </tbody> </table> <p>A length modifier (<code class="docutils literal notranslate"><span class="pre">h</span></code>, <code class="docutils literal notranslate"><span class="pre">l</span></code>, or <code class="docutils literal notranslate"><span class="pre">L</span></code>) may be present, but is ignored as it is not necessary for Python – so e.g. <code class="docutils literal notranslate"><span class="pre">%ld</span></code> is identical to <code class="docutils literal notranslate"><span class="pre">%d</span></code>.</p> <p>The conversion types are:</p> <table border="1" class="docutils"> <colgroup> <col width="17%" /> <col width="74%" /> <col width="10%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Conversion</th> <th class="head">Meaning</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'d'</span></code></td> <td>Signed integer decimal.</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'i'</span></code></td> <td>Signed integer decimal.</td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'o'</span></code></td> <td>Signed octal value.</td> <td>(1)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'u'</span></code></td> <td>Obsolete type – it is identical to <code class="docutils literal notranslate"><span class="pre">'d'</span></code>.</td> <td>(7)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'x'</span></code></td> <td>Signed hexadecimal (lowercase).</td> <td>(2)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'X'</span></code></td> <td>Signed hexadecimal (uppercase).</td> <td>(2)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'e'</span></code></td> <td>Floating point exponential format (lowercase).</td> <td>(3)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'E'</span></code></td> <td>Floating point exponential format (uppercase).</td> <td>(3)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'f'</span></code></td> <td>Floating point decimal format.</td> <td>(3)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'F'</span></code></td> <td>Floating point decimal format.</td> <td>(3)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'g'</span></code></td> <td>Floating point format. Uses lowercase exponential format if exponent is less than -4 or not less than precision, decimal format otherwise.</td> <td>(4)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'G'</span></code></td> <td>Floating point format. Uses uppercase exponential format if exponent is less than -4 or not less than precision, decimal format otherwise.</td> <td>(4)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'c'</span></code></td> <td>Single character (accepts integer or single character string).</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'r'</span></code></td> <td>String (converts any Python object using <a class="reference internal" href="functions.html#func-repr"><span class="std std-ref">repr()</span></a>).</td> <td>(5)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">'s'</span></code></td> <td>String (converts any Python object using <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-func docutils literal notranslate"><span class="pre">str()</span></code></a>).</td> <td>(6)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">'%'</span></code></td> <td>No argument is converted, results in a <code class="docutils literal notranslate"><span class="pre">'%'</span></code> character in the result.</td> <td> </td> </tr> </tbody> </table> <p>Notes:</p> <ol class="arabic"> <li><p class="first">The alternate form causes a leading zero (<code class="docutils literal notranslate"><span class="pre">'0'</span></code>) to be inserted between left-hand padding and the formatting of the number if the leading character of the result is not already a zero.</p> </li> <li><p class="first">The alternate form causes a leading <code class="docutils literal notranslate"><span class="pre">'0x'</span></code> or <code class="docutils literal notranslate"><span class="pre">'0X'</span></code> (depending on whether the <code class="docutils literal notranslate"><span class="pre">'x'</span></code> or <code class="docutils literal notranslate"><span class="pre">'X'</span></code> format was used) to be inserted before the first digit.</p> </li> <li><p class="first">The alternate form causes the result to always contain a decimal point, even if no digits follow it.</p> <p>The precision determines the number of digits after the decimal point and defaults to 6.</p> </li> <li><p class="first">The alternate form causes the result to always contain a decimal point, and trailing zeroes are not removed as they would otherwise be.</p> <p>The precision determines the number of significant digits before and after the decimal point and defaults to 6.</p> </li> <li><p class="first">The <code class="docutils literal notranslate"><span class="pre">%r</span></code> conversion was added in Python 2.0.</p> <p>The precision determines the maximal number of characters used.</p> </li> <li><p class="first">If the object or format provided is a <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-class docutils literal notranslate"><span class="pre">unicode</span></code></a> string, the resulting string will also be <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-class docutils literal notranslate"><span class="pre">unicode</span></code></a>.</p> <p>The precision determines the maximal number of characters used.</p> </li> <li><p class="first">See <span class="target" id="index-26"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0237"><strong>PEP 237</strong></a>.</p> </li> </ol> <p>Since Python strings have an explicit length, <code class="docutils literal notranslate"><span class="pre">%s</span></code> conversions do not assume that <code class="docutils literal notranslate"><span class="pre">'\0'</span></code> is the end of the string.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.7: </span><code class="docutils literal notranslate"><span class="pre">%f</span></code> conversions for numbers whose absolute value is over 1e50 are no longer replaced by <code class="docutils literal notranslate"><span class="pre">%g</span></code> conversions.</p> </div> <p id="index-27">Additional string operations are defined in standard modules <a class="reference internal" href="string.html#module-string" title="string: Common string operations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">string</span></code></a> and <a class="reference internal" href="re.html#module-re" title="re: Regular expression operations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code></a>.</p> </div> <div class="section" id="xrange-type"> <span id="typesseq-xrange"></span><h3>5.6.3. XRange Type<a class="headerlink" href="#xrange-type" title="Permalink to this headline">¶</a></h3> <p id="index-28">The <a class="reference internal" href="functions.html#xrange" title="xrange"><code class="xref py py-class docutils literal notranslate"><span class="pre">xrange</span></code></a> type is an immutable sequence which is commonly used for looping. The advantage of the <a class="reference internal" href="functions.html#xrange" title="xrange"><code class="xref py py-class docutils literal notranslate"><span class="pre">xrange</span></code></a> type is that an <a class="reference internal" href="functions.html#xrange" title="xrange"><code class="xref py py-class docutils literal notranslate"><span class="pre">xrange</span></code></a> object will always take the same amount of memory, no matter the size of the range it represents. There are no consistent performance advantages.</p> <p>XRange objects have very little behavior: they only support indexing, iteration, and the <a class="reference internal" href="functions.html#len" title="len"><code class="xref py py-func docutils literal notranslate"><span class="pre">len()</span></code></a> function.</p> </div> <div class="section" id="mutable-sequence-types"> <span id="typesseq-mutable"></span><h3>5.6.4. Mutable Sequence Types<a class="headerlink" href="#mutable-sequence-types" title="Permalink to this headline">¶</a></h3> <p id="index-29">List and <a class="reference internal" href="functions.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> objects support additional operations that allow in-place modification of the object. Other mutable sequence types (when added to the language) should also support these operations. Strings and tuples are immutable sequence types: such objects cannot be modified once created. The following operations are defined on mutable sequence types (where <em>x</em> is an arbitrary object):</p> <table border="1" class="docutils" id="index-30"> <colgroup> <col width="36%" /> <col width="39%" /> <col width="25%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Operation</th> <th class="head">Result</th> <th class="head">Notes</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s[i]</span> <span class="pre">=</span> <span class="pre">x</span></code></td> <td>item <em>i</em> of <em>s</em> is replaced by <em>x</em></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s[i:j]</span> <span class="pre">=</span> <span class="pre">t</span></code></td> <td>slice of <em>s</em> from <em>i</em> to <em>j</em> is replaced by the contents of the iterable <em>t</em></td> <td> </td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">del</span> <span class="pre">s[i:j]</span></code></td> <td>same as <code class="docutils literal notranslate"><span class="pre">s[i:j]</span> <span class="pre">=</span> <span class="pre">[]</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s[i:j:k]</span> <span class="pre">=</span> <span class="pre">t</span></code></td> <td>the elements of <code class="docutils literal notranslate"><span class="pre">s[i:j:k]</span></code> are replaced by those of <em>t</em></td> <td>(1)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">del</span> <span class="pre">s[i:j:k]</span></code></td> <td>removes the elements of <code class="docutils literal notranslate"><span class="pre">s[i:j:k]</span></code> from the list</td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s.append(x)</span></code></td> <td>same as <code class="docutils literal notranslate"><span class="pre">s[len(s):len(s)]</span> <span class="pre">=</span> <span class="pre">[x]</span></code></td> <td>(2)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s.extend(t)</span></code> or <code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">+=</span> <span class="pre">t</span></code></td> <td>for the most part the same as <code class="docutils literal notranslate"><span class="pre">s[len(s):len(s)]</span> <span class="pre">=</span> <span class="pre">t</span></code></td> <td>(3)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">*=</span> <span class="pre">n</span></code></td> <td>updates <em>s</em> with its contents repeated <em>n</em> times</td> <td>(11)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s.count(x)</span></code></td> <td>return number of <em>i</em>’s for which <code class="docutils literal notranslate"><span class="pre">s[i]</span> <span class="pre">==</span> <span class="pre">x</span></code></td> <td> </td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s.index(x[,</span> <span class="pre">i[,</span> <span class="pre">j]])</span></code></td> <td>return smallest <em>k</em> such that <code class="docutils literal notranslate"><span class="pre">s[k]</span> <span class="pre">==</span> <span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">i</span> <span class="pre"><=</span> <span class="pre">k</span> <span class="pre"><</span> <span class="pre">j</span></code></td> <td>(4)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s.insert(i,</span> <span class="pre">x)</span></code></td> <td>same as <code class="docutils literal notranslate"><span class="pre">s[i:i]</span> <span class="pre">=</span> <span class="pre">[x]</span></code></td> <td>(5)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s.pop([i])</span></code></td> <td>same as <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">s[i];</span> <span class="pre">del</span> <span class="pre">s[i];</span> <span class="pre">return</span> <span class="pre">x</span></code></td> <td>(6)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s.remove(x)</span></code></td> <td>same as <code class="docutils literal notranslate"><span class="pre">del</span> <span class="pre">s[s.index(x)]</span></code></td> <td>(4)</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">s.reverse()</span></code></td> <td>reverses the items of <em>s</em> in place</td> <td>(7)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">s.sort([cmp[,</span> <span class="pre">key[,</span> <span class="pre">reverse]]])</span></code></td> <td>sort the items of <em>s</em> in place</td> <td>(7)(8)(9)(10)</td> </tr> </tbody> </table> <p>Notes:</p> <ol class="arabic"> <li><p class="first"><em>t</em> must have the same length as the slice it is replacing.</p> </li> <li><p class="first">The C implementation of Python has historically accepted multiple parameters and implicitly joined them into a tuple; this no longer works in Python 2.0. Use of this misfeature has been deprecated since Python 1.4.</p> </li> <li><p class="first"><em>t</em> can be any iterable object.</p> </li> <li><p class="first">Raises <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> when <em>x</em> is not found in <em>s</em>. When a negative index is passed as the second or third parameter to the <code class="xref py py-meth docutils literal notranslate"><span class="pre">index()</span></code> method, the list length is added, as for slice indices. If it is still negative, it is truncated to zero, as for slice indices.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.3: </span>Previously, <code class="xref py py-meth docutils literal notranslate"><span class="pre">index()</span></code> didn’t have arguments for specifying start and stop positions.</p> </div> </li> <li><p class="first">When a negative index is passed as the first parameter to the <code class="xref py py-meth docutils literal notranslate"><span class="pre">insert()</span></code> method, the list length is added, as for slice indices. If it is still negative, it is truncated to zero, as for slice indices.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.3: </span>Previously, all negative indices were truncated to zero.</p> </div> </li> <li><p class="first">The <code class="xref py py-meth docutils literal notranslate"><span class="pre">pop()</span></code> method’s optional argument <em>i</em> defaults to <code class="docutils literal notranslate"><span class="pre">-1</span></code>, so that by default the last item is removed and returned.</p> </li> <li><p class="first">The <code class="xref py py-meth docutils literal notranslate"><span class="pre">sort()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">reverse()</span></code> methods modify the list in place for economy of space when sorting or reversing a large list. To remind you that they operate by side effect, they don’t return the sorted or reversed list.</p> </li> <li><p class="first">The <code class="xref py py-meth docutils literal notranslate"><span class="pre">sort()</span></code> method takes optional arguments for controlling the comparisons.</p> <p><em>cmp</em> specifies a custom comparison function of two arguments (list items) which should return a negative, zero or positive number depending on whether the first argument is considered smaller than, equal to, or larger than the second argument: <code class="docutils literal notranslate"><span class="pre">cmp=lambda</span> <span class="pre">x,y:</span> <span class="pre">cmp(x.lower(),</span> <span class="pre">y.lower())</span></code>. The default value is <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <p><em>key</em> specifies a function of one argument that is used to extract a comparison key from each list element: <code class="docutils literal notranslate"><span class="pre">key=str.lower</span></code>. The default value is <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <p><em>reverse</em> is a boolean value. If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, then the list elements are sorted as if each comparison were reversed.</p> <p>In general, the <em>key</em> and <em>reverse</em> conversion processes are much faster than specifying an equivalent <em>cmp</em> function. This is because <em>cmp</em> is called multiple times for each list element while <em>key</em> and <em>reverse</em> touch each element only once. Use <a class="reference internal" href="functools.html#functools.cmp_to_key" title="functools.cmp_to_key"><code class="xref py py-func docutils literal notranslate"><span class="pre">functools.cmp_to_key()</span></code></a> to convert an old-style <em>cmp</em> function to a <em>key</em> function.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.3: </span>Support for <code class="docutils literal notranslate"><span class="pre">None</span></code> as an equivalent to omitting <em>cmp</em> was added.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.4: </span>Support for <em>key</em> and <em>reverse</em> was added.</p> </div> </li> <li><p class="first">Starting with Python 2.3, the <code class="xref py py-meth docutils literal notranslate"><span class="pre">sort()</span></code> method is guaranteed to be stable. A sort is stable if it guarantees not to change the relative order of elements that compare equal — this is helpful for sorting in multiple passes (for example, sort by department, then by salary grade).</p> </li> <li><div class="impl-detail first compound"> <p><strong>CPython implementation detail:</strong> While a list is being sorted, the effect of attempting to mutate, or even inspect, the list is undefined. The C implementation of Python 2.3 and newer makes the list appear empty for the duration, and raises <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if it can detect that the list has been mutated during a sort.</p> </div> </li> <li><p class="first">The value <em>n</em> is an integer, or an object implementing <a class="reference internal" href="../reference/datamodel.html#object.__index__" title="object.__index__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__index__()</span></code></a>. Zero and negative values of <em>n</em> clear the sequence. Items in the sequence are not copied; they are referenced multiple times, as explained for <code class="docutils literal notranslate"><span class="pre">s</span> <span class="pre">*</span> <span class="pre">n</span></code> under <a class="reference internal" href="#typesseq"><span class="std std-ref">Sequence Types — str, unicode, list, tuple, bytearray, buffer, xrange</span></a>.</p> </li> </ol> </div> </div> <div class="section" id="set-types-set-frozenset"> <span id="types-set"></span><h2>5.7. Set Types — <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a>, <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a><a class="headerlink" href="#set-types-set-frozenset" title="Permalink to this headline">¶</a></h2> <p id="index-31">A <em class="dfn">set</em> object is an unordered collection of distinct <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a> objects. Common uses include membership testing, removing duplicates from a sequence, and computing mathematical operations such as intersection, union, difference, and symmetric difference. (For other containers see the built in <a class="reference internal" href="#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>, and <a class="reference internal" href="functions.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> classes, and the <a class="reference internal" href="collections.html#module-collections" title="collections: High-performance datatypes"><code class="xref py py-mod docutils literal notranslate"><span class="pre">collections</span></code></a> module.)</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.4.</span></p> </div> <p>Like other collections, sets support <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">in</span> <span class="pre">set</span></code>, <code class="docutils literal notranslate"><span class="pre">len(set)</span></code>, and <code class="docutils literal notranslate"><span class="pre">for</span> <span class="pre">x</span> <span class="pre">in</span> <span class="pre">set</span></code>. Being an unordered collection, sets do not record element position or order of insertion. Accordingly, sets do not support indexing, slicing, or other sequence-like behavior.</p> <p>There are currently two built-in set types, <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> and <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a>. The <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> type is mutable — the contents can be changed using methods like <code class="xref py py-meth docutils literal notranslate"><span class="pre">add()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">remove()</span></code>. Since it is mutable, it has no hash value and cannot be used as either a dictionary key or as an element of another set. The <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a> type is immutable and <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a> — its contents cannot be altered after it is created; it can therefore be used as a dictionary key or as an element of another set.</p> <p>As of Python 2.7, non-empty sets (not frozensets) can be created by placing a comma-separated list of elements within braces, for example: <code class="docutils literal notranslate"><span class="pre">{'jack',</span> <span class="pre">'sjoerd'}</span></code>, in addition to the <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> constructor.</p> <p>The constructors for both classes work the same:</p> <dl class="class"> <dt id="set"> <em class="property">class </em><code class="descname">set</code><span class="sig-paren">(</span><span class="optional">[</span><em>iterable</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#set" title="Permalink to this definition">¶</a></dt> <dt id="frozenset"> <em class="property">class </em><code class="descname">frozenset</code><span class="sig-paren">(</span><span class="optional">[</span><em>iterable</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#frozenset" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new set or frozenset object whose elements are taken from <em>iterable</em>. The elements of a set must be <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>. To represent sets of sets, the inner sets must be <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a> objects. If <em>iterable</em> is not specified, a new empty set is returned.</p> <p>Instances of <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> and <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a> provide the following operations:</p> <dl class="describe"> <dt> <code class="descname">len(s)</code></dt> <dd><p>Return the number of elements in set <em>s</em> (cardinality of <em>s</em>).</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">x in s</code></dt> <dd><p>Test <em>x</em> for membership in <em>s</em>.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">x not in s</code></dt> <dd><p>Test <em>x</em> for non-membership in <em>s</em>.</p> </dd></dl> <dl class="method"> <dt id="frozenset.isdisjoint"> <code class="descname">isdisjoint</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.isdisjoint" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the set has no elements in common with <em>other</em>. Sets are disjoint if and only if their intersection is the empty set.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.issubset"> <code class="descname">issubset</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.issubset" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set <= other</code></dt> <dd><p>Test whether every element in the set is in <em>other</em>.</p> </dd></dl> <dl class="method"> <dt> <code class="descname">set < other</code></dt> <dd><p>Test whether the set is a proper subset of <em>other</em>, that is, <code class="docutils literal notranslate"><span class="pre">set</span> <span class="pre"><=</span> <span class="pre">other</span> <span class="pre">and</span> <span class="pre">set</span> <span class="pre">!=</span> <span class="pre">other</span></code>.</p> </dd></dl> <dl class="method"> <dt id="frozenset.issuperset"> <code class="descname">issuperset</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.issuperset" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set >= other</code></dt> <dd><p>Test whether every element in <em>other</em> is in the set.</p> </dd></dl> <dl class="method"> <dt> <code class="descname">set > other</code></dt> <dd><p>Test whether the set is a proper superset of <em>other</em>, that is, <code class="docutils literal notranslate"><span class="pre">set</span> <span class="pre">>=</span> <span class="pre">other</span> <span class="pre">and</span> <span class="pre">set</span> <span class="pre">!=</span> <span class="pre">other</span></code>.</p> </dd></dl> <dl class="method"> <dt id="frozenset.union"> <code class="descname">union</code><span class="sig-paren">(</span><em>*others</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.union" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set | other | ...</code></dt> <dd><p>Return a new set with elements from the set and all others.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Accepts multiple input iterables.</p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.intersection"> <code class="descname">intersection</code><span class="sig-paren">(</span><em>*others</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.intersection" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set & other & ...</code></dt> <dd><p>Return a new set with elements common to the set and all others.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Accepts multiple input iterables.</p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.difference"> <code class="descname">difference</code><span class="sig-paren">(</span><em>*others</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.difference" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set - other - ...</code></dt> <dd><p>Return a new set with elements in the set that are not in the others.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Accepts multiple input iterables.</p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.symmetric_difference"> <code class="descname">symmetric_difference</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.symmetric_difference" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set ^ other</code></dt> <dd><p>Return a new set with elements in either the set or <em>other</em> but not both.</p> </dd></dl> <dl class="method"> <dt id="frozenset.copy"> <code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.copy" title="Permalink to this definition">¶</a></dt> <dd><p>Return a shallow copy of the set.</p> </dd></dl> <p>Note, the non-operator versions of <a class="reference internal" href="#frozenset.union" title="frozenset.union"><code class="xref py py-meth docutils literal notranslate"><span class="pre">union()</span></code></a>, <a class="reference internal" href="#frozenset.intersection" title="frozenset.intersection"><code class="xref py py-meth docutils literal notranslate"><span class="pre">intersection()</span></code></a>, <a class="reference internal" href="#frozenset.difference" title="frozenset.difference"><code class="xref py py-meth docutils literal notranslate"><span class="pre">difference()</span></code></a>, and <a class="reference internal" href="#frozenset.symmetric_difference" title="frozenset.symmetric_difference"><code class="xref py py-meth docutils literal notranslate"><span class="pre">symmetric_difference()</span></code></a>, <a class="reference internal" href="#frozenset.issubset" title="frozenset.issubset"><code class="xref py py-meth docutils literal notranslate"><span class="pre">issubset()</span></code></a>, and <a class="reference internal" href="#frozenset.issuperset" title="frozenset.issuperset"><code class="xref py py-meth docutils literal notranslate"><span class="pre">issuperset()</span></code></a> methods will accept any iterable as an argument. In contrast, their operator based counterparts require their arguments to be sets. This precludes error-prone constructions like <code class="docutils literal notranslate"><span class="pre">set('abc')</span> <span class="pre">&</span> <span class="pre">'cbs'</span></code> in favor of the more readable <code class="docutils literal notranslate"><span class="pre">set('abc').intersection('cbs')</span></code>.</p> <p>Both <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> and <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a> support set to set comparisons. Two sets are equal if and only if every element of each set is contained in the other (each is a subset of the other). A set is less than another set if and only if the first set is a proper subset of the second set (is a subset, but is not equal). A set is greater than another set if and only if the first set is a proper superset of the second set (is a superset, but is not equal).</p> <p>Instances of <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> are compared to instances of <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a> based on their members. For example, <code class="docutils literal notranslate"><span class="pre">set('abc')</span> <span class="pre">==</span> <span class="pre">frozenset('abc')</span></code> returns <code class="docutils literal notranslate"><span class="pre">True</span></code> and so does <code class="docutils literal notranslate"><span class="pre">set('abc')</span> <span class="pre">in</span> <span class="pre">set([frozenset('abc')])</span></code>.</p> <p>The subset and equality comparisons do not generalize to a total ordering function. For example, any two non-empty disjoint sets are not equal and are not subsets of each other, so <em>all</em> of the following return <code class="docutils literal notranslate"><span class="pre">False</span></code>: <code class="docutils literal notranslate"><span class="pre">a<b</span></code>, <code class="docutils literal notranslate"><span class="pre">a==b</span></code>, or <code class="docutils literal notranslate"><span class="pre">a>b</span></code>. Accordingly, sets do not implement the <a class="reference internal" href="../reference/datamodel.html#object.__cmp__" title="object.__cmp__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__cmp__()</span></code></a> method.</p> <p>Since sets only define partial ordering (subset relationships), the output of the <code class="xref py py-meth docutils literal notranslate"><span class="pre">list.sort()</span></code> method is undefined for lists of sets.</p> <p>Set elements, like dictionary keys, must be <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>.</p> <p>Binary operations that mix <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> instances with <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a> return the type of the first operand. For example: <code class="docutils literal notranslate"><span class="pre">frozenset('ab')</span> <span class="pre">|</span> <span class="pre">set('bc')</span></code> returns an instance of <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a>.</p> <p>The following table lists operations available for <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a> that do not apply to immutable instances of <a class="reference internal" href="#frozenset" title="frozenset"><code class="xref py py-class docutils literal notranslate"><span class="pre">frozenset</span></code></a>:</p> <dl class="method"> <dt id="frozenset.update"> <code class="descname">update</code><span class="sig-paren">(</span><em>*others</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.update" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set |= other | ...</code></dt> <dd><p>Update the set, adding elements from all others.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Accepts multiple input iterables.</p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.intersection_update"> <code class="descname">intersection_update</code><span class="sig-paren">(</span><em>*others</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.intersection_update" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set &= other & ...</code></dt> <dd><p>Update the set, keeping only elements found in it and all others.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Accepts multiple input iterables.</p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.difference_update"> <code class="descname">difference_update</code><span class="sig-paren">(</span><em>*others</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.difference_update" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set -= other | ...</code></dt> <dd><p>Update the set, removing elements found in others.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Accepts multiple input iterables.</p> </div> </dd></dl> <dl class="method"> <dt id="frozenset.symmetric_difference_update"> <code class="descname">symmetric_difference_update</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.symmetric_difference_update" title="Permalink to this definition">¶</a></dt> <dt> <code class="descname">set ^= other</code></dt> <dd><p>Update the set, keeping only elements found in either set, but not in both.</p> </dd></dl> <dl class="method"> <dt id="frozenset.add"> <code class="descname">add</code><span class="sig-paren">(</span><em>elem</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.add" title="Permalink to this definition">¶</a></dt> <dd><p>Add element <em>elem</em> to the set.</p> </dd></dl> <dl class="method"> <dt id="frozenset.remove"> <code class="descname">remove</code><span class="sig-paren">(</span><em>elem</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.remove" title="Permalink to this definition">¶</a></dt> <dd><p>Remove element <em>elem</em> from the set. Raises <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> if <em>elem</em> is not contained in the set.</p> </dd></dl> <dl class="method"> <dt id="frozenset.discard"> <code class="descname">discard</code><span class="sig-paren">(</span><em>elem</em><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.discard" title="Permalink to this definition">¶</a></dt> <dd><p>Remove element <em>elem</em> from the set if it is present.</p> </dd></dl> <dl class="method"> <dt id="frozenset.pop"> <code class="descname">pop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.pop" title="Permalink to this definition">¶</a></dt> <dd><p>Remove and return an arbitrary element from the set. Raises <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> if the set is empty.</p> </dd></dl> <dl class="method"> <dt id="frozenset.clear"> <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#frozenset.clear" title="Permalink to this definition">¶</a></dt> <dd><p>Remove all elements from the set.</p> </dd></dl> <p>Note, the non-operator versions of the <a class="reference internal" href="#frozenset.update" title="frozenset.update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">update()</span></code></a>, <a class="reference internal" href="#frozenset.intersection_update" title="frozenset.intersection_update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">intersection_update()</span></code></a>, <a class="reference internal" href="#frozenset.difference_update" title="frozenset.difference_update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">difference_update()</span></code></a>, and <a class="reference internal" href="#frozenset.symmetric_difference_update" title="frozenset.symmetric_difference_update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">symmetric_difference_update()</span></code></a> methods will accept any iterable as an argument.</p> <p>Note, the <em>elem</em> argument to the <a class="reference internal" href="../reference/datamodel.html#object.__contains__" title="object.__contains__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__contains__()</span></code></a>, <a class="reference internal" href="#frozenset.remove" title="frozenset.remove"><code class="xref py py-meth docutils literal notranslate"><span class="pre">remove()</span></code></a>, and <a class="reference internal" href="#frozenset.discard" title="frozenset.discard"><code class="xref py py-meth docutils literal notranslate"><span class="pre">discard()</span></code></a> methods may be a set. To support searching for an equivalent frozenset, a temporary one is created from <em>elem</em>.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt><a class="reference internal" href="sets.html#comparison-to-builtin-set"><span class="std std-ref">Comparison to the built-in set types</span></a></dt> <dd>Differences between the <a class="reference internal" href="sets.html#module-sets" title="sets: Implementation of sets of unique elements. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sets</span></code></a> module and the built-in set types.</dd> </dl> </div> </div> <div class="section" id="mapping-types-dict"> <span id="typesmapping"></span><h2>5.8. Mapping Types — <a class="reference internal" href="#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a><a class="headerlink" href="#mapping-types-dict" title="Permalink to this headline">¶</a></h2> <p id="index-32">A <a class="reference internal" href="../glossary.html#term-mapping"><span class="xref std std-term">mapping</span></a> object maps <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a> values to arbitrary objects. Mappings are mutable objects. There is currently only one standard mapping type, the <em class="dfn">dictionary</em>. (For other containers see the built in <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>, <a class="reference internal" href="#set" title="set"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code></a>, and <a class="reference internal" href="functions.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> classes, and the <a class="reference internal" href="collections.html#module-collections" title="collections: High-performance datatypes"><code class="xref py py-mod docutils literal notranslate"><span class="pre">collections</span></code></a> module.)</p> <p>A dictionary’s keys are <em>almost</em> arbitrary values. Values that are not <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>, that is, values containing lists, dictionaries or other mutable types (that are compared by value rather than by object identity) may not be used as keys. Numeric types used for keys obey the normal rules for numeric comparison: if two numbers compare equal (such as <code class="docutils literal notranslate"><span class="pre">1</span></code> and <code class="docutils literal notranslate"><span class="pre">1.0</span></code>) then they can be used interchangeably to index the same dictionary entry. (Note however, that since computers store floating-point numbers as approximations it is usually unwise to use them as dictionary keys.)</p> <p>Dictionaries can be created by placing a comma-separated list of <code class="docutils literal notranslate"><span class="pre">key:</span> <span class="pre">value</span></code> pairs within braces, for example: <code class="docutils literal notranslate"><span class="pre">{'jack':</span> <span class="pre">4098,</span> <span class="pre">'sjoerd':</span> <span class="pre">4127}</span></code> or <code class="docutils literal notranslate"><span class="pre">{4098:</span> <span class="pre">'jack',</span> <span class="pre">4127:</span> <span class="pre">'sjoerd'}</span></code>, or by the <a class="reference internal" href="#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> constructor.</p> <dl class="class"> <dt id="dict"> <em class="property">class </em><code class="descname">dict</code><span class="sig-paren">(</span><em>**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#dict" title="Permalink to this definition">¶</a></dt> <dt> <em class="property">class </em><code class="descname">dict</code><span class="sig-paren">(</span><em>mapping</em>, <em>**kwarg</em><span class="sig-paren">)</span></dt> <dt> <em class="property">class </em><code class="descname">dict</code><span class="sig-paren">(</span><em>iterable</em>, <em>**kwarg</em><span class="sig-paren">)</span></dt> <dd><p>Return a new dictionary initialized from an optional positional argument and a possibly empty set of keyword arguments.</p> <p>If no positional argument is given, an empty dictionary is created. If a positional argument is given and it is a mapping object, a dictionary is created with the same key-value pairs as the mapping object. Otherwise, the positional argument must be an <a class="reference internal" href="../glossary.html#term-iterable"><span class="xref std std-term">iterable</span></a> object. Each item in the iterable must itself be an iterable with exactly two objects. The first object of each item becomes a key in the new dictionary, and the second object the corresponding value. If a key occurs more than once, the last value for that key becomes the corresponding value in the new dictionary.</p> <p>If keyword arguments are given, the keyword arguments and their values are added to the dictionary created from the positional argument. If a key being added is already present, the value from the keyword argument replaces the value from the positional argument.</p> <p>To illustrate, the following examples all return a dictionary equal to <code class="docutils literal notranslate"><span class="pre">{"one":</span> <span class="pre">1,</span> <span class="pre">"two":</span> <span class="pre">2,</span> <span class="pre">"three":</span> <span class="pre">3}</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">a</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">one</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">two</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">three</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">b</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'one'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">:</span> <span class="mi">3</span><span class="p">}</span> <span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">zip</span><span class="p">([</span><span class="s1">'one'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]))</span> <span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="s1">'two'</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="p">(</span><span class="s1">'one'</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="p">(</span><span class="s1">'three'</span><span class="p">,</span> <span class="mi">3</span><span class="p">)])</span> <span class="gp">>>> </span><span class="n">e</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">({</span><span class="s1">'three'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'one'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">:</span> <span class="mi">2</span><span class="p">})</span> <span class="gp">>>> </span><span class="n">a</span> <span class="o">==</span> <span class="n">b</span> <span class="o">==</span> <span class="n">c</span> <span class="o">==</span> <span class="n">d</span> <span class="o">==</span> <span class="n">e</span> <span class="go">True</span> </pre></div> </div> <p>Providing keyword arguments as in the first example only works for keys that are valid Python identifiers. Otherwise, any valid keys can be used.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.3: </span>Support for building a dictionary from keyword arguments added.</p> </div> <p>These are the operations that dictionaries support (and therefore, custom mapping types should support too):</p> <dl class="describe"> <dt> <code class="descname">len(d)</code></dt> <dd><p>Return the number of items in the dictionary <em>d</em>.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">d[key]</code></dt> <dd><p>Return the item of <em>d</em> with key <em>key</em>. Raises a <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> if <em>key</em> is not in the map.</p> <p id="index-33">If a subclass of dict defines a method <a class="reference internal" href="../reference/datamodel.html#object.__missing__" title="object.__missing__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__missing__()</span></code></a> and <em>key</em> is not present, the <code class="docutils literal notranslate"><span class="pre">d[key]</span></code> operation calls that method with the key <em>key</em> as argument. The <code class="docutils literal notranslate"><span class="pre">d[key]</span></code> operation then returns or raises whatever is returned or raised by the <code class="docutils literal notranslate"><span class="pre">__missing__(key)</span></code> call. No other operations or methods invoke <a class="reference internal" href="../reference/datamodel.html#object.__missing__" title="object.__missing__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__missing__()</span></code></a>. If <a class="reference internal" href="../reference/datamodel.html#object.__missing__" title="object.__missing__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__missing__()</span></code></a> is not defined, <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> is raised. <a class="reference internal" href="../reference/datamodel.html#object.__missing__" title="object.__missing__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__missing__()</span></code></a> must be a method; it cannot be an instance variable:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">class</span> <span class="nc">Counter</span><span class="p">(</span><span class="nb">dict</span><span class="p">):</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">__missing__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> <span class="gp">... </span> <span class="k">return</span> <span class="mi">0</span> <span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="n">Counter</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">c</span><span class="p">[</span><span class="s1">'red'</span><span class="p">]</span> <span class="go">0</span> <span class="gp">>>> </span><span class="n">c</span><span class="p">[</span><span class="s1">'red'</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span> <span class="gp">>>> </span><span class="n">c</span><span class="p">[</span><span class="s1">'red'</span><span class="p">]</span> <span class="go">1</span> </pre></div> </div> <p>The example above shows part of the implementation of <a class="reference internal" href="collections.html#collections.Counter" title="collections.Counter"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.Counter</span></code></a>. A different <code class="docutils literal notranslate"><span class="pre">__missing__</span></code> method is used by <a class="reference internal" href="collections.html#collections.defaultdict" title="collections.defaultdict"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.defaultdict</span></code></a>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.5: </span>Recognition of __missing__ methods of dict subclasses.</p> </div> </dd></dl> <dl class="describe"> <dt> <code class="descname">d[key] = value</code></dt> <dd><p>Set <code class="docutils literal notranslate"><span class="pre">d[key]</span></code> to <em>value</em>.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">del d[key]</code></dt> <dd><p>Remove <code class="docutils literal notranslate"><span class="pre">d[key]</span></code> from <em>d</em>. Raises a <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> if <em>key</em> is not in the map.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">key in d</code></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if <em>d</em> has a key <em>key</em>, else <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> </dd></dl> <dl class="describe"> <dt> <code class="descname">key not in d</code></dt> <dd><p>Equivalent to <code class="docutils literal notranslate"><span class="pre">not</span> <span class="pre">key</span> <span class="pre">in</span> <span class="pre">d</span></code>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> </dd></dl> <dl class="describe"> <dt> <code class="descname">iter(d)</code></dt> <dd><p>Return an iterator over the keys of the dictionary. This is a shortcut for <a class="reference internal" href="#dict.iterkeys" title="dict.iterkeys"><code class="xref py py-meth docutils literal notranslate"><span class="pre">iterkeys()</span></code></a>.</p> </dd></dl> <dl class="method"> <dt id="dict.clear"> <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.clear" title="Permalink to this definition">¶</a></dt> <dd><p>Remove all items from the dictionary.</p> </dd></dl> <dl class="method"> <dt id="dict.copy"> <code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.copy" title="Permalink to this definition">¶</a></dt> <dd><p>Return a shallow copy of the dictionary.</p> </dd></dl> <dl class="method"> <dt id="dict.fromkeys"> <code class="descname">fromkeys</code><span class="sig-paren">(</span><em>seq</em><span class="optional">[</span>, <em>value</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.fromkeys" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new dictionary with keys from <em>seq</em> and values set to <em>value</em>.</p> <p><a class="reference internal" href="#dict.fromkeys" title="dict.fromkeys"><code class="xref py py-func docutils literal notranslate"><span class="pre">fromkeys()</span></code></a> is a class method that returns a new dictionary. <em>value</em> defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.3.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.get"> <code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.get" title="Permalink to this definition">¶</a></dt> <dd><p>Return the value for <em>key</em> if <em>key</em> is in the dictionary, else <em>default</em>. If <em>default</em> is not given, it defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>, so that this method never raises a <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a>.</p> </dd></dl> <dl class="method"> <dt id="dict.has_key"> <code class="descname">has_key</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#dict.has_key" title="Permalink to this definition">¶</a></dt> <dd><p>Test for the presence of <em>key</em> in the dictionary. <a class="reference internal" href="#dict.has_key" title="dict.has_key"><code class="xref py py-meth docutils literal notranslate"><span class="pre">has_key()</span></code></a> is deprecated in favor of <code class="docutils literal notranslate"><span class="pre">key</span> <span class="pre">in</span> <span class="pre">d</span></code>.</p> </dd></dl> <dl class="method"> <dt id="dict.items"> <code class="descname">items</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.items" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the dictionary’s list of <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> pairs.</p> <div class="impl-detail compound"> <p><strong>CPython implementation detail:</strong> Keys and values are listed in an arbitrary order which is non-random, varies across Python implementations, and depends on the dictionary’s history of insertions and deletions.</p> </div> <p>If <a class="reference internal" href="#dict.items" title="dict.items"><code class="xref py py-meth docutils literal notranslate"><span class="pre">items()</span></code></a>, <a class="reference internal" href="#dict.keys" title="dict.keys"><code class="xref py py-meth docutils literal notranslate"><span class="pre">keys()</span></code></a>, <a class="reference internal" href="#dict.values" title="dict.values"><code class="xref py py-meth docutils literal notranslate"><span class="pre">values()</span></code></a>, <a class="reference internal" href="#dict.iteritems" title="dict.iteritems"><code class="xref py py-meth docutils literal notranslate"><span class="pre">iteritems()</span></code></a>, <a class="reference internal" href="#dict.iterkeys" title="dict.iterkeys"><code class="xref py py-meth docutils literal notranslate"><span class="pre">iterkeys()</span></code></a>, and <a class="reference internal" href="#dict.itervalues" title="dict.itervalues"><code class="xref py py-meth docutils literal notranslate"><span class="pre">itervalues()</span></code></a> are called with no intervening modifications to the dictionary, the lists will directly correspond. This allows the creation of <code class="docutils literal notranslate"><span class="pre">(value,</span> <span class="pre">key)</span></code> pairs using <a class="reference internal" href="functions.html#zip" title="zip"><code class="xref py py-func docutils literal notranslate"><span class="pre">zip()</span></code></a>: <code class="docutils literal notranslate"><span class="pre">pairs</span> <span class="pre">=</span> <span class="pre">zip(d.values(),</span> <span class="pre">d.keys())</span></code>. The same relationship holds for the <a class="reference internal" href="#dict.iterkeys" title="dict.iterkeys"><code class="xref py py-meth docutils literal notranslate"><span class="pre">iterkeys()</span></code></a> and <a class="reference internal" href="#dict.itervalues" title="dict.itervalues"><code class="xref py py-meth docutils literal notranslate"><span class="pre">itervalues()</span></code></a> methods: <code class="docutils literal notranslate"><span class="pre">pairs</span> <span class="pre">=</span> <span class="pre">zip(d.itervalues(),</span> <span class="pre">d.iterkeys())</span></code> provides the same value for <code class="docutils literal notranslate"><span class="pre">pairs</span></code>. Another way to create the same list is <code class="docutils literal notranslate"><span class="pre">pairs</span> <span class="pre">=</span> <span class="pre">[(v,</span> <span class="pre">k)</span> <span class="pre">for</span> <span class="pre">(k,</span> <span class="pre">v)</span> <span class="pre">in</span> <span class="pre">d.iteritems()]</span></code>.</p> </dd></dl> <dl class="method"> <dt id="dict.iteritems"> <code class="descname">iteritems</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.iteritems" title="Permalink to this definition">¶</a></dt> <dd><p>Return an iterator over the dictionary’s <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> pairs. See the note for <a class="reference internal" href="#dict.items" title="dict.items"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.items()</span></code></a>.</p> <p>Using <a class="reference internal" href="#dict.iteritems" title="dict.iteritems"><code class="xref py py-meth docutils literal notranslate"><span class="pre">iteritems()</span></code></a> while adding or deleting entries in the dictionary may raise a <a class="reference internal" href="exceptions.html#exceptions.RuntimeError" title="exceptions.RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> or fail to iterate over all entries.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.iterkeys"> <code class="descname">iterkeys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.iterkeys" title="Permalink to this definition">¶</a></dt> <dd><p>Return an iterator over the dictionary’s keys. See the note for <a class="reference internal" href="#dict.items" title="dict.items"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.items()</span></code></a>.</p> <p>Using <a class="reference internal" href="#dict.iterkeys" title="dict.iterkeys"><code class="xref py py-meth docutils literal notranslate"><span class="pre">iterkeys()</span></code></a> while adding or deleting entries in the dictionary may raise a <a class="reference internal" href="exceptions.html#exceptions.RuntimeError" title="exceptions.RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> or fail to iterate over all entries.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.itervalues"> <code class="descname">itervalues</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.itervalues" title="Permalink to this definition">¶</a></dt> <dd><p>Return an iterator over the dictionary’s values. See the note for <a class="reference internal" href="#dict.items" title="dict.items"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.items()</span></code></a>.</p> <p>Using <a class="reference internal" href="#dict.itervalues" title="dict.itervalues"><code class="xref py py-meth docutils literal notranslate"><span class="pre">itervalues()</span></code></a> while adding or deleting entries in the dictionary may raise a <a class="reference internal" href="exceptions.html#exceptions.RuntimeError" title="exceptions.RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> or fail to iterate over all entries.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.2.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.keys"> <code class="descname">keys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.keys" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the dictionary’s list of keys. See the note for <a class="reference internal" href="#dict.items" title="dict.items"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.items()</span></code></a>.</p> </dd></dl> <dl class="method"> <dt id="dict.pop"> <code class="descname">pop</code><span class="sig-paren">(</span><em>key</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.pop" title="Permalink to this definition">¶</a></dt> <dd><p>If <em>key</em> is in the dictionary, remove it and return its value, else return <em>default</em>. If <em>default</em> is not given and <em>key</em> is not in the dictionary, a <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a> is raised.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.3.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.popitem"> <code class="descname">popitem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.popitem" title="Permalink to this definition">¶</a></dt> <dd><p>Remove and return an arbitrary <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> pair from the dictionary.</p> <p><a class="reference internal" href="#dict.popitem" title="dict.popitem"><code class="xref py py-func docutils literal notranslate"><span class="pre">popitem()</span></code></a> is useful to destructively iterate over a dictionary, as often used in set algorithms. If the dictionary is empty, calling <a class="reference internal" href="#dict.popitem" title="dict.popitem"><code class="xref py py-func docutils literal notranslate"><span class="pre">popitem()</span></code></a> raises a <a class="reference internal" href="exceptions.html#exceptions.KeyError" title="exceptions.KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a>.</p> </dd></dl> <dl class="method"> <dt id="dict.setdefault"> <code class="descname">setdefault</code><span class="sig-paren">(</span><em>key</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.setdefault" title="Permalink to this definition">¶</a></dt> <dd><p>If <em>key</em> is in the dictionary, return its value. If not, insert <em>key</em> with a value of <em>default</em> and return <em>default</em>. <em>default</em> defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> </dd></dl> <dl class="method"> <dt id="dict.update"> <code class="descname">update</code><span class="sig-paren">(</span><span class="optional">[</span><em>other</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.update" title="Permalink to this definition">¶</a></dt> <dd><p>Update the dictionary with the key/value pairs from <em>other</em>, overwriting existing keys. Return <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <p><a class="reference internal" href="#dict.update" title="dict.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">update()</span></code></a> accepts either another dictionary object or an iterable of key/value pairs (as tuples or other iterables of length two). If keyword arguments are specified, the dictionary is then updated with those key/value pairs: <code class="docutils literal notranslate"><span class="pre">d.update(red=1,</span> <span class="pre">blue=2)</span></code>.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.4: </span>Allowed the argument to be an iterable of key/value pairs and allowed keyword arguments.</p> </div> </dd></dl> <dl class="method"> <dt id="dict.values"> <code class="descname">values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.values" title="Permalink to this definition">¶</a></dt> <dd><p>Return a copy of the dictionary’s list of values. See the note for <a class="reference internal" href="#dict.items" title="dict.items"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.items()</span></code></a>.</p> </dd></dl> <dl class="method"> <dt id="dict.viewitems"> <code class="descname">viewitems</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.viewitems" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new view of the dictionary’s items (<code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> pairs). See below for documentation of view objects.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.viewkeys"> <code class="descname">viewkeys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.viewkeys" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new view of the dictionary’s keys. See below for documentation of view objects.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> </dd></dl> <dl class="method"> <dt id="dict.viewvalues"> <code class="descname">viewvalues</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dict.viewvalues" title="Permalink to this definition">¶</a></dt> <dd><p>Return a new view of the dictionary’s values. See below for documentation of view objects.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> </dd></dl> <p>Dictionaries compare equal if and only if they have the same <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> pairs.</p> </dd></dl> <div class="section" id="dictionary-view-objects"> <span id="dict-views"></span><h3>5.8.1. Dictionary view objects<a class="headerlink" href="#dictionary-view-objects" title="Permalink to this headline">¶</a></h3> <p>The objects returned by <a class="reference internal" href="#dict.viewkeys" title="dict.viewkeys"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.viewkeys()</span></code></a>, <a class="reference internal" href="#dict.viewvalues" title="dict.viewvalues"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.viewvalues()</span></code></a> and <a class="reference internal" href="#dict.viewitems" title="dict.viewitems"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.viewitems()</span></code></a> are <em>view objects</em>. They provide a dynamic view on the dictionary’s entries, which means that when the dictionary changes, the view reflects these changes.</p> <p>Dictionary views can be iterated over to yield their respective data, and support membership tests:</p> <dl class="describe"> <dt> <code class="descname">len(dictview)</code></dt> <dd><p>Return the number of entries in the dictionary.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">iter(dictview)</code></dt> <dd><p>Return an iterator over the keys, values or items (represented as tuples of <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code>) in the dictionary.</p> <p>Keys and values are iterated over in an arbitrary order which is non-random, varies across Python implementations, and depends on the dictionary’s history of insertions and deletions. If keys, values and items views are iterated over with no intervening modifications to the dictionary, the order of items will directly correspond. This allows the creation of <code class="docutils literal notranslate"><span class="pre">(value,</span> <span class="pre">key)</span></code> pairs using <a class="reference internal" href="functions.html#zip" title="zip"><code class="xref py py-func docutils literal notranslate"><span class="pre">zip()</span></code></a>: <code class="docutils literal notranslate"><span class="pre">pairs</span> <span class="pre">=</span> <span class="pre">zip(d.values(),</span> <span class="pre">d.keys())</span></code>. Another way to create the same list is <code class="docutils literal notranslate"><span class="pre">pairs</span> <span class="pre">=</span> <span class="pre">[(v,</span> <span class="pre">k)</span> <span class="pre">for</span> <span class="pre">(k,</span> <span class="pre">v)</span> <span class="pre">in</span> <span class="pre">d.items()]</span></code>.</p> <p>Iterating views while adding or deleting entries in the dictionary may raise a <a class="reference internal" href="exceptions.html#exceptions.RuntimeError" title="exceptions.RuntimeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> or fail to iterate over all entries.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">x in dictview</code></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if <em>x</em> is in the underlying dictionary’s keys, values or items (in the latter case, <em>x</em> should be a <code class="docutils literal notranslate"><span class="pre">(key,</span> <span class="pre">value)</span></code> tuple).</p> </dd></dl> <p>Keys views are set-like since their entries are unique and hashable. If all values are hashable, so that (key, value) pairs are unique and hashable, then the items view is also set-like. (Values views are not treated as set-like since the entries are generally not unique.) Then these set operations are available (“other” refers either to another view or a set):</p> <dl class="describe"> <dt> <code class="descname">dictview & other</code></dt> <dd><p>Return the intersection of the dictview and the other object as a new set.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">dictview | other</code></dt> <dd><p>Return the union of the dictview and the other object as a new set.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">dictview - other</code></dt> <dd><p>Return the difference between the dictview and the other object (all elements in <em>dictview</em> that aren’t in <em>other</em>) as a new set.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname">dictview ^ other</code></dt> <dd><p>Return the symmetric difference (all elements either in <em>dictview</em> or <em>other</em>, but not in both) of the dictview and the other object as a new set.</p> </dd></dl> <p>An example of dictionary view usage:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">dishes</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'eggs'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s1">'sausage'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'bacon'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'spam'</span><span class="p">:</span> <span class="mi">500</span><span class="p">}</span> <span class="gp">>>> </span><span class="n">keys</span> <span class="o">=</span> <span class="n">dishes</span><span class="o">.</span><span class="n">viewkeys</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">values</span> <span class="o">=</span> <span class="n">dishes</span><span class="o">.</span><span class="n">viewvalues</span><span class="p">()</span> <span class="gp">>>> </span><span class="c1"># iteration</span> <span class="gp">>>> </span><span class="n">n</span> <span class="o">=</span> <span class="mi">0</span> <span class="gp">>>> </span><span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span> <span class="gp">... </span> <span class="n">n</span> <span class="o">+=</span> <span class="n">val</span> <span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="go">504</span> <span class="gp">>>> </span><span class="c1"># keys and values are iterated over in the same order</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="go">['eggs', 'bacon', 'sausage', 'spam']</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">values</span><span class="p">)</span> <span class="go">[2, 1, 1, 500]</span> <span class="gp">>>> </span><span class="c1"># view objects are dynamic and reflect dict changes</span> <span class="gp">>>> </span><span class="k">del</span> <span class="n">dishes</span><span class="p">[</span><span class="s1">'eggs'</span><span class="p">]</span> <span class="gp">>>> </span><span class="k">del</span> <span class="n">dishes</span><span class="p">[</span><span class="s1">'sausage'</span><span class="p">]</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="go">['spam', 'bacon']</span> <span class="gp">>>> </span><span class="c1"># set operations</span> <span class="gp">>>> </span><span class="n">keys</span> <span class="o">&</span> <span class="p">{</span><span class="s1">'eggs'</span><span class="p">,</span> <span class="s1">'bacon'</span><span class="p">,</span> <span class="s1">'salad'</span><span class="p">}</span> <span class="go">{'bacon'}</span> </pre></div> </div> </div> </div> <div class="section" id="file-objects"> <span id="bltin-file-objects"></span><h2>5.9. File Objects<a class="headerlink" href="#file-objects" title="Permalink to this headline">¶</a></h2> <p id="index-34">File objects are implemented using C’s <code class="docutils literal notranslate"><span class="pre">stdio</span></code> package and can be created with the built-in <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> function. File objects are also returned by some other built-in functions and methods, such as <a class="reference internal" href="os.html#os.popen" title="os.popen"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.popen()</span></code></a> and <a class="reference internal" href="os.html#os.fdopen" title="os.fdopen"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fdopen()</span></code></a> and the <code class="xref py py-meth docutils literal notranslate"><span class="pre">makefile()</span></code> method of socket objects. Temporary files can be created using the <a class="reference internal" href="tempfile.html#module-tempfile" title="tempfile: Generate temporary files and directories."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tempfile</span></code></a> module, and high-level file operations such as copying, moving, and deleting files and directories can be achieved with the <a class="reference internal" href="shutil.html#module-shutil" title="shutil: High-level file operations, including copying."><code class="xref py py-mod docutils literal notranslate"><span class="pre">shutil</span></code></a> module.</p> <p>When a file operation fails for an I/O-related reason, the exception <a class="reference internal" href="exceptions.html#exceptions.IOError" title="exceptions.IOError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IOError</span></code></a> is raised. This includes situations where the operation is not defined for some reason, like <code class="xref py py-meth docutils literal notranslate"><span class="pre">seek()</span></code> on a tty device or writing a file opened for reading.</p> <p>Files have the following methods:</p> <dl class="method"> <dt id="file.close"> <code class="descclassname">file.</code><code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.close" title="Permalink to this definition">¶</a></dt> <dd><p>Close the file. A closed file cannot be read or written any more. Any operation which requires that the file be open will raise a <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> after the file has been closed. Calling <a class="reference internal" href="#file.close" title="file.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> more than once is allowed.</p> <p>As of Python 2.5, you can avoid having to call this method explicitly if you use the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement. For example, the following code will automatically close <em>f</em> when the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> block is exited:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">with_statement</span> <span class="c1"># This isn't required in Python 2.6</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"hello.txt"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span> <span class="nb">print</span> <span class="n">line</span><span class="p">,</span> </pre></div> </div> <p>In older versions of Python, you would have needed to do this to get the same effect:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"hello.txt"</span><span class="p">)</span> <span class="k">try</span><span class="p">:</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span> <span class="nb">print</span> <span class="n">line</span><span class="p">,</span> <span class="k">finally</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> </pre></div> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Not all “file-like” types in Python support use as a context manager for the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement. If your code is intended to work with any file-like object, you can use the function <a class="reference internal" href="contextlib.html#contextlib.closing" title="contextlib.closing"><code class="xref py py-func docutils literal notranslate"><span class="pre">contextlib.closing()</span></code></a> instead of using the object directly.</p> </div> </dd></dl> <dl class="method"> <dt id="file.flush"> <code class="descclassname">file.</code><code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.flush" title="Permalink to this definition">¶</a></dt> <dd><p>Flush the internal buffer, like <code class="docutils literal notranslate"><span class="pre">stdio</span></code>’s <code class="xref c c-func docutils literal notranslate"><span class="pre">fflush()</span></code>. This may be a no-op on some file-like objects.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last"><a class="reference internal" href="#file.flush" title="file.flush"><code class="xref py py-meth docutils literal notranslate"><span class="pre">flush()</span></code></a> does not necessarily write the file’s data to disk. Use <a class="reference internal" href="#file.flush" title="file.flush"><code class="xref py py-meth docutils literal notranslate"><span class="pre">flush()</span></code></a> followed by <a class="reference internal" href="os.html#os.fsync" title="os.fsync"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.fsync()</span></code></a> to ensure this behavior.</p> </div> </dd></dl> <dl class="method"> <dt id="file.fileno"> <code class="descclassname">file.</code><code class="descname">fileno</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.fileno" title="Permalink to this definition">¶</a></dt> <dd><p id="index-35">Return the integer “file descriptor” that is used by the underlying implementation to request I/O operations from the operating system. This can be useful for other, lower level interfaces that use file descriptors, such as the <a class="reference internal" href="fcntl.html#module-fcntl" title="fcntl: The fcntl() and ioctl() system calls. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fcntl</span></code></a> module or <a class="reference internal" href="os.html#os.read" title="os.read"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.read()</span></code></a> and friends.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">File-like objects which do not have a real file descriptor should <em>not</em> provide this method!</p> </div> </dd></dl> <dl class="method"> <dt id="file.isatty"> <code class="descclassname">file.</code><code class="descname">isatty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.isatty" title="Permalink to this definition">¶</a></dt> <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the file is connected to a tty(-like) device, else <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If a file-like object is not associated with a real file, this method should <em>not</em> be implemented.</p> </div> </dd></dl> <dl class="method"> <dt id="file.next"> <code class="descclassname">file.</code><code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.next" title="Permalink to this definition">¶</a></dt> <dd><p>A file object is its own iterator, for example <code class="docutils literal notranslate"><span class="pre">iter(f)</span></code> returns <em>f</em> (unless <em>f</em> is closed). When a file is used as an iterator, typically in a <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">for</span></code></a> loop (for example, <code class="docutils literal notranslate"><span class="pre">for</span> <span class="pre">line</span> <span class="pre">in</span> <span class="pre">f:</span> <span class="pre">print</span> <span class="pre">line.strip()</span></code>), the <a class="reference internal" href="#file.next" title="file.next"><code class="xref py py-meth docutils literal notranslate"><span class="pre">next()</span></code></a> method is called repeatedly. This method returns the next input line, or raises <a class="reference internal" href="exceptions.html#exceptions.StopIteration" title="exceptions.StopIteration"><code class="xref py py-exc docutils literal notranslate"><span class="pre">StopIteration</span></code></a> when EOF is hit when the file is open for reading (behavior is undefined when the file is open for writing). In order to make a <a class="reference internal" href="../reference/compound_stmts.html#for"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">for</span></code></a> loop the most efficient way of looping over the lines of a file (a very common operation), the <a class="reference internal" href="#file.next" title="file.next"><code class="xref py py-meth docutils literal notranslate"><span class="pre">next()</span></code></a> method uses a hidden read-ahead buffer. As a consequence of using a read-ahead buffer, combining <a class="reference internal" href="#file.next" title="file.next"><code class="xref py py-meth docutils literal notranslate"><span class="pre">next()</span></code></a> with other file methods (like <a class="reference internal" href="#file.readline" title="file.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a>) does not work right. However, using <a class="reference internal" href="#file.seek" title="file.seek"><code class="xref py py-meth docutils literal notranslate"><span class="pre">seek()</span></code></a> to reposition the file to an absolute position will flush the read-ahead buffer.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.3.</span></p> </div> </dd></dl> <dl class="method"> <dt id="file.read"> <code class="descclassname">file.</code><code class="descname">read</code><span class="sig-paren">(</span><span class="optional">[</span><em>size</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#file.read" title="Permalink to this definition">¶</a></dt> <dd><p>Read at most <em>size</em> bytes from the file (less if the read hits EOF before obtaining <em>size</em> bytes). If the <em>size</em> argument is negative or omitted, read all data until EOF is reached. The bytes are returned as a string object. An empty string is returned when EOF is encountered immediately. (For certain files, like ttys, it makes sense to continue reading after an EOF is hit.) Note that this method may call the underlying C function <code class="xref c c-func docutils literal notranslate"><span class="pre">fread()</span></code> more than once in an effort to acquire as close to <em>size</em> bytes as possible. Also note that when in non-blocking mode, less data than was requested may be returned, even if no <em>size</em> parameter was given.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This function is simply a wrapper for the underlying <code class="xref c c-func docutils literal notranslate"><span class="pre">fread()</span></code> C function, and will behave the same in corner cases, such as whether the EOF value is cached.</p> </div> </dd></dl> <dl class="method"> <dt id="file.readline"> <code class="descclassname">file.</code><code class="descname">readline</code><span class="sig-paren">(</span><span class="optional">[</span><em>size</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#file.readline" title="Permalink to this definition">¶</a></dt> <dd><p>Read one entire line from the file. A trailing newline character is kept in the string (but may be absent when a file ends with an incomplete line). <a class="footnote-reference" href="#id17" id="id11">[6]</a> If the <em>size</em> argument is present and non-negative, it is a maximum byte count (including the trailing newline) and an incomplete line may be returned. When <em>size</em> is not 0, an empty string is returned <em>only</em> when EOF is encountered immediately.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Unlike <code class="docutils literal notranslate"><span class="pre">stdio</span></code>’s <code class="xref c c-func docutils literal notranslate"><span class="pre">fgets()</span></code>, the returned string contains null characters (<code class="docutils literal notranslate"><span class="pre">'\0'</span></code>) if they occurred in the input.</p> </div> </dd></dl> <dl class="method"> <dt id="file.readlines"> <code class="descclassname">file.</code><code class="descname">readlines</code><span class="sig-paren">(</span><span class="optional">[</span><em>sizehint</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#file.readlines" title="Permalink to this definition">¶</a></dt> <dd><p>Read until EOF using <a class="reference internal" href="#file.readline" title="file.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> and return a list containing the lines thus read. If the optional <em>sizehint</em> argument is present, instead of reading up to EOF, whole lines totalling approximately <em>sizehint</em> bytes (possibly after rounding up to an internal buffer size) are read. Objects implementing a file-like interface may choose to ignore <em>sizehint</em> if it cannot be implemented, or cannot be implemented efficiently.</p> </dd></dl> <dl class="method"> <dt id="file.xreadlines"> <code class="descclassname">file.</code><code class="descname">xreadlines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.xreadlines" title="Permalink to this definition">¶</a></dt> <dd><p>This method returns the same thing as <code class="docutils literal notranslate"><span class="pre">iter(f)</span></code>.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.1.</span></p> </div> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 2.3: </span>Use <code class="docutils literal notranslate"><span class="pre">for</span> <span class="pre">line</span> <span class="pre">in</span> <span class="pre">file</span></code> instead.</p> </div> </dd></dl> <dl class="method"> <dt id="file.seek"> <code class="descclassname">file.</code><code class="descname">seek</code><span class="sig-paren">(</span><em>offset</em><span class="optional">[</span>, <em>whence</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#file.seek" title="Permalink to this definition">¶</a></dt> <dd><p>Set the file’s current position, like <code class="docutils literal notranslate"><span class="pre">stdio</span></code>’s <code class="xref c c-func docutils literal notranslate"><span class="pre">fseek()</span></code>. The <em>whence</em> argument is optional and defaults to <code class="docutils literal notranslate"><span class="pre">os.SEEK_SET</span></code> or <code class="docutils literal notranslate"><span class="pre">0</span></code> (absolute file positioning); other values are <code class="docutils literal notranslate"><span class="pre">os.SEEK_CUR</span></code> or <code class="docutils literal notranslate"><span class="pre">1</span></code> (seek relative to the current position) and <code class="docutils literal notranslate"><span class="pre">os.SEEK_END</span></code> or <code class="docutils literal notranslate"><span class="pre">2</span></code> (seek relative to the file’s end). There is no return value.</p> <p>For example, <code class="docutils literal notranslate"><span class="pre">f.seek(2,</span> <span class="pre">os.SEEK_CUR)</span></code> advances the position by two and <code class="docutils literal notranslate"><span class="pre">f.seek(-3,</span> <span class="pre">os.SEEK_END)</span></code> sets the position to the third to last.</p> <p>Note that if the file is opened for appending (mode <code class="docutils literal notranslate"><span class="pre">'a'</span></code> or <code class="docutils literal notranslate"><span class="pre">'a+'</span></code>), any <a class="reference internal" href="#file.seek" title="file.seek"><code class="xref py py-meth docutils literal notranslate"><span class="pre">seek()</span></code></a> operations will be undone at the next write. If the file is only opened for writing in append mode (mode <code class="docutils literal notranslate"><span class="pre">'a'</span></code>), this method is essentially a no-op, but it remains useful for files opened in append mode with reading enabled (mode <code class="docutils literal notranslate"><span class="pre">'a+'</span></code>). If the file is opened in text mode (without <code class="docutils literal notranslate"><span class="pre">'b'</span></code>), only offsets returned by <a class="reference internal" href="#file.tell" title="file.tell"><code class="xref py py-meth docutils literal notranslate"><span class="pre">tell()</span></code></a> are legal. Use of other offsets causes undefined behavior.</p> <p>Note that not all file objects are seekable.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 2.6: </span>Passing float values as offset has been deprecated.</p> </div> </dd></dl> <dl class="method"> <dt id="file.tell"> <code class="descclassname">file.</code><code class="descname">tell</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#file.tell" title="Permalink to this definition">¶</a></dt> <dd><p>Return the file’s current position, like <code class="docutils literal notranslate"><span class="pre">stdio</span></code>’s <code class="xref c c-func docutils literal notranslate"><span class="pre">ftell()</span></code>.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">On Windows, <a class="reference internal" href="#file.tell" title="file.tell"><code class="xref py py-meth docutils literal notranslate"><span class="pre">tell()</span></code></a> can return illegal values (after an <code class="xref c c-func docutils literal notranslate"><span class="pre">fgets()</span></code>) when reading files with Unix-style line-endings. Use binary mode (<code class="docutils literal notranslate"><span class="pre">'rb'</span></code>) to circumvent this problem.</p> </div> </dd></dl> <dl class="method"> <dt id="file.truncate"> <code class="descclassname">file.</code><code class="descname">truncate</code><span class="sig-paren">(</span><span class="optional">[</span><em>size</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#file.truncate" title="Permalink to this definition">¶</a></dt> <dd><p>Truncate the file’s size. If the optional <em>size</em> argument is present, the file is truncated to (at most) that size. The size defaults to the current position. The current file position is not changed. Note that if a specified size exceeds the file’s current size, the result is platform-dependent: possibilities include that the file may remain unchanged, increase to the specified size as if zero-filled, or increase to the specified size with undefined new content. Availability: Windows, many Unix variants.</p> </dd></dl> <dl class="method"> <dt id="file.write"> <code class="descclassname">file.</code><code class="descname">write</code><span class="sig-paren">(</span><em>str</em><span class="sig-paren">)</span><a class="headerlink" href="#file.write" title="Permalink to this definition">¶</a></dt> <dd><p>Write a string to the file. There is no return value. Due to buffering, the string may not actually show up in the file until the <a class="reference internal" href="#file.flush" title="file.flush"><code class="xref py py-meth docutils literal notranslate"><span class="pre">flush()</span></code></a> or <a class="reference internal" href="#file.close" title="file.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> method is called.</p> </dd></dl> <dl class="method"> <dt id="file.writelines"> <code class="descclassname">file.</code><code class="descname">writelines</code><span class="sig-paren">(</span><em>sequence</em><span class="sig-paren">)</span><a class="headerlink" href="#file.writelines" title="Permalink to this definition">¶</a></dt> <dd><p>Write a sequence of strings to the file. The sequence can be any iterable object producing strings, typically a list of strings. There is no return value. (The name is intended to match <a class="reference internal" href="#file.readlines" title="file.readlines"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readlines()</span></code></a>; <a class="reference internal" href="#file.writelines" title="file.writelines"><code class="xref py py-meth docutils literal notranslate"><span class="pre">writelines()</span></code></a> does not add line separators.)</p> </dd></dl> <p>Files support the iterator protocol. Each iteration returns the same result as <a class="reference internal" href="#file.readline" title="file.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a>, and iteration ends when the <a class="reference internal" href="#file.readline" title="file.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a> method returns an empty string.</p> <p>File objects also offer a number of other interesting attributes. These are not required for file-like objects, but should be implemented if they make sense for the particular object.</p> <dl class="attribute"> <dt id="file.closed"> <code class="descclassname">file.</code><code class="descname">closed</code><a class="headerlink" href="#file.closed" title="Permalink to this definition">¶</a></dt> <dd><p>bool indicating the current state of the file object. This is a read-only attribute; the <a class="reference internal" href="#file.close" title="file.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> method changes the value. It may not be available on all file-like objects.</p> </dd></dl> <dl class="attribute"> <dt id="file.encoding"> <code class="descclassname">file.</code><code class="descname">encoding</code><a class="headerlink" href="#file.encoding" title="Permalink to this definition">¶</a></dt> <dd><p>The encoding that this file uses. When Unicode strings are written to a file, they will be converted to byte strings using this encoding. In addition, when the file is connected to a terminal, the attribute gives the encoding that the terminal is likely to use (that information might be incorrect if the user has misconfigured the terminal). The attribute is read-only and may not be present on all file-like objects. It may also be <code class="docutils literal notranslate"><span class="pre">None</span></code>, in which case the file uses the system default encoding for converting Unicode strings.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.3.</span></p> </div> </dd></dl> <dl class="attribute"> <dt id="file.errors"> <code class="descclassname">file.</code><code class="descname">errors</code><a class="headerlink" href="#file.errors" title="Permalink to this definition">¶</a></dt> <dd><p>The Unicode error handler used along with the encoding.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 2.6.</span></p> </div> </dd></dl> <dl class="attribute"> <dt id="file.mode"> <code class="descclassname">file.</code><code class="descname">mode</code><a class="headerlink" href="#file.mode" title="Permalink to this definition">¶</a></dt> <dd><p>The I/O mode for the file. If the file was created using the <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> built-in function, this will be the value of the <em>mode</em> parameter. This is a read-only attribute and may not be present on all file-like objects.</p> </dd></dl> <dl class="attribute"> <dt id="file.name"> <code class="descclassname">file.</code><code class="descname">name</code><a class="headerlink" href="#file.name" title="Permalink to this definition">¶</a></dt> <dd><p>If the file object was created using <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>, the name of the file. Otherwise, some string that indicates the source of the file object, of the form <code class="docutils literal notranslate"><span class="pre"><...></span></code>. This is a read-only attribute and may not be present on all file-like objects.</p> <span class="target" id="index-36"></span></dd></dl> <dl class="attribute"> <dt id="file.newlines"> <code class="descclassname">file.</code><code class="descname">newlines</code><a class="headerlink" href="#file.newlines" title="Permalink to this definition">¶</a></dt> <dd><p>If Python was built with <a class="reference internal" href="../glossary.html#term-universal-newlines"><span class="xref std std-term">universal newlines</span></a> enabled (the default) this read-only attribute exists, and for files opened in universal newline read mode it keeps track of the types of newlines encountered while reading the file. The values it can take are <code class="docutils literal notranslate"><span class="pre">'\r'</span></code>, <code class="docutils literal notranslate"><span class="pre">'\n'</span></code>, <code class="docutils literal notranslate"><span class="pre">'\r\n'</span></code>, <code class="docutils literal notranslate"><span class="pre">None</span></code> (unknown, no newlines read yet) or a tuple containing all the newline types seen, to indicate that multiple newline conventions were encountered. For files not opened in universal newlines read mode the value of this attribute will be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> </dd></dl> <dl class="attribute"> <dt id="file.softspace"> <code class="descclassname">file.</code><code class="descname">softspace</code><a class="headerlink" href="#file.softspace" title="Permalink to this definition">¶</a></dt> <dd><p>Boolean that indicates whether a space character needs to be printed before another value when using the <a class="reference internal" href="../reference/simple_stmts.html#print"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">print</span></code></a> statement. Classes that are trying to simulate a file object should also have a writable <a class="reference internal" href="#file.softspace" title="file.softspace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">softspace</span></code></a> attribute, which should be initialized to zero. This will be automatic for most classes implemented in Python (care may be needed for objects that override attribute access); types implemented in C will have to provide a writable <a class="reference internal" href="#file.softspace" title="file.softspace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">softspace</span></code></a> attribute.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">This attribute is not used to control the <a class="reference internal" href="../reference/simple_stmts.html#print"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">print</span></code></a> statement, but to allow the implementation of <a class="reference internal" href="../reference/simple_stmts.html#print"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">print</span></code></a> to keep track of its internal state.</p> </div> </dd></dl> </div> <div class="section" id="memoryview-type"> <span id="typememoryview"></span><h2>5.10. memoryview type<a class="headerlink" href="#memoryview-type" title="Permalink to this headline">¶</a></h2> <div class="versionadded"> <p><span class="versionmodified">New in version 2.7.</span></p> </div> <p><a class="reference internal" href="#memoryview" title="memoryview"><code class="xref py py-class docutils literal notranslate"><span class="pre">memoryview</span></code></a> objects allow Python code to access the internal data of an object that supports the buffer protocol without copying. Memory is generally interpreted as simple bytes.</p> <dl class="class"> <dt id="memoryview"> <em class="property">class </em><code class="descname">memoryview</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#memoryview" title="Permalink to this definition">¶</a></dt> <dd><p>Create a <a class="reference internal" href="#memoryview" title="memoryview"><code class="xref py py-class docutils literal notranslate"><span class="pre">memoryview</span></code></a> that references <em>obj</em>. <em>obj</em> must support the buffer protocol. Built-in objects that support the buffer protocol include <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> and <a class="reference internal" href="functions.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a> (but not <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-class docutils literal notranslate"><span class="pre">unicode</span></code></a>).</p> <p>A <a class="reference internal" href="#memoryview" title="memoryview"><code class="xref py py-class docutils literal notranslate"><span class="pre">memoryview</span></code></a> has the notion of an <em>element</em>, which is the atomic memory unit handled by the originating object <em>obj</em>. For many simple types such as <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> and <a class="reference internal" href="functions.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a>, an element is a single byte, but other third-party types may expose larger elements.</p> <p><code class="docutils literal notranslate"><span class="pre">len(view)</span></code> returns the total number of elements in the memoryview, <em>view</em>. The <a class="reference internal" href="#memoryview.itemsize" title="memoryview.itemsize"><code class="xref py py-class docutils literal notranslate"><span class="pre">itemsize</span></code></a> attribute will give you the number of bytes in a single element.</p> <p>A <a class="reference internal" href="#memoryview" title="memoryview"><code class="xref py py-class docutils literal notranslate"><span class="pre">memoryview</span></code></a> supports slicing to expose its data. Taking a single index will return a single element as a <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> object. Full slicing will result in a subview:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="nb">memoryview</span><span class="p">(</span><span class="s1">'abcefg'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="go">'b'</span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="go">'g'</span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">4</span><span class="p">]</span> <span class="go"><memory at 0x77ab28></span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">4</span><span class="p">]</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()</span> <span class="go">'bce'</span> </pre></div> </div> <p>If the object the memoryview is over supports changing its data, the memoryview supports slice assignment:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="nb">bytearray</span><span class="p">(</span><span class="s1">'abcefg'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="nb">memoryview</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">v</span><span class="o">.</span><span class="n">readonly</span> <span class="go">False</span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'z'</span> <span class="gp">>>> </span><span class="n">data</span> <span class="go">bytearray(b'zbcefg')</span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">4</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'123'</span> <span class="gp">>>> </span><span class="n">data</span> <span class="go">bytearray(b'z123fg')</span> <span class="gp">>>> </span><span class="n">v</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'spam'</span> <span class="gt">Traceback (most recent call last):</span> File <span class="nb">"<stdin>"</span>, line <span class="m">1</span>, in <span class="n"><module></span> <span class="gr">ValueError</span>: <span class="n">cannot modify size of memoryview object</span> </pre></div> </div> <p>Notice how the size of the memoryview object cannot be changed.</p> <p><a class="reference internal" href="#memoryview" title="memoryview"><code class="xref py py-class docutils literal notranslate"><span class="pre">memoryview</span></code></a> has two methods:</p> <dl class="method"> <dt id="memoryview.tobytes"> <code class="descname">tobytes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#memoryview.tobytes" title="Permalink to this definition">¶</a></dt> <dd><p>Return the data in the buffer as a bytestring (an object of class <a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>).</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="nb">memoryview</span><span class="p">(</span><span class="s2">"abc"</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()</span> <span class="go">'abc'</span> </pre></div> </div> </dd></dl> <dl class="method"> <dt id="memoryview.tolist"> <code class="descname">tolist</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#memoryview.tolist" title="Permalink to this definition">¶</a></dt> <dd><p>Return the data in the buffer as a list of integers.</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">memoryview</span><span class="p">(</span><span class="s2">"abc"</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span> <span class="go">[97, 98, 99]</span> </pre></div> </div> </dd></dl> <p>There are also several readonly attributes available:</p> <dl class="attribute"> <dt id="memoryview.format"> <code class="descname">format</code><a class="headerlink" href="#memoryview.format" title="Permalink to this definition">¶</a></dt> <dd><p>A string containing the format (in <a class="reference internal" href="struct.html#module-struct" title="struct: Interpret strings as packed binary data."><code class="xref py py-mod docutils literal notranslate"><span class="pre">struct</span></code></a> module style) for each element in the view. This defaults to <code class="docutils literal notranslate"><span class="pre">'B'</span></code>, a simple bytestring.</p> </dd></dl> <dl class="attribute"> <dt id="memoryview.itemsize"> <code class="descname">itemsize</code><a class="headerlink" href="#memoryview.itemsize" title="Permalink to this definition">¶</a></dt> <dd><p>The size in bytes of each element of the memoryview.</p> </dd></dl> <dl class="attribute"> <dt id="memoryview.shape"> <code class="descname">shape</code><a class="headerlink" href="#memoryview.shape" title="Permalink to this definition">¶</a></dt> <dd><p>A tuple of integers the length of <a class="reference internal" href="#memoryview.ndim" title="memoryview.ndim"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ndim</span></code></a> giving the shape of the memory as an N-dimensional array.</p> </dd></dl> <dl class="attribute"> <dt id="memoryview.ndim"> <code class="descname">ndim</code><a class="headerlink" href="#memoryview.ndim" title="Permalink to this definition">¶</a></dt> <dd><p>An integer indicating how many dimensions of a multi-dimensional array the memory represents.</p> </dd></dl> <dl class="attribute"> <dt id="memoryview.strides"> <code class="descname">strides</code><a class="headerlink" href="#memoryview.strides" title="Permalink to this definition">¶</a></dt> <dd><p>A tuple of integers the length of <a class="reference internal" href="#memoryview.ndim" title="memoryview.ndim"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ndim</span></code></a> giving the size in bytes to access each element for each dimension of the array.</p> </dd></dl> <dl class="attribute"> <dt id="memoryview.readonly"> <code class="descname">readonly</code><a class="headerlink" href="#memoryview.readonly" title="Permalink to this definition">¶</a></dt> <dd><p>A bool indicating whether the memory is read only.</p> </dd></dl> </dd></dl> </div> <div class="section" id="context-manager-types"> <span id="typecontextmanager"></span><h2>5.11. Context Manager Types<a class="headerlink" href="#context-manager-types" title="Permalink to this headline">¶</a></h2> <div class="versionadded"> <p><span class="versionmodified">New in version 2.5.</span></p> </div> <p id="index-37">Python’s <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement supports the concept of a runtime context defined by a context manager. This is implemented using two separate methods that allow user-defined classes to define a runtime context that is entered before the statement body is executed and exited when the statement ends.</p> <p>The <em class="dfn">context management protocol</em> consists of a pair of methods that need to be provided for a context manager object to define a runtime context:</p> <dl class="method"> <dt id="contextmanager.__enter__"> <code class="descclassname">contextmanager.</code><code class="descname">__enter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#contextmanager.__enter__" title="Permalink to this definition">¶</a></dt> <dd><p>Enter the runtime context and return either this object or another object related to the runtime context. The value returned by this method is bound to the identifier in the <a class="reference internal" href="../reference/compound_stmts.html#as"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">as</span></code></a> clause of <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statements using this context manager.</p> <p>An example of a context manager that returns itself is a file object. File objects return themselves from __enter__() to allow <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> to be used as the context expression in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.</p> <p>An example of a context manager that returns a related object is the one returned by <a class="reference internal" href="decimal.html#decimal.localcontext" title="decimal.localcontext"><code class="xref py py-func docutils literal notranslate"><span class="pre">decimal.localcontext()</span></code></a>. These managers set the active decimal context to a copy of the original decimal context and then return the copy. This allows changes to be made to the current decimal context in the body of the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement without affecting code outside the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.</p> </dd></dl> <dl class="method"> <dt id="contextmanager.__exit__"> <code class="descclassname">contextmanager.</code><code class="descname">__exit__</code><span class="sig-paren">(</span><em>exc_type</em>, <em>exc_val</em>, <em>exc_tb</em><span class="sig-paren">)</span><a class="headerlink" href="#contextmanager.__exit__" title="Permalink to this definition">¶</a></dt> <dd><p>Exit the runtime context and return a Boolean flag indicating if any exception that occurred should be suppressed. If an exception occurred while executing the body of the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement, the arguments contain the exception type, value and traceback information. Otherwise, all three arguments are <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> <p>Returning a true value from this method will cause the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement to suppress the exception and continue execution with the statement immediately following the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement. Otherwise the exception continues propagating after this method has finished executing. Exceptions that occur during execution of this method will replace any exception that occurred in the body of the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.</p> <p>The exception passed in should never be reraised explicitly - instead, this method should return a false value to indicate that the method completed successfully and does not want to suppress the raised exception. This allows context management code (such as <code class="docutils literal notranslate"><span class="pre">contextlib.nested</span></code>) to easily detect whether or not an <a class="reference internal" href="#contextmanager.__exit__" title="contextmanager.__exit__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__exit__()</span></code></a> method has actually failed.</p> </dd></dl> <p>Python defines several context managers to support easy thread synchronisation, prompt closure of files or other objects, and simpler manipulation of the active decimal arithmetic context. The specific types are not treated specially beyond their implementation of the context management protocol. See the <a class="reference internal" href="contextlib.html#module-contextlib" title="contextlib: Utilities for with-statement contexts."><code class="xref py py-mod docutils literal notranslate"><span class="pre">contextlib</span></code></a> module for some examples.</p> <p>Python’s <a class="reference internal" href="../glossary.html#term-generator"><span class="xref std std-term">generator</span></a>s and the <code class="docutils literal notranslate"><span class="pre">contextlib.contextmanager</span></code> <a class="reference internal" href="../glossary.html#term-decorator"><span class="xref std std-term">decorator</span></a> provide a convenient way to implement these protocols. If a generator function is decorated with the <code class="docutils literal notranslate"><span class="pre">contextlib.contextmanager</span></code> decorator, it will return a context manager implementing the necessary <a class="reference internal" href="../reference/datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__enter__()</span></code></a> and <a class="reference internal" href="../reference/datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__exit__()</span></code></a> methods, rather than the iterator produced by an undecorated generator function.</p> <p>Note that there is no specific slot for any of these methods in the type structure for Python objects in the Python/C API. Extension types wanting to define these methods must provide them as a normal Python accessible method. Compared to the overhead of setting up the runtime context, the overhead of a single class dictionary lookup is negligible.</p> </div> <div class="section" id="other-built-in-types"> <span id="typesother"></span><h2>5.12. Other Built-in Types<a class="headerlink" href="#other-built-in-types" title="Permalink to this headline">¶</a></h2> <p>The interpreter supports several other kinds of objects. Most of these support only one or two operations.</p> <div class="section" id="modules"> <span id="typesmodules"></span><h3>5.12.1. Modules<a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h3> <p>The only special operation on a module is attribute access: <code class="docutils literal notranslate"><span class="pre">m.name</span></code>, where <em>m</em> is a module and <em>name</em> accesses a name defined in <em>m</em>’s symbol table. Module attributes can be assigned to. (Note that the <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">import</span></code></a> statement is not, strictly speaking, an operation on a module object; <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">foo</span></code> does not require a module object named <em>foo</em> to exist, rather it requires an (external) <em>definition</em> for a module named <em>foo</em> somewhere.)</p> <p>A special attribute of every module is <a class="reference internal" href="#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>. This is the dictionary containing the module’s symbol table. Modifying this dictionary will actually change the module’s symbol table, but direct assignment to the <a class="reference internal" href="#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> attribute is not possible (you can write <code class="docutils literal notranslate"><span class="pre">m.__dict__['a']</span> <span class="pre">=</span> <span class="pre">1</span></code>, which defines <code class="docutils literal notranslate"><span class="pre">m.a</span></code> to be <code class="docutils literal notranslate"><span class="pre">1</span></code>, but you can’t write <code class="docutils literal notranslate"><span class="pre">m.__dict__</span> <span class="pre">=</span> <span class="pre">{}</span></code>). Modifying <a class="reference internal" href="#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> directly is not recommended.</p> <p>Modules built into the interpreter are written like this: <code class="docutils literal notranslate"><span class="pre"><module</span> <span class="pre">'sys'</span> <span class="pre">(built-in)></span></code>. If loaded from a file, they are written as <code class="docutils literal notranslate"><span class="pre"><module</span> <span class="pre">'os'</span> <span class="pre">from</span> <span class="pre">'/usr/local/lib/pythonX.Y/os.pyc'></span></code>.</p> </div> <div class="section" id="classes-and-class-instances"> <span id="typesobjects"></span><h3>5.12.2. Classes and Class Instances<a class="headerlink" href="#classes-and-class-instances" title="Permalink to this headline">¶</a></h3> <p>See <a class="reference internal" href="../reference/datamodel.html#objects"><span class="std std-ref">Objects, values and types</span></a> and <a class="reference internal" href="../reference/compound_stmts.html#class"><span class="std std-ref">Class definitions</span></a> for these.</p> </div> <div class="section" id="functions"> <span id="typesfunctions"></span><h3>5.12.3. Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> <p>Function objects are created by function definitions. The only operation on a function object is to call it: <code class="docutils literal notranslate"><span class="pre">func(argument-list)</span></code>.</p> <p>There are really two flavors of function objects: built-in functions and user-defined functions. Both support the same operation (to call the function), but the implementation is different, hence the different object types.</p> <p>See <a class="reference internal" href="../reference/compound_stmts.html#function"><span class="std std-ref">Function definitions</span></a> for more information.</p> </div> <div class="section" id="methods"> <span id="typesmethods"></span><h3>5.12.4. Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h3> <p id="index-38">Methods are functions that are called using the attribute notation. There are two flavors: built-in methods (such as <code class="xref py py-meth docutils literal notranslate"><span class="pre">append()</span></code> on lists) and class instance methods. Built-in methods are described with the types that support them.</p> <p>The implementation adds two special read-only attributes to class instance methods: <code class="docutils literal notranslate"><span class="pre">m.im_self</span></code> is the object on which the method operates, and <code class="docutils literal notranslate"><span class="pre">m.im_func</span></code> is the function implementing the method. Calling <code class="docutils literal notranslate"><span class="pre">m(arg-1,</span> <span class="pre">arg-2,</span> <span class="pre">...,</span> <span class="pre">arg-n)</span></code> is completely equivalent to calling <code class="docutils literal notranslate"><span class="pre">m.im_func(m.im_self,</span> <span class="pre">arg-1,</span> <span class="pre">arg-2,</span> <span class="pre">...,</span> <span class="pre">arg-n)</span></code>.</p> <p>Class instance methods are either <em>bound</em> or <em>unbound</em>, referring to whether the method was accessed through an instance or a class, respectively. When a method is unbound, its <code class="docutils literal notranslate"><span class="pre">im_self</span></code> attribute will be <code class="docutils literal notranslate"><span class="pre">None</span></code> and if called, an explicit <code class="docutils literal notranslate"><span class="pre">self</span></code> object must be passed as the first argument. In this case, <code class="docutils literal notranslate"><span class="pre">self</span></code> must be an instance of the unbound method’s class (or a subclass of that class), otherwise a <a class="reference internal" href="exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> is raised.</p> <p>Like function objects, methods objects support getting arbitrary attributes. However, since method attributes are actually stored on the underlying function object (<code class="docutils literal notranslate"><span class="pre">meth.im_func</span></code>), setting method attributes on either bound or unbound methods is disallowed. Attempting to set an attribute on a method results in an <a class="reference internal" href="exceptions.html#exceptions.AttributeError" title="exceptions.AttributeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AttributeError</span></code></a> being raised. In order to set a method attribute, you need to explicitly set it on the underlying function object:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">class</span> <span class="nc">C</span><span class="p">:</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">method</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="gp">... </span> <span class="k">pass</span> <span class="gp">...</span> <span class="gp">>>> </span><span class="n">c</span> <span class="o">=</span> <span class="n">C</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">c</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">whoami</span> <span class="o">=</span> <span class="s1">'my name is method'</span> <span class="c1"># can't set on the method</span> <span class="gt">Traceback (most recent call last):</span> File <span class="nb">"<stdin>"</span>, line <span class="m">1</span>, in <span class="n"><module></span> <span class="gr">AttributeError</span>: <span class="n">'instancemethod' object has no attribute 'whoami'</span> <span class="gp">>>> </span><span class="n">c</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">im_func</span><span class="o">.</span><span class="n">whoami</span> <span class="o">=</span> <span class="s1">'my name is method'</span> <span class="gp">>>> </span><span class="n">c</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">whoami</span> <span class="go">'my name is method'</span> </pre></div> </div> <p>See <a class="reference internal" href="../reference/datamodel.html#types"><span class="std std-ref">The standard type hierarchy</span></a> for more information.</p> </div> <div class="section" id="code-objects"> <span id="bltin-code-objects"></span><span id="index-39"></span><h3>5.12.5. Code Objects<a class="headerlink" href="#code-objects" title="Permalink to this headline">¶</a></h3> <p id="index-40">Code objects are used by the implementation to represent “pseudo-compiled” executable Python code such as a function body. They differ from function objects because they don’t contain a reference to their global execution environment. Code objects are returned by the built-in <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate"><span class="pre">compile()</span></code></a> function and can be extracted from function objects through their <code class="xref py py-attr docutils literal notranslate"><span class="pre">func_code</span></code> attribute. See also the <a class="reference internal" href="code.html#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-mod docutils literal notranslate"><span class="pre">code</span></code></a> module.</p> <p id="index-41">A code object can be executed or evaluated by passing it (instead of a source string) to the <a class="reference internal" href="../reference/simple_stmts.html#exec"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">exec</span></code></a> statement or the built-in <a class="reference internal" href="functions.html#eval" title="eval"><code class="xref py py-func docutils literal notranslate"><span class="pre">eval()</span></code></a> function.</p> <p>See <a class="reference internal" href="../reference/datamodel.html#types"><span class="std std-ref">The standard type hierarchy</span></a> for more information.</p> </div> <div class="section" id="type-objects"> <span id="bltin-type-objects"></span><h3>5.12.6. Type Objects<a class="headerlink" href="#type-objects" title="Permalink to this headline">¶</a></h3> <p id="index-42">Type objects represent the various object types. An object’s type is accessed by the built-in function <a class="reference internal" href="functions.html#type" title="type"><code class="xref py py-func docutils literal notranslate"><span class="pre">type()</span></code></a>. There are no special operations on types. The standard module <a class="reference internal" href="types.html#module-types" title="types: Names for built-in types."><code class="xref py py-mod docutils literal notranslate"><span class="pre">types</span></code></a> defines names for all standard built-in types.</p> <p>Types are written like this: <code class="docutils literal notranslate"><span class="pre"><type</span> <span class="pre">'int'></span></code>.</p> </div> <div class="section" id="the-null-object"> <span id="bltin-null-object"></span><h3>5.12.7. The Null Object<a class="headerlink" href="#the-null-object" title="Permalink to this headline">¶</a></h3> <p>This object is returned by functions that don’t explicitly return a value. It supports no special operations. There is exactly one null object, named <code class="docutils literal notranslate"><span class="pre">None</span></code> (a built-in name).</p> <p>It is written as <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p> </div> <div class="section" id="the-ellipsis-object"> <span id="bltin-ellipsis-object"></span><h3>5.12.8. The Ellipsis Object<a class="headerlink" href="#the-ellipsis-object" title="Permalink to this headline">¶</a></h3> <p>This object is used by extended slice notation (see <a class="reference internal" href="../reference/expressions.html#slicings"><span class="std std-ref">Slicings</span></a>). It supports no special operations. There is exactly one ellipsis object, named <a class="reference internal" href="constants.html#Ellipsis" title="Ellipsis"><code class="xref py py-const docutils literal notranslate"><span class="pre">Ellipsis</span></code></a> (a built-in name).</p> <p>It is written as <code class="docutils literal notranslate"><span class="pre">Ellipsis</span></code>. When in a subscript, it can also be written as <code class="docutils literal notranslate"><span class="pre">...</span></code>, for example <code class="docutils literal notranslate"><span class="pre">seq[...]</span></code>.</p> </div> <div class="section" id="the-notimplemented-object"> <h3>5.12.9. The NotImplemented Object<a class="headerlink" href="#the-notimplemented-object" title="Permalink to this headline">¶</a></h3> <p>This object is returned from comparisons and binary operations when they are asked to operate on types they don’t support. See <a class="reference internal" href="../reference/expressions.html#comparisons"><span class="std std-ref">Comparisons</span></a> for more information.</p> <p>It is written as <code class="docutils literal notranslate"><span class="pre">NotImplemented</span></code>.</p> </div> <div class="section" id="boolean-values"> <h3>5.12.10. Boolean Values<a class="headerlink" href="#boolean-values" title="Permalink to this headline">¶</a></h3> <p>Boolean values are the two constant objects <code class="docutils literal notranslate"><span class="pre">False</span></code> and <code class="docutils literal notranslate"><span class="pre">True</span></code>. They are used to represent truth values (although other values can also be considered false or true). In numeric contexts (for example when used as the argument to an arithmetic operator), they behave like the integers 0 and 1, respectively. The built-in function <a class="reference internal" href="functions.html#bool" title="bool"><code class="xref py py-func docutils literal notranslate"><span class="pre">bool()</span></code></a> can be used to convert any value to a Boolean, if the value can be interpreted as a truth value (see section <a class="reference internal" href="#truth"><span class="std std-ref">Truth Value Testing</span></a> above).</p> <p id="index-43">They are written as <code class="docutils literal notranslate"><span class="pre">False</span></code> and <code class="docutils literal notranslate"><span class="pre">True</span></code>, respectively.</p> </div> <div class="section" id="internal-objects"> <span id="typesinternal"></span><h3>5.12.11. Internal Objects<a class="headerlink" href="#internal-objects" title="Permalink to this headline">¶</a></h3> <p>See <a class="reference internal" href="../reference/datamodel.html#types"><span class="std std-ref">The standard type hierarchy</span></a> for this information. It describes stack frame objects, traceback objects, and slice objects.</p> </div> </div> <div class="section" id="special-attributes"> <span id="specialattrs"></span><h2>5.13. Special Attributes<a class="headerlink" href="#special-attributes" title="Permalink to this headline">¶</a></h2> <p>The implementation adds a few special read-only attributes to several object types, where they are relevant. Some of these are not reported by the <a class="reference internal" href="functions.html#dir" title="dir"><code class="xref py py-func docutils literal notranslate"><span class="pre">dir()</span></code></a> built-in function.</p> <dl class="attribute"> <dt id="object.__dict__"> <code class="descclassname">object.</code><code class="descname">__dict__</code><a class="headerlink" href="#object.__dict__" title="Permalink to this definition">¶</a></dt> <dd><p>A dictionary or other mapping object used to store an object’s (writable) attributes.</p> </dd></dl> <dl class="attribute"> <dt id="object.__methods__"> <code class="descclassname">object.</code><code class="descname">__methods__</code><a class="headerlink" href="#object.__methods__" title="Permalink to this definition">¶</a></dt> <dd><div class="deprecated"> <p><span class="versionmodified">Deprecated since version 2.2: </span>Use the built-in function <a class="reference internal" href="functions.html#dir" title="dir"><code class="xref py py-func docutils literal notranslate"><span class="pre">dir()</span></code></a> to get a list of an object’s attributes. This attribute is no longer available.</p> </div> </dd></dl> <dl class="attribute"> <dt id="object.__members__"> <code class="descclassname">object.</code><code class="descname">__members__</code><a class="headerlink" href="#object.__members__" title="Permalink to this definition">¶</a></dt> <dd><div class="deprecated"> <p><span class="versionmodified">Deprecated since version 2.2: </span>Use the built-in function <a class="reference internal" href="functions.html#dir" title="dir"><code class="xref py py-func docutils literal notranslate"><span class="pre">dir()</span></code></a> to get a list of an object’s attributes. This attribute is no longer available.</p> </div> </dd></dl> <dl class="attribute"> <dt id="instance.__class__"> <code class="descclassname">instance.</code><code class="descname">__class__</code><a class="headerlink" href="#instance.__class__" title="Permalink to this definition">¶</a></dt> <dd><p>The class to which a class instance belongs.</p> </dd></dl> <dl class="attribute"> <dt id="class.__bases__"> <code class="descclassname">class.</code><code class="descname">__bases__</code><a class="headerlink" href="#class.__bases__" title="Permalink to this definition">¶</a></dt> <dd><p>The tuple of base classes of a class object.</p> </dd></dl> <dl class="attribute"> <dt id="definition.__name__"> <code class="descclassname">definition.</code><code class="descname">__name__</code><a class="headerlink" href="#definition.__name__" title="Permalink to this definition">¶</a></dt> <dd><p>The name of the class, type, function, method, descriptor, or generator instance.</p> </dd></dl> <p>The following attributes are only supported by <a class="reference internal" href="../glossary.html#term-new-style-class"><span class="xref std std-term">new-style class</span></a>es.</p> <dl class="attribute"> <dt id="class.__mro__"> <code class="descclassname">class.</code><code class="descname">__mro__</code><a class="headerlink" href="#class.__mro__" title="Permalink to this definition">¶</a></dt> <dd><p>This attribute is a tuple of classes that are considered when looking for base classes during method resolution.</p> </dd></dl> <dl class="method"> <dt id="class.mro"> <code class="descclassname">class.</code><code class="descname">mro</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#class.mro" title="Permalink to this definition">¶</a></dt> <dd><p>This method can be overridden by a metaclass to customize the method resolution order for its instances. It is called at class instantiation, and its result is stored in <a class="reference internal" href="#class.__mro__" title="class.__mro__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__mro__</span></code></a>.</p> </dd></dl> <dl class="method"> <dt id="class.__subclasses__"> <code class="descclassname">class.</code><code class="descname">__subclasses__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#class.__subclasses__" title="Permalink to this definition">¶</a></dt> <dd><p>Each new-style class keeps a list of weak references to its immediate subclasses. This method returns a list of all those references still alive. Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">int</span><span class="o">.</span><span class="n">__subclasses__</span><span class="p">()</span> <span class="go">[<type 'bool'>]</span> </pre></div> </div> </dd></dl> <p class="rubric">Footnotes</p> <table class="docutils footnote" frame="void" id="id12" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Additional information on these special methods may be found in the Python Reference Manual (<a class="reference internal" href="../reference/datamodel.html#customization"><span class="std std-ref">Basic customization</span></a>).</td></tr> </tbody> </table> <table class="docutils footnote" frame="void" id="id13" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>As a consequence, the list <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">2]</span></code> is considered equal to <code class="docutils literal notranslate"><span class="pre">[1.0,</span> <span class="pre">2.0]</span></code>, and similarly for tuples.</td></tr> </tbody> </table> <table class="docutils footnote" frame="void" id="id14" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id4">[3]</a></td><td>They must have since the parser can’t tell the type of the operands.</td></tr> </tbody> </table> <table class="docutils footnote" frame="void" id="id15" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label">[4]</td><td><em>(<a class="fn-backref" href="#id6">1</a>, <a class="fn-backref" href="#id7">2</a>, <a class="fn-backref" href="#id8">3</a>, <a class="fn-backref" href="#id9">4</a>)</em> Cased characters are those with general category property being one of “Lu” (Letter, uppercase), “Ll” (Letter, lowercase), or “Lt” (Letter, titlecase).</td></tr> </tbody> </table> <table class="docutils footnote" frame="void" id="id16" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id10">[5]</a></td><td>To format only a tuple you should therefore provide a singleton tuple whose only element is the tuple to be formatted.</td></tr> </tbody> </table> <table class="docutils footnote" frame="void" id="id17" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id11">[6]</a></td><td>The advantage of leaving the newline on is that returning an empty string is then an unambiguous EOF indication. It is also possible (in cases where it might matter, for example, if you want to make an exact copy of a file while scanning its lines) to tell whether the last line of a file ended in a newline or not (yes this happens!).</td></tr> </tbody> </table> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#">5. Built-in Types</a><ul> <li><a class="reference internal" href="#truth-value-testing">5.1. Truth Value Testing</a></li> <li><a class="reference internal" href="#boolean-operations-and-or-not">5.2. Boolean Operations — <code class="docutils literal notranslate"><span class="pre">and</span></code>, <code class="docutils literal notranslate"><span class="pre">or</span></code>, <code class="docutils literal notranslate"><span class="pre">not</span></code></a></li> <li><a class="reference internal" href="#comparisons">5.3. Comparisons</a></li> <li><a class="reference internal" href="#numeric-types-int-float-long-complex">5.4. Numeric Types — <code class="docutils literal notranslate"><span class="pre">int</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>, <code class="docutils literal notranslate"><span class="pre">long</span></code>, <code class="docutils literal notranslate"><span class="pre">complex</span></code></a><ul> <li><a class="reference internal" href="#bitwise-operations-on-integer-types">5.4.1. Bitwise Operations on Integer Types</a></li> <li><a class="reference internal" href="#additional-methods-on-integer-types">5.4.2. Additional Methods on Integer Types</a></li> <li><a class="reference internal" href="#additional-methods-on-float">5.4.3. Additional Methods on Float</a></li> </ul> </li> <li><a class="reference internal" href="#iterator-types">5.5. Iterator Types</a><ul> <li><a class="reference internal" href="#generator-types">5.5.1. Generator Types</a></li> </ul> </li> <li><a class="reference internal" href="#sequence-types-str-unicode-list-tuple-bytearray-buffer-xrange">5.6. Sequence Types — <code class="docutils literal notranslate"><span class="pre">str</span></code>, <code class="docutils literal notranslate"><span class="pre">unicode</span></code>, <code class="docutils literal notranslate"><span class="pre">list</span></code>, <code class="docutils literal notranslate"><span class="pre">tuple</span></code>, <code class="docutils literal notranslate"><span class="pre">bytearray</span></code>, <code class="docutils literal notranslate"><span class="pre">buffer</span></code>, <code class="docutils literal notranslate"><span class="pre">xrange</span></code></a><ul> <li><a class="reference internal" href="#string-methods">5.6.1. String Methods</a></li> <li><a class="reference internal" href="#string-formatting-operations">5.6.2. String Formatting Operations</a></li> <li><a class="reference internal" href="#xrange-type">5.6.3. XRange Type</a></li> <li><a class="reference internal" href="#mutable-sequence-types">5.6.4. Mutable Sequence Types</a></li> </ul> </li> <li><a class="reference internal" href="#set-types-set-frozenset">5.7. Set Types — <code class="docutils literal notranslate"><span class="pre">set</span></code>, <code class="docutils literal notranslate"><span class="pre">frozenset</span></code></a></li> <li><a class="reference internal" href="#mapping-types-dict">5.8. Mapping Types — <code class="docutils literal notranslate"><span class="pre">dict</span></code></a><ul> <li><a class="reference internal" href="#dictionary-view-objects">5.8.1. Dictionary view objects</a></li> </ul> </li> <li><a class="reference internal" href="#file-objects">5.9. File Objects</a></li> <li><a class="reference internal" href="#memoryview-type">5.10. memoryview type</a></li> <li><a class="reference internal" href="#context-manager-types">5.11. Context Manager Types</a></li> <li><a class="reference internal" href="#other-built-in-types">5.12. Other Built-in Types</a><ul> <li><a class="reference internal" href="#modules">5.12.1. Modules</a></li> <li><a class="reference internal" href="#classes-and-class-instances">5.12.2. Classes and Class Instances</a></li> <li><a class="reference internal" href="#functions">5.12.3. Functions</a></li> <li><a class="reference internal" href="#methods">5.12.4. Methods</a></li> <li><a class="reference internal" href="#code-objects">5.12.5. Code Objects</a></li> <li><a class="reference internal" href="#type-objects">5.12.6. Type Objects</a></li> <li><a class="reference internal" href="#the-null-object">5.12.7. The Null Object</a></li> <li><a class="reference internal" href="#the-ellipsis-object">5.12.8. The Ellipsis Object</a></li> <li><a class="reference internal" href="#the-notimplemented-object">5.12.9. The NotImplemented Object</a></li> <li><a class="reference internal" href="#boolean-values">5.12.10. Boolean Values</a></li> <li><a class="reference internal" href="#internal-objects">5.12.11. Internal Objects</a></li> </ul> </li> <li><a class="reference internal" href="#special-attributes">5.13. Special Attributes</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="constants.html" title="previous chapter">4. Built-in Constants</a></p> <h4>Next topic</h4> <p class="topless"><a href="exceptions.html" title="next chapter">6. Built-in Exceptions</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/library/stdtypes.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <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> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="exceptions.html" title="6. Built-in Exceptions" >next</a> |</li> <li class="right" > <a href="constants.html" title="4. Built-in Constants" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.18 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on December 09, 2024. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.5. </div> </body> </html>