Google Git
Sign in
apache / superset-site / b241e8201c9d383d54f9fc037a52cc498fba2a14 / . / _modules / superset / jinja_context.html
blob: f14b07b201edb9b25f88ef6a8b0105e3e5d8d51b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>superset.jinja_context &mdash; Apache Superset documentation</title>
<script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> Apache Superset
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../sqllab.html">SQL Lab</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../gallery.html">Visualizations Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../druid.html">Druid</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../misc.html">Misc</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Apache Superset</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li>superset.jinja_context</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for superset.jinja_context</h1><div class="highlight"><pre>
<span></span><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="sd">&quot;&quot;&quot;Defines the templating context for SQL Lab&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">cast</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">TYPE_CHECKING</span>
<span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">g</span><span class="p">,</span> <span class="n">request</span>
<span class="kn">from</span> <span class="nn">jinja2.sandbox</span> <span class="kn">import</span> <span class="n">SandboxedEnvironment</span>
<span class="kn">from</span> <span class="nn">superset</span> <span class="kn">import</span> <span class="n">jinja_base_context</span>
<span class="kn">from</span> <span class="nn">superset.extensions</span> <span class="kn">import</span> <span class="n">jinja_context_manager</span>
<span class="kn">from</span> <span class="nn">superset.utils.core</span> <span class="kn">import</span> <span class="n">convert_legacy_filters_into_adhoc</span><span class="p">,</span> <span class="n">merge_extra_filters</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">superset.connectors.sqla.models</span> <span class="kn">import</span> <span class="p">(</span> <span class="c1"># pylint: disable=unused-import</span>
<span class="n">SqlaTable</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">superset.models.core</span> <span class="kn">import</span> <span class="n">Database</span> <span class="c1"># pylint: disable=unused-import</span>
<span class="kn">from</span> <span class="nn">superset.models.sql_lab</span> <span class="kn">import</span> <span class="n">Query</span> <span class="c1"># pylint: disable=unused-import</span>
<div class="viewcode-block" id="filter_values"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.filter_values">[docs]</a><span class="k">def</span> <span class="nf">filter_values</span><span class="p">(</span><span class="n">column</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot; Gets a values for a particular filter as a list</span>
<span class="sd"> This is useful if:</span>
<span class="sd"> - you want to use a filter box to filter a query where the name of filter box</span>
<span class="sd"> column doesn&#39;t match the one in the select statement</span>
<span class="sd"> - you want to have the ability for filter inside the main query for speed</span>
<span class="sd"> purposes</span>
<span class="sd"> Usage example::</span>
<span class="sd"> SELECT action, count(*) as times</span>
<span class="sd"> FROM logs</span>
<span class="sd"> WHERE action in ( {{ &quot;&#39;&quot; + &quot;&#39;,&#39;&quot;.join(filter_values(&#39;action_type&#39;)) + &quot;&#39;&quot; }} )</span>
<span class="sd"> GROUP BY action</span>
<span class="sd"> :param column: column/filter name to lookup</span>
<span class="sd"> :param default: default value to return if there&#39;s no matching columns</span>
<span class="sd"> :return: returns a list of filter values</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">superset.views.utils</span> <span class="kn">import</span> <span class="n">get_form_data</span>
<span class="n">form_data</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">get_form_data</span><span class="p">()</span>
<span class="n">convert_legacy_filters_into_adhoc</span><span class="p">(</span><span class="n">form_data</span><span class="p">)</span>
<span class="n">merge_extra_filters</span><span class="p">(</span><span class="n">form_data</span><span class="p">)</span>
<span class="n">return_val</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">comparator</span>
<span class="k">for</span> <span class="nb">filter</span> <span class="ow">in</span> <span class="n">form_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;adhoc_filters&quot;</span><span class="p">,</span> <span class="p">[])</span>
<span class="k">for</span> <span class="n">comparator</span> <span class="ow">in</span> <span class="p">(</span>
<span class="nb">filter</span><span class="p">[</span><span class="s2">&quot;comparator&quot;</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">filter</span><span class="p">[</span><span class="s2">&quot;comparator&quot;</span><span class="p">],</span> <span class="nb">list</span><span class="p">)</span>
<span class="k">else</span> <span class="p">[</span><span class="nb">filter</span><span class="p">[</span><span class="s2">&quot;comparator&quot;</span><span class="p">]]</span>
<span class="p">)</span>
<span class="k">if</span> <span class="p">(</span>
<span class="nb">filter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;expressionType&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;SIMPLE&quot;</span>
<span class="ow">and</span> <span class="nb">filter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;clause&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="s2">&quot;WHERE&quot;</span>
<span class="ow">and</span> <span class="nb">filter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;subject&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="n">column</span>
<span class="ow">and</span> <span class="nb">filter</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;comparator&quot;</span><span class="p">)</span>
<span class="p">)</span>
<span class="p">]</span>
<span class="k">if</span> <span class="n">return_val</span><span class="p">:</span>
<span class="k">return</span> <span class="n">return_val</span>
<span class="k">if</span> <span class="n">default</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">default</span><span class="p">]</span>
<span class="k">return</span> <span class="p">[]</span></div>
<div class="viewcode-block" id="ExtraCache"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.ExtraCache">[docs]</a><span class="k">class</span> <span class="nc">ExtraCache</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Dummy class that exposes a method used to store additional values used in</span>
<span class="sd"> calculation of query object cache keys.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Regular expression for detecting the presence of templated methods which could</span>
<span class="c1"># be added to the cache key.</span>
<span class="n">regex</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="sa">r</span><span class="s2">&quot;\{\{.*(&quot;</span>
<span class="sa">r</span><span class="s2">&quot;current_user_id\(.*\)|&quot;</span>
<span class="sa">r</span><span class="s2">&quot;current_username\(.*\)|&quot;</span>
<span class="sa">r</span><span class="s2">&quot;cache_key_wrapper\(.*\)|&quot;</span>
<span class="sa">r</span><span class="s2">&quot;url_param\(.*\)&quot;</span>
<span class="sa">r</span><span class="s2">&quot;).*\}\}&quot;</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">extra_cache_keys</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">extra_cache_keys</span> <span class="o">=</span> <span class="n">extra_cache_keys</span>
<div class="viewcode-block" id="ExtraCache.current_user_id"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.ExtraCache.current_user_id">[docs]</a> <span class="k">def</span> <span class="nf">current_user_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">add_to_cache_keys</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the user ID of the user who is currently logged in.</span>
<span class="sd"> :param add_to_cache_keys: Whether the value should be included in the cache key</span>
<span class="sd"> :returns: The user ID</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="s2">&quot;user&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">g</span><span class="o">.</span><span class="n">user</span><span class="p">:</span>
<span class="k">if</span> <span class="n">add_to_cache_keys</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cache_key_wrapper</span><span class="p">(</span><span class="n">g</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
<span class="k">return</span> <span class="n">g</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">id</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="ExtraCache.current_username"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.ExtraCache.current_username">[docs]</a> <span class="k">def</span> <span class="nf">current_username</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">add_to_cache_keys</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the username of the user who is currently logged in.</span>
<span class="sd"> :param add_to_cache_keys: Whether the value should be included in the cache key</span>
<span class="sd"> :returns: The username</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">g</span><span class="o">.</span><span class="n">user</span><span class="p">:</span>
<span class="k">if</span> <span class="n">add_to_cache_keys</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cache_key_wrapper</span><span class="p">(</span><span class="n">g</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">username</span><span class="p">)</span>
<span class="k">return</span> <span class="n">g</span><span class="o">.</span><span class="n">user</span><span class="o">.</span><span class="n">username</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="ExtraCache.cache_key_wrapper"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.ExtraCache.cache_key_wrapper">[docs]</a> <span class="k">def</span> <span class="nf">cache_key_wrapper</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Adds values to a list that is added to the query object used for calculating a</span>
<span class="sd"> cache key.</span>
<span class="sd"> This is needed if the following applies:</span>
<span class="sd"> - Caching is enabled</span>
<span class="sd"> - The query is dynamically generated using a jinja template</span>
<span class="sd"> - A `JINJA_CONTEXT_ADDONS` or similar is used as a filter in the query</span>
<span class="sd"> :param key: Any value that should be considered when calculating the cache key</span>
<span class="sd"> :return: the original value ``key`` passed to the function</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">extra_cache_keys</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">extra_cache_keys</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span> <span class="n">key</span></div>
<div class="viewcode-block" id="ExtraCache.url_param"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.ExtraCache.url_param">[docs]</a> <span class="k">def</span> <span class="nf">url_param</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">add_to_cache_keys</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Any</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Read a url or post parameter and use it in your SQL Lab query.</span>
<span class="sd"> When in SQL Lab, it&#39;s possible to add arbitrary URL &quot;query string&quot; parameters,</span>
<span class="sd"> and use those in your SQL code. For instance you can alter your url and add</span>
<span class="sd"> `?foo=bar`, as in `{domain}/superset/sqllab?foo=bar`. Then if your query is</span>
<span class="sd"> something like SELECT * FROM foo = &#39;{{ url_param(&#39;foo&#39;) }}&#39;, it will be parsed</span>
<span class="sd"> at runtime and replaced by the value in the URL.</span>
<span class="sd"> As you create a visualization form this SQL Lab query, you can pass parameters</span>
<span class="sd"> in the explore view as well as from the dashboard, and it should carry through</span>
<span class="sd"> to your queries.</span>
<span class="sd"> Default values for URL parameters can be defined in chart metadata by adding the</span>
<span class="sd"> key-value pair `url_params: {&#39;foo&#39;: &#39;bar&#39;}`</span>
<span class="sd"> :param param: the parameter to lookup</span>
<span class="sd"> :param default: the value to return in the absence of the parameter</span>
<span class="sd"> :param add_to_cache_keys: Whether the value should be included in the cache key</span>
<span class="sd"> :returns: The URL parameters</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">superset.views.utils</span> <span class="kn">import</span> <span class="n">get_form_data</span>
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">param</span><span class="p">):</span>
<span class="k">return</span> <span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
<span class="n">form_data</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">get_form_data</span><span class="p">()</span>
<span class="n">url_params</span> <span class="o">=</span> <span class="n">form_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;url_params&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{}</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">url_params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">param</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
<span class="k">if</span> <span class="n">add_to_cache_keys</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cache_key_wrapper</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span></div></div>
<span class="k">class</span> <span class="nc">BaseTemplateProcessor</span><span class="p">:</span> <span class="c1"># pylint: disable=too-few-public-methods</span>
<span class="sd">&quot;&quot;&quot;Base class for database-specific jinja context</span>
<span class="sd"> There&#39;s this bit of magic in ``process_template`` that instantiates only</span>
<span class="sd"> the database context for the active database as a ``models.Database``</span>
<span class="sd"> object binds it to the context object, so that object methods</span>
<span class="sd"> have access to</span>
<span class="sd"> that context. This way, {{ hive.latest_partition(&#39;mytable&#39;) }} just</span>
<span class="sd"> knows about the database it is operating in.</span>
<span class="sd"> This means that object methods are only available for the active database</span>
<span class="sd"> and are given access to the ``models.Database`` object and schema</span>
<span class="sd"> name. For globally available methods use ``@classmethod``.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">engine</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">database</span><span class="p">:</span> <span class="s2">&quot;Database&quot;</span><span class="p">,</span>
<span class="n">query</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;Query&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">table</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;SqlaTable&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">extra_cache_keys</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">database</span> <span class="o">=</span> <span class="n">database</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">=</span> <span class="n">query</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">query</span> <span class="ow">and</span> <span class="n">query</span><span class="o">.</span><span class="n">schema</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">schema</span>
<span class="k">elif</span> <span class="n">table</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">schema</span>
<span class="n">extra_cache</span> <span class="o">=</span> <span class="n">ExtraCache</span><span class="p">(</span><span class="n">extra_cache_keys</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;url_param&quot;</span><span class="p">:</span> <span class="n">extra_cache</span><span class="o">.</span><span class="n">url_param</span><span class="p">,</span>
<span class="s2">&quot;current_user_id&quot;</span><span class="p">:</span> <span class="n">extra_cache</span><span class="o">.</span><span class="n">current_user_id</span><span class="p">,</span>
<span class="s2">&quot;current_username&quot;</span><span class="p">:</span> <span class="n">extra_cache</span><span class="o">.</span><span class="n">current_username</span><span class="p">,</span>
<span class="s2">&quot;cache_key_wrapper&quot;</span><span class="p">:</span> <span class="n">extra_cache</span><span class="o">.</span><span class="n">cache_key_wrapper</span><span class="p">,</span>
<span class="s2">&quot;filter_values&quot;</span><span class="p">:</span> <span class="n">filter_values</span><span class="p">,</span>
<span class="s2">&quot;form_data&quot;</span><span class="p">:</span> <span class="p">{},</span>
<span class="p">}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">jinja_base_context</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span>
<span class="bp">self</span><span class="o">.</span><span class="n">env</span> <span class="o">=</span> <span class="n">SandboxedEnvironment</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">process_template</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Processes a sql template</span>
<span class="sd"> &gt;&gt;&gt; sql = &quot;SELECT &#39;{{ datetime(2017, 1, 1).isoformat() }}&#39;&quot;</span>
<span class="sd"> &gt;&gt;&gt; process_template(sql)</span>
<span class="sd"> &quot;SELECT &#39;2017-01-01T00:00:00&#39;&quot;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">template</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span>
<span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="PrestoTemplateProcessor"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.PrestoTemplateProcessor">[docs]</a><span class="k">class</span> <span class="nc">PrestoTemplateProcessor</span><span class="p">(</span><span class="n">BaseTemplateProcessor</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Presto Jinja context</span>
<span class="sd"> The methods described here are namespaced under ``presto`` in the</span>
<span class="sd"> jinja context as in ``SELECT &#39;{{ presto.some_macro_call() }}&#39;``</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">engine</span> <span class="o">=</span> <span class="s2">&quot;presto&quot;</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_schema_table</span><span class="p">(</span>
<span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">schema</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span>
<span class="k">if</span> <span class="s2">&quot;.&quot;</span> <span class="ow">in</span> <span class="n">table_name</span><span class="p">:</span>
<span class="n">schema</span><span class="p">,</span> <span class="n">table_name</span> <span class="o">=</span> <span class="n">table_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">table_name</span><span class="p">,</span> <span class="n">schema</span>
<div class="viewcode-block" id="PrestoTemplateProcessor.first_latest_partition"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.PrestoTemplateProcessor.first_latest_partition">[docs]</a> <span class="k">def</span> <span class="nf">first_latest_partition</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the first value in the array of all latest partitions</span>
<span class="sd"> :param table_name: table name in the format `schema.table`</span>
<span class="sd"> :return: the first (or only) value in the latest partition array</span>
<span class="sd"> :raises IndexError: If no partition exists</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">latest_partitions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">latest_partitions</span><span class="p">(</span><span class="n">table_name</span><span class="p">)</span>
<span class="k">return</span> <span class="n">latest_partitions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">latest_partitions</span> <span class="k">else</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="PrestoTemplateProcessor.latest_partitions"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.PrestoTemplateProcessor.latest_partitions">[docs]</a> <span class="k">def</span> <span class="nf">latest_partitions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the array of all latest partitions</span>
<span class="sd"> :param table_name: table name in the format `schema.table`</span>
<span class="sd"> :return: the latest partition array</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">superset.db_engine_specs.presto</span> <span class="kn">import</span> <span class="n">PrestoEngineSpec</span>
<span class="n">table_name</span><span class="p">,</span> <span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_schema_table</span><span class="p">(</span><span class="n">table_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span>
<span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="n">PrestoEngineSpec</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="o">.</span><span class="n">db_engine_spec</span><span class="p">)</span><span class="o">.</span><span class="n">latest_partition</span><span class="p">(</span>
<span class="n">table_name</span><span class="p">,</span> <span class="n">schema</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span>
<span class="p">)[</span><span class="mi">1</span><span class="p">]</span></div>
<span class="k">def</span> <span class="nf">latest_sub_partition</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="n">table_name</span><span class="p">,</span> <span class="n">schema</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_schema_table</span><span class="p">(</span><span class="n">table_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">superset.db_engine_specs.presto</span> <span class="kn">import</span> <span class="n">PrestoEngineSpec</span>
<span class="k">return</span> <span class="n">cast</span><span class="p">(</span>
<span class="n">PrestoEngineSpec</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="o">.</span><span class="n">db_engine_spec</span>
<span class="p">)</span><span class="o">.</span><span class="n">latest_sub_partition</span><span class="p">(</span>
<span class="n">table_name</span><span class="o">=</span><span class="n">table_name</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">database</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
<span class="n">latest_partition</span> <span class="o">=</span> <span class="n">first_latest_partition</span></div>
<div class="viewcode-block" id="HiveTemplateProcessor"><a class="viewcode-back" href="../../sqllab.html#superset.jinja_context.HiveTemplateProcessor">[docs]</a><span class="k">class</span> <span class="nc">HiveTemplateProcessor</span><span class="p">(</span><span class="n">PrestoTemplateProcessor</span><span class="p">):</span>
<span class="n">engine</span> <span class="o">=</span> <span class="s2">&quot;hive&quot;</span></div>
<span class="c1"># The global template processors from Jinja context manager.</span>
<span class="n">template_processors</span> <span class="o">=</span> <span class="n">jinja_context_manager</span><span class="o">.</span><span class="n">template_processors</span>
<span class="n">keys</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">globals</span><span class="p">()</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">:</span>
<span class="n">o</span> <span class="o">=</span> <span class="nb">globals</span><span class="p">()[</span><span class="n">k</span><span class="p">]</span>
<span class="k">if</span> <span class="n">o</span> <span class="ow">and</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">o</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">BaseTemplateProcessor</span><span class="p">):</span>
<span class="n">template_processors</span><span class="p">[</span><span class="n">o</span><span class="o">.</span><span class="n">engine</span><span class="p">]</span> <span class="o">=</span> <span class="n">o</span>
<span class="k">def</span> <span class="nf">get_template_processor</span><span class="p">(</span>
<span class="n">database</span><span class="p">:</span> <span class="s2">&quot;Database&quot;</span><span class="p">,</span>
<span class="n">table</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;SqlaTable&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">query</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;Query&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BaseTemplateProcessor</span><span class="p">:</span>
<span class="n">template_processor</span> <span class="o">=</span> <span class="n">template_processors</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="n">database</span><span class="o">.</span><span class="n">backend</span><span class="p">,</span> <span class="n">BaseTemplateProcessor</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">template_processor</span><span class="p">(</span><span class="n">database</span><span class="o">=</span><span class="n">database</span><span class="p">,</span> <span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright Copyright © 2020 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>