github-actions
354 lines
76 KiB
HTML
354 lines
76 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/file_system/skill_store.py: 99%</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>file_system<span class="sep">/</span>skill_store.py</b>:
|
|
<span class="pc_cov">99%</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">95 statements </span>
|
|
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">94<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">1<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">0<span class="text"> excluded</span></button>
|
|
</h2>
|
|
<p class="text">
|
|
<a id="prevFileLink" class="nav" href="z_776979e115d6a8b2___init___py.html">« prev</a>
|
|
<a id="indexLink" class="nav" href="index.html">^ index</a>
|
|
<a id="nextFileLink" class="nav" href="z_8f41eaad49a0f53b___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">import</span> <span class="nam">base64</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t6" href="#t6">6</a></span><span class="t"><span class="key">import</span> <span class="nam">mimetypes</span> </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">pathlib</span> <span class="key">import</span> <span class="nam">Path</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">typing</span> <span class="key">import</span> <span class="nam">Any</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t"><span class="key">import</span> <span class="nam">yaml</span> </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">from</span> <span class="nam">haystack</span><span class="op">.</span><span class="nam">core</span><span class="op">.</span><span class="nam">serialization</span> <span class="key">import</span> <span class="nam">default_from_dict</span><span class="op">,</span> <span class="nam">default_to_dict</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t13" href="#t13">13</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="t14" href="#t14">14</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">IMAGE_MIME_TYPES</span><span class="op">,</span> <span class="nam">ImageContent</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t15" href="#t15">15</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="t16" href="#t16">16</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t17" href="#t17">17</a></span><span class="t"><span class="nam">SKILL_FILE_NAME</span> <span class="op">=</span> <span class="str">"SKILL.md"</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t"><span class="com"># Non-text, non-image MIME types that are returned as `FileContent` so a multimodal LLM can ingest them directly.</span> </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="com"># Scoped to PDF, which is what the major providers accept as a file input; everything else falls back to text.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"><span class="nam">_SUPPORTED_FILE_MIME_TYPES</span> <span class="op">=</span> <span class="op">{</span><span class="str">"application/pdf"</span><span class="op">}</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><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"><span class="key">def</span> <span class="nam">_parse_frontmatter</span><span class="op">(</span><span class="nam">text</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">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="nam">str</span><span class="op">]</span><span class="op">:</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 class="str">"""</span> </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"> Split a `SKILL.md` file into its YAML frontmatter and markdown body.</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><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"> The frontmatter is the YAML block delimited by a leading and a trailing line containing exactly `---`.</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 class="str"> If the first line is not `---`, no frontmatter is present and an empty mapping and the original text</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"><span class="str"> are returned.</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><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"> :param text: The full contents of a `SKILL.md` file.</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 class="str"> :returns: A tuple of (frontmatter mapping, body).</span> </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"> :raises ValueError: If the frontmatter is opened with `---` but never closed, is not valid YAML, or is</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"> not a YAML mapping.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t36" href="#t36">36</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"> <span class="nam">lines</span> <span class="op">=</span> <span class="nam">text</span><span class="op">.</span><span class="nam">lstrip</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">split</span><span class="op">(</span><span class="str">"\n"</span><span class="op">)</span> </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">if</span> <span class="nam">lines</span><span class="op">[</span><span class="num">0</span><span class="op">]</span><span class="op">.</span><span class="nam">rstrip</span><span class="op">(</span><span class="op">)</span> <span class="op">!=</span> <span class="str">"---"</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> <span class="key">return</span> <span class="op">{</span><span class="op">}</span><span class="op">,</span> <span class="nam">text</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> <span class="com"># Find the closing delimiter: the next line containing exactly '---'.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"> <span class="nam">closing_index</span> <span class="op">=</span> <span class="nam">next</span><span class="op">(</span><span class="op">(</span><span class="nam">i</span> <span class="key">for</span> <span class="nam">i</span><span class="op">,</span> <span class="nam">line</span> <span class="key">in</span> <span class="nam">enumerate</span><span class="op">(</span><span class="nam">lines</span><span class="op">[</span><span class="num">1</span><span class="op">:</span><span class="op">]</span><span class="op">,</span> <span class="nam">start</span><span class="op">=</span><span class="num">1</span><span class="op">)</span> <span class="key">if</span> <span class="nam">line</span><span class="op">.</span><span class="nam">rstrip</span><span class="op">(</span><span class="op">)</span> <span class="op">==</span> <span class="str">"---"</span><span class="op">)</span><span class="op">,</span> <span class="key">None</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"> <span class="key">if</span> <span class="nam">closing_index</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t44" href="#t44">44</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Skill frontmatter is opened with '---' but never closed with a matching '---' line."</span><span class="op">)</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><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t46" href="#t46">46</a></span><span class="t"> <span class="nam">frontmatter_block</span> <span class="op">=</span> <span class="str">"\n"</span><span class="op">.</span><span class="nam">join</span><span class="op">(</span><span class="nam">lines</span><span class="op">[</span><span class="num">1</span><span class="op">:</span><span class="nam">closing_index</span><span class="op">]</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t47" href="#t47">47</a></span><span class="t"> <span class="nam">body</span> <span class="op">=</span> <span class="str">"\n"</span><span class="op">.</span><span class="nam">join</span><span class="op">(</span><span class="nam">lines</span><span class="op">[</span><span class="nam">closing_index</span> <span class="op">+</span> <span class="num">1</span> <span class="op">:</span><span class="op">]</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"> <span class="key">try</span><span class="op">:</span> </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="nam">loaded</span> <span class="op">=</span> <span class="nam">yaml</span><span class="op">.</span><span class="nam">safe_load</span><span class="op">(</span><span class="nam">frontmatter_block</span><span class="op">)</span> <span class="key">or</span> <span class="op">{</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t50" href="#t50">50</a></span><span class="t"> <span class="key">except</span> <span class="nam">yaml</span><span class="op">.</span><span class="nam">YAMLError</span> <span class="key">as</span> <span class="nam">e</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t51" href="#t51">51</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="fst">f"</span><span class="fst">Skill frontmatter is not valid YAML: </span><span class="op">{</span><span class="nam">e</span><span class="op">}</span><span class="fst">"</span><span class="op">)</span> <span class="key">from</span> <span class="nam">e</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t52" href="#t52">52</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">loaded</span><span class="op">,</span> <span class="nam">dict</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"Skill frontmatter must be a YAML mapping."</span><span class="op">)</span> <span class="com"># noqa: TRY004</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"> <span class="key">return</span> <span class="nam">loaded</span><span class="op">,</span> <span class="nam">body</span><span class="op">.</span><span class="nam">lstrip</span><span class="op">(</span><span class="str">"\n"</span><span class="op">)</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><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"><span class="key">class</span> <span class="nam">FileSystemSkillStore</span><span class="op">:</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">"""</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"> SkillStore backed by a directory of skill sub-directories on the local filesystem.</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><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"> Expected layout:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t62" href="#t62">62</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t63" href="#t63">63</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t64" href="#t64">64</a></span><span class="t"><span class="str"> skills/</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"> pdf-forms/</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"> SKILL.md # frontmatter (name, description) + markdown instructions</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 class="str"> reference/forms.md # optional bundled file</span> </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"> ```</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t70" href="#t70">70</a></span><span class="t"><span class="str"> The skill catalog is built by reading the frontmatter of each `SKILL.md` on `warm_up`; bodies and bundled files</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t71" href="#t71">71</a></span><span class="t"><span class="str"> are read lazily when the agent calls the corresponding tool.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t72" href="#t72">72</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t73" href="#t73">73</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"> <span class="key">def</span> <span class="nam">__init__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">skills_dir</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="op">-></span> <span class="key">None</span><span class="op">:</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">"""</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 class="str"> Initialize the store with the root directory to scan.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t77" href="#t77">77</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"><span class="str"> No filesystem access happens here; the directory is scanned lazily on first use (see `warm_up`), so the store</span> </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"> can be constructed cheaply.</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t81" href="#t81">81</a></span><span class="t"><span class="str"> :param skills_dir: Root directory that contains one sub-directory per skill.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t82" href="#t82">82</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t83" href="#t83">83</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">skills_dir</span> <span class="op">=</span> <span class="nam">Path</span><span class="op">(</span><span class="nam">skills_dir</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t84" href="#t84">84</a></span><span class="t"> <span class="com"># Public metadata catalog returned by `list_skills`, populated on warm_up.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t85" href="#t85">85</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_skills</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 class="op">{</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t86" href="#t86">86</a></span><span class="t"> <span class="com"># Private locator: maps each skill name to its directory, used to read content lazily.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t87" href="#t87">87</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_skill_dirs</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">Path</span><span class="op">]</span> <span class="op">=</span> <span class="op">{</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t88" href="#t88">88</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_is_warmed_up</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t89" href="#t89">89</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t90" href="#t90">90</a></span><span class="t"> <span class="key">def</span> <span class="nam">warm_up</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t91" href="#t91">91</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t92" href="#t92">92</a></span><span class="t"><span class="str"> Scan `skills_dir` and build the skill catalog by reading each skill's `SKILL.md` frontmatter.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t93" href="#t93">93</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t94" href="#t94">94</a></span><span class="t"><span class="str"> Only the frontmatter is read here; bodies and bundled files are read lazily when the corresponding method is</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t95" href="#t95">95</a></span><span class="t"><span class="str"> called. Idempotent: repeated calls after the first are no-ops.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t96" href="#t96">96</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t97" href="#t97">97</a></span><span class="t"><span class="str"> :raises ValueError: If `skills_dir` does not exist, is not a directory, a skill's frontmatter is missing,</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t98" href="#t98">98</a></span><span class="t"><span class="str"> malformed, or missing a required field, or two skills share the same name.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t99" href="#t99">99</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t100" href="#t100">100</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_is_warmed_up</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t101" href="#t101">101</a></span><span class="t"> <span class="key">return</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t102" href="#t102">102</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">self</span><span class="op">.</span><span class="nam">skills_dir</span><span class="op">.</span><span class="nam">is_dir</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t103" href="#t103">103</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="fst">f"</span><span class="fst">Skills directory '</span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">skills_dir</span><span class="op">}</span><span class="fst">' does not exist or is not a directory.</span><span class="fst">"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t104" href="#t104">104</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t105" href="#t105">105</a></span><span class="t"> <span class="com"># Build into locals and swap at the end: if the scan fails halfway, no partial state is left behind (a retry</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t106" href="#t106">106</a></span><span class="t"> <span class="com"># after fixing the offending skill starts clean), and concurrent callers only ever observe either an empty or</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t107" href="#t107">107</a></span><span class="t"> <span class="com"># a complete catalog.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t108" href="#t108">108</a></span><span class="t"> <span class="nam">skills</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 class="op">{</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t109" href="#t109">109</a></span><span class="t"> <span class="nam">skill_dirs</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">Path</span><span class="op">]</span> <span class="op">=</span> <span class="op">{</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t110" href="#t110">110</a></span><span class="t"> <span class="key">for</span> <span class="nam">skill_file</span> <span class="key">in</span> <span class="nam">sorted</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">skills_dir</span><span class="op">.</span><span class="nam">glob</span><span class="op">(</span><span class="fst">f"</span><span class="fst">*/</span><span class="op">{</span><span class="nam">SKILL_FILE_NAME</span><span class="op">}</span><span class="fst">"</span><span class="op">)</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t111" href="#t111">111</a></span><span class="t"> <span class="nam">skill_dir</span> <span class="op">=</span> <span class="nam">skill_file</span><span class="op">.</span><span class="nam">parent</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t112" href="#t112">112</a></span><span class="t"> <span class="nam">frontmatter</span><span class="op">,</span> <span class="nam">_</span> <span class="op">=</span> <span class="nam">_parse_frontmatter</span><span class="op">(</span><span class="nam">skill_file</span><span class="op">.</span><span class="nam">read_text</span><span class="op">(</span><span class="nam">encoding</span><span class="op">=</span><span class="str">"utf-8"</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t113" href="#t113">113</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t114" href="#t114">114</a></span><span class="t"> <span class="nam">name</span> <span class="op">=</span> <span class="nam">frontmatter</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"name"</span><span class="op">,</span> <span class="nam">skill_dir</span><span class="op">.</span><span class="nam">name</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t115" href="#t115">115</a></span><span class="t"> <span class="nam">description</span> <span class="op">=</span> <span class="nam">frontmatter</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"description"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t116" href="#t116">116</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">description</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t117" href="#t117">117</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="fst">f"</span><span class="fst">Skill '</span><span class="op">{</span><span class="nam">name</span><span class="op">}</span><span class="fst">' (</span><span class="op">{</span><span class="nam">skill_file</span><span class="op">}</span><span class="fst">) is missing a 'description' in its frontmatter.</span><span class="fst">"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t118" href="#t118">118</a></span><span class="t"> <span class="key">if</span> <span class="nam">name</span> <span class="key">in</span> <span class="nam">skills</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="mis show_mis"><span class="n"><a id="t119" href="#t119">119</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="fst">f"</span><span class="fst">Duplicate skill name '</span><span class="op">{</span><span class="nam">name</span><span class="op">}</span><span class="fst">' found in '</span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">skills_dir</span><span class="op">}</span><span class="fst">'.</span><span class="fst">"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t120" href="#t120">120</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t121" href="#t121">121</a></span><span class="t"> <span class="nam">skills</span><span class="op">[</span><span class="nam">name</span><span class="op">]</span> <span class="op">=</span> <span class="nam">SkillInfo</span><span class="op">(</span><span class="nam">name</span><span class="op">=</span><span class="nam">name</span><span class="op">,</span> <span class="nam">description</span><span class="op">=</span><span class="nam">description</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t122" href="#t122">122</a></span><span class="t"> <span class="nam">skill_dirs</span><span class="op">[</span><span class="nam">name</span><span class="op">]</span> <span class="op">=</span> <span class="nam">skill_dir</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t124" href="#t124">124</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_skills</span> <span class="op">=</span> <span class="nam">skills</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t125" href="#t125">125</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_skill_dirs</span> <span class="op">=</span> <span class="nam">skill_dirs</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t126" href="#t126">126</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_is_warmed_up</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t127" href="#t127">127</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t128" href="#t128">128</a></span><span class="t"> <span class="key">def</span> <span class="nam">_skill_dir</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">Path</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"><span class="str"> Return the directory of the named skill, warming up the store first if needed.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t131" href="#t131">131</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t132" href="#t132">132</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="t133" href="#t133">133</a></span><span class="t"><span class="str"> :returns: The skill's directory.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t134" href="#t134">134</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="t135" href="#t135">135</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t136" href="#t136">136</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">warm_up</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t137" href="#t137">137</a></span><span class="t"> <span class="key">try</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t138" href="#t138">138</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_skill_dirs</span><span class="op">[</span><span class="nam">name</span><span class="op">]</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t139" href="#t139">139</a></span><span class="t"> <span class="key">except</span> <span class="nam">KeyError</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t140" href="#t140">140</a></span><span class="t"> <span class="nam">available</span> <span class="op">=</span> <span class="str">", "</span><span class="op">.</span><span class="nam">join</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">_skills</span><span class="op">)</span> <span class="key">or</span> <span class="str">"none"</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"> <span class="com"># We suppress the original error since we are replacing it with a more informative error message</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> <span class="key">raise</span> <span class="nam">KeyError</span><span class="op">(</span><span class="fst">f"</span><span class="fst">Unknown skill '</span><span class="op">{</span><span class="nam">name</span><span class="op">}</span><span class="fst">'. Available skills: </span><span class="op">{</span><span class="nam">available</span><span class="op">}</span><span class="fst">.</span><span class="fst">"</span><span class="op">)</span> <span class="key">from</span> <span class="key">None</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t143" href="#t143">143</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t144" href="#t144">144</a></span><span class="t"> <span class="key">def</span> <span class="nam">_readable_files_hint</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">str</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t145" href="#t145">145</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t146" href="#t146">146</a></span><span class="t"><span class="str"> Return a human-readable list of the files that can be read from the named skill.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t147" href="#t147">147</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t148" href="#t148">148</a></span><span class="t"><span class="str"> Used to make `read_skill_file` errors actionable by telling the caller which paths are valid.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t149" href="#t149">149</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t150" href="#t150">150</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="t151" href="#t151">151</a></span><span class="t"><span class="str"> :returns: Comma-separated relative paths, or `"none"` if the skill bundles no readable files.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t152" href="#t152">152</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t153" href="#t153">153</a></span><span class="t"> <span class="key">return</span> <span class="str">", "</span><span class="op">.</span><span class="nam">join</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">_list_skill_files</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span><span class="op">)</span> <span class="key">or</span> <span class="str">"none"</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t154" href="#t154">154</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t155" href="#t155">155</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="t156" href="#t156">156</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t157" href="#t157">157</a></span><span class="t"><span class="str"> Return all skills discovered on disk, warming up the store first if needed.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t158" href="#t158">158</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t159" href="#t159">159</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="t160" href="#t160">160</a></span><span class="t"><span class="str"> :raises ValueError: If the skills directory is invalid or a skill's frontmatter is malformed.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t161" href="#t161">161</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t162" href="#t162">162</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">warm_up</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t163" href="#t163">163</a></span><span class="t"> <span class="com"># We return a copy to prevent callers from mutating our internal state.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t164" href="#t164">164</a></span><span class="t"> <span class="key">return</span> <span class="nam">dict</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">_skills</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t165" href="#t165">165</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t166" href="#t166">166</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="t167" href="#t167">167</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t168" href="#t168">168</a></span><span class="t"><span class="str"> Read 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="t169" href="#t169">169</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t170" href="#t170">170</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="t171" href="#t171">171</a></span><span class="t"><span class="str"> :returns: A tuple of (markdown body of the skill's `SKILL.md` with frontmatter stripped, sorted list of</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t172" href="#t172">172</a></span><span class="t"><span class="str"> POSIX-style paths relative to the skill directory for any bundled files). The file list is empty when</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t173" href="#t173">173</a></span><span class="t"><span class="str"> the skill bundles no extras.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t174" href="#t174">174</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="t175" href="#t175">175</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t176" href="#t176">176</a></span><span class="t"> <span class="nam">_</span><span class="op">,</span> <span class="nam">body</span> <span class="op">=</span> <span class="nam">_parse_frontmatter</span><span class="op">(</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">_skill_dir</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span> <span class="op">/</span> <span class="nam">SKILL_FILE_NAME</span><span class="op">)</span><span class="op">.</span><span class="nam">read_text</span><span class="op">(</span><span class="nam">encoding</span><span class="op">=</span><span class="str">"utf-8"</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t177" href="#t177">177</a></span><span class="t"> <span class="key">return</span> <span class="nam">body</span><span class="op">,</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_list_skill_files</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t178" href="#t178">178</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t179" href="#t179">179</a></span><span class="t"> <span class="key">def</span> <span class="nam">_list_skill_files</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">list</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t180" href="#t180">180</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t181" href="#t181">181</a></span><span class="t"><span class="str"> Return the relative paths of all files bundled with the named skill, excluding its `SKILL.md`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t182" href="#t182">182</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t183" href="#t183">183</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="t184" href="#t184">184</a></span><span class="t"><span class="str"> :returns: Sorted list of POSIX-style paths relative to the skill directory. Empty when there are none.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t185" href="#t185">185</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="t186" href="#t186">186</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t187" href="#t187">187</a></span><span class="t"> <span class="nam">skill_dir</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_skill_dir</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t188" href="#t188">188</a></span><span class="t"> <span class="key">return</span> <span class="nam">sorted</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t189" href="#t189">189</a></span><span class="t"> <span class="nam">p</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">skill_dir</span><span class="op">)</span><span class="op">.</span><span class="nam">as_posix</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t190" href="#t190">190</a></span><span class="t"> <span class="key">for</span> <span class="nam">p</span> <span class="key">in</span> <span class="nam">skill_dir</span><span class="op">.</span><span class="nam">rglob</span><span class="op">(</span><span class="str">"*"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t191" href="#t191">191</a></span><span class="t"> <span class="key">if</span> <span class="nam">p</span><span class="op">.</span><span class="nam">is_file</span><span class="op">(</span><span class="op">)</span> <span class="key">and</span> <span class="nam">p</span><span class="op">.</span><span class="nam">name</span> <span class="op">!=</span> <span class="nam">SKILL_FILE_NAME</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t192" href="#t192">192</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t193" href="#t193">193</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t194" href="#t194">194</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="t195" href="#t195">195</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t196" href="#t196">196</a></span><span class="t"><span class="str"> Read a file bundled with the named skill, preventing path traversal outside the skill directory.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t197" href="#t197">197</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t198" href="#t198">198</a></span><span class="t"><span class="str"> The return type depends on the file: text files are returned as a `str`, image files (PNG, JPEG, ...) as an</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t199" href="#t199">199</a></span><span class="t"><span class="str"> `ImageContent`, and PDFs as a `FileContent`, so a multimodal agent can pass them straight to the model.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t200" href="#t200">200</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t201" href="#t201">201</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="t202" href="#t202">202</a></span><span class="t"><span class="str"> :param path: Path of the file relative to the skill directory (e.g. `"reference/forms.md"`).</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t203" href="#t203">203</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="t204" href="#t204">204</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="t205" href="#t205">205</a></span><span class="t"><span class="str"> :raises PermissionError: If `path` resolves outside the skill's directory (path-traversal attempt). The</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t206" href="#t206">206</a></span><span class="t"><span class="str"> message lists the readable files so the caller can retry with a valid path.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t207" href="#t207">207</a></span><span class="t"><span class="str"> :raises FileNotFoundError: If the file does not exist within the skill. The message lists the readable</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t208" href="#t208">208</a></span><span class="t"><span class="str"> files so the caller can retry with a valid path.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t209" href="#t209">209</a></span><span class="t"><span class="str"> :raises ValueError: If the file is binary but not a supported image or PDF (i.e. not UTF-8 text either).</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t210" href="#t210">210</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t211" href="#t211">211</a></span><span class="t"> <span class="nam">skill_dir</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_skill_dir</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span><span class="op">.</span><span class="nam">resolve</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t212" href="#t212">212</a></span><span class="t"> <span class="nam">target</span> <span class="op">=</span> <span class="op">(</span><span class="nam">skill_dir</span> <span class="op">/</span> <span class="nam">path</span><span class="op">)</span><span class="op">.</span><span class="nam">resolve</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t213" href="#t213">213</a></span><span class="t"> <span class="key">if</span> <span class="nam">skill_dir</span> <span class="op">!=</span> <span class="nam">target</span> <span class="key">and</span> <span class="nam">skill_dir</span> <span class="key">not</span> <span class="key">in</span> <span class="nam">target</span><span class="op">.</span><span class="nam">parents</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t214" href="#t214">214</a></span><span class="t"> <span class="key">raise</span> <span class="nam">PermissionError</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t215" href="#t215">215</a></span><span class="t"> <span class="fst">f"</span><span class="fst">Cannot read '</span><span class="op">{</span><span class="nam">path</span><span class="op">}</span><span class="fst">' from skill '</span><span class="op">{</span><span class="nam">name</span><span class="op">}</span><span class="fst">': the path resolves outside the skill directory. </span><span class="fst">"</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t216" href="#t216">216</a></span><span class="t"> <span class="fst">f"</span><span class="fst">Use a path relative to the skill root. Readable files: </span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">_readable_files_hint</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span><span class="op">}</span><span class="fst">.</span><span class="fst">"</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t217" href="#t217">217</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t218" href="#t218">218</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">target</span><span class="op">.</span><span class="nam">is_file</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t219" href="#t219">219</a></span><span class="t"> <span class="key">raise</span> <span class="nam">FileNotFoundError</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t220" href="#t220">220</a></span><span class="t"> <span class="fst">f"</span><span class="fst">File '</span><span class="op">{</span><span class="nam">path</span><span class="op">}</span><span class="fst">' not found in skill '</span><span class="op">{</span><span class="nam">name</span><span class="op">}</span><span class="fst">'. Readable files: </span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">_readable_files_hint</span><span class="op">(</span><span class="nam">name</span><span class="op">)</span><span class="op">}</span><span class="fst">.</span><span class="fst">"</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t221" href="#t221">221</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t222" href="#t222">222</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t223" href="#t223">223</a></span><span class="t"> <span class="com"># Check file types (PDF) before images: IMAGE_MIME_TYPES includes "application/pdf" (ImageContent can</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t224" href="#t224">224</a></span><span class="t"> <span class="com"># rasterize PDFs), but a skill's bundled PDF should reach the model as a FileContent, not an image.</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t225" href="#t225">225</a></span><span class="t"> <span class="nam">mime_type</span><span class="op">,</span> <span class="nam">_</span> <span class="op">=</span> <span class="nam">mimetypes</span><span class="op">.</span><span class="nam">guess_type</span><span class="op">(</span><span class="nam">target</span><span class="op">.</span><span class="nam">as_posix</span><span class="op">(</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t226" href="#t226">226</a></span><span class="t"> <span class="key">if</span> <span class="nam">mime_type</span> <span class="key">in</span> <span class="nam">_SUPPORTED_FILE_MIME_TYPES</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t227" href="#t227">227</a></span><span class="t"> <span class="nam">encoded</span> <span class="op">=</span> <span class="nam">base64</span><span class="op">.</span><span class="nam">b64encode</span><span class="op">(</span><span class="nam">target</span><span class="op">.</span><span class="nam">read_bytes</span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">.</span><span class="nam">decode</span><span class="op">(</span><span class="str">"utf-8"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t228" href="#t228">228</a></span><span class="t"> <span class="key">return</span> <span class="nam">FileContent</span><span class="op">(</span><span class="nam">base64_data</span><span class="op">=</span><span class="nam">encoded</span><span class="op">,</span> <span class="nam">mime_type</span><span class="op">=</span><span class="nam">mime_type</span><span class="op">,</span> <span class="nam">filename</span><span class="op">=</span><span class="nam">target</span><span class="op">.</span><span class="nam">name</span><span class="op">,</span> <span class="nam">validation</span><span class="op">=</span><span class="key">False</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t229" href="#t229">229</a></span><span class="t"> <span class="key">if</span> <span class="nam">mime_type</span> <span class="key">in</span> <span class="nam">IMAGE_MIME_TYPES</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t230" href="#t230">230</a></span><span class="t"> <span class="nam">encoded</span> <span class="op">=</span> <span class="nam">base64</span><span class="op">.</span><span class="nam">b64encode</span><span class="op">(</span><span class="nam">target</span><span class="op">.</span><span class="nam">read_bytes</span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">.</span><span class="nam">decode</span><span class="op">(</span><span class="str">"utf-8"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t231" href="#t231">231</a></span><span class="t"> <span class="key">return</span> <span class="nam">ImageContent</span><span class="op">(</span><span class="nam">base64_image</span><span class="op">=</span><span class="nam">encoded</span><span class="op">,</span> <span class="nam">mime_type</span><span class="op">=</span><span class="nam">mime_type</span><span class="op">,</span> <span class="nam">validation</span><span class="op">=</span><span class="key">False</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t232" href="#t232">232</a></span><span class="t"> <span class="key">try</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t233" href="#t233">233</a></span><span class="t"> <span class="key">return</span> <span class="nam">target</span><span class="op">.</span><span class="nam">read_text</span><span class="op">(</span><span class="nam">encoding</span><span class="op">=</span><span class="str">"utf-8"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t234" href="#t234">234</a></span><span class="t"> <span class="key">except</span> <span class="nam">UnicodeDecodeError</span> <span class="key">as</span> <span class="nam">e</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t235" href="#t235">235</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t236" href="#t236">236</a></span><span class="t"> <span class="fst">f"</span><span class="fst">File '</span><span class="op">{</span><span class="nam">path</span><span class="op">}</span><span class="fst">' in skill '</span><span class="op">{</span><span class="nam">name</span><span class="op">}</span><span class="fst">' is not a readable asset. Only UTF-8 text, images, and PDFs </span><span class="fst">"</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t237" href="#t237">237</a></span><span class="t"> <span class="fst">f"</span><span class="fst">are supported.</span><span class="fst">"</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t238" href="#t238">238</a></span><span class="t"> <span class="op">)</span> <span class="key">from</span> <span class="nam">e</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t239" href="#t239">239</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t240" href="#t240">240</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="t241" href="#t241">241</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t242" href="#t242">242</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="t243" href="#t243">243</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t244" href="#t244">244</a></span><span class="t"><span class="str"> :returns: Dictionary representation of the store.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t245" href="#t245">245</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t246" href="#t246">246</a></span><span class="t"> <span class="key">return</span> <span class="nam">default_to_dict</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">skills_dir</span><span class="op">=</span><span class="nam">str</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">skills_dir</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t247" href="#t247">247</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t248" href="#t248">248</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="t249" href="#t249">249</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">"FileSystemSkillStore"</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t250" href="#t250">250</a></span><span class="t"> <span class="str">"""</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t251" href="#t251">251</a></span><span class="t"><span class="str"> Deserialize a `FileSystemSkillStore` from its dictionary representation.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t252" href="#t252">252</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t253" href="#t253">253</a></span><span class="t"><span class="str"> :param data: Dictionary representation of the store, as produced by `to_dict`.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t254" href="#t254">254</a></span><span class="t"><span class="str"> :returns: A new `FileSystemSkillStore` instance.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t255" href="#t255">255</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t256" href="#t256">256</a></span><span class="t"> <span class="key">return</span> <span class="nam">default_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><span class="r"></span></p>
|
|
</main>
|
|
<footer>
|
|
<div class="content">
|
|
<p>
|
|
<a class="nav" href="z_776979e115d6a8b2___init___py.html">« prev</a>
|
|
<a class="nav" href="index.html">^ index</a>
|
|
<a class="nav" href="z_8f41eaad49a0f53b___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>
|