github-actions
222 lines
39 KiB
HTML
222 lines
39 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>Coverage for haystack/dataclasses/byte_stream.py: 100%</title>
|
|
<link rel="icon" sizes="32x32" href="favicon_32_cb_c827f16f.png">
|
|
<link rel="stylesheet" href="style_cb_4667309f.css" type="text/css">
|
|
<script src="coverage_html_cb_dd2e7eb5.js" defer></script>
|
|
</head>
|
|
<body class="pyfile">
|
|
<header>
|
|
<div class="content">
|
|
<h1>
|
|
<span class="text">Coverage for </span><b>haystack<span class="sep">/</span>dataclasses<span class="sep">/</span>byte_stream.py</b>:
|
|
<span class="pc_cov">100%</span>
|
|
</h1>
|
|
<aside id="help_panel_wrapper">
|
|
<input id="help_panel_state" type="checkbox">
|
|
<label for="help_panel_state">
|
|
<img id="keyboard_icon" src="keybd_closed_cb_900cfef5.png" alt="Show/hide keyboard shortcuts">
|
|
</label>
|
|
<div id="help_panel">
|
|
<p class="legend">Shortcuts on this page</p>
|
|
<div class="keyhelp">
|
|
<p>
|
|
<kbd>r</kbd>
|
|
<kbd>m</kbd>
|
|
<kbd>x</kbd>
|
|
toggle line displays
|
|
</p>
|
|
<p>
|
|
<kbd>j</kbd>
|
|
<kbd>k</kbd>
|
|
next/prev highlighted chunk
|
|
</p>
|
|
<p>
|
|
<kbd>0</kbd> (zero) top of page
|
|
</p>
|
|
<p>
|
|
<kbd>1</kbd> (one) first highlighted chunk
|
|
</p>
|
|
<p>
|
|
<kbd>[</kbd>
|
|
<kbd>]</kbd>
|
|
prev/next file
|
|
</p>
|
|
<p>
|
|
<kbd>u</kbd> up to the index
|
|
</p>
|
|
<p>
|
|
<kbd>?</kbd> show/hide this help
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</aside>
|
|
<h2>
|
|
<span class="text">39 statements </span>
|
|
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">39<span class="text"> run</span></button>
|
|
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">0<span class="text"> missing</span></button>
|
|
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">0<span class="text"> excluded</span></button>
|
|
</h2>
|
|
<p class="text">
|
|
<a id="prevFileLink" class="nav" href="z_9dcdde560c860e5e_breakpoints_py.html">« prev</a>
|
|
<a id="indexLink" class="nav" href="index.html">^ index</a>
|
|
<a id="nextFileLink" class="nav" href="z_9dcdde560c860e5e_chat_message_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">dataclasses</span> <span class="key">import</span> <span class="nam">dataclass</span><span class="op">,</span> <span class="nam">field</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">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="t7" href="#t7">7</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="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="nam">haystack</span><span class="op">.</span><span class="nam">utils</span><span class="op">.</span><span class="nam">dataclasses</span> <span class="key">import</span> <span class="nam">_warn_on_inplace_mutation</span> </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">from</span> <span class="nam">haystack</span><span class="op">.</span><span class="nam">utils</span><span class="op">.</span><span class="nam">misc</span> <span class="key">import</span> <span class="nam">_guess_mime_type</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="pln"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"> </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="op">@</span><span class="nam">_warn_on_inplace_mutation</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="op">@</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">repr</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="t15" href="#t15">15</a></span><span class="t"><span class="key">class</span> <span class="nam">ByteStream</span><span class="op">:</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"> Base data class representing a binary object in the Haystack API.</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"> :param data: The binary data stored in Bytestream.</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"> :param meta: Additional metadata to be stored with the ByteStream.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"><span class="str"> :param mime_type: The mime type of the binary data.</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 class="str"> """</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><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"> <span class="nam">data</span><span class="op">:</span> <span class="nam">bytes</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t25" href="#t25">25</a></span><span class="t"> <span class="nam">meta</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">field</span><span class="op">(</span><span class="nam">default_factory</span><span class="op">=</span><span class="nam">dict</span><span class="op">,</span> <span class="nam">hash</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="t26" href="#t26">26</a></span><span class="t"> <span class="nam">mime_type</span><span class="op">:</span> <span class="nam">str</span> <span class="op">|</span> <span class="key">None</span> <span class="op">=</span> <span class="nam">field</span><span class="op">(</span><span class="nam">default</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="t27" href="#t27">27</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"> <span class="key">def</span> <span class="nam">to_file</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">destination_path</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="t29" href="#t29">29</a></span><span class="t"> <span class="str">"""</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"> Write the ByteStream to a file. Note: the metadata will be lost.</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 destination_path: The path to write the ByteStream to.</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"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"> <span class="key">with</span> <span class="nam">open</span><span class="op">(</span><span class="nam">destination_path</span><span class="op">,</span> <span class="str">"wb"</span><span class="op">)</span> <span class="key">as</span> <span class="nam">fd</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"> <span class="nam">fd</span><span class="op">.</span><span class="nam">write</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">data</span><span class="op">)</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><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t37" href="#t37">37</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="t38" href="#t38">38</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_file_path</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> <span class="nam">cls</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t40" href="#t40">40</a></span><span class="t"> <span class="nam">filepath</span><span class="op">:</span> <span class="nam">Path</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> <span class="nam">mime_type</span><span class="op">:</span> <span class="nam">str</span> <span class="op">|</span> <span class="key">None</span> <span class="op">=</span> <span class="key">None</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"> <span class="nam">meta</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="key">None</span> <span class="op">=</span> <span class="key">None</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"> <span class="nam">guess_mime_type</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t44" href="#t44">44</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="str">"ByteStream"</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 class="str">"""</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"> Create a ByteStream from the contents read from a file.</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"> :param filepath: A valid path to a file.</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"> :param mime_type: The mime type of the file.</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"> :param meta: Additional metadata to be stored with the ByteStream.</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"> :param guess_mime_type: Whether to guess the mime type from the file.</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 class="str"> """</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">if</span> <span class="key">not</span> <span class="nam">mime_type</span> <span class="key">and</span> <span class="nam">guess_mime_type</span><span class="op">:</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="nam">mime_type</span> <span class="op">=</span> <span class="nam">_guess_mime_type</span><span class="op">(</span><span class="nam">filepath</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"> <span class="key">with</span> <span class="nam">open</span><span class="op">(</span><span class="nam">filepath</span><span class="op">,</span> <span class="str">"rb"</span><span class="op">)</span> <span class="key">as</span> <span class="nam">fd</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t56" href="#t56">56</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span><span class="nam">data</span><span class="op">=</span><span class="nam">fd</span><span class="op">.</span><span class="nam">read</span><span class="op">(</span><span class="op">)</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">meta</span><span class="op">=</span><span class="nam">meta</span> <span class="key">or</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="t57" href="#t57">57</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t58" href="#t58">58</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="t59" href="#t59">59</a></span><span class="t"> <span class="key">def</span> <span class="nam">from_string</span><span class="op">(</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t60" href="#t60">60</a></span><span class="t"> <span class="nam">cls</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="nam">encoding</span><span class="op">:</span> <span class="nam">str</span> <span class="op">=</span> <span class="str">"utf-8"</span><span class="op">,</span> <span class="nam">mime_type</span><span class="op">:</span> <span class="nam">str</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="nam">meta</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="key">None</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p>
|
|
<p class="run run2"><span class="n"><a id="t61" href="#t61">61</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="str">"ByteStream"</span><span class="op">:</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 class="str">"""</span> </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"> Create a ByteStream encoding a string.</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><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"> :param text: The string to encode</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"> :param encoding: The encoding used to convert the string into bytes</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"> :param mime_type: The mime type of the 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"> :param meta: Additional metadata to be stored with the ByteStream.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t69" href="#t69">69</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t70" href="#t70">70</a></span><span class="t"> <span class="key">return</span> <span class="nam">cls</span><span class="op">(</span><span class="nam">data</span><span class="op">=</span><span class="nam">text</span><span class="op">.</span><span class="nam">encode</span><span class="op">(</span><span class="nam">encoding</span><span class="op">)</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">meta</span><span class="op">=</span><span class="nam">meta</span> <span class="key">or</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="t71" href="#t71">71</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t72" href="#t72">72</a></span><span class="t"> <span class="key">def</span> <span class="nam">to_string</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">encoding</span><span class="op">:</span> <span class="nam">str</span> <span class="op">=</span> <span class="str">"utf-8"</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="t73" href="#t73">73</a></span><span class="t"> <span class="str">"""</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"> Convert the ByteStream to a string, metadata will not be included.</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><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"> :param encoding: The encoding used to convert the bytes to a string. Defaults to "utf-8".</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 class="str"> :returns: The string representation of the ByteStream.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"><span class="str"> :raises UnicodeDecodeError: If the ByteStream data cannot be decoded with the specified encoding.</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"> """</span> </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">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">data</span><span class="op">.</span><span class="nam">decode</span><span class="op">(</span><span class="nam">encoding</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t81" href="#t81">81</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t82" href="#t82">82</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="pln"><span class="n"><a id="t83" href="#t83">83</a></span><span class="t"> <span class="str">"""</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="str"> Return a string representation of the ByteStream, truncating the data to 100 bytes.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t85" href="#t85">85</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t86" href="#t86">86</a></span><span class="t"> <span class="nam">fields</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="t87" href="#t87">87</a></span><span class="t"> <span class="nam">truncated_data</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">data</span><span class="op">[</span><span class="op">:</span><span class="num">100</span><span class="op">]</span> <span class="op">+</span> <span class="str">b"..."</span> <span class="key">if</span> <span class="nam">len</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">data</span><span class="op">)</span> <span class="op">></span> <span class="num">100</span> <span class="key">else</span> <span class="nam">self</span><span class="op">.</span><span class="nam">data</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">fields</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="fst">f"</span><span class="fst">data=</span><span class="op">{</span><span class="nam">truncated_data</span><span class="op">!</span><span class="nam">r</span><span class="op">}</span><span class="fst">"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t89" href="#t89">89</a></span><span class="t"> <span class="nam">fields</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="fst">f"</span><span class="fst">meta=</span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">meta</span><span class="op">!</span><span class="nam">r</span><span class="op">}</span><span class="fst">"</span><span class="op">)</span> </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="nam">fields</span><span class="op">.</span><span class="nam">append</span><span class="op">(</span><span class="fst">f"</span><span class="fst">mime_type=</span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">mime_type</span><span class="op">!</span><span class="nam">r</span><span class="op">}</span><span class="fst">"</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t91" href="#t91">91</a></span><span class="t"> <span class="nam">fields_str</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">fields</span><span class="op">)</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t92" href="#t92">92</a></span><span class="t"> <span class="key">return</span> <span class="fst">f"</span><span class="op">{</span><span class="nam">self</span><span class="op">.</span><span class="nam">__class__</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">fields_str</span><span class="op">}</span><span class="fst">)</span><span class="fst">"</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="run"><span class="n"><a id="t94" href="#t94">94</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="t95" href="#t95">95</a></span><span class="t"> <span class="str">"""</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"> Convert the ByteStream to a dictionary representation.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t97" href="#t97">97</a></span><span class="t"> </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"> :returns: A dictionary with keys 'data', 'meta', and 'mime_type'.</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="pln"><span class="n"><a id="t100" href="#t100">100</a></span><span class="t"> <span class="com"># Note: The data is converted to a list of integers for serialization since JSON does not support bytes</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t101" href="#t101">101</a></span><span class="t"> <span class="com"># directly.</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">return</span> <span class="op">{</span><span class="str">"data"</span><span class="op">:</span> <span class="nam">list</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">data</span><span class="op">)</span><span class="op">,</span> <span class="str">"meta"</span><span class="op">:</span> <span class="nam">self</span><span class="op">.</span><span class="nam">meta</span><span class="op">,</span> <span class="str">"mime_type"</span><span class="op">:</span> <span class="nam">self</span><span class="op">.</span><span class="nam">mime_type</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t103" href="#t103">103</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t104" href="#t104">104</a></span><span class="t"> <span class="key">def</span> <span class="nam">_to_trace_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="t105" href="#t105">105</a></span><span class="t"> <span class="str">"""</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="str"> Convert the ByteStream to a dictionary representation for tracing.</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><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"> Binary data is replaced with a placeholder string to avoid sending large payloads to the tracing backend.</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><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"> :returns:</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"> Serialized version of the object only for tracing purposes.</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"> """</span> </span><span class="r"></span></p>
|
|
<p class="run"><span class="n"><a id="t113" href="#t113">113</a></span><span class="t"> <span class="key">return</span> <span class="op">{</span><span class="str">"data"</span><span class="op">:</span> <span class="fst">f"</span><span class="fst">Binary data (</span><span class="op">{</span><span class="nam">len</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">data</span><span class="op">)</span><span class="op">}</span><span class="fst"> bytes)</span><span class="fst">"</span><span class="op">,</span> <span class="str">"meta"</span><span class="op">:</span> <span class="nam">self</span><span class="op">.</span><span class="nam">meta</span><span class="op">,</span> <span class="str">"mime_type"</span><span class="op">:</span> <span class="nam">self</span><span class="op">.</span><span class="nam">mime_type</span><span class="op">}</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t114" href="#t114">114</a></span><span class="t"> </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="op">@</span><span class="nam">classmethod</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">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">"ByteStream"</span><span class="op">:</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t117" href="#t117">117</a></span><span class="t"> <span class="str">"""</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="str"> Create a ByteStream from a dictionary representation.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t119" href="#t119">119</a></span><span class="t"> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t120" href="#t120">120</a></span><span class="t"><span class="str"> :param data: A dictionary with keys 'data', 'meta', and 'mime_type'.</span> </span><span class="r"></span></p>
|
|
<p class="pln"><span class="n"><a id="t121" href="#t121">121</a></span><span class="t"> </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="str"> :returns: A ByteStream instance.</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="str"> """</span> </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="key">return</span> <span class="nam">ByteStream</span><span class="op">(</span><span class="nam">data</span><span class="op">=</span><span class="nam">bytes</span><span class="op">(</span><span class="nam">data</span><span class="op">[</span><span class="str">"data"</span><span class="op">]</span><span class="op">)</span><span class="op">,</span> <span class="nam">meta</span><span class="op">=</span><span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"meta"</span><span class="op">,</span> <span class="op">{</span><span class="op">}</span><span class="op">)</span><span class="op">,</span> <span class="nam">mime_type</span><span class="op">=</span><span class="nam">data</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"mime_type"</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_9dcdde560c860e5e_breakpoints_py.html">« prev</a>
|
|
<a class="nav" href="index.html">^ index</a>
|
|
<a class="nav" href="z_9dcdde560c860e5e_chat_message_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>
|