Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 6f61f4fc58119d17ef9d99939eb417b3 > files > 172

python-django-horizon-doc-2012.2.3-1.fc18.noarch.rpm


<!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.tables.actions &mdash; 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.tables" href="../tables.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.tables.actions</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</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 &quot;License&quot;); 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 &quot;AS IS&quot; 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">import</span> <span class="nn">new</span>

<span class="kn">from</span> <span class="nn">django</span> <span class="kn">import</span> <span class="n">shortcuts</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">django.core</span> <span class="kn">import</span> <span class="n">urlresolvers</span>
<span class="kn">from</span> <span class="nn">django.utils.functional</span> <span class="kn">import</span> <span class="n">Promise</span>
<span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="kn">import</span> <span class="n">string_concat</span><span class="p">,</span> <span class="n">ugettext_lazy</span> <span class="k">as</span> <span class="n">_</span>

<span class="kn">from</span> <span class="nn">horizon</span> <span class="kn">import</span> <span class="n">exceptions</span>
<span class="kn">from</span> <span class="nn">horizon</span> <span class="kn">import</span> <span class="n">messages</span>
<span class="kn">from</span> <span class="nn">horizon.utils</span> <span class="kn">import</span> <span class="n">html</span><span class="p">,</span> <span class="n">functions</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>

<span class="c"># For Bootstrap integration; can be overridden in settings.</span>
<span class="n">ACTION_CSS_CLASSES</span> <span class="o">=</span> <span class="p">(</span><span class="s">&quot;btn&quot;</span><span class="p">,</span> <span class="s">&quot;btn-small&quot;</span><span class="p">)</span>
<span class="n">STRING_SEPARATOR</span> <span class="o">=</span> <span class="s">&quot;__&quot;</span>


<div class="viewcode-block" id="BaseAction"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BaseAction">[docs]</a><span class="k">class</span> <span class="nc">BaseAction</span><span class="p">(</span><span class="n">html</span><span class="o">.</span><span class="n">HTMLElement</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Common base class for all ``Action`` classes. &quot;&quot;&quot;</span>
    <span class="n">table</span> <span class="o">=</span> <span class="bp">None</span>
    <span class="n">handles_multiple</span> <span class="o">=</span> <span class="bp">False</span>
    <span class="n">requires_input</span> <span class="o">=</span> <span class="bp">False</span>
    <span class="n">preempt</span> <span class="o">=</span> <span class="bp">False</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">datum</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">BaseAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">datum</span> <span class="o">=</span> <span class="n">datum</span>

<div class="viewcode-block" id="BaseAction.data_type_matched"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BaseAction.data_type_matched">[docs]</a>    <span class="k">def</span> <span class="nf">data_type_matched</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">datum</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Method to see if the action is allowed for a certain type of data.</span>
<span class="sd">            Only affects mixed data type tables.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="n">datum</span><span class="p">:</span>
            <span class="n">action_data_types</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;allowed_data_types&quot;</span><span class="p">,</span> <span class="p">[])</span>
            <span class="c"># If the data types of this action is empty, we assume it accepts</span>
            <span class="c"># all kinds of data and this method will return True.</span>
            <span class="k">if</span> <span class="n">action_data_types</span><span class="p">:</span>
                <span class="n">datum_type</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">datum</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">data_type_name</span><span class="p">,</span>
                                     <span class="bp">None</span><span class="p">)</span>
                <span class="k">if</span> <span class="n">datum_type</span> <span class="ow">and</span> <span class="p">(</span><span class="n">datum_type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">action_data_types</span><span class="p">):</span>
                    <span class="k">return</span> <span class="bp">False</span>
        <span class="k">return</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="BaseAction.allowed"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BaseAction.allowed">[docs]</a>    <span class="k">def</span> <span class="nf">allowed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Determine whether this action is allowed for the current request.</span>

<span class="sd">        This method is meant to be overridden with more specific checks.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="bp">True</span>
</div>
    <span class="k">def</span> <span class="nf">_allowed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">):</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">allowed</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">)</span>

<div class="viewcode-block" id="BaseAction.update"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BaseAction.update">[docs]</a>    <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Allows per-action customization based on current conditions.</span>

<span class="sd">        This is particularly useful when you wish to create a &quot;toggle&quot;</span>
<span class="sd">        action that will be rendered differently based on the value of an</span>
<span class="sd">        attribute on the current row&#39;s data.</span>

<span class="sd">        By default this method is a no-op.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseAction.get_default_classes"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BaseAction.get_default_classes">[docs]</a>    <span class="k">def</span> <span class="nf">get_default_classes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Returns a list of the default classes for the action. Defaults to</span>
<span class="sd">        ``[&quot;btn&quot;, &quot;btn-small&quot;]``.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s">&quot;ACTION_CSS_CLASSES&quot;</span><span class="p">,</span> <span class="n">ACTION_CSS_CLASSES</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BaseAction.get_default_attrs"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BaseAction.get_default_attrs">[docs]</a>    <span class="k">def</span> <span class="nf">get_default_attrs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Returns a list of the default HTML attributes for the action. Defaults</span>
<span class="sd">        to returning an ``id`` attribute with the value</span>
<span class="sd">        ``{{ table.name }}__action_{{ action.name }}__{{ creation counter }}``.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">datum</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
            <span class="n">bits</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
                    <span class="s">&quot;row_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">get_object_id</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">datum</span><span class="p">),</span>
                    <span class="s">&quot;action_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">bits</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s">&quot;action_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
        <span class="k">return</span> <span class="p">{</span><span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="n">STRING_SEPARATOR</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">bits</span><span class="p">)}</span>
</div>
    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="s">&quot;&lt;</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

</div>
<div class="viewcode-block" id="Action"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.Action">[docs]</a><span class="k">class</span> <span class="nc">Action</span><span class="p">(</span><span class="n">BaseAction</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; Represents an action which can be taken on this table&#39;s data.</span>

<span class="sd">    .. attribute:: name</span>

<span class="sd">        Required. The short name or &quot;slug&quot; representing this</span>
<span class="sd">        action. This name should not be changed at runtime.</span>

<span class="sd">    .. attribute:: verbose_name</span>

<span class="sd">        A descriptive name used for display purposes. Defaults to the</span>
<span class="sd">        value of ``name`` with the first letter of each word capitalized.</span>

<span class="sd">    .. attribute:: verbose_name_plural</span>

<span class="sd">        Used like ``verbose_name`` in cases where ``handles_multiple`` is</span>
<span class="sd">        ``True``. Defaults to ``verbose_name`` with the letter &quot;s&quot; appended.</span>

<span class="sd">    .. attribute:: method</span>

<span class="sd">        The HTTP method for this action. Defaults to ``POST``. Other methods</span>
<span class="sd">        may or may not succeed currently.</span>

<span class="sd">    .. attribute:: requires_input</span>

<span class="sd">        Boolean value indicating whether or not this action can be taken</span>
<span class="sd">        without any additional input (e.g. an object id). Defaults to ``True``.</span>

<span class="sd">    .. attribute:: preempt</span>

<span class="sd">        Boolean value indicating whether this action should be evaluated in</span>
<span class="sd">        the period after the table is instantiated but before the data has</span>
<span class="sd">        been loaded.</span>

<span class="sd">        This can allow actions which don&#39;t need access to the full table data</span>
<span class="sd">        to bypass any API calls and processing which would otherwise be</span>
<span class="sd">        required to load the table.</span>

<span class="sd">    .. attribute:: allowed_data_types</span>

<span class="sd">        A list that contains the allowed data types of the action.  If the</span>
<span class="sd">        datum&#39;s type is in this list, the action will be shown on the row</span>
<span class="sd">        for the datum.</span>

<span class="sd">        Default to be an empty list (``[]``). When set to empty, the action</span>
<span class="sd">        will accept any kind of data.</span>

<span class="sd">    At least one of the following methods must be defined:</span>

<span class="sd">    .. method:: single(self, data_table, request, object_id)</span>

<span class="sd">        Handler for a single-object action.</span>

<span class="sd">    .. method:: multiple(self, data_table, request, object_ids)</span>

<span class="sd">        Handler for multi-object actions.</span>

<span class="sd">    .. method:: handle(self, data_table, request, object_ids)</span>

<span class="sd">        If a single function can work for both single-object and</span>
<span class="sd">        multi-object cases then simply providing a ``handle`` function</span>
<span class="sd">        will internally route both ``single`` and ``multiple`` requests</span>
<span class="sd">        to ``handle`` with the calls from ``single`` being transformed</span>
<span class="sd">        into a list containing only the single object id.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">method</span> <span class="o">=</span> <span class="s">&quot;POST&quot;</span>
    <span class="n">requires_input</span> <span class="o">=</span> <span class="bp">True</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">verbose_name</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">verbose_name_plural</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
                 <span class="n">single_func</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">multiple_func</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">handle_func</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
                 <span class="n">handles_multiple</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">attrs</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">requires_input</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
                 <span class="n">allowed_data_types</span><span class="o">=</span><span class="p">[],</span> <span class="n">datum</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">Action</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">datum</span><span class="o">=</span><span class="n">datum</span><span class="p">)</span>
        <span class="c"># Priority: constructor, class-defined, fallback</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="o">=</span> <span class="n">verbose_name</span> <span class="ow">or</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;verbose_name&#39;</span><span class="p">,</span>
                                                    <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">title</span><span class="p">())</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name_plural</span> <span class="o">=</span> <span class="n">verbose_name_plural</span> <span class="ow">or</span> \
                                    <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;verbose_name_plural&#39;</span><span class="p">,</span>
                                           <span class="s">&quot;</span><span class="si">%s</span><span class="s">s&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">handles_multiple</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                                        <span class="s">&quot;handles_multiple&quot;</span><span class="p">,</span>
                                        <span class="n">handles_multiple</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">requires_input</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                                      <span class="s">&quot;requires_input&quot;</span><span class="p">,</span>
                                      <span class="n">requires_input</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">allowed_data_types</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;allowed_data_types&quot;</span><span class="p">,</span>
                                          <span class="n">allowed_data_types</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">attrs</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">attrs</span><span class="p">)</span>

        <span class="c"># Don&#39;t set these if they&#39;re None</span>
        <span class="k">if</span> <span class="n">single_func</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">single</span> <span class="o">=</span> <span class="n">single_func</span>
        <span class="k">if</span> <span class="n">multiple_func</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">multiple</span> <span class="o">=</span> <span class="n">multiple_func</span>
        <span class="k">if</span> <span class="n">handle_func</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">handle</span> <span class="o">=</span> <span class="n">handle_func</span>

        <span class="c"># Ensure we have the appropriate methods</span>
        <span class="n">has_handler</span> <span class="o">=</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;handle&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">)</span>
        <span class="n">has_single</span> <span class="o">=</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;single&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">single</span><span class="p">)</span>
        <span class="n">has_multiple</span> <span class="o">=</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;multiple&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">multiple</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">has_handler</span> <span class="ow">or</span> <span class="n">has_multiple</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">handles_multiple</span> <span class="o">=</span> <span class="bp">True</span>

        <span class="k">if</span> <span class="ow">not</span> <span class="n">has_handler</span> <span class="ow">and</span> <span class="p">(</span><span class="ow">not</span> <span class="n">has_single</span> <span class="ow">or</span> <span class="n">has_multiple</span><span class="p">):</span>
            <span class="n">cls_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>
            <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&#39;You must define either a &quot;handle&quot; &#39;</span>
                                      <span class="s">&#39;method or a &quot;single&quot; or &quot;multiple&quot; &#39;</span>
                                      <span class="s">&#39;method on </span><span class="si">%s</span><span class="s">.&#39;</span> <span class="o">%</span> <span class="n">cls_name</span><span class="p">)</span>

        <span class="k">if</span> <span class="ow">not</span> <span class="n">has_single</span><span class="p">:</span>
            <span class="k">def</span> <span class="nf">single</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_table</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">object_id</span><span class="p">):</span>
                <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">(</span><span class="n">data_table</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="p">[</span><span class="n">object_id</span><span class="p">])</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">single</span> <span class="o">=</span> <span class="n">new</span><span class="o">.</span><span class="n">instancemethod</span><span class="p">(</span><span class="n">single</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>

        <span class="k">if</span> <span class="ow">not</span> <span class="n">has_multiple</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">handles_multiple</span><span class="p">:</span>
            <span class="k">def</span> <span class="nf">multiple</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_table</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">object_ids</span><span class="p">):</span>
                <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">handle</span><span class="p">(</span><span class="n">data_table</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">object_ids</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">multiple</span> <span class="o">=</span> <span class="n">new</span><span class="o">.</span><span class="n">instancemethod</span><span class="p">(</span><span class="n">multiple</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>

<div class="viewcode-block" id="Action.get_param_name"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.Action.get_param_name">[docs]</a>    <span class="k">def</span> <span class="nf">get_param_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Returns the full POST parameter name for this action.</span>

<span class="sd">        Defaults to</span>
<span class="sd">        ``{{ table.name }}__{{ action.name }}``.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="s">&quot;__&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">])</span>

</div></div>
<div class="viewcode-block" id="LinkAction"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.LinkAction">[docs]</a><span class="k">class</span> <span class="nc">LinkAction</span><span class="p">(</span><span class="n">BaseAction</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; A table action which is simply a link rather than a form POST.</span>

<span class="sd">    .. attribute:: name</span>

<span class="sd">        Required. The short name or &quot;slug&quot; representing this</span>
<span class="sd">        action. This name should not be changed at runtime.</span>

<span class="sd">    .. attribute:: verbose_name</span>

<span class="sd">        A string which will be rendered as the link text. (Required)</span>

<span class="sd">    .. attribute:: url</span>

<span class="sd">        A string or a callable which resolves to a url to be used as the link</span>
<span class="sd">        target. You must either define the ``url`` attribute or override</span>
<span class="sd">        the ``get_link_url`` method on the class.</span>

<span class="sd">    .. attribute:: allowed_data_types</span>

<span class="sd">        A list that contains the allowed data types of the action.  If the</span>
<span class="sd">        datum&#39;s type is in this list, the action will be shown on the row</span>
<span class="sd">        for the datum.</span>

<span class="sd">        Defaults to be an empty list (``[]``). When set to empty, the action</span>
<span class="sd">        will accept any kind of data.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">method</span> <span class="o">=</span> <span class="s">&quot;GET&quot;</span>
    <span class="n">bound_url</span> <span class="o">=</span> <span class="bp">None</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">verbose_name</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">allowed_data_types</span><span class="o">=</span><span class="p">[],</span>
                 <span class="n">url</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">attrs</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">LinkAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="o">=</span> <span class="n">verbose_name</span> <span class="ow">or</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                                                    <span class="s">&quot;verbose_name&quot;</span><span class="p">,</span>
                                                    <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">title</span><span class="p">())</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">url</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;url&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">:</span>
            <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&#39;A LinkAction object must have a &#39;</span>
                                      <span class="s">&#39;verbose_name attribute.&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">allowed_data_types</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;allowed_data_types&quot;</span><span class="p">,</span>
                                          <span class="n">allowed_data_types</span><span class="p">)</span>
        <span class="k">if</span> <span class="n">attrs</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">attrs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">attrs</span><span class="p">)</span>

<div class="viewcode-block" id="LinkAction.get_link_url"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.LinkAction.get_link_url">[docs]</a>    <span class="k">def</span> <span class="nf">get_link_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">datum</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Returns the final URL based on the value of ``url``.</span>

<span class="sd">        If ``url`` is callable it will call the function.</span>
<span class="sd">        If not, it will then try to call ``reverse`` on ``url``.</span>
<span class="sd">        Failing that, it will simply return the value of ``url`` as-is.</span>

<span class="sd">        When called for a row action, the current row data object will be</span>
<span class="sd">        passed as the first parameter.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">:</span>
            <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&#39;A LinkAction class must have a &#39;</span>
                                      <span class="s">&#39;url attribute or define its own &#39;</span>
                                      <span class="s">&#39;get_link_url method.&#39;</span><span class="p">)</span>
        <span class="k">if</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">):</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">(</span><span class="n">datum</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">datum</span><span class="p">:</span>
                <span class="n">obj_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">get_object_id</span><span class="p">(</span><span class="n">datum</span><span class="p">)</span>
                <span class="k">return</span> <span class="n">urlresolvers</span><span class="o">.</span><span class="n">reverse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">obj_id</span><span class="p">,))</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="k">return</span> <span class="n">urlresolvers</span><span class="o">.</span><span class="n">reverse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">)</span>
        <span class="k">except</span> <span class="n">urlresolvers</span><span class="o">.</span><span class="n">NoReverseMatch</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span>
            <span class="n">LOG</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&#39;No reverse found for &quot;</span><span class="si">%s</span><span class="s">&quot;: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">ex</span><span class="p">))</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">url</span>

</div></div>
<div class="viewcode-block" id="FilterAction"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.FilterAction">[docs]</a><span class="k">class</span> <span class="nc">FilterAction</span><span class="p">(</span><span class="n">BaseAction</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; A base class representing a filter action for a table.</span>

<span class="sd">    .. attribute:: name</span>

<span class="sd">        The short name or &quot;slug&quot; representing this action. Defaults to</span>
<span class="sd">        ``&quot;filter&quot;``.</span>

<span class="sd">    .. attribute:: verbose_name</span>

<span class="sd">        A descriptive name used for display purposes. Defaults to the</span>
<span class="sd">        value of ``name`` with the first letter of each word capitalized.</span>

<span class="sd">    .. attribute:: param_name</span>

<span class="sd">        A string representing the name of the request parameter used for the</span>
<span class="sd">        search term. Default: ``&quot;q&quot;``.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="c"># TODO(gabriel): The method for a filter action should be a GET,</span>
    <span class="c"># but given the form structure of the table that&#39;s currently impossible.</span>
    <span class="c"># At some future date this needs to be reworked to get the filter action</span>
    <span class="c"># separated from the table&#39;s POST form.</span>
    <span class="n">method</span> <span class="o">=</span> <span class="s">&quot;POST&quot;</span>
    <span class="n">name</span> <span class="o">=</span> <span class="s">&quot;filter&quot;</span>
    <span class="n">verbose_name</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">&quot;Filter&quot;</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">verbose_name</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">param_name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">FilterAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="o">=</span> <span class="n">verbose_name</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">param_name</span> <span class="o">=</span> <span class="n">param_name</span> <span class="ow">or</span> <span class="s">&#39;q&#39;</span>

<div class="viewcode-block" id="FilterAction.get_param_name"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.FilterAction.get_param_name">[docs]</a>    <span class="k">def</span> <span class="nf">get_param_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Returns the full query parameter name for this action.</span>

<span class="sd">        Defaults to</span>
<span class="sd">        ``{{ table.name }}__{{ action.name }}__{{ action.param_name }}``.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="s">&quot;__&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">param_name</span><span class="p">])</span>
</div>
<div class="viewcode-block" id="FilterAction.get_default_classes"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.FilterAction.get_default_classes">[docs]</a>    <span class="k">def</span> <span class="nf">get_default_classes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">classes</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">FilterAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get_default_classes</span><span class="p">()</span>
        <span class="n">classes</span> <span class="o">+=</span> <span class="p">(</span><span class="s">&quot;btn-search&quot;</span><span class="p">,)</span>
        <span class="k">return</span> <span class="n">classes</span>
</div>
<div class="viewcode-block" id="FilterAction.assign_type_string"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.FilterAction.assign_type_string">[docs]</a>    <span class="k">def</span> <span class="nf">assign_type_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">type_string</span><span class="p">):</span>
        <span class="k">for</span> <span class="n">datum</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
            <span class="nb">setattr</span><span class="p">(</span><span class="n">datum</span><span class="p">,</span> <span class="n">table</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">data_type_name</span><span class="p">,</span> <span class="n">type_string</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="FilterAction.data_type_filter"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.FilterAction.data_type_filter">[docs]</a>    <span class="k">def</span> <span class="nf">data_type_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">filter_string</span><span class="p">):</span>
        <span class="n">filtered_data</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">data_type</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">data_types</span><span class="p">:</span>
            <span class="n">func_name</span> <span class="o">=</span> <span class="s">&quot;filter_</span><span class="si">%s</span><span class="s">_data&quot;</span> <span class="o">%</span> <span class="n">data_type</span>
            <span class="n">filter_func</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func_name</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
            <span class="k">if</span> <span class="ow">not</span> <span class="n">filter_func</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">callable</span><span class="p">(</span><span class="n">filter_func</span><span class="p">):</span>
                <span class="c"># The check of filter function implementation should happen</span>
                <span class="c"># in the __init__. However, the current workflow of DataTable</span>
                <span class="c"># and actions won&#39;t allow it. Need to be fixed in the future.</span>
                <span class="n">cls_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>
                <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&quot;You must define a </span><span class="si">%s</span><span class="s"> method &quot;</span>
                                            <span class="s">&quot;for </span><span class="si">%s</span><span class="s"> data type in </span><span class="si">%s</span><span class="s">.&quot;</span> <span class="o">%</span>
                                            <span class="p">(</span><span class="n">func_name</span><span class="p">,</span> <span class="n">data_type</span><span class="p">,</span> <span class="n">cls_name</span><span class="p">))</span>
            <span class="n">_data</span> <span class="o">=</span> <span class="n">filter_func</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">filter_string</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">assign_type_string</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">_data</span><span class="p">,</span> <span class="n">data_type</span><span class="p">)</span>
            <span class="n">filtered_data</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">_data</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">filtered_data</span>
</div>
<div class="viewcode-block" id="FilterAction.filter"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.FilterAction.filter">[docs]</a>    <span class="k">def</span> <span class="nf">filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">filter_string</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot; Provides the actual filtering logic.</span>

<span class="sd">        This method must be overridden by subclasses and return</span>
<span class="sd">        the filtered data.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&quot;The filter method has not been &quot;</span>
                                  <span class="s">&quot;implemented by </span><span class="si">%s</span><span class="s">.&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">)</span>

</div></div>
<div class="viewcode-block" id="BatchAction"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BatchAction">[docs]</a><span class="k">class</span> <span class="nc">BatchAction</span><span class="p">(</span><span class="n">Action</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot; A table action which takes batch action on one or more</span>
<span class="sd">        objects. This action should not require user input on a</span>
<span class="sd">        per-object basis.</span>

<span class="sd">    .. attribute:: name</span>

<span class="sd">       An internal name for this action.</span>

<span class="sd">    .. attribute:: action_present</span>

<span class="sd">       String or tuple/list. The display forms of the name.</span>
<span class="sd">       Should be a transitive verb, capitalized and translated. (&quot;Delete&quot;,</span>
<span class="sd">       &quot;Rotate&quot;, etc.) If tuple or list - then setting</span>
<span class="sd">       self.current_present_action = n will set the current active item</span>
<span class="sd">       from the list(action_present[n])</span>

<span class="sd">    .. attribute:: action_past</span>

<span class="sd">       String or tuple/list. The past tense of action_present. (&quot;Deleted&quot;,</span>
<span class="sd">       &quot;Rotated&quot;, etc.) If tuple or list - then</span>
<span class="sd">       setting self.current_past_action = n will set the current active item</span>
<span class="sd">       from the list(action_past[n])</span>

<span class="sd">    .. attribute:: data_type_singular</span>

<span class="sd">       A display name for the type of data that receives the</span>
<span class="sd">       action. (&quot;Keypair&quot;, &quot;Floating IP&quot;, etc.)</span>

<span class="sd">    .. attribute:: data_type_plural</span>

<span class="sd">       Optional plural word for the type of data being acted</span>
<span class="sd">       on. Defaults to appending &#39;s&#39;. Relying on the default is bad</span>
<span class="sd">       for translations and should not be done.</span>

<span class="sd">    .. attribute:: success_url</span>

<span class="sd">       Optional location to redirect after completion of the delete</span>
<span class="sd">       action. Defaults to the current page.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">success_url</span> <span class="o">=</span> <span class="bp">None</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="bp">self</span><span class="o">.</span><span class="n">current_present_action</span> <span class="o">=</span> <span class="mi">0</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">current_past_action</span> <span class="o">=</span> <span class="mi">0</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">data_type_plural</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;data_type_plural&#39;</span><span class="p">,</span>
                                        <span class="bp">self</span><span class="o">.</span><span class="n">data_type_singular</span> <span class="o">+</span> <span class="s">&#39;s&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;verbose_name&quot;</span><span class="p">,</span>
                                    <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">())</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name_plural</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;verbose_name_plural&quot;</span><span class="p">,</span>
                                           <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="s">&#39;plural&#39;</span><span class="p">))</span>
        <span class="c"># Keep record of successfully handled objects</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">success_ids</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">BatchAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>

    <span class="k">def</span> <span class="nf">_allowed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="c"># Override the default internal action method to prevent batch</span>
        <span class="c"># actions from appearing on tables with no data.</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">table</span><span class="o">.</span><span class="n">data</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">datum</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">False</span>
        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">BatchAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_allowed</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">_conjugate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">items</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">past</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Builds combinations like &#39;Delete Object&#39; and &#39;Deleted</span>
<span class="sd">        Objects&#39; based on the number of items and `past` flag.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">action_type</span> <span class="o">=</span> <span class="s">&quot;past&quot;</span> <span class="k">if</span> <span class="n">past</span> <span class="k">else</span> <span class="s">&quot;present&quot;</span>
        <span class="n">action_attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;action_</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">action_type</span><span class="p">)</span>
        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">action_attr</span><span class="p">,</span> <span class="p">(</span><span class="nb">basestring</span><span class="p">,</span> <span class="n">Promise</span><span class="p">)):</span>
            <span class="n">action</span> <span class="o">=</span> <span class="n">action_attr</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">toggle_selection</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;current_</span><span class="si">%s</span><span class="s">_action&quot;</span> <span class="o">%</span> <span class="n">action_type</span><span class="p">)</span>
            <span class="n">action</span> <span class="o">=</span> <span class="n">action_attr</span><span class="p">[</span><span class="n">toggle_selection</span><span class="p">]</span>
        <span class="k">if</span> <span class="n">items</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">items</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
            <span class="n">data_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type_singular</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">data_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type_plural</span>
        <span class="k">return</span> <span class="n">_</span><span class="p">(</span><span class="s">&quot;</span><span class="si">%(action)s</span><span class="s"> </span><span class="si">%(data_type)s</span><span class="s">&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span><span class="s">&#39;action&#39;</span><span class="p">:</span> <span class="n">action</span><span class="p">,</span>
                                                <span class="s">&#39;data_type&#39;</span><span class="p">:</span> <span class="n">data_type</span><span class="p">}</span>

<div class="viewcode-block" id="BatchAction.action"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BatchAction.action">[docs]</a>    <span class="k">def</span> <span class="nf">action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum_id</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Required. Accepts a single object id and performs the specific action.</span>

<span class="sd">        Return values are discarded, errors raised are caught and logged.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&#39;action() must be defined for &#39;</span>
                                  <span class="s">&#39;BatchAction: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type_singular</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BatchAction.update"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BatchAction.update">[docs]</a>    <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Switches the action verbose name, if needed</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;action_present&#39;</span><span class="p">,</span> <span class="bp">False</span><span class="p">):</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">()</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">verbose_name_plural</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="s">&#39;plural&#39;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BatchAction.get_success_url"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BatchAction.get_success_url">[docs]</a>    <span class="k">def</span> <span class="nf">get_success_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Returns the URL to redirect to after a successful action.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">success_url</span><span class="p">:</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">success_url</span>
        <span class="k">return</span> <span class="n">request</span><span class="o">.</span><span class="n">get_full_path</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="BatchAction.handle"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.BatchAction.handle">[docs]</a>    <span class="k">def</span> <span class="nf">handle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">obj_ids</span><span class="p">):</span>
        <span class="n">action_success</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">action_failure</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">action_not_allowed</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">datum_id</span> <span class="ow">in</span> <span class="n">obj_ids</span><span class="p">:</span>
            <span class="n">datum</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">get_object_by_id</span><span class="p">(</span><span class="n">datum_id</span><span class="p">)</span>
            <span class="n">datum_display</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">get_object_display</span><span class="p">(</span><span class="n">datum</span><span class="p">)</span> <span class="ow">or</span> <span class="n">_</span><span class="p">(</span><span class="s">&quot;N/A&quot;</span><span class="p">)</span>
            <span class="k">if</span> <span class="ow">not</span> <span class="n">table</span><span class="o">.</span><span class="n">_filter_action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">):</span>
                <span class="n">action_not_allowed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datum_display</span><span class="p">)</span>
                <span class="n">LOG</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&#39;Permission denied to </span><span class="si">%s</span><span class="s">: &quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span>
                         <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="n">past</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="n">datum_display</span><span class="p">))</span>
                <span class="k">continue</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">action</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">datum_id</span><span class="p">)</span>
                <span class="c">#Call update to invoke changes if needed</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">datum</span><span class="p">)</span>
                <span class="n">action_success</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datum_display</span><span class="p">)</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">success_ids</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datum_id</span><span class="p">)</span>
                <span class="n">LOG</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s">: &quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span>
                         <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="n">past</span><span class="o">=</span><span class="bp">True</span><span class="p">),</span> <span class="n">datum_display</span><span class="p">))</span>
            <span class="k">except</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span>
                <span class="c"># Handle the exception but silence it since we&#39;ll display</span>
                <span class="c"># an aggregate error message later. Otherwise we&#39;d get</span>
                <span class="c"># multiple error messages displayed to the user.</span>
                <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">ex</span><span class="p">,</span> <span class="s">&quot;_safe_message&quot;</span><span class="p">,</span> <span class="bp">None</span><span class="p">):</span>
                    <span class="n">ignore</span> <span class="o">=</span> <span class="bp">False</span>
                <span class="k">else</span><span class="p">:</span>
                    <span class="n">ignore</span> <span class="o">=</span> <span class="bp">True</span>
                    <span class="n">action_failure</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datum_display</span><span class="p">)</span>
                <span class="n">exceptions</span><span class="o">.</span><span class="n">handle</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">ignore</span><span class="o">=</span><span class="n">ignore</span><span class="p">)</span>

        <span class="c">#Begin with success message class, downgrade to info if problems</span>
        <span class="n">success_message_level</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">success</span>
        <span class="k">if</span> <span class="n">action_not_allowed</span><span class="p">:</span>
            <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">&#39;You do not have permission to </span><span class="si">%(action)s</span><span class="s">: </span><span class="si">%(objs)s</span><span class="s">&#39;</span><span class="p">)</span>
            <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;action&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="n">action_not_allowed</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span>
                      <span class="s">&quot;objs&quot;</span><span class="p">:</span> <span class="n">functions</span><span class="o">.</span><span class="n">lazy_join</span><span class="p">(</span><span class="s">&quot;, &quot;</span><span class="p">,</span> <span class="n">action_not_allowed</span><span class="p">)}</span>
            <span class="n">messages</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">msg</span> <span class="o">%</span> <span class="n">params</span><span class="p">)</span>
            <span class="n">success_message_level</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">info</span>
        <span class="k">if</span> <span class="n">action_failure</span><span class="p">:</span>
            <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">&#39;Unable to </span><span class="si">%(action)s</span><span class="s">: </span><span class="si">%(objs)s</span><span class="s">&#39;</span><span class="p">)</span>
            <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;action&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="n">action_failure</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span>
                      <span class="s">&quot;objs&quot;</span><span class="p">:</span> <span class="n">functions</span><span class="o">.</span><span class="n">lazy_join</span><span class="p">(</span><span class="s">&quot;, &quot;</span><span class="p">,</span> <span class="n">action_failure</span><span class="p">)}</span>
            <span class="n">messages</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">msg</span> <span class="o">%</span> <span class="n">params</span><span class="p">)</span>
            <span class="n">success_message_level</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">info</span>
        <span class="k">if</span> <span class="n">action_success</span><span class="p">:</span>
            <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%(action)s</span><span class="s">: </span><span class="si">%(objs)s</span><span class="s">&#39;</span><span class="p">)</span>
            <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;action&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conjugate</span><span class="p">(</span><span class="n">action_success</span><span class="p">,</span> <span class="bp">True</span><span class="p">),</span>
                      <span class="s">&quot;objs&quot;</span><span class="p">:</span> <span class="n">functions</span><span class="o">.</span><span class="n">lazy_join</span><span class="p">(</span><span class="s">&quot;, &quot;</span><span class="p">,</span> <span class="n">action_success</span><span class="p">)}</span>
            <span class="n">success_message_level</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">msg</span> <span class="o">%</span> <span class="n">params</span><span class="p">)</span>

        <span class="k">return</span> <span class="n">shortcuts</span><span class="o">.</span><span class="n">redirect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_success_url</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>

</div></div>
<div class="viewcode-block" id="DeleteAction"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.DeleteAction">[docs]</a><span class="k">class</span> <span class="nc">DeleteAction</span><span class="p">(</span><span class="n">BatchAction</span><span class="p">):</span>
    <span class="n">name</span> <span class="o">=</span> <span class="s">&quot;delete&quot;</span>
    <span class="n">action_present</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">&quot;Delete&quot;</span><span class="p">)</span>
    <span class="n">action_past</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s">&quot;Deleted&quot;</span><span class="p">)</span>

<div class="viewcode-block" id="DeleteAction.action"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.DeleteAction.action">[docs]</a>    <span class="k">def</span> <span class="nf">action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">obj_id</span><span class="p">):</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">obj_id</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="DeleteAction.delete"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.DeleteAction.delete">[docs]</a>    <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">obj_id</span><span class="p">):</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">&quot;DeleteAction must define a delete method.&quot;</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="DeleteAction.get_default_classes"><a class="viewcode-back" href="../../../sourcecode/horizon/horizon.tables.actions.html#horizon.tables.actions.DeleteAction.get_default_classes">[docs]</a>    <span class="k">def</span> <span class="nf">get_default_classes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">classes</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">DeleteAction</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get_default_classes</span><span class="p">()</span>
        <span class="n">classes</span> <span class="o">+=</span> <span class="p">(</span><span class="s">&quot;btn-danger&quot;</span><span class="p">,</span> <span class="s">&quot;btn-delete&quot;</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">classes</span></div></div>
</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> &raquo;</li>
          <li><a href="../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../../horizon.html" >horizon</a> &raquo;</li>
          <li><a href="../tables.html" accesskey="U">horizon.tables</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; 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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional