mirror of
https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git
synced 2026-02-14 14:09:49 +00:00
331 lines
32 KiB
HTML
331 lines
32 KiB
HTML
<!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.extraction_trace — Hansken Extraction Plugins for plugin developers 0.7.0
|
|
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 src="../../../_static/jquery.js"></script>
|
|
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
|
|
<script src="../../../_static/doctools.js"></script>
|
|
<script src="../../../_static/sphinx_highlight.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">
|
|
0.7.0
|
|
|
|
</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" aria-label="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" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
|
|
<li class="breadcrumb-item active">hansken_extraction_plugin.api.extraction_trace</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.extraction_trace</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</span>
|
|
<span class="sd">This module contains the different Trace apis.</span>
|
|
|
|
<span class="sd">Note that there are a couple of different traces:</span>
|
|
<span class="sd"> * The ExtractionTrace and MetaExtractionTrace, which are offered to the process function.</span>
|
|
<span class="sd"> * ExtractionTraceBuilder, which is a trace that can be built; it does not exist in hansken yet, but it is added after</span>
|
|
<span class="sd"> building.</span>
|
|
<span class="sd"> * SearchTrace, which represents an immutable trace which is returned after searching for traces.</span>
|
|
<span class="sd">"""</span>
|
|
<span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABC</span><span class="p">,</span> <span class="n">abstractmethod</span>
|
|
<span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">BufferedReader</span><span class="p">,</span> <span class="n">BufferedWriter</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">Literal</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">hansken_extraction_plugin.api.tracelet</span> <span class="kn">import</span> <span class="n">Tracelet</span>
|
|
<span class="kn">from</span> <span class="nn">hansken_extraction_plugin.api.transformation</span> <span class="kn">import</span> <span class="n">Transformation</span>
|
|
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder">[docs]</a><span class="k">class</span> <span class="nc">ExtractionTraceBuilder</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> ExtractionTrace that can be build.</span>
|
|
|
|
<span class="sd"> Represents child traces.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.update"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.update">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key_or_updates</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Mapping</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">value</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">data</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="s1">'ExtractionTraceBuilder'</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Update or add metadata properties for this `.ExtractionTraceBuilder`.</span>
|
|
|
|
<span class="sd"> Can be used to update the name of the Trace represented by this builder,</span>
|
|
<span class="sd"> if not already set.</span>
|
|
|
|
<span class="sd"> :param key_or_updates: either a `str` (the metadata property to be</span>
|
|
<span class="sd"> updated) or a mapping supplying both keys and values to be updated</span>
|
|
<span class="sd"> :param value: the value to update metadata property *key* to (used</span>
|
|
<span class="sd"> only when *key_or_updates* is a `str`, an exception will be thrown</span>
|
|
<span class="sd"> if *key_or_updates* is a mapping)</span>
|
|
<span class="sd"> :param data: a `dict` mapping data type / stream name to bytes to be</span>
|
|
<span class="sd"> added to the trace</span>
|
|
<span class="sd"> :return: this `.ExtractionTraceBuilder`</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.add_tracelet"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.add_tracelet">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">add_tracelet</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">tracelet</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Tracelet</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span>
|
|
<span class="n">value</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Mapping</span><span class="p">[</span><span class="nb">str</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="s1">'ExtractionTraceBuilder'</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Add a `.Tracelet` to this `.ExtractionTraceBuilder`.</span>
|
|
|
|
<span class="sd"> :param tracelet: the Tracelet or tracelet type (supplied as a `str`) to add</span>
|
|
<span class="sd"> :param value: the tracelet properties to add (only applicable when *tracelet* is a `str`)</span>
|
|
<span class="sd"> :return: this `.ExtractionTraceBuilder`</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.add_transformation"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.add_transformation">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">add_transformation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">transformation</span><span class="p">:</span> <span class="n">Transformation</span><span class="p">)</span> <span class="o">-></span> <span class="s1">'ExtractionTraceBuilder'</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Update or add transformations for this `.ExtractionTraceBuilder`.</span>
|
|
|
|
<span class="sd"> :param data_type: data type of the Transformation</span>
|
|
<span class="sd"> :param transformation: the Transformation to add</span>
|
|
<span class="sd"> :return: this `.ExtractionTraceBuilder`</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.child_builder"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.child_builder">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">child_builder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="s1">'ExtractionTraceBuilder'</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Create a new `.TraceBuilder` to build a child trace to the trace to be represented by this builder.</span>
|
|
|
|
<span class="sd"> .. note::</span>
|
|
<span class="sd"> Traces should be created and built in depth first order,</span>
|
|
<span class="sd"> parent before child (pre-order).</span>
|
|
|
|
<span class="sd"> :return: a `.TraceBuilder` set up to save a new trace as the child</span>
|
|
<span class="sd"> trace of this builder</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.add_data"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.add_data">[docs]</a> <span class="k">def</span> <span class="nf">add_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="s1">'ExtractionTraceBuilder'</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Add data to this trace as a named stream.</span>
|
|
|
|
<span class="sd"> :param stream: name of the data stream to be added</span>
|
|
<span class="sd"> :param data: data to be attached</span>
|
|
<span class="sd"> :return: this `.ExtractionTraceBuilder`</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="n">stream</span><span class="p">:</span> <span class="n">data</span><span class="p">})</span></div>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.open"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.open">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">mode</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">'rb'</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'rb'</span><span class="p">)</span> \
|
|
<span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">BufferedReader</span><span class="p">,</span> <span class="n">BufferedWriter</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Open a data stream to read or write data from or to the `.ExtractionTrace`.</span>
|
|
|
|
<span class="sd"> :param data_type: the data type of the datastream, 'raw' by default</span>
|
|
<span class="sd"> :param offset: byte offset to start the stream on when reading</span>
|
|
<span class="sd"> :param size: the number of bytes to make available when reading</span>
|
|
<span class="sd"> :param mode: 'rb' for reading, 'wb' for writing</span>
|
|
<span class="sd"> :return: a file-like object to read or write bytes from the named stream</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="ExtractionTraceBuilder.build"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTraceBuilder.build">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">build</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Save the trace being built by this builder to remote.</span>
|
|
|
|
<span class="sd"> .. note::</span>
|
|
<span class="sd"> Building more than once will result in an error being raised.</span>
|
|
|
|
<span class="sd"> :return: the new trace' id</span>
|
|
<span class="sd"> """</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="Trace"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.Trace">[docs]</a><span class="k">class</span> <span class="nc">Trace</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""All trace classes should be able to return values."""</span>
|
|
|
|
<div class="viewcode-block" id="Trace.get"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.Trace.get">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">get</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="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return metadata properties for this `.ExtractionTrace`.</span>
|
|
|
|
<span class="sd"> :param key: the metadata property to be retrieved</span>
|
|
<span class="sd"> :param default: value returned if property is not set</span>
|
|
<span class="sd"> :return: the value of the requested metadata property</span>
|
|
<span class="sd"> """</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="SearchTrace"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.SearchTrace">[docs]</a><span class="k">class</span> <span class="nc">SearchTrace</span><span class="p">(</span><span class="n">Trace</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""SearchTraces represent traces returned when searching for traces."""</span>
|
|
|
|
<div class="viewcode-block" id="SearchTrace.open"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.SearchTrace.open">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stream</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'raw'</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">BufferedReader</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Open a data stream of the data that is being processed.</span>
|
|
|
|
<span class="sd"> :param stream: data stream of trace to open. defaults to raw. other examples are html, text, etc.</span>
|
|
<span class="sd"> :param offset: byte offset to start the stream on</span>
|
|
<span class="sd"> :param size: the number of bytes to make available</span>
|
|
<span class="sd"> :return: a file-like object to read bytes from the named stream</span>
|
|
<span class="sd"> """</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="MetaExtractionTrace"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.MetaExtractionTrace">[docs]</a><span class="k">class</span> <span class="nc">MetaExtractionTrace</span><span class="p">(</span><span class="n">Trace</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> MetaExtractionTraces contain only metadata.</span>
|
|
|
|
<span class="sd"> This class represenst traces during the extraction of an extraction plugin without a data stream.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="MetaExtractionTrace.update"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.MetaExtractionTrace.update">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key_or_updates</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Mapping</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">value</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="n">data</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Update or add metadata properties for this `.ExtractionTrace`.</span>
|
|
|
|
<span class="sd"> :param key_or_updates: either a `str` (the metadata property to be</span>
|
|
<span class="sd"> updated) or a mapping supplying both keys and values to be updated</span>
|
|
<span class="sd"> :param value: the value to update metadata property *key* to (used</span>
|
|
<span class="sd"> only when *key_or_updates* is a `str`, an exception will be thrown</span>
|
|
<span class="sd"> if *key_or_updates* is a mapping)</span>
|
|
<span class="sd"> :param data: a `dict` mapping data type / stream name to bytes to be</span>
|
|
<span class="sd"> added to the trace</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="MetaExtractionTrace.add_tracelet"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.MetaExtractionTrace.add_tracelet">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">add_tracelet</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">tracelet</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Tracelet</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span>
|
|
<span class="n">value</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Mapping</span><span class="p">[</span><span class="nb">str</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="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Add a `.Tracelet` to this `.MetaExtractionTrace`.</span>
|
|
|
|
<span class="sd"> :param tracelet: the Tracelet or tracelet type to add</span>
|
|
<span class="sd"> :param value: the tracelet properties to add (only applicable when *tracelet* is a tracelet type)</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="MetaExtractionTrace.add_transformation"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.MetaExtractionTrace.add_transformation">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">add_transformation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">transformation</span><span class="p">:</span> <span class="n">Transformation</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Update or add transformations for this `.ExtractionTraceBuilder`.</span>
|
|
|
|
<span class="sd"> :param data_type: data type of the Transformation</span>
|
|
<span class="sd"> :param transformation: the Transformation to add</span>
|
|
<span class="sd"> """</span></div>
|
|
|
|
<div class="viewcode-block" id="MetaExtractionTrace.child_builder"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.MetaExtractionTrace.child_builder">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">child_builder</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">ExtractionTraceBuilder</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Create a `.TraceBuilder` to build a trace to be saved as a child of this `.Trace`.</span>
|
|
|
|
<span class="sd"> A new trace will only be added to the index once explicitly saved (e.g.</span>
|
|
<span class="sd"> through `.TraceBuilder.build`).</span>
|
|
|
|
<span class="sd"> .. note::</span>
|
|
<span class="sd"> Traces should be created and built in depth first order,</span>
|
|
<span class="sd"> parent before child (pre-order).</span>
|
|
|
|
<span class="sd"> :param name: the name for the trace being built</span>
|
|
<span class="sd"> :return: a `.TraceBuilder` set up to create a child trace of this `.MetaExtractionTrace`</span>
|
|
<span class="sd"> """</span></div></div>
|
|
|
|
|
|
<div class="viewcode-block" id="ExtractionTrace"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTrace">[docs]</a><span class="k">class</span> <span class="nc">ExtractionTrace</span><span class="p">(</span><span class="n">MetaExtractionTrace</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Trace offered to be processed."""</span>
|
|
|
|
<div class="viewcode-block" id="ExtractionTrace.open"><a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_trace.html#hansken_extraction_plugin.api.extraction_trace.ExtractionTrace.open">[docs]</a> <span class="nd">@abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">mode</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">'rb'</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'rb'</span><span class="p">)</span> \
|
|
<span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">BufferedReader</span><span class="p">,</span> <span class="n">BufferedWriter</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Open a data stream to read or write data from or to the `.ExtractionTrace`.</span>
|
|
|
|
<span class="sd"> :param data_type: the data type of the datastream, 'raw' by default</span>
|
|
<span class="sd"> :param offset: byte offset to start the stream on when reading</span>
|
|
<span class="sd"> :param size: the number of bytes to make available when reading</span>
|
|
<span class="sd"> :param mode: 'rb' for reading, 'wb' for writing</span>
|
|
<span class="sd"> :return: a file-like object to read or write bytes from the named stream</span>
|
|
<span class="sd"> """</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020-2023 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> |