170 lines
11 KiB
HTML
170 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>kheops.plugin.scope package — Khéops 0.1 documentation</title>
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="../" id="documentation_options" 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/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="kheops.plugin.strategy package" href="kheops.plugin.strategy.html" />
|
|
<link rel="prev" title="kheops.plugin.backend package" href="kheops.plugin.backend.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"> Khéops
|
|
</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="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../docs/app/index.html">Application</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../docs/learn/index.html">Learn</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../docs/guide/index.html">Guides</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">Python API</a><ul class="current">
|
|
<li class="toctree-l2 current"><a class="reference internal" href="kheops.html">kheops package</a><ul class="current">
|
|
<li class="toctree-l3 current"><a class="reference internal" href="kheops.html#subpackages">Subpackages</a><ul class="current">
|
|
<li class="toctree-l4 current"><a class="reference internal" href="kheops.plugin.html">kheops.plugin package</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="kheops.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.app">kheops.app module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.cli">kheops.cli module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.controllers">kheops.controllers module</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="kheops.html#module-kheops.utils">kheops.utils module</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">Khéops</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
|
<li><a href="modules.html">kheops</a> »</li>
|
|
<li><a href="kheops.html">kheops package</a> »</li>
|
|
<li><a href="kheops.plugin.html">kheops.plugin package</a> »</li>
|
|
<li>kheops.plugin.scope package</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../_sources/api/kheops.plugin.scope.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="module-kheops.plugin.scope">
|
|
<span id="kheops-plugin-scope-package"></span><h1>kheops.plugin.scope package<a class="headerlink" href="#module-kheops.plugin.scope" title="Permalink to this headline"></a></h1>
|
|
<p>Scope plugins</p>
|
|
<section id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
|
|
</section>
|
|
<section id="module-kheops.plugin.scope.hier">
|
|
<span id="kheops-plugin-scope-hier-module"></span><h2>kheops.plugin.scope.hier module<a class="headerlink" href="#module-kheops.plugin.scope.hier" title="Permalink to this headline"></a></h2>
|
|
<p>Hierarchy backend plugin</p>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.scope.hier.Plugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.scope.hier.</span></span><span class="sig-name descname"><span class="pre">Plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.scope.hier.Plugin" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="kheops.plugin.html#kheops.plugin.common.ScopePlugin" title="kheops.plugin.common.ScopePlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.ScopePlugin</span></code></a>, <a class="reference internal" href="kheops.plugin.html#kheops.plugin.common.ScopeExtLoop" title="kheops.plugin.common.ScopeExtLoop"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.ScopeExtLoop</span></code></a></p>
|
|
<p>Hierarchy plugin</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.scope.hier.Plugin.plugin_name">
|
|
<span class="sig-name descname"><span class="pre">plugin_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'hier'</span></em><a class="headerlink" href="#kheops.plugin.scope.hier.Plugin.plugin_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.scope.hier.Plugin.process_items">
|
|
<span class="sig-name descname"><span class="pre">process_items</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lookups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.scope.hier.Plugin.process_items" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
<section id="module-kheops.plugin.scope.loop">
|
|
<span id="kheops-plugin-scope-loop-module"></span><h2>kheops.plugin.scope.loop module<a class="headerlink" href="#module-kheops.plugin.scope.loop" title="Permalink to this headline"></a></h2>
|
|
<p>Hierarchy backend plugin</p>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.scope.loop.Plugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.scope.loop.</span></span><span class="sig-name descname"><span class="pre">Plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.scope.loop.Plugin" title="Permalink to this definition"></a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="kheops.plugin.html#kheops.plugin.common.ScopePlugin" title="kheops.plugin.common.ScopePlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.ScopePlugin</span></code></a>, <a class="reference internal" href="kheops.plugin.html#kheops.plugin.common.ScopeExtLoop" title="kheops.plugin.common.ScopeExtLoop"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.ScopeExtLoop</span></code></a></p>
|
|
<p>Loop plugin</p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.scope.loop.Plugin.plugin_name">
|
|
<span class="sig-name descname"><span class="pre">plugin_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'loop'</span></em><a class="headerlink" href="#kheops.plugin.scope.loop.Plugin.plugin_name" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.scope.loop.Plugin.process_items">
|
|
<span class="sig-name descname"><span class="pre">process_items</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lookups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">conf</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.scope.loop.Plugin.process_items" title="Permalink to this definition"></a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="kheops.plugin.backend.html" class="btn btn-neutral float-left" title="kheops.plugin.backend package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="kheops.plugin.strategy.html" class="btn btn-neutral float-right" title="kheops.plugin.strategy package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2022, Barbu IT.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |