<!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.api.base — 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.api.base</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span>
<span class="c"># Copyright 2012 United States Government as represented by the</span>
<span class="c"># Administrator of the National Aeronautics and Space Administration.</span>
<span class="c"># All Rights Reserved.</span>
<span class="c">#</span>
<span class="c"># Copyright 2012 Nebula, Inc.</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="kn">import</span> <span class="nn">logging</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">horizon</span> <span class="kn">import</span> <span class="n">exceptions</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s">'APIResourceWrapper'</span><span class="p">,</span> <span class="s">'APIDictWrapper'</span><span class="p">,</span>
<span class="s">'get_service_from_catalog'</span><span class="p">,</span> <span class="s">'url_for'</span><span class="p">,)</span>
<span class="n">LOG</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="APIResourceWrapper"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.base.html#horizon.api.base.APIResourceWrapper">[docs]</a><span class="k">class</span> <span class="nc">APIResourceWrapper</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">""" Simple wrapper for api objects</span>
<span class="sd"> Define _attrs on the child class and pass in the</span>
<span class="sd"> api object as the only argument to the constructor</span>
<span class="sd"> """</span>
<span class="n">_attrs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">apiresource</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_apiresource</span> <span class="o">=</span> <span class="n">apiresource</span>
<span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="k">if</span> <span class="n">attr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attrs</span><span class="p">:</span>
<span class="c"># __getattr__ won't find properties</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_apiresource</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s">'Attempted to access unknown attribute "</span><span class="si">%s</span><span class="s">" on '</span>
<span class="s">'APIResource object of type "</span><span class="si">%s</span><span class="s">" wrapping resource of '</span>
<span class="s">'type "</span><span class="si">%s</span><span class="s">".'</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_apiresource</span><span class="o">.</span><span class="n">__class__</span><span class="p">)</span>
<span class="n">LOG</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">exceptions</span><span class="o">.</span><span class="n">error_color</span><span class="p">(</span><span class="n">msg</span><span class="p">))</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="APIDictWrapper"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.base.html#horizon.api.base.APIDictWrapper">[docs]</a><span class="k">class</span> <span class="nc">APIDictWrapper</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">""" Simple wrapper for api dictionaries</span>
<span class="sd"> Some api calls return dictionaries. This class provides identical</span>
<span class="sd"> behavior as APIResourceWrapper, except that it will also behave as a</span>
<span class="sd"> dictionary, in addition to attribute accesses.</span>
<span class="sd"> Attribute access is the preferred method of access, to be</span>
<span class="sd"> consistent with api resource objects from novclient.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">apidict</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_apidict</span> <span class="o">=</span> <span class="n">apidict</span>
<span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_apidict</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">'Unknown attribute "</span><span class="si">%(attr)s</span><span class="s">" on APIResource object '</span> \
<span class="s">'of type "</span><span class="si">%(cls)s</span><span class="s">"'</span> <span class="o">%</span> <span class="p">{</span><span class="s">'attr'</span><span class="p">:</span> <span class="n">attr</span><span class="p">,</span> <span class="s">'cls'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">}</span>
<span class="n">LOG</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">exceptions</span><span class="o">.</span><span class="n">error_color</span><span class="p">(</span><span class="n">msg</span><span class="p">))</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__getattr__</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="c"># caller is expecting a KeyError</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<div class="viewcode-block" id="APIDictWrapper.get"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.base.html#horizon.api.base.APIDictWrapper.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__getattr__</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">return</span> <span class="n">default</span>
</div></div>
<div class="viewcode-block" id="get_service_from_catalog"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.base.html#horizon.api.base.get_service_from_catalog">[docs]</a><span class="k">def</span> <span class="nf">get_service_from_catalog</span><span class="p">(</span><span class="n">catalog</span><span class="p">,</span> <span class="n">service_type</span><span class="p">):</span>
<span class="k">if</span> <span class="n">catalog</span><span class="p">:</span>
<span class="k">for</span> <span class="n">service</span> <span class="ow">in</span> <span class="n">catalog</span><span class="p">:</span>
<span class="k">if</span> <span class="n">service</span><span class="p">[</span><span class="s">'type'</span><span class="p">]</span> <span class="o">==</span> <span class="n">service_type</span><span class="p">:</span>
<span class="k">return</span> <span class="n">service</span>
<span class="k">return</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="url_for"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.api.base.html#horizon.api.base.url_for">[docs]</a><span class="k">def</span> <span class="nf">url_for</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">service_type</span><span class="p">,</span> <span class="n">admin</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">endpoint_type</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="n">endpoint_type</span> <span class="o">=</span> <span class="n">endpoint_type</span> <span class="ow">or</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span>
<span class="s">'OPENSTACK_ENDPOINT_TYPE'</span><span class="p">,</span>
<span class="s">'publicURL'</span><span class="p">)</span>
<span class="n">catalog</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">service_catalog</span>
<span class="n">service</span> <span class="o">=</span> <span class="n">get_service_from_catalog</span><span class="p">(</span><span class="n">catalog</span><span class="p">,</span> <span class="n">service_type</span><span class="p">)</span>
<span class="k">if</span> <span class="n">service</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">admin</span><span class="p">:</span>
<span class="k">return</span> <span class="n">service</span><span class="p">[</span><span class="s">'endpoints'</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s">'adminURL'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">service</span><span class="p">[</span><span class="s">'endpoints'</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="n">endpoint_type</span><span class="p">]</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">IndexError</span><span class="p">,</span> <span class="ne">KeyError</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">ServiceCatalogException</span><span class="p">(</span><span class="n">service_type</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">ServiceCatalogException</span><span class="p">(</span><span class="n">service_type</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">is_service_enabled</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">service_type</span><span class="p">,</span> <span class="n">service_name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="n">service</span> <span class="o">=</span> <span class="n">get_service_from_catalog</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">service_catalog</span><span class="p">,</span>
<span class="n">service_type</span><span class="p">)</span>
<span class="k">if</span> <span class="n">service</span> <span class="ow">and</span> <span class="n">service_name</span><span class="p">:</span>
<span class="k">return</span> <span class="n">service</span><span class="p">[</span><span class="s">'name'</span><span class="p">]</span> <span class="o">==</span> <span class="n">service_name</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">service</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</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>
