339 lines
29 KiB
HTML
339 lines
29 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<title>kheops.plugin package — Khéops 0.1 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
|
|
<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>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="kheops.plugin.backend package" href="kheops.plugin.backend.html" />
|
|
<link rel="prev" title="kheops package" href="kheops.html" />
|
|
|
|
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
</head><body>
|
|
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
<section id="module-kheops.plugin">
|
|
<span id="kheops-plugin-package"></span><h1>kheops.plugin package<a class="headerlink" href="#module-kheops.plugin" title="Permalink to this headline">¶</a></h1>
|
|
<section id="subpackages">
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="kheops.plugin.backend.html">kheops.plugin.backend package</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.backend.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.backend.html#module-kheops.plugin.backend.file">kheops.plugin.backend.file module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="kheops.plugin.scope.html">kheops.plugin.scope package</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.scope.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.scope.html#module-kheops.plugin.scope.hier">kheops.plugin.scope.hier module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.scope.html#module-kheops.plugin.scope.loop">kheops.plugin.scope.loop module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="kheops.plugin.strategy.html">kheops.plugin.strategy package</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.strategy.html#submodules">Submodules</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.strategy.html#module-kheops.plugin.strategy.last">kheops.plugin.strategy.last module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="kheops.plugin.strategy.html#module-kheops.plugin.strategy.merge_deep">kheops.plugin.strategy.merge_deep module</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="submodules">
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|
</section>
|
|
<section id="module-kheops.plugin.common">
|
|
<span id="kheops-plugin-common-module"></span><h2>kheops.plugin.common module<a class="headerlink" href="#module-kheops.plugin.common" title="Permalink to this headline">¶</a></h2>
|
|
<p>Common libraries for plugins</p>
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.BackendCandidate">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">BackendCandidate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">run</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.common.BackendCandidate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.BackendPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">BackendPlugin</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.common.BackendPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsItemPlugin" title="kheops.plugin.common.KheopsItemPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsItemPlugin</span></code></a></p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.BackendPlugin.fetch_data">
|
|
<span class="sig-name descname"><span class="pre">fetch_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lookups</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.BackendPlugin.fetch_data" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.BackendPlugin.plugin_kind">
|
|
<span class="sig-name descname"><span class="pre">plugin_kind</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'backend'</span></em><a class="headerlink" href="#kheops.plugin.common.BackendPlugin.plugin_kind" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.BackendPlugin.schema_prop">
|
|
<span class="sig-name descname"><span class="pre">schema_prop</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'backend':</span> <span class="pre">{},</span> <span class="pre">'consul':</span> <span class="pre">{},</span> <span class="pre">'file':</span> <span class="pre">{},</span> <span class="pre">'glob':</span> <span class="pre">{},</span> <span class="pre">'http':</span> <span class="pre">{},</span> <span class="pre">'vault':</span> <span class="pre">{}}</span></em><a class="headerlink" href="#kheops.plugin.common.BackendPlugin.schema_prop" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ConfPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">ConfPlugin</span></span><a class="headerlink" href="#kheops.plugin.common.ConfPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsListPlugin" title="kheops.plugin.common.KheopsListPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsListPlugin</span></code></a></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ConfPlugin.plugin_kind">
|
|
<span class="sig-name descname"><span class="pre">plugin_kind</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'conf'</span></em><a class="headerlink" href="#kheops.plugin.common.ConfPlugin.plugin_kind" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ConfPlugin.process_list">
|
|
<span class="sig-name descname"><span class="pre">process_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item_list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.ConfPlugin.process_list" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ConfPlugin.schema_prop">
|
|
<span class="sig-name descname"><span class="pre">schema_prop</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'include':</span> <span class="pre">{}}</span></em><a class="headerlink" href="#kheops.plugin.common.ConfPlugin.schema_prop" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsItemPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">KheopsItemPlugin</span></span><a class="headerlink" href="#kheops.plugin.common.KheopsItemPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsPlugin" title="kheops.plugin.common.KheopsPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsPlugin</span></code></a></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsItemPlugin.plugin_type">
|
|
<span class="sig-name descname"><span class="pre">plugin_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'item'</span></em><a class="headerlink" href="#kheops.plugin.common.KheopsItemPlugin.plugin_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsItemPlugin.process_item">
|
|
<span class="sig-name descname"><span class="pre">process_item</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.KheopsItemPlugin.process_item" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsListPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">KheopsListPlugin</span></span><a class="headerlink" href="#kheops.plugin.common.KheopsListPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsPlugin" title="kheops.plugin.common.KheopsPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsPlugin</span></code></a></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsListPlugin.plugin_type">
|
|
<span class="sig-name descname"><span class="pre">plugin_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'list'</span></em><a class="headerlink" href="#kheops.plugin.common.KheopsListPlugin.plugin_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsListPlugin.process_list">
|
|
<span class="sig-name descname"><span class="pre">process_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item_list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.KheopsListPlugin.process_list" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">KheopsPlugin</span></span><a class="headerlink" href="#kheops.plugin.common.KheopsPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsPlugin.plugin_kind">
|
|
<span class="sig-name descname"><span class="pre">plugin_kind</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#kheops.plugin.common.KheopsPlugin.plugin_kind" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsPlugin.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">None</span></em><a class="headerlink" href="#kheops.plugin.common.KheopsPlugin.plugin_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.KheopsPlugin.plugin_type">
|
|
<span class="sig-name descname"><span class="pre">plugin_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#kheops.plugin.common.KheopsPlugin.plugin_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.OutPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">OutPlugin</span></span><a class="headerlink" href="#kheops.plugin.common.OutPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsItemPlugin" title="kheops.plugin.common.KheopsItemPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsItemPlugin</span></code></a></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.OutPlugin.plugin_kind">
|
|
<span class="sig-name descname"><span class="pre">plugin_kind</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'out'</span></em><a class="headerlink" href="#kheops.plugin.common.OutPlugin.plugin_kind" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.OutPlugin.process_item">
|
|
<span class="sig-name descname"><span class="pre">process_item</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.OutPlugin.process_item" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.OutPlugin.schema_prop">
|
|
<span class="sig-name descname"><span class="pre">schema_prop</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'_out':</span> <span class="pre">{},</span> <span class="pre">'toml':</span> <span class="pre">{},</span> <span class="pre">'validate':</span> <span class="pre">{}}</span></em><a class="headerlink" href="#kheops.plugin.common.OutPlugin.schema_prop" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopeExtLoop">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">ScopeExtLoop</span></span><a class="headerlink" href="#kheops.plugin.common.ScopeExtLoop" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>This Scope Extension allow to loop over a lookup</p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopeExtLoop.loop_over">
|
|
<span class="sig-name descname"><span class="pre">loop_over</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>, <em class="sig-param"><span class="n"><span class="pre">var_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'item'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kheops.plugin.common.ScopeExtLoop.loop_over" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopeExtLoop.schema_props">
|
|
<span class="sig-name descname"><span class="pre">schema_props</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'properties':</span> <span class="pre">{'data':</span> <span class="pre">{'anyOf':</span> <span class="pre">[{'type':</span> <span class="pre">'null'},</span> <span class="pre">{'type':</span> <span class="pre">'string'},</span> <span class="pre">{'type':</span> <span class="pre">'array'}],</span> <span class="pre">'default':</span> <span class="pre">None},</span> <span class="pre">'var':</span> <span class="pre">{'default':</span> <span class="pre">'item',</span> <span class="pre">'optional':</span> <span class="pre">True,</span> <span class="pre">'type':</span> <span class="pre">'string'}}}</span></em><a class="headerlink" href="#kheops.plugin.common.ScopeExtLoop.schema_props" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopePlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">ScopePlugin</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.common.ScopePlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsListPlugin" title="kheops.plugin.common.KheopsListPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsListPlugin</span></code></a></p>
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopePlugin.plugin_kind">
|
|
<span class="sig-name descname"><span class="pre">plugin_kind</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'scope'</span></em><a class="headerlink" href="#kheops.plugin.common.ScopePlugin.plugin_kind" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopePlugin.process_item">
|
|
<span class="sig-name descname"><span class="pre">process_item</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item_list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.ScopePlugin.process_item" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.ScopePlugin.schema_prop">
|
|
<span class="sig-name descname"><span class="pre">schema_prop</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'_scope':</span> <span class="pre">[],</span> <span class="pre">'hier_N':</span> <span class="pre">{},</span> <span class="pre">'init':</span> <span class="pre">{},</span> <span class="pre">'loop_N':</span> <span class="pre">{}}</span></em><a class="headerlink" href="#kheops.plugin.common.ScopePlugin.schema_prop" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.StrategyPlugin">
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kheops.plugin.common.</span></span><span class="sig-name descname"><span class="pre">StrategyPlugin</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.common.StrategyPlugin" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#kheops.plugin.common.KheopsItemPlugin" title="kheops.plugin.common.KheopsItemPlugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">kheops.plugin.common.KheopsItemPlugin</span></code></a></p>
|
|
<dl class="py method">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.StrategyPlugin.merge_results">
|
|
<span class="sig-name descname"><span class="pre">merge_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">candidates</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rule</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#kheops.plugin.common.StrategyPlugin.merge_results" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.StrategyPlugin.plugin_kind">
|
|
<span class="sig-name descname"><span class="pre">plugin_kind</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'strategy'</span></em><a class="headerlink" href="#kheops.plugin.common.StrategyPlugin.plugin_kind" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt class="sig sig-object py" id="kheops.plugin.common.StrategyPlugin.schema_prop">
|
|
<span class="sig-name descname"><span class="pre">schema_prop</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'_strategy':</span> <span class="pre">{},</span> <span class="pre">'first':</span> <span class="pre">{},</span> <span class="pre">'last':</span> <span class="pre">{},</span> <span class="pre">'merge':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{},</span> <span class="pre">'smart':</span> <span class="pre">{}}</span></em><a class="headerlink" href="#kheops.plugin.common.StrategyPlugin.schema_prop" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h1 class="logo"><a href="../index.html">Khéops</a></h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
<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></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 class="relations">
|
|
<h3>Related Topics</h3>
|
|
<ul>
|
|
<li><a href="../index.html">Documentation overview</a><ul>
|
|
<li><a href="modules.html">kheops</a><ul>
|
|
<li><a href="kheops.html">kheops package</a><ul>
|
|
<li>Previous: <a href="kheops.html" title="previous chapter">kheops package</a></li>
|
|
<li>Next: <a href="kheops.plugin.backend.html" title="next chapter">kheops.plugin.backend package</a></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
©2022, Barbu IT.
|
|
|
|
|
|
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
|
|
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
|
|
|
|
|
|
<a href="../_sources/api/kheops.plugin.rst.txt"
|
|
rel="nofollow">Page source</a>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |