github/hansken-extraction-plugin-sdk-documentation
1
0
Fork 0
mirror of https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git synced 2026-02-14 14:09:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
14e571d0e2d617945b75da436a561b70428c2ced
hansken-extraction-plugin-s…/0.6.1/_modules/hansken_extraction_plugin/api/plugin_info.html
remco 14e571d0e2 0.6.1
2022-08-23 08:40:02 +02:00

193 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hansken_extraction_plugin.api.plugin_info &mdash; Hansken Extraction Plugins for plugin developers SNAPSHOT
documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/wider_pages.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/_sphinx_javascript_frameworks_compat.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" />
</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"> Hansken Extraction Plugins for plugin developers
</a>
<div class="version">
SNAPSHOT
</div>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/concepts.html">General concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/spec.html">Extraction Plugin specifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/java.html">Java</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/python.html">Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../contact.html">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../changes.html">Changelog</a></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">Hansken Extraction Plugins for plugin developers</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> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>hansken_extraction_plugin.api.plugin_info</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 hansken_extraction_plugin.api.plugin_info</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;This module contains all definitions to describe meta data of a plugin, a.k.a. PluginInfo.&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<div class="viewcode-block" id="Author"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.plugin_info.html#hansken_extraction_plugin.api.plugin_info.Author">[docs]</a><span class="nd">@dataclass</span><span class="p">(</span><span class="n">frozen</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Author</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The author of an Extraction Plugin.</span>
<span class="sd"> This information can be retrieved by an end-user from Hansken.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">email</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">organisation</span><span class="p">:</span> <span class="nb">str</span></div>
<div class="viewcode-block" id="MaturityLevel"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.plugin_info.html#hansken_extraction_plugin.api.plugin_info.MaturityLevel">[docs]</a><span class="k">class</span> <span class="nc">MaturityLevel</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;This class represents the maturity level of an extraction plugin.&quot;&quot;&quot;</span>
<span class="n">PROOF_OF_CONCEPT</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">READY_FOR_TEST</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">PRODUCTION_READY</span> <span class="o">=</span> <span class="mi">2</span></div>
<div class="viewcode-block" id="PluginId"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.plugin_info.html#hansken_extraction_plugin.api.plugin_info.PluginId">[docs]</a><span class="nd">@dataclass</span><span class="p">(</span><span class="n">frozen</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">PluginId</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Identifier of a plugin, consisting of domain, category and name. Needs to be unique among all tools/plugins.&quot;&quot;&quot;</span>
<span class="n">domain</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">category</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">domain</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">category</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span></div>
<div class="viewcode-block" id="PluginResources"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.plugin_info.html#hansken_extraction_plugin.api.plugin_info.PluginResources">[docs]</a><span class="nd">@dataclass</span><span class="p">(</span><span class="n">frozen</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">PluginResources</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;PluginResources contains information about how many resources will be used for a plugin.&quot;&quot;&quot;</span>
<span class="n">maximum_cpu</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> CPU resources are measured in cpu units. One cpu is equivalent to 1 vCPU/Core for cloud providers and 1 hyperthread</span>
<span class="sd"> on bare-metal Intel processors. Also, fractional requests are allowed. A plugin that asks 0.5 CPU uses half as</span>
<span class="sd"> much CPU as one that asks for 1 CPU.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">maximum_memory</span><span class="p">:</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;Max usable memory for a plugin, measured in megabytes.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">maximum_cpu</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">maximum_cpu</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;maximum_cpu cannot be &lt; 0: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">maximum_cpu</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">maximum_memory</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">maximum_memory</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;maximum_memory cannot be &lt; 0: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">maximum_memory</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="PluginInfo"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.plugin_info.html#hansken_extraction_plugin.api.plugin_info.PluginInfo">[docs]</a><span class="nd">@dataclass</span>
<span class="k">class</span> <span class="nc">PluginInfo</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This information is used by Hansken to identify and run the plugin.</span>
<span class="sd"> Note that the build_plugin.py build script is used to build a plugin docker image with PluginInfo docker labels.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">id</span><span class="p">:</span> <span class="n">PluginId</span> <span class="c1">#: a plugin&#39;s unique identifier, see PluginId</span>
<span class="n">version</span><span class="p">:</span> <span class="nb">str</span> <span class="c1">#: version of the plugin</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="c1">#: short description of the functionality of the plugin</span>
<span class="n">author</span><span class="p">:</span> <span class="n">Author</span> <span class="c1">#: the plugin&#39;s author, see Author</span>
<span class="n">maturity</span><span class="p">:</span> <span class="n">MaturityLevel</span> <span class="c1">#: maturity level, see MaturityLevel</span>
<span class="n">matcher</span><span class="p">:</span> <span class="nb">str</span> <span class="c1">#: this matcher selects the traces offered to the plugin</span>
<span class="n">webpage_url</span><span class="p">:</span> <span class="nb">str</span> <span class="c1">#: plugin url</span>
<span class="n">license</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="c1">#: license of this plugin</span>
<span class="n">deferred_iterations</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1">#: number of deferred iterations (1 to 20), nly for deferred plugins (optional)</span>
<span class="n">resources</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">PluginResources</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1">#: resources to be reserved for a plugin (optional)</span>
<span class="k">def</span> <span class="nf">__post_init__</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="mi">1</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">deferred_iterations</span> <span class="o">&lt;=</span> <span class="mi">20</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Invalid value for deferred_iterations: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">deferred_iterations</span><span class="si">}</span><span class="s1">. &#39;</span>
<span class="sa">f</span><span class="s1">&#39;Valid values are 1 =&lt; 20.&#39;</span><span class="p">)</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2020-2022 Netherlands Forensic Institute.</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>
Reference in New Issue View Git Blame Copy Permalink