diff options
Diffstat (limited to 'doxygen/html/classcmd2_1_1StubbornDict.html')
| -rw-r--r-- | doxygen/html/classcmd2_1_1StubbornDict.html | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/doxygen/html/classcmd2_1_1StubbornDict.html b/doxygen/html/classcmd2_1_1StubbornDict.html new file mode 100644 index 0000000..f663de0 --- /dev/null +++ b/doxygen/html/classcmd2_1_1StubbornDict.html @@ -0,0 +1,378 @@ +<!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/xhtml;charset=UTF-8"/> +<title>Cmd2: cmd2::StubbornDict Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Cmd2 + + </div> + + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Packages</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li><a href="dirs.html"><span>Directories</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> + initNavTree('classcmd2_1_1StubbornDict.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-attribs">Static Public Attributes</a> </div> + <div class="headertitle"> +<div class="title">cmd2::StubbornDict Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="cmd2::StubbornDict" --> +<p><a href="classcmd2_1_1StubbornDict-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1StubbornDict.html#a219b3f21c078f3b8158de67beae62da2">__add__</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1StubbornDict.html#ad7c49b2ca37c0c88b198853706ae7e99">__iadd__</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1StubbornDict.html#a190b1b2bd8a914bafaab137c5b1276ea">__radd__</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1StubbornDict.html#ad46f55b61faae98d241e30d52cd04eee">to_dict</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1StubbornDict.html#a669dd7f5373f3726d8c8fb52a1e85bbd">update</a></td></tr> +<tr><td colspan="2"><h2><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcmd2_1_1StubbornDict.html#a66dc32a221c00611f1c131382703c333">append</a> = update</td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><div class="fragment"><pre class="fragment">Dictionary that tolerates many input formats. +Create it with stubbornDict(arg) factory function. + +>>> d = StubbornDict(large='gross', small='klein') +>>> sorted(d.items()) +[('large', 'gross'), ('small', 'klein')] +>>> d.append(['plain', ' plaid']) +>>> sorted(d.items()) +[('large', 'gross'), ('plaid', ''), ('plain', ''), ('small', 'klein')] +>>> d += ' girl Frauelein, Maedchen\\n\\n shoe schuh' +>>> sorted(d.items()) +[('girl', 'Frauelein, Maedchen'), ('large', 'gross'), ('plaid', ''), ('plain', ''), ('shoe', 'schuh'), ('small', 'klein')] +</pre></div> +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00271">271</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> +</div><hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a219b3f21c078f3b8158de67beae62da2"></a><!-- doxytag: member="cmd2::StubbornDict::__add__" ref="a219b3f21c078f3b8158de67beae62da2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::StubbornDict::__add__ </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00291">291</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> + +<p>References <a class="el" href="cmd2_8py_source.html#l00321">cmd2::stubbornDict()</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00291"></a><a class="code" href="classcmd2_1_1StubbornDict.html#a219b3f21c078f3b8158de67beae62da2">00291</a> +<a name="l00292"></a>00292 <span class="keyword">def </span><a class="code" href="classcmd2_1_1StubbornDict.html#a219b3f21c078f3b8158de67beae62da2">__add__</a>(self, arg): +<a name="l00293"></a>00293 selfcopy = copy.copy(self) +<a name="l00294"></a>00294 selfcopy.update(<a class="code" href="namespacecmd2.html#aae88fcdb31e45b322ecdaf7df9922823">stubbornDict</a>(arg)) + <span class="keywordflow">return</span> selfcopy +</pre></div> +</div> +</div> +<a class="anchor" id="ad7c49b2ca37c0c88b198853706ae7e99"></a><!-- doxytag: member="cmd2::StubbornDict::__iadd__" ref="ad7c49b2ca37c0c88b198853706ae7e99" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::StubbornDict::__iadd__ </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00288">288</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> + +<p>References <a class="el" href="cmd2_8py_source.html#l00285">update()</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00288"></a><a class="code" href="classcmd2_1_1StubbornDict.html#ad7c49b2ca37c0c88b198853706ae7e99">00288</a> +<a name="l00289"></a>00289 <span class="keyword">def </span><a class="code" href="classcmd2_1_1StubbornDict.html#ad7c49b2ca37c0c88b198853706ae7e99">__iadd__</a>(self, arg): +<a name="l00290"></a>00290 self.<a class="code" href="classcmd2_1_1StubbornDict.html#a669dd7f5373f3726d8c8fb52a1e85bbd">update</a>(arg) + <span class="keywordflow">return</span> self +</pre></div> +</div> +</div> +<a class="anchor" id="a190b1b2bd8a914bafaab137c5b1276ea"></a><!-- doxytag: member="cmd2::StubbornDict::__radd__" ref="a190b1b2bd8a914bafaab137c5b1276ea" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::StubbornDict::__radd__ </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00295">295</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> + +<p>References <a class="el" href="cmd2_8py_source.html#l00321">cmd2::stubbornDict()</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00295"></a><a class="code" href="classcmd2_1_1StubbornDict.html#a190b1b2bd8a914bafaab137c5b1276ea">00295</a> +<a name="l00296"></a>00296 <span class="keyword">def </span><a class="code" href="classcmd2_1_1StubbornDict.html#a190b1b2bd8a914bafaab137c5b1276ea">__radd__</a>(self, arg): +<a name="l00297"></a>00297 selfcopy = copy.copy(self) +<a name="l00298"></a>00298 selfcopy.update(<a class="code" href="namespacecmd2.html#aae88fcdb31e45b322ecdaf7df9922823">stubbornDict</a>(arg)) +<a name="l00299"></a>00299 <span class="keywordflow">return</span> selfcopy + +</pre></div> +</div> +</div> +<a class="anchor" id="ad46f55b61faae98d241e30d52cd04eee"></a><!-- doxytag: member="cmd2::StubbornDict::to_dict" ref="ad46f55b61faae98d241e30d52cd04eee" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::StubbornDict::to_dict </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>cls</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00301">301</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00301"></a><a class="code" href="classcmd2_1_1StubbornDict.html#ad46f55b61faae98d241e30d52cd04eee">00301</a> +<a name="l00302"></a>00302 <span class="keyword">def </span><a class="code" href="classcmd2_1_1StubbornDict.html#ad46f55b61faae98d241e30d52cd04eee">to_dict</a>(cls, arg): +<a name="l00303"></a>00303 <span class="stringliteral">'Generates dictionary from string or list of strings'</span> +<a name="l00304"></a>00304 <span class="keywordflow">if</span> hasattr(arg, <span class="stringliteral">'splitlines'</span>): +<a name="l00305"></a>00305 arg = arg.splitlines() +<a name="l00306"></a>00306 <span class="keywordflow">if</span> hasattr(arg, <span class="stringliteral">'__reversed__'</span>): +<a name="l00307"></a>00307 result = {} +<a name="l00308"></a>00308 <span class="keywordflow">for</span> a <span class="keywordflow">in</span> arg: +<a name="l00309"></a>00309 a = a.strip() +<a name="l00310"></a>00310 <span class="keywordflow">if</span> a: +<a name="l00311"></a>00311 key_val = a.split(<span class="keywordtype">None</span>, 1) +<a name="l00312"></a>00312 key = key_val[0] +<a name="l00313"></a>00313 <span class="keywordflow">if</span> len(key_val) > 1: +<a name="l00314"></a>00314 val = key_val[1] +<a name="l00315"></a>00315 <span class="keywordflow">else</span>: +<a name="l00316"></a>00316 val = <span class="stringliteral">''</span> +<a name="l00317"></a>00317 result[key] = val +<a name="l00318"></a>00318 <span class="keywordflow">else</span>: +<a name="l00319"></a>00319 result = arg +<a name="l00320"></a>00320 <span class="keywordflow">return</span> result + +</pre></div> +</div> +</div> +<a class="anchor" id="a669dd7f5373f3726d8c8fb52a1e85bbd"></a><!-- doxytag: member="cmd2::StubbornDict::update" ref="a669dd7f5373f3726d8c8fb52a1e85bbd" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">def cmd2::StubbornDict::update </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>self</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>arg</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00285">285</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> + +<p>Referenced by <a class="el" href="cmd2_8py_source.html#l00288">__iadd__()</a>.</p> +<div class="fragment"><pre class="fragment"><a name="l00285"></a><a class="code" href="classcmd2_1_1StubbornDict.html#a669dd7f5373f3726d8c8fb52a1e85bbd">00285</a> +<a name="l00286"></a>00286 <span class="keyword">def </span><a class="code" href="classcmd2_1_1StubbornDict.html#a669dd7f5373f3726d8c8fb52a1e85bbd">update</a>(self, arg): + dict.update(self, StubbornDict.to_dict(arg)) +</pre></div> +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a66dc32a221c00611f1c131382703c333"></a><!-- doxytag: member="cmd2::StubbornDict::append" ref="a66dc32a221c00611f1c131382703c333" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classcmd2_1_1StubbornDict.html#a66dc32a221c00611f1c131382703c333">cmd2::StubbornDict::append</a> = update<code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Definition at line <a class="el" href="cmd2_8py_source.html#l00287">287</a> of file <a class="el" href="cmd2_8py_source.html">cmd2.py</a>.</p> + +<p>Referenced by <a class="el" href="cmd2_8py_source.html#l01372">cmd2::History::extend()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/Users/amrogers/Developer/Projects/cmd2/<a class="el" href="cmd2_8py_source.html">cmd2.py</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespacecmd2.html">cmd2</a> </li> + <li class="navelem"><a class="el" href="classcmd2_1_1StubbornDict.html">StubbornDict</a> </li> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + + <li class="footer">Generated on Fri Sep 9 2011 10:50:48 for Cmd2 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + </ul> + </div> + + +</body> +</html> |