github-actions
241 lines
38 KiB
HTML
241 lines
38 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>Coverage for haystack/core/component/sockets.py: 85%</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>core<span class="sep">/</span>component<span class="sep">/</span>sockets.py</b>:
|
|
<span class="pc_cov">85%</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">41 statements </span>
|
|
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">35<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">6<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_d0114671b518af99_component_py.html">« prev</a>
|
|
<a id="indexLink" class="nav" href="index.html">^ index</a>
|
|
<a id="nextFileLink" class="nav" href="z_d0114671b518af99_types_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><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">core</span><span class="op">.</span><span class="nam">type_utils</span> <span class="key">import</span> <span class="nam">_type_name</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t8" href="#t8">8</a></span><span class="t"> </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="op">.</span><span class="nam">types</span> <span class="key">import</span> <span class="nam">InputSocket</span><span class="op">,</span> <span class="nam">OutputSocket</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="run"><span class="n"><a id="t11" href="#t11">11</a></span><span class="t"><span class="nam">SocketsDict</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">InputSocket</span> <span class="op">|</span> <span class="nam">OutputSocket</span><span class="op">]</span> </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="nam">SocketsIOType</span> <span class="op">=</span> <span class="nam">type</span><span class="op">[</span><span class="nam">InputSocket</span><span class="op">]</span> <span class="op">|</span> <span class="nam">type</span><span class="op">[</span><span class="nam">OutputSocket</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"> </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">class</span> <span class="nam">Sockets</span><span class="op">:</span> <span class="com"># noqa: PLW1641</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 class="str">"""</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"> Represents the inputs or outputs of a `Component`.</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="str"> Depending on the type passed to the constructor, it will represent either the inputs or the outputs of</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="str"> the `Component`.</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"><span class="str"> Usage:</span> </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"> ```python</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"> from typing import Any</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"> from haystack.components.builders.prompt_builder import PromptBuilder</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"> from haystack.core.component.sockets import Sockets</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"> from haystack.core.component.types import InputSocket, OutputSocket</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><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="pln"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"><span class="str"> prompt_template = \"""</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"> Given these documents, answer the question.\nDocuments:</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"> {% for doc in documents %}</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"> {{ doc.content }}</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"> {% endfor %}</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><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"> \nQuestion: {{question}}</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"><span class="str"> \nAnswer:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"><span class="str"> \"""</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><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"> prompt_builder = PromptBuilder(template=prompt_template)</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 class="str"> sockets = {"question": InputSocket("question", Any), "documents": InputSocket("documents", Any)}</span> </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"> inputs = Sockets(component=prompt_builder, sockets_dict=sockets, sockets_io_type=InputSocket)</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"> inputs</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"> # >> Inputs:</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"> # >> - question: Any</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"> # >> - documents: Any</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t47" href="#t47">47</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"><span class="str"> inputs.question</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t49" href="#t49">49</a></span><span class="t"><span class="str"> # >> InputSocket(name='question', type=typing.Any, default_value=<class 'haystack.core.component.types._empty'>, ...</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"> """</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="com"># We're using a forward declaration here to avoid a circular import.</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">def</span> <span class="nam">__init__</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t56" href="#t56">56</a></span><span class="t"> <span class="nam">component</span><span class="op">:</span> <span class="str">"Component"</span><span class="op">,</span> <span class="com"># type: ignore[name-defined] # noqa: F821</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"> <span class="nam">sockets_dict</span><span class="op">:</span> <span class="nam">SocketsDict</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t58" href="#t58">58</a></span><span class="t"> <span class="nam">sockets_io_type</span><span class="op">:</span> <span class="nam">SocketsIOType</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t59" href="#t59">59</a></span><span class="t"> <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="t60" href="#t60">60</a></span><span class="t"> <span class="str">"""</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"> Create a new Sockets object.</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"> We don't do any enforcement on the types of the sockets here, the `sockets_type` is only used for</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"> the `__repr__` method.</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"> We could do without it and use the type of a random value in the `sockets` dict, but that wouldn't</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"> work for components that have no sockets at all. Either input or output.</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"> :param component:</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"> The component that these sockets belong to.</span> </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"> :param sockets_dict:</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"> A dictionary of sockets.</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"> :param sockets_io_type:</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 class="str"> The type of the sockets.</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="run"><span class="n"><a id="t75" href="#t75">75</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_io_type</span> <span class="op">=</span> <span class="nam">sockets_io_type</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t76" href="#t76">76</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_component</span> <span class="op">=</span> <span class="nam">component</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t77" href="#t77">77</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_dict</span> <span class="op">=</span> <span class="nam">sockets_dict</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">__dict__</span><span class="op">.</span><span class="nam">update</span><span class="op">(</span><span class="nam">sockets_dict</span><span class="op">)</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><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"> <span class="key">def</span> <span class="nam">__eq__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">value</span><span class="op">:</span> <span class="nam">object</span><span class="op">)</span> <span class="op">-></span> <span class="nam">bool</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t81" href="#t81">81</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">value</span><span class="op">,</span> <span class="nam">Sockets</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="mis show_mis"><span class="n"><a id="t82" href="#t82">82</a></span><span class="t"> <span class="key">return</span> <span class="key">False</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t83" href="#t83">83</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t84" href="#t84">84</a></span><span class="t"> <span class="key">return</span> <span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><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">_sockets_io_type</span> <span class="op">==</span> <span class="nam">value</span><span class="op">.</span><span class="nam">_sockets_io_type</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t86" href="#t86">86</a></span><span class="t"> <span class="key">and</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_component</span> <span class="op">==</span> <span class="nam">value</span><span class="op">.</span><span class="nam">_component</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t87" href="#t87">87</a></span><span class="t"> <span class="key">and</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_dict</span> <span class="op">==</span> <span class="nam">value</span><span class="op">.</span><span class="nam">_sockets_dict</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t88" href="#t88">88</a></span><span class="t"> <span class="op">)</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">__setitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> <span class="nam">socket</span><span class="op">:</span> <span class="nam">InputSocket</span> <span class="op">|</span> <span class="nam">OutputSocket</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"> Adds a new socket to this Sockets object.</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"> This eases a bit updating the list of sockets after Sockets has been created.</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"> That should happen only in the `component` decorator.</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 class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t97" href="#t97">97</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_dict</span><span class="op">[</span><span class="nam">key</span><span class="op">]</span> <span class="op">=</span> <span class="nam">socket</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t98" href="#t98">98</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">__dict__</span><span class="op">[</span><span class="nam">key</span><span class="op">]</span> <span class="op">=</span> <span class="nam">socket</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><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">def</span> <span class="nam">__contains__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">bool</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 class="nam">key</span> <span class="key">in</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_dict</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t102" href="#t102">102</a></span><span class="t"> </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">def</span> <span class="nam">get</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</span><span class="op">:</span> <span class="nam">str</span><span class="op">,</span> <span class="nam">default</span><span class="op">:</span> <span class="nam">InputSocket</span> <span class="op">|</span> <span class="nam">OutputSocket</span> <span class="op">|</span> <span class="key">None</span> <span class="op">=</span> <span class="key">None</span><span class="op">)</span> <span class="op">-></span> <span class="nam">InputSocket</span> <span class="op">|</span> <span class="nam">OutputSocket</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="t104" href="#t104">104</a></span><span class="t"> <span class="str">"""</span> </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="str"> Get a socket from the Sockets object.</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t107" href="#t107">107</a></span><span class="t"><span class="str"> :param key:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t108" href="#t108">108</a></span><span class="t"><span class="str"> The name of the socket to get.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t109" href="#t109">109</a></span><span class="t"><span class="str"> :param default:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t110" href="#t110">110</a></span><span class="t"><span class="str"> The value to return if the key is not found.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t111" href="#t111">111</a></span><span class="t"><span class="str"> :returns:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t112" href="#t112">112</a></span><span class="t"><span class="str"> The socket with the given key or `default` if the key is not found.</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 class="str"> """</span> </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="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_dict</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="nam">key</span><span class="op">,</span> <span class="nam">default</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t115" href="#t115">115</a></span><span class="t"> </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">def</span> <span class="nam">_component_name</span><span class="op">(</span><span class="nam">self</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="mis show_mis"><span class="n"><a id="t117" href="#t117">117</a></span><span class="t"> <span class="key">if</span> <span class="nam">pipeline</span> <span class="op">:=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_component</span><span class="op">.</span><span class="nam">__haystack_added_to_pipeline__</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t118" href="#t118">118</a></span><span class="t"> <span class="com"># This Component has been added in a Pipeline, let's get the name from there.</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">return</span> <span class="nam">pipeline</span><span class="op">.</span><span class="nam">get_component_name</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">_component</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="pln"><span class="n"><a id="t121" href="#t121">121</a></span><span class="t"> <span class="com"># This Component has not been added to a Pipeline yet, so we can't know its name.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t122" href="#t122">122</a></span><span class="t"> <span class="com"># Let's use default __repr__. We don't call repr() directly as Components have a custom</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 class="com"># __repr__ method and that would lead to infinite recursion since we call Sockets.__repr__ in it.</span> </span><span class="r"></span></p>
|
|
<p class="mis show_mis"><span class="n"><a id="t124" href="#t124">124</a></span><span class="t"> <span class="key">return</span> <span class="nam">object</span><span class="op">.</span><span class="nam">__repr__</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">_component</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t125" href="#t125">125</a></span><span class="t"> </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="key">def</span> <span class="nam">__getattribute__</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">Any</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Any</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t127" href="#t127">127</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="t128" href="#t128">128</a></span><span class="t"> <span class="nam">sockets</span> <span class="op">=</span> <span class="nam">object</span><span class="op">.</span><span class="nam">__getattribute__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="str">"_sockets"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="mis show_mis"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"> <span class="key">if</span> <span class="nam">name</span> <span class="key">in</span> <span class="nam">sockets</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="mis show_mis"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"> <span class="key">return</span> <span class="nam">sockets</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="t131" href="#t131">131</a></span><span class="t"> <span class="key">except</span> <span class="nam">AttributeError</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t132" href="#t132">132</a></span><span class="t"> <span class="key">pass</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><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t134" href="#t134">134</a></span><span class="t"> <span class="key">return</span> <span class="nam">object</span><span class="op">.</span><span class="nam">__getattribute__</span><span class="op">(</span><span class="nam">self</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="t135" href="#t135">135</a></span><span class="t"> </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="key">def</span> <span class="nam">__repr__</span><span class="op">(</span><span class="nam">self</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="run"><span class="n"><a id="t137" href="#t137">137</a></span><span class="t"> <span class="nam">result</span> <span class="op">=</span> <span class="str">""</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">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_io_type</span> <span class="op">==</span> <span class="nam">InputSocket</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="nam">result</span> <span class="op">=</span> <span class="str">"Inputs:\n"</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="key">elif</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_io_type</span> <span class="op">==</span> <span class="nam">OutputSocket</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"> <span class="nam">result</span> <span class="op">=</span> <span class="str">"Outputs:\n"</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t143" href="#t143">143</a></span><span class="t"> <span class="key">return</span> <span class="nam">result</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="op">[</span><span class="fst">f"</span><span class="fst"> - </span><span class="op">{</span><span class="nam">n</span><span class="op">}</span><span class="fst">: </span><span class="op">{</span><span class="nam">_type_name</span><span class="op">(</span><span class="nam">s</span><span class="op">.</span><span class="nam">type</span><span class="op">)</span><span class="op">}</span><span class="fst">"</span> <span class="key">for</span> <span class="nam">n</span><span class="op">,</span> <span class="nam">s</span> <span class="key">in</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_sockets_dict</span><span class="op">.</span><span class="nam">items</span><span class="op">(</span><span class="op">)</span><span class="op">]</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
</main>
|
|
<footer>
|
|
<div class="content">
|
|
<p>
|
|
<a class="nav" href="z_d0114671b518af99_component_py.html">« prev</a>
|
|
<a class="nav" href="index.html">^ index</a>
|
|
<a class="nav" href="z_d0114671b518af99_types_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>
|