<!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>horizon.openstack.common.jsonutils — Horizon 2012.2.3 documentation</title>
<link rel="stylesheet" href="../../../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '2012.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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/jquery.tweet.js"></script>
<link rel="top" title="Horizon 2012.2.3 documentation" href="../../../../index.html" />
<link rel="up" title="horizon" href="../../../horizon.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for horizon.openstack.common.jsonutils</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span>
<span class="c"># Copyright 2010 United States Government as represented by the</span>
<span class="c"># Administrator of the National Aeronautics and Space Administration.</span>
<span class="c"># Copyright 2011 Justin Santa Barbara</span>
<span class="c"># All Rights Reserved.</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span>
<span class="c"># not use this file except in compliance with the License. You may obtain</span>
<span class="c"># a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span>
<span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c"># License for the specific language governing permissions and limitations</span>
<span class="c"># under the License.</span>
<span class="sd">'''</span>
<span class="sd">JSON related utilities.</span>
<span class="sd">This module provides a few things:</span>
<span class="sd"> 1) A handy function for getting an object down to something that can be</span>
<span class="sd"> JSON serialized. See to_primitive().</span>
<span class="sd"> 2) Wrappers around loads() and dumps(). The dumps() wrapper will</span>
<span class="sd"> automatically use to_primitive() for you if needed.</span>
<span class="sd"> 3) This sets up anyjson to use the loads() and dumps() wrappers if anyjson</span>
<span class="sd"> is available.</span>
<span class="sd">'''</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="kn">import</span> <span class="nn">itertools</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">xmlrpclib</span>
<div class="viewcode-block" id="to_primitive"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.jsonutils.html#horizon.openstack.common.jsonutils.to_primitive">[docs]</a><span class="k">def</span> <span class="nf">to_primitive</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">convert_instances</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Convert a complex object into primitives.</span>
<span class="sd"> Handy for JSON serialization. We can optionally handle instances,</span>
<span class="sd"> but since this is a recursive function, we could have cyclical</span>
<span class="sd"> data structures.</span>
<span class="sd"> To handle cyclical data structures we could track the actual objects</span>
<span class="sd"> visited in a set, but not all objects are hashable. Instead we just</span>
<span class="sd"> track the depth of the object inspections and don't go too deep.</span>
<span class="sd"> Therefore, convert_instances=True is lossy ... be aware.</span>
<span class="sd"> """</span>
<span class="n">nasty</span> <span class="o">=</span> <span class="p">[</span><span class="n">inspect</span><span class="o">.</span><span class="n">ismodule</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismethod</span><span class="p">,</span>
<span class="n">inspect</span><span class="o">.</span><span class="n">isfunction</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isgeneratorfunction</span><span class="p">,</span>
<span class="n">inspect</span><span class="o">.</span><span class="n">isgenerator</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">istraceback</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isframe</span><span class="p">,</span>
<span class="n">inspect</span><span class="o">.</span><span class="n">iscode</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isbuiltin</span><span class="p">,</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isroutine</span><span class="p">,</span>
<span class="n">inspect</span><span class="o">.</span><span class="n">isabstract</span><span class="p">]</span>
<span class="k">for</span> <span class="n">test</span> <span class="ow">in</span> <span class="n">nasty</span><span class="p">:</span>
<span class="k">if</span> <span class="n">test</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="c"># value of itertools.count doesn't get caught by inspects</span>
<span class="c"># above and results in infinite loop when list(value) is called.</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">==</span> <span class="n">itertools</span><span class="o">.</span><span class="n">count</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="c"># FIXME(vish): Workaround for LP bug 852095. Without this workaround,</span>
<span class="c"># tests that raise an exception in a mocked method that</span>
<span class="c"># has a @wrap_exception with a notifier will fail. If</span>
<span class="c"># we up the dependency to 0.5.4 (when it is released) we</span>
<span class="c"># can remove this workaround.</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s">'__module__'</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span> <span class="o">==</span> <span class="s">'mox'</span><span class="p">:</span>
<span class="k">return</span> <span class="s">'mock'</span>
<span class="k">if</span> <span class="n">level</span> <span class="o">></span> <span class="mi">3</span><span class="p">:</span>
<span class="k">return</span> <span class="s">'?'</span>
<span class="c"># The try block may not be necessary after the class check above,</span>
<span class="c"># but just in case ...</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># It's not clear why xmlrpclib created their own DateTime type, but</span>
<span class="c"># for our purposes, make it a datetime type which is explicitly</span>
<span class="c"># handled</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">xmlrpclib</span><span class="o">.</span><span class="n">DateTime</span><span class="p">):</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">(</span><span class="o">*</span><span class="nb">tuple</span><span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">timetuple</span><span class="p">())[:</span><span class="mi">6</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
<span class="n">o</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="n">o</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">to_primitive</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">convert_instances</span><span class="o">=</span><span class="n">convert_instances</span><span class="p">,</span>
<span class="n">level</span><span class="o">=</span><span class="n">level</span><span class="p">))</span>
<span class="k">return</span> <span class="n">o</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">o</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
<span class="n">o</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">to_primitive</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">convert_instances</span><span class="o">=</span><span class="n">convert_instances</span><span class="p">,</span>
<span class="n">level</span><span class="o">=</span><span class="n">level</span><span class="p">)</span>
<span class="k">return</span> <span class="n">o</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s">'iteritems'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">to_primitive</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()),</span>
<span class="n">convert_instances</span><span class="o">=</span><span class="n">convert_instances</span><span class="p">,</span>
<span class="n">level</span><span class="o">=</span><span class="n">level</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s">'__iter__'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">to_primitive</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">level</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">convert_instances</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s">'__dict__'</span><span class="p">):</span>
<span class="c"># Likely an instance of something. Watch for cycles.</span>
<span class="c"># Ignore class member vars.</span>
<span class="k">return</span> <span class="n">to_primitive</span><span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">__dict__</span><span class="p">,</span>
<span class="n">convert_instances</span><span class="o">=</span><span class="n">convert_instances</span><span class="p">,</span>
<span class="n">level</span><span class="o">=</span><span class="n">level</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">value</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="c"># Class objects are tricky since they may define something like</span>
<span class="c"># __iter__ defined but it isn't callable as list().</span>
<span class="k">return</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="dumps"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.jsonutils.html#horizon.openstack.common.jsonutils.dumps">[docs]</a><span class="k">def</span> <span class="nf">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">to_primitive</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="loads"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.jsonutils.html#horizon.openstack.common.jsonutils.loads">[docs]</a><span class="k">def</span> <span class="nf">loads</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="load"><a class="viewcode-back" href="../../../../sourcecode/horizon/horizon.openstack.common.jsonutils.html#horizon.openstack.common.jsonutils.load">[docs]</a><span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
</div>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">anyjson</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">anyjson</span><span class="o">.</span><span class="n">_modules</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">__name__</span><span class="p">,</span> <span class="s">'dumps'</span><span class="p">,</span> <span class="ne">TypeError</span><span class="p">,</span>
<span class="s">'loads'</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">'load'</span><span class="p">))</span>
<span class="n">anyjson</span><span class="o">.</span><span class="n">force_implementation</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<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"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../../index.html">Horizon 2012.2.3 documentation</a> »</li>
<li><a href="../../../index.html" >Module code</a> »</li>
<li><a href="../../../horizon.html" accesskey="U">horizon</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, OpenStack, LLC.
Last updated on Feb 08, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
