Gecko [ v99win.today ]

Name	Size	Permission
abstract.html	7.8 KB	-rw-r--r--
allocation.html	24.04 KB	-rw-r--r--
arg.html	64.25 KB	-rw-r--r--
bool.html	11.44 KB	-rw-r--r--
buffer.html	58.49 KB	-rw-r--r--
bytearray.html	18.39 KB	-rw-r--r--
capsule.html	26.78 KB	-rw-r--r--
cell.html	13.74 KB	-rw-r--r--
class.html	14.3 KB	-rw-r--r--
cobject.html	15.67 KB	-rw-r--r--
code.html	15.57 KB	-rw-r--r--
codec.html	29.28 KB	-rw-r--r--
complex.html	25.03 KB	-rw-r--r--
concrete.html	15.93 KB	-rw-r--r--
conversion.html	29.24 KB	-rw-r--r--
datetime.html	35.92 KB	-rw-r--r--
descriptor.html	15.74 KB	-rw-r--r--
dict.html	42.03 KB	-rw-r--r--
exceptions.html	112.66 KB	-rw-r--r--
file.html	28.8 KB	-rw-r--r--
float.html	21.5 KB	-rw-r--r--
function.html	17.69 KB	-rw-r--r--
gcsupport.html	29.5 KB	-rw-r--r--
gen.html	9.84 KB	-rw-r--r--
import.html	43.14 KB	-rw-r--r--
index.html	13.69 KB	-rw-r--r--
init.html	122.91 KB	-rw-r--r--
int.html	24.28 KB	-rw-r--r--
intro.html	57.73 KB	-rw-r--r--
iter.html	11.38 KB	-rw-r--r--
iterator.html	13.32 KB	-rw-r--r--
list.html	31.45 KB	-rw-r--r--
long.html	39.54 KB	-rw-r--r--
mapping.html	20.85 KB	-rw-r--r--
marshal.html	18.82 KB	-rw-r--r--
memory.html	37.51 KB	-rw-r--r--
method.html	16.77 KB	-rw-r--r--
module.html	21.95 KB	-rw-r--r--
none.html	8.76 KB	-rw-r--r--
number.html	64.95 KB	-rw-r--r--
objbuffer.html	14.62 KB	-rw-r--r--
object.html	74.9 KB	-rw-r--r--
objimpl.html	7.59 KB	-rw-r--r--
refcounting.html	14.46 KB	-rw-r--r--
reflection.html	12.81 KB	-rw-r--r--
sequence.html	41.73 KB	-rw-r--r--
set.html	35.44 KB	-rw-r--r--
slice.html	16.89 KB	-rw-r--r--
string.html	46.73 KB	-rw-r--r--
structures.html	41.96 KB	-rw-r--r--
sys.html	26.72 KB	-rw-r--r--
tuple.html	27.17 KB	-rw-r--r--
type.html	19.18 KB	-rw-r--r--
typeobj.html	209.91 KB	-rw-r--r--
unicode.html	160.87 KB	-rw-r--r--
utilities.html	7.88 KB	-rw-r--r--
veryhigh.html	66.91 KB	-rw-r--r--
weakref.html	15.68 KB	-rw-r--r--

Code Editor : mapping.html

<!DOCTYPE html>

<title>Mapping Protocol &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script 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="Iterator Protocol" href="iter.html" />
 <link rel="prev" title="Sequence Protocol" href="sequence.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/c-api/mapping.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/c-api/mapping.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="iter.html" title="Iterator Protocol"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="sequence.html" title="Sequence Protocol"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="abstract.html" accesskey="U">Abstract Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Mapping Protocol</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="mapping-protocol">
<h1>Mapping Protocol<a class="headerlink" href="#mapping-protocol" title="Permalink to this headline">¶</a></h1>
<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_Check">
int PyMapping_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyMapping_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> if the object provides mapping protocol, and <code class="docutils literal notranslate">0</code> otherwise. This
function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_Size">
Py_ssize_t PyMapping_Size(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyMapping_Size" title="Permalink to this definition">¶</a> </dt>
<dt class="sig sig-object c" id="c.PyMapping_Length">
Py_ssize_t PyMapping_Length(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyMapping_Length" title="Permalink to this definition">¶</a> </dt>
<dd>Returns the number of keys in object o on success, and <code class="docutils literal notranslate">-1</code> on failure. For
objects that do not provide mapping protocol, this is equivalent to the Python
expression <code class="docutils literal notranslate">len(o)</code>.
<div class="versionchanged">
Changed in version 2.5: These functions returned an <code class="xref c c-type docutils literal notranslate">int</code> type. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_DelItemString">
int PyMapping_DelItemString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, char *key)<a class="headerlink" href="#c.PyMapping_DelItemString" title="Permalink to this definition">¶</a> </dt>
<dd>Remove the mapping for object key from the object o. Return <code class="docutils literal notranslate">-1</code> on
failure. This is equivalent to the Python statement <code class="docutils literal notranslate">del o[key]</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_DelItem">
int PyMapping_DelItem(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PyMapping_DelItem" title="Permalink to this definition">¶</a> </dt>
<dd>Remove the mapping for object key from the object o. Return <code class="docutils literal notranslate">-1</code> on
failure. This is equivalent to the Python statement <code class="docutils literal notranslate">del o[key]</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_HasKeyString">
int PyMapping_HasKeyString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, char *key)<a class="headerlink" href="#c.PyMapping_HasKeyString" title="Permalink to this definition">¶</a> </dt>
<dd>On success, return <code class="docutils literal notranslate">1</code> if the mapping object has the key key and <code class="docutils literal notranslate">0</code>
otherwise. This is equivalent to <code class="docutils literal notranslate">o[key]</code>, returning <code class="docutils literal notranslate">True</code> on success
and <code class="docutils literal notranslate">False</code> on an exception. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_HasKey">
int PyMapping_HasKey(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *key)<a class="headerlink" href="#c.PyMapping_HasKey" title="Permalink to this definition">¶</a> </dt>
<dd>Return <code class="docutils literal notranslate">1</code> if the mapping object has the key key and <code class="docutils literal notranslate">0</code> otherwise.
This is equivalent to <code class="docutils literal notranslate">o[key]</code>, returning <code class="docutils literal notranslate">True</code> on success and <code class="docutils literal notranslate">False</code>
on an exception. This function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_Keys">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMapping_Keys(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyMapping_Keys" title="Permalink to this definition">¶</a> </dt>
<dd>On success, return a list of the keys in object o. On failure, return NULL.
This is equivalent to the Python expression <code class="docutils literal notranslate">o.keys()</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_Values">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMapping_Values(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyMapping_Values" title="Permalink to this definition">¶</a> </dt>
<dd>On success, return a list of the values in object o. On failure, return
NULL. This is equivalent to the Python expression <code class="docutils literal notranslate">o.values()</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_Items">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMapping_Items(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyMapping_Items" title="Permalink to this definition">¶</a> </dt>
<dd>On success, return a list of the items in object o, where each item is a tuple
containing a key-value pair. On failure, return NULL. This is equivalent to
the Python expression <code class="docutils literal notranslate">o.items()</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_GetItemString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyMapping_GetItemString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, char *key)<a class="headerlink" href="#c.PyMapping_GetItemString" title="Permalink to this definition">¶</a> </dt>
<dd>Return element of o corresponding to the object key or NULL on failure.
This is the equivalent of the Python expression <code class="docutils literal notranslate">o[key]</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyMapping_SetItemString">
int PyMapping_SetItemString(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o, char *key, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *v)<a class="headerlink" href="#c.PyMapping_SetItemString" title="Permalink to this definition">¶</a> </dt>
<dd>Map the object key to the value v in object o. Returns <code class="docutils literal notranslate">-1</code> on failure.
This is the equivalent of the Python statement <code class="docutils literal notranslate">o[key] = v</code>.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="sequence.html"
 title="previous chapter">Sequence Protocol</a>
 <h4>Next topic</h4>
 <a href="iter.html"
 title="next chapter">Iterator Protocol</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/c-api/mapping.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#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="iter.html" title="Iterator Protocol"
 >next</a> |</li>
 <li class="right" >
 <a href="sequence.html" title="Sequence Protocol"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="abstract.html" >Abstract Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Mapping Protocol</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : mapping.html