github-actions
179 lines
22 KiB
HTML
179 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>Coverage for haystack/skill_stores/types/protocol.py: 100%</title>
|
|
<link rel="icon" sizes="32x32" href="favicon_32_cb_c827f16f.png">
|
|
<link rel="stylesheet" href="style_cb_4667309f.css" type="text/css">
|
|
<script src="coverage_html_cb_dd2e7eb5.js" defer></script>
|
|
</head>
|
|
<body class="pyfile">
|
|
<header>
|
|
<div class="content">
|
|
<h1>
|
|
<span class="text">Coverage for </span><b>haystack<span class="sep">/</span>skill_stores<span class="sep">/</span>types<span class="sep">/</span>protocol.py</b>:
|
|
<span class="pc_cov">100%</span>
|
|
</h1>
|
|
<aside id="help_panel_wrapper">
|
|
<input id="help_panel_state" type="checkbox">
|
|
<label for="help_panel_state">
|
|
<img id="keyboard_icon" src="keybd_closed_cb_900cfef5.png" alt="Show/hide keyboard shortcuts">
|
|
</label>
|
|
<div id="help_panel">
|
|
<p class="legend">Shortcuts on this page</p>
|
|
<div class="keyhelp">
|
|
<p>
|
|
<kbd>r</kbd>
|
|
<kbd>m</kbd>
|
|
<kbd>x</kbd>
|
|
toggle line displays
|
|
</p>
|
|
<p>
|
|
<kbd>j</kbd>
|
|
<kbd>k</kbd>
|
|
next/prev highlighted chunk
|
|
</p>
|
|
<p>
|
|
<kbd>0</kbd> (zero) top of page
|
|
</p>
|
|
<p>
|
|
<kbd>1</kbd> (one) first highlighted chunk
|
|
</p>
|
|
<p>
|
|
<kbd>[</kbd>
|
|
<kbd>]</kbd>
|
|
prev/next file
|
|
</p>
|
|
<p>
|
|
<kbd>u</kbd> up to the index
|
|
</p>
|
|
<p>
|
|
<kbd>?</kbd> show/hide this help
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</aside>
|
|
<h2>
|
|
<span class="text">11 statements </span>
|
|
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">11<span class="text"> run</span></button>
|
|
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">0<span class="text"> missing</span></button>
|
|
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">10<span class="text"> excluded</span></button>
|
|
</h2>
|
|
<p class="text">
|
|
<a id="prevFileLink" class="nav" href="z_8f41eaad49a0f53b___init___py.html">« prev</a>
|
|
<a id="indexLink" class="nav" href="index.html">^ index</a>
|
|
<a id="nextFileLink" class="nav" href="z_3e768068d9f1cbfe___init___py.html">» next</a>
|
|
|
|
<a class="nav" href="https://coverage.readthedocs.io/en/7.15.4">coverage.py v7.15.4</a>,
|
|
created at 2026-08-21 13:53 +0000
|
|
</p>
|
|
<aside class="hidden">
|
|
<button type="button" class="button_next_chunk" data-shortcut="j"></button>
|
|
<button type="button" class="button_prev_chunk" data-shortcut="k"></button>
|
|
<button type="button" class="button_top_of_page" data-shortcut="0"></button>
|
|
<button type="button" class="button_first_chunk" data-shortcut="1"></button>
|
|
<button type="button" class="button_prev_file" data-shortcut="["></button>
|
|
<button type="button" class="button_next_file" data-shortcut="]"></button>
|
|
<button type="button" class="button_to_index" data-shortcut="u"></button>
|
|
<button type="button" class="button_show_hide_help" data-shortcut="?"></button>
|
|
</aside>
|
|
</div>
|
|
</header>
|
|
<main id="source">
|
|
<p class="pln"><span class="n"><a id="t1" href="#t1">1</a></span><span class="t"><span class="com"># SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai></span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t2" href="#t2">2</a></span><span class="t"><span class="com">#</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t3" href="#t3">3</a></span><span class="t"><span class="com"># SPDX-License-Identifier: Apache-2.0</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t4" href="#t4">4</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t5" href="#t5">5</a></span><span class="t"><span class="key">from</span> <span class="nam">typing</span> <span class="key">import</span> <span class="nam">Any</span><span class="op">,</span> <span class="nam">Protocol</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t6" href="#t6">6</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t7" href="#t7">7</a></span><span class="t"><span class="key">from</span> <span class="nam">haystack</span><span class="op">.</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">file_content</span> <span class="key">import</span> <span class="nam">FileContent</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t8" href="#t8">8</a></span><span class="t"><span class="key">from</span> <span class="nam">haystack</span><span class="op">.</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">image_content</span> <span class="key">import</span> <span class="nam">ImageContent</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"><span class="key">from</span> <span class="nam">haystack</span><span class="op">.</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">skill_info</span> <span class="key">import</span> <span class="nam">SkillInfo</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t11" href="#t11">11</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"><span class="key">class</span> <span class="nam">SkillStore</span><span class="op">(</span><span class="nam">Protocol</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t13" href="#t13">13</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"><span class="str"> Protocol for a skill storage layer.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t16" href="#t16">16</a></span><span class="t"><span class="str"> A `SkillStore` is responsible for discovering available skills and providing their content on demand. Implement</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t17" href="#t17">17</a></span><span class="t"><span class="str"> this protocol to back a `haystack.tools.SkillToolset` with any storage system — a local directory, a database,</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t18" href="#t18">18</a></span><span class="t"><span class="str"> a remote API, or an in-memory fixture.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"><span class="str"> Skills are identified by their `name`, which must be unique within a store. The `name` is the lookup key for every</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"><span class="str"> method below; implementations resolve it to their own internal locator (a directory, a row id, an object key, ...).</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t23" href="#t23">23</a></span><span class="t"><span class="str"> Implementations may defer all I/O (filesystem reads, database connections, ...) until a method is actually called,</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"><span class="str"> so a store can be constructed cheaply and only touch its backend on first use.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t25" href="#t25">25</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t26" href="#t26">26</a></span><span class="t"><span class="str"> Skill content is text: instruction bodies and bundled files are returned as strings. Binary assets (images,</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t27" href="#t27">27</a></span><span class="t"><span class="str"> fonts, ...) are not supported.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t29" href="#t29">29</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"> <span class="key">def</span> <span class="nam">list_skills</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">dict</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">SkillInfo</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t31" href="#t31">31</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t32" href="#t32">32</a></span><span class="t"><span class="str"> Discover and return all available skills.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t33" href="#t33">33</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"><span class="str"> :returns: Mapping of skill name to its metadata.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t36" href="#t36">36</a></span><span class="t"> <span class="op">...</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"> <span class="key">def</span> <span class="nam">load_skill</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">name</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">tuple</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">list</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t40" href="#t40">40</a></span><span class="t"><span class="str"> Return the named skill's instruction body and the manifest of its bundled files.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"><span class="str"> :param name: Skill name as returned by `list_skills`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"><span class="str"> :returns: A tuple of (markdown body with frontmatter stripped, sorted list of POSIX-style paths relative</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t44" href="#t44">44</a></span><span class="t"><span class="str"> to the skill root for any bundled files). The file list is empty when the skill bundles no extras.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t45" href="#t45">45</a></span><span class="t"><span class="str"> :raises KeyError: If no skill with `name` exists.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t46" href="#t46">46</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t47" href="#t47">47</a></span><span class="t"> <span class="op">...</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t49" href="#t49">49</a></span><span class="t"> <span class="key">def</span> <span class="nam">read_skill_file</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">name</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> <span class="nam">path</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">str</span> <span class="op">|</span> <span class="nam">ImageContent</span> <span class="op">|</span> <span class="nam">FileContent</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t50" href="#t50">50</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t51" href="#t51">51</a></span><span class="t"><span class="str"> Read a file bundled with the named skill.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t52" href="#t52">52</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"><span class="str"> Implementations should return text files as a `str`, image files as an `ImageContent`, and PDFs as a</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"><span class="str"> `FileContent`, so a multimodal agent can pass binary assets straight to the model.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t56" href="#t56">56</a></span><span class="t"><span class="str"> :param name: Skill name as returned by `list_skills`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"><span class="str"> :param path: Path of the file relative to the skill root (e.g. `"reference/forms.md"`).</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t58" href="#t58">58</a></span><span class="t"><span class="str"> :returns: The file's text content (`str`), an `ImageContent` for images, or a `FileContent` for PDFs.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t59" href="#t59">59</a></span><span class="t"><span class="str"> :raises KeyError: If no skill with `name` exists.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t60" href="#t60">60</a></span><span class="t"><span class="str"> :raises FileNotFoundError: If the file does not exist within the skill.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t61" href="#t61">61</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t62" href="#t62">62</a></span><span class="t"> <span class="op">...</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t63" href="#t63">63</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t64" href="#t64">64</a></span><span class="t"> <span class="key">def</span> <span class="nam">to_dict</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">dict</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Any</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t65" href="#t65">65</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t66" href="#t66">66</a></span><span class="t"><span class="str"> Serialize this store to a dictionary for use with `from_dict`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t67" href="#t67">67</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t68" href="#t68">68</a></span><span class="t"><span class="str"> Implement both this method and `from_dict` to make your custom store serializable.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t69" href="#t69">69</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t70" href="#t70">70</a></span><span class="t"> <span class="op">...</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t71" href="#t71">71</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t72" href="#t72">72</a></span><span class="t"> <span class="op">@</span><span class="nam">classmethod</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t73" href="#t73">73</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_dict</span><span class="op">(</span><span class="nam">cls</span><span class="op">,</span> <span class="nam">data</span><span class="op">:</span> <span class="nam">dict</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Any</span><span class="op">]</span><span class="op">)</span> <span class="op">-></span> <span class="str">"SkillStore"</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t75" href="#t75">75</a></span><span class="t"><span class="str"> Deserialize a store from a dictionary produced by `to_dict`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t76" href="#t76">76</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t77" href="#t77">77</a></span><span class="t"><span class="str"> Implement both this method and `to_dict` to make your custom store serializable.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t79" href="#t79">79</a></span><span class="t"><span class="str"> :param data: Dictionary as produced by `to_dict`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="exc show_exc"><span class="n"><a id="t81" href="#t81">81</a></span><span class="t"> <span class="op">...</span> </span><span class="r"></span></p>
|
|
</main>
|
|
<footer>
|
|
<div class="content">
|
|
<p>
|
|
<a class="nav" href="z_8f41eaad49a0f53b___init___py.html">« prev</a>
|
|
<a class="nav" href="index.html">^ index</a>
|
|
<a class="nav" href="z_3e768068d9f1cbfe___init___py.html">» next</a>
|
|
|
|
<a class="nav" href="https://coverage.readthedocs.io/en/7.15.4">coverage.py v7.15.4</a>,
|
|
created at 2026-08-21 13:53 +0000
|
|
</p>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|