<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Bio.EUtils.MultiDict.OrderedMultiDict</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Bio-module.html">Package Bio</a> ::
<a href="Bio.EUtils-module.html">Package EUtils</a> ::
<a href="Bio.EUtils.MultiDict-module.html">Module MultiDict</a> ::
Class OrderedMultiDict
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Bio.EUtils.MultiDict.OrderedMultiDict-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class OrderedMultiDict</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict">source code</a></span></p>
<pre class="base-tree">
<a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html" onclick="show_private();">_BaseMultiDict</a> --+
|
<strong class="uidshort">OrderedMultiDict</strong>
</pre>
<hr />
<p>Store key/value mappings.</p>
<p>Acts like a standard dictionary with the following features:</p>
<ul>
<li>
duplicate keys are allowed;
</li>
<li>
input order is preserved for all key/value pairs.
</li>
</ul>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>od = OrderedMultiDict([(<span class="py-string">"Food"</span>, <span class="py-string">"Spam"</span>), (<span class="py-string">"Color"</span>, <span class="py-string">"Blue"</span>),
<span class="py-more">... </span> (<span class="py-string">"Food"</span>, <span class="py-string">"Eggs"</span>), (<span class="py-string">"Color"</span>, <span class="py-string">"Green"</span>)])
<span class="py-prompt">>>> </span>od[<span class="py-string">"Food"</span>]
<span class="py-output">'Eggs'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>od.getall(<span class="py-string">"Food"</span>)
<span class="py-output">['Spam', 'Eggs']</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>list(od.allkeys())
<span class="py-output">['Food', 'Color', 'Food', 'Color']</span>
<span class="py-output"></span><span class="py-prompt">>>></span></pre>
<p>The order of keys and values(eg, od.allkeys() and od.allitems())
preserves input order.</p>
<p>Can also pass in an object to the constructor which has an allitems()
method that returns a list of key/value pairs.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">multidict</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Does this OrderedMultiDict have the same contents and order as
another?</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__eq__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__ne__"></a><span class="summary-sig-name">__ne__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Does this OrderedMultiDict have different contents or order as
another?</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__ne__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__repr__"></a><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Bio.EUtils.MultiDict.OrderedMultiDict-class.html#__setitem__" class="summary-sig-name">__setitem__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Add a new key/value pair</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__setitem__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__delitem__"></a><span class="summary-sig-name">__delitem__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>)</span><br />
Remove all values for the given key</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__delitem__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="allkeys"></a><span class="summary-sig-name">allkeys</span>(<span class="summary-sig-arg">self</span>)</span><br />
iterate over all keys in input order</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.allkeys">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="allvalues"></a><span class="summary-sig-name">allvalues</span>(<span class="summary-sig-arg">self</span>)</span><br />
iterate over all values in input order</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.allvalues">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="allitems"></a><span class="summary-sig-name">allitems</span>(<span class="summary-sig-arg">self</span>)</span><br />
iterate over all key/value pairs in input order</td>
<td align="right" valign="top">
<span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.allitems">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html" onclick="show_private();">_BaseMultiDict</a></code></b>:
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#__contains__">__contains__</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#__getitem__">__getitem__</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#__iter__">__iter__</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#__len__">__len__</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#__str__">__str__</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#get">get</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#getall">getall</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#items">items</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#keys">keys</a></code>,
<code><a href="Bio.EUtils.MultiDict._BaseMultiDict-class.html#values">values</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__setitem__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__setitem__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">key</span>,
<span class="sig-arg">value</span>)</span>
<br /><em class="fname">(Index assignment operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Bio.EUtils.MultiDict-pysrc.html#OrderedMultiDict.__setitem__">source code</a></span>
</td>
</tr></table>
<p>Add a new key/value pair</p>
<p>If the key already exists, replaces the existing value so that d[key]
is the new value and not the old one.</p>
<p>To get all values for a given key, use d.getall(key).</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:33 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
