<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Dictionary Objects — Python v3.1.1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '3.1.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v3.1.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python v3.1.1 documentation" href="../index.html" />
<link rel="up" title="Concrete Objects Layer" href="concrete.html" />
<link rel="next" title="Set Objects" href="set.html" />
<link rel="prev" title="List Objects" href="list.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="set.html" title="Set Objects"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="list.html" title="List Objects"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v3.1.1 documentation</a> »</li>
<li><a href="index.html" >Python/C API Reference Manual</a> »</li>
<li><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="dictionary-objects">
<span id="dictobjects"></span><h1>Dictionary Objects<a class="headerlink" href="#dictionary-objects" title="Permalink to this headline">¶</a></h1>
<span class="target" id="index-11"></span><dl class="ctype">
<dt id="PyDictObject">
<tt class="descname">PyDictObject</tt><a class="headerlink" href="#PyDictObject" title="Permalink to this definition">¶</a></dt>
<dd>This subtype of <a title="PyObject" class="reference external" href="structures.html#PyObject"><tt class="xref docutils literal"><span class="pre">PyObject</span></tt></a> represents a Python dictionary object.</dd></dl>
<dl class="cvar">
<dt id="PyDict_Type">
<a title="PyTypeObject" class="reference external" href="type.html#PyTypeObject">PyTypeObject</a> <tt class="descname">PyDict_Type</tt><a class="headerlink" href="#PyDict_Type" title="Permalink to this definition">¶</a></dt>
<dd><p id="index-12">This instance of <a title="PyTypeObject" class="reference external" href="type.html#PyTypeObject"><tt class="xref docutils literal"><span class="pre">PyTypeObject</span></tt></a> represents the Python dictionary
type. This is exposed to Python programs as <tt class="docutils literal"><span class="pre">dict</span></tt> and
<tt class="docutils literal"><span class="pre">types.DictType</span></tt>.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Check">
int <tt class="descname">PyDict_Check</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Check" title="Permalink to this definition">¶</a></dt>
<dd>Return true if <em>p</em> is a dict object or an instance of a subtype of the dict
type.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_CheckExact">
int <tt class="descname">PyDict_CheckExact</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_CheckExact" title="Permalink to this definition">¶</a></dt>
<dd>Return true if <em>p</em> is a dict object, but not an instance of a subtype of
the dict type.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_New">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_New</tt><big>(</big><big>)</big><a class="headerlink" href="#PyDict_New" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Return a new empty dictionary, or <em>NULL</em> on failure.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDictProxy_New">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDictProxy_New</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *dict</em><big>)</big><a class="headerlink" href="#PyDictProxy_New" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Return a proxy object for a mapping which enforces read-only behavior.
This is normally used to create a proxy to prevent modification of the
dictionary for non-dynamic class types.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Clear">
void <tt class="descname">PyDict_Clear</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Clear" title="Permalink to this definition">¶</a></dt>
<dd>Empty an existing dictionary of all key-value pairs.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Contains">
int <tt class="descname">PyDict_Contains</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *key</em><big>)</big><a class="headerlink" href="#PyDict_Contains" title="Permalink to this definition">¶</a></dt>
<dd>Determine if dictionary <em>p</em> contains <em>key</em>. If an item in <em>p</em> is matches
<em>key</em>, return <tt class="docutils literal"><span class="pre">1</span></tt>, otherwise return <tt class="docutils literal"><span class="pre">0</span></tt>. On error, return <tt class="docutils literal"><span class="pre">-1</span></tt>.
This is equivalent to the Python expression <tt class="docutils literal"><span class="pre">key</span> <span class="pre">in</span> <span class="pre">p</span></tt>.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Copy">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_Copy</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Copy" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Return a new dictionary that contains the same key-value pairs as <em>p</em>.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_SetItem">
int <tt class="descname">PyDict_SetItem</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *key</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *val</em><big>)</big><a class="headerlink" href="#PyDict_SetItem" title="Permalink to this definition">¶</a></dt>
<dd>Insert <em>value</em> into the dictionary <em>p</em> with a key of <em>key</em>. <em>key</em> must be
<a class="reference external" href="../glossary.html#term-hashable"><em class="xref">hashable</em></a>; if it isn’t, <a title="exceptions.TypeError" class="reference external" href="../library/exceptions.html#exceptions.TypeError"><tt class="xref docutils literal"><span class="pre">TypeError</span></tt></a> will be raised. Return
<tt class="docutils literal"><span class="pre">0</span></tt> on success or <tt class="docutils literal"><span class="pre">-1</span></tt> on failure.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_SetItemString">
int <tt class="descname">PyDict_SetItemString</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, const char<em> *key</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *val</em><big>)</big><a class="headerlink" href="#PyDict_SetItemString" title="Permalink to this definition">¶</a></dt>
<dd><p id="index-13">Insert <em>value</em> into the dictionary <em>p</em> using <em>key</em> as a key. <em>key</em> should
be a <tt class="xref docutils literal"><span class="pre">char*</span></tt>. The key object is created using
<tt class="docutils literal"><span class="pre">PyUnicode_FromString(key)</span></tt>. Return <tt class="docutils literal"><span class="pre">0</span></tt> on success or <tt class="docutils literal"><span class="pre">-1</span></tt> on
failure.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_DelItem">
int <tt class="descname">PyDict_DelItem</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *key</em><big>)</big><a class="headerlink" href="#PyDict_DelItem" title="Permalink to this definition">¶</a></dt>
<dd>Remove the entry in dictionary <em>p</em> with key <em>key</em>. <em>key</em> must be hashable;
if it isn’t, <a title="exceptions.TypeError" class="reference external" href="../library/exceptions.html#exceptions.TypeError"><tt class="xref docutils literal"><span class="pre">TypeError</span></tt></a> is raised. Return <tt class="docutils literal"><span class="pre">0</span></tt> on success or <tt class="docutils literal"><span class="pre">-1</span></tt>
on failure.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_DelItemString">
int <tt class="descname">PyDict_DelItemString</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, char<em> *key</em><big>)</big><a class="headerlink" href="#PyDict_DelItemString" title="Permalink to this definition">¶</a></dt>
<dd>Remove the entry in dictionary <em>p</em> which has a key specified by the string
<em>key</em>. Return <tt class="docutils literal"><span class="pre">0</span></tt> on success or <tt class="docutils literal"><span class="pre">-1</span></tt> on failure.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_GetItem">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_GetItem</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *key</em><big>)</big><a class="headerlink" href="#PyDict_GetItem" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: Borrowed reference.</em><p>Return the object from dictionary <em>p</em> which has a key <em>key</em>. Return <em>NULL</em>
if the key <em>key</em> is not present, but <em>without</em> setting an exception.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_GetItemWithError">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_GetItemWithError</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *key</em><big>)</big><a class="headerlink" href="#PyDict_GetItemWithError" title="Permalink to this definition">¶</a></dt>
<dd>Variant of <a title="PyDict_GetItem" class="reference internal" href="#PyDict_GetItem"><tt class="xref docutils literal"><span class="pre">PyDict_GetItem()</span></tt></a> that does not suppress
exceptions. Return <em>NULL</em> <strong>with</strong> an exception set if an exception
occurred. Return <em>NULL</em> <strong>without</strong> an exception set if the key
wasn’t present.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_GetItemString">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_GetItemString</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, const char<em> *key</em><big>)</big><a class="headerlink" href="#PyDict_GetItemString" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: Borrowed reference.</em><p>This is the same as <a title="PyDict_GetItem" class="reference internal" href="#PyDict_GetItem"><tt class="xref docutils literal"><span class="pre">PyDict_GetItem()</span></tt></a>, but <em>key</em> is specified as a
<tt class="xref docutils literal"><span class="pre">char*</span></tt>, rather than a <a title="PyObject" class="reference external" href="structures.html#PyObject"><tt class="xref docutils literal"><span class="pre">PyObject*</span></tt></a>.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Items">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_Items</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Items" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Return a <a title="PyListObject" class="reference external" href="list.html#PyListObject"><tt class="xref docutils literal"><span class="pre">PyListObject</span></tt></a> containing all the items from the
dictionary, as in the dictionary method <a title="dict.items" class="reference external" href="../library/stdtypes.html#dict.items"><tt class="xref docutils literal"><span class="pre">dict.items()</span></tt></a>.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Keys">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_Keys</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Keys" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Return a <a title="PyListObject" class="reference external" href="list.html#PyListObject"><tt class="xref docutils literal"><span class="pre">PyListObject</span></tt></a> containing all the keys from the dictionary,
as in the dictionary method <a title="dict.keys" class="reference external" href="../library/stdtypes.html#dict.keys"><tt class="xref docutils literal"><span class="pre">dict.keys()</span></tt></a>.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Values">
<a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyDict_Values</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Values" title="Permalink to this definition">¶</a></dt>
<dd><em class="refcount">Return value: New reference.</em><p>Return a <a title="PyListObject" class="reference external" href="list.html#PyListObject"><tt class="xref docutils literal"><span class="pre">PyListObject</span></tt></a> containing all the values from the
dictionary <em>p</em>, as in the dictionary method <a title="dict.values" class="reference external" href="../library/stdtypes.html#dict.values"><tt class="xref docutils literal"><span class="pre">dict.values()</span></tt></a>.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Size">
Py_ssize_t <tt class="descname">PyDict_Size</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em><big>)</big><a class="headerlink" href="#PyDict_Size" title="Permalink to this definition">¶</a></dt>
<dd><p id="index-14">Return the number of items in the dictionary. This is equivalent to
<tt class="docutils literal"><span class="pre">len(p)</span></tt> on a dictionary.</p>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Next">
int <tt class="descname">PyDict_Next</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *p</em>, Py_ssize_t<em> *ppos</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> **pkey</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> **pvalue</em><big>)</big><a class="headerlink" href="#PyDict_Next" title="Permalink to this definition">¶</a></dt>
<dd><p>Iterate over all key-value pairs in the dictionary <em>p</em>. The
<tt class="xref docutils literal"><span class="pre">Py_ssize_t</span></tt> referred to by <em>ppos</em> must be initialized to <tt class="docutils literal"><span class="pre">0</span></tt>
prior to the first call to this function to start the iteration; the
function returns true for each pair in the dictionary, and false once all
pairs have been reported. The parameters <em>pkey</em> and <em>pvalue</em> should either
point to <a title="PyObject" class="reference external" href="structures.html#PyObject"><tt class="xref docutils literal"><span class="pre">PyObject*</span></tt></a> variables that will be filled in with each key
and value, respectively, or may be <em>NULL</em>. Any references returned through
them are borrowed. <em>ppos</em> should not be altered during iteration. Its
value represents offsets within the internal dictionary structure, and
since the structure is sparse, the offsets are not consecutive.</p>
<p>For example:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">PyObject</span> <span class="o">*</span><span class="n">key</span><span class="p">,</span> <span class="o">*</span><span class="n">value</span><span class="p">;</span>
<span class="n">Py_ssize_t</span> <span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="k">while</span> <span class="p">(</span><span class="n">PyDict_Next</span><span class="p">(</span><span class="n">self</span><span class="o">-></span><span class="n">dict</span><span class="p">,</span> <span class="o">&</span><span class="n">pos</span><span class="p">,</span> <span class="o">&</span><span class="n">key</span><span class="p">,</span> <span class="o">&</span><span class="n">value</span><span class="p">))</span> <span class="p">{</span>
<span class="c">/* do something interesting with the values... */</span>
<span class="p">...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The dictionary <em>p</em> should not be mutated during iteration. It is safe to
modify the values of the keys as you iterate over the dictionary, but only
so long as the set of keys does not change. For example:</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">PyObject</span> <span class="o">*</span><span class="n">key</span><span class="p">,</span> <span class="o">*</span><span class="n">value</span><span class="p">;</span>
<span class="n">Py_ssize_t</span> <span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
<span class="k">while</span> <span class="p">(</span><span class="n">PyDict_Next</span><span class="p">(</span><span class="n">self</span><span class="o">-></span><span class="n">dict</span><span class="p">,</span> <span class="o">&</span><span class="n">pos</span><span class="p">,</span> <span class="o">&</span><span class="n">key</span><span class="p">,</span> <span class="o">&</span><span class="n">value</span><span class="p">))</span> <span class="p">{</span>
<span class="kt">long</span> <span class="n">i</span> <span class="o">=</span> <span class="n">PyLong_AsLong</span><span class="p">(</span><span class="n">value</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">i</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span> <span class="o">&&</span> <span class="n">PyErr_Occurred</span><span class="p">())</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">-</span><span class="mi">1</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">PyObject</span> <span class="o">*</span><span class="n">o</span> <span class="o">=</span> <span class="n">PyLong_FromLong</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">o</span> <span class="o">==</span> <span class="nb">NULL</span><span class="p">)</span>
<span class="k">return</span> <span class="o">-</span><span class="mi">1</span><span class="p">;</span>
<span class="k">if</span> <span class="p">(</span><span class="n">PyDict_SetItem</span><span class="p">(</span><span class="n">self</span><span class="o">-></span><span class="n">dict</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">o</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="n">Py_DECREF</span><span class="p">(</span><span class="n">o</span><span class="p">);</span>
<span class="k">return</span> <span class="o">-</span><span class="mi">1</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">Py_DECREF</span><span class="p">(</span><span class="n">o</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Merge">
int <tt class="descname">PyDict_Merge</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *a</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *b</em>, int<em> override</em><big>)</big><a class="headerlink" href="#PyDict_Merge" title="Permalink to this definition">¶</a></dt>
<dd>Iterate over mapping object <em>b</em> adding key-value pairs to dictionary <em>a</em>.
<em>b</em> may be a dictionary, or any object supporting <a title="PyMapping_Keys" class="reference external" href="mapping.html#PyMapping_Keys"><tt class="xref docutils literal"><span class="pre">PyMapping_Keys()</span></tt></a>
and <a title="PyObject_GetItem" class="reference external" href="object.html#PyObject_GetItem"><tt class="xref docutils literal"><span class="pre">PyObject_GetItem()</span></tt></a>. If <em>override</em> is true, existing pairs in <em>a</em>
will be replaced if a matching key is found in <em>b</em>, otherwise pairs will
only be added if there is not a matching key in <em>a</em>. Return <tt class="docutils literal"><span class="pre">0</span></tt> on
success or <tt class="docutils literal"><span class="pre">-1</span></tt> if an exception was raised.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_Update">
int <tt class="descname">PyDict_Update</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *a</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *b</em><big>)</big><a class="headerlink" href="#PyDict_Update" title="Permalink to this definition">¶</a></dt>
<dd>This is the same as <tt class="docutils literal"><span class="pre">PyDict_Merge(a,</span> <span class="pre">b,</span> <span class="pre">1)</span></tt> in C, or <tt class="docutils literal"><span class="pre">a.update(b)</span></tt> in
Python. Return <tt class="docutils literal"><span class="pre">0</span></tt> on success or <tt class="docutils literal"><span class="pre">-1</span></tt> if an exception was raised.</dd></dl>
<dl class="cfunction">
<dt id="PyDict_MergeFromSeq2">
int <tt class="descname">PyDict_MergeFromSeq2</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *a</em>, <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *seq2</em>, int<em> override</em><big>)</big><a class="headerlink" href="#PyDict_MergeFromSeq2" title="Permalink to this definition">¶</a></dt>
<dd><p>Update or merge into dictionary <em>a</em>, from the key-value pairs in <em>seq2</em>.
<em>seq2</em> must be an iterable object producing iterable objects of length 2,
viewed as key-value pairs. In case of duplicate keys, the last wins if
<em>override</em> is true, else the first wins. Return <tt class="docutils literal"><span class="pre">0</span></tt> on success or <tt class="docutils literal"><span class="pre">-1</span></tt>
if an exception was raised. Equivalent Python (except for the return
value):</p>
<div class="highlight-c"><div class="highlight"><pre><span class="n">def</span> <span class="n">PyDict_MergeFromSeq2</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">seq2</span><span class="p">,</span> <span class="n">override</span><span class="p">)</span><span class="o">:</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="n">in</span> <span class="nl">seq2:</span>
<span class="k">if</span> <span class="n">override</span> <span class="n">or</span> <span class="n">key</span> <span class="n">not</span> <span class="n">in</span> <span class="nl">a:</span>
<span class="n">a</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="list.html"
title="previous chapter">List Objects</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="set.html"
title="next chapter">Set Objects</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/c-api/dict.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="set.html" title="Set Objects"
>next</a> |</li>
<li class="right" >
<a href="list.html" title="List Objects"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v3.1.1 documentation</a> »</li>
<li><a href="index.html" >Python/C API Reference Manual</a> »</li>
<li><a href="concrete.html" >Concrete Objects Layer</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2009, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Aug 16, 2009.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
e870e6598e1c7e3918555a3d0ba5f3d4
>
files
>
441
