-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
85 changed files
with
2,843 additions
and
2,288 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: d97fe96d42dbd27545146cd477179c43 | ||
| config: ede650957a02b475b6fb53791b321e15 | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,19 @@ | ||
| <!doctype html> | ||
| <html class="no-js"> | ||
| <html class="no-js" lang="en"> | ||
| <head><meta charset="utf-8"/> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1"/> | ||
| <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /> | ||
|
|
||
| <meta name="generator" content="sphinx-4.5.0, furo 2022.09.29"/> | ||
| <!-- Generated with Sphinx 5.0.2 and Furo 2023.03.27 --> | ||
| <title>abc - Sashimi</title> | ||
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/togglebutton.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/mystnb.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> | ||
|
|
||
|
|
||
|
|
@@ -157,7 +157,7 @@ | |
| <span class="sidebar-brand-text">Sashimi</span> | ||
|
|
||
| </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> | ||
| <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> | ||
| <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> | ||
| <input type="hidden" name="check_keywords" value="yes"> | ||
| <input type="hidden" name="area" value="default"> | ||
| </form> | ||
|
|
@@ -279,7 +279,7 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
|
|
||
|
|
||
| <div class="viewcode-block" id="abstractmethod"><a class="viewcode-back" href="../api/sashimi.hardware.scanning.html#sashimi.hardware.scanning.abstractmethod">[docs]</a><span class="k">def</span> <span class="nf">abstractmethod</span><span class="p">(</span><span class="n">funcobj</span><span class="p">):</span> | ||
| <span class="sd">"""A decorator indicating abstract methods.</span> | ||
| <span class="w"> </span><span class="sd">"""A decorator indicating abstract methods.</span> | ||
|
|
||
| <span class="sd"> Requires that the metaclass is ABCMeta or derived from it. A</span> | ||
| <span class="sd"> class that has a metaclass derived from ABCMeta cannot be</span> | ||
|
|
@@ -300,33 +300,33 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
|
|
||
|
|
||
| <span class="k">class</span> <span class="nc">abstractclassmethod</span><span class="p">(</span><span class="nb">classmethod</span><span class="p">):</span> | ||
| <span class="sd">"""A decorator indicating abstract classmethods.</span> | ||
| <span class="w"> </span><span class="sd">"""A decorator indicating abstract classmethods.</span> | ||
|
|
||
| <span class="sd"> Deprecated, use 'classmethod' with 'abstractmethod' instead.</span> | ||
| <span class="sd"> """</span> | ||
|
|
||
| <span class="n">__isabstractmethod__</span> <span class="o">=</span> <span class="kc">True</span> | ||
|
|
||
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callable</span><span class="p">):</span> | ||
| <span class="n">callable</span><span class="o">.</span><span class="n">__isabstractmethod__</span> <span class="o">=</span> <span class="kc">True</span> | ||
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">callable</span><span class="p">)</span> | ||
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">callable</span><span class="p">):</span> | ||
| <span class="nb">callable</span><span class="o">.</span><span class="n">__isabstractmethod__</span> <span class="o">=</span> <span class="kc">True</span> | ||
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">callable</span><span class="p">)</span> | ||
|
|
||
|
|
||
| <span class="k">class</span> <span class="nc">abstractstaticmethod</span><span class="p">(</span><span class="nb">staticmethod</span><span class="p">):</span> | ||
| <span class="sd">"""A decorator indicating abstract staticmethods.</span> | ||
| <span class="w"> </span><span class="sd">"""A decorator indicating abstract staticmethods.</span> | ||
|
|
||
| <span class="sd"> Deprecated, use 'staticmethod' with 'abstractmethod' instead.</span> | ||
| <span class="sd"> """</span> | ||
|
|
||
| <span class="n">__isabstractmethod__</span> <span class="o">=</span> <span class="kc">True</span> | ||
|
|
||
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callable</span><span class="p">):</span> | ||
| <span class="n">callable</span><span class="o">.</span><span class="n">__isabstractmethod__</span> <span class="o">=</span> <span class="kc">True</span> | ||
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">callable</span><span class="p">)</span> | ||
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">callable</span><span class="p">):</span> | ||
| <span class="nb">callable</span><span class="o">.</span><span class="n">__isabstractmethod__</span> <span class="o">=</span> <span class="kc">True</span> | ||
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">callable</span><span class="p">)</span> | ||
|
|
||
|
|
||
| <span class="k">class</span> <span class="nc">abstractproperty</span><span class="p">(</span><span class="nb">property</span><span class="p">):</span> | ||
| <span class="sd">"""A decorator indicating abstract properties.</span> | ||
| <span class="w"> </span><span class="sd">"""A decorator indicating abstract properties.</span> | ||
|
|
||
| <span class="sd"> Deprecated, use 'property' with 'abstractmethod' instead.</span> | ||
| <span class="sd"> """</span> | ||
|
|
@@ -343,7 +343,7 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
| <span class="n">ABCMeta</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="s1">'abc'</span> | ||
| <span class="k">else</span><span class="p">:</span> | ||
| <span class="k">class</span> <span class="nc">ABCMeta</span><span class="p">(</span><span class="nb">type</span><span class="p">):</span> | ||
| <span class="sd">"""Metaclass for defining Abstract Base Classes (ABCs).</span> | ||
| <span class="w"> </span><span class="sd">"""Metaclass for defining Abstract Base Classes (ABCs).</span> | ||
|
|
||
| <span class="sd"> Use this metaclass to create an ABC. An ABC can be subclassed</span> | ||
| <span class="sd"> directly, and then acts as a mix-in class. You can also register</span> | ||
|
|
@@ -361,22 +361,22 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
| <span class="k">return</span> <span class="bp">cls</span> | ||
|
|
||
| <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">):</span> | ||
| <span class="sd">"""Register a virtual subclass of an ABC.</span> | ||
| <span class="w"> </span><span class="sd">"""Register a virtual subclass of an ABC.</span> | ||
|
|
||
| <span class="sd"> Returns the subclass, to allow usage as a class decorator.</span> | ||
| <span class="sd"> """</span> | ||
| <span class="k">return</span> <span class="n">_abc_register</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">)</span> | ||
|
|
||
| <span class="k">def</span> <span class="fm">__instancecheck__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">instance</span><span class="p">):</span> | ||
| <span class="sd">"""Override for isinstance(instance, cls)."""</span> | ||
| <span class="w"> </span><span class="sd">"""Override for isinstance(instance, cls)."""</span> | ||
| <span class="k">return</span> <span class="n">_abc_instancecheck</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">instance</span><span class="p">)</span> | ||
|
|
||
| <span class="k">def</span> <span class="fm">__subclasscheck__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">):</span> | ||
| <span class="sd">"""Override for issubclass(subclass, cls)."""</span> | ||
| <span class="w"> </span><span class="sd">"""Override for issubclass(subclass, cls)."""</span> | ||
| <span class="k">return</span> <span class="n">_abc_subclasscheck</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">)</span> | ||
|
|
||
| <span class="k">def</span> <span class="nf">_dump_registry</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> | ||
| <span class="sd">"""Debug helper to print the ABC registry."""</span> | ||
| <span class="w"> </span><span class="sd">"""Debug helper to print the ABC registry."""</span> | ||
| <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Class: </span><span class="si">{</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__module__</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__qualname__</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="n">file</span><span class="p">)</span> | ||
| <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Inv. counter: </span><span class="si">{</span><span class="n">get_cache_token</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="n">file</span><span class="p">)</span> | ||
| <span class="p">(</span><span class="n">_abc_registry</span><span class="p">,</span> <span class="n">_abc_cache</span><span class="p">,</span> <span class="n">_abc_negative_cache</span><span class="p">,</span> | ||
|
|
@@ -388,16 +388,16 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
| <span class="n">file</span><span class="o">=</span><span class="n">file</span><span class="p">)</span> | ||
|
|
||
| <span class="k">def</span> <span class="nf">_abc_registry_clear</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span> | ||
| <span class="sd">"""Clear the registry (for debugging or testing)."""</span> | ||
| <span class="w"> </span><span class="sd">"""Clear the registry (for debugging or testing)."""</span> | ||
| <span class="n">_reset_registry</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> | ||
|
|
||
| <span class="k">def</span> <span class="nf">_abc_caches_clear</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span> | ||
| <span class="sd">"""Clear the caches (for debugging or testing)."""</span> | ||
| <span class="w"> </span><span class="sd">"""Clear the caches (for debugging or testing)."""</span> | ||
| <span class="n">_reset_caches</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> | ||
|
|
||
|
|
||
| <div class="viewcode-block" id="ABC"><a class="viewcode-back" href="../api/sashimi.hardware.scanning.ABC.html#sashimi.hardware.scanning.ABC">[docs]</a><span class="k">class</span> <span class="nc">ABC</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span> | ||
| <span class="sd">"""Helper class that provides a standard way to create an ABC using</span> | ||
| <span class="w"> </span><span class="sd">"""Helper class that provides a standard way to create an ABC using</span> | ||
| <span class="sd"> inheritance.</span> | ||
| <span class="sd"> """</span> | ||
| <span class="vm">__slots__</span> <span class="o">=</span> <span class="p">()</span></div> | ||
|
|
@@ -421,9 +421,7 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
|
|
||
| </div> | ||
| <div class="right-details"> | ||
| <div class="icons"> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
|
|
@@ -438,15 +436,16 @@ <h1>Source code for abc</h1><div class="highlight"><pre> | |
| </div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> | ||
| <script src="../_static/jquery.js"></script> | ||
| <script src="../_static/underscore.js"></script> | ||
| <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> | ||
| <script src="../_static/doctools.js"></script> | ||
| <script src="../_static/clipboard.min.js"></script> | ||
| <script src="../_static/copybutton.js"></script> | ||
| <script src="../_static/scripts/sphinx-book-theme.js?digest=9c920249402e914e316237a7dbc6769907cce411"></script> | ||
| <script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script> | ||
| <script>let toggleHintShow = 'Click to show';</script> | ||
| <script>let toggleHintHide = 'Click to hide';</script> | ||
| <script>let toggleOpenOnPrint = 'true';</script> | ||
| <script src="../_static/togglebutton.js"></script> | ||
| <script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script> | ||
| <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script> | ||
| <script src="../_static/design-tabs.js"></script> | ||
| <script src="../_static/scripts/furo.js"></script> | ||
| <script>const THEBE_JS_URL = "https://unpkg.com/[email protected]/lib/index.js" | ||
|
|
||
Oops, something went wrong.