Optional dependencies. (#2)

kuznia-rdzeni · Nov 20, 2024 · 0d37b9f · 0d37b9f
1 parent c806a84
commit 0d37b9f
Show file tree

Hide file tree

Showing 20 changed files with 39 additions and 17 deletions.
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/transactron.lib.doctree b/.doctrees/transactron.lib.doctree
diff --git a/.doctrees/transactron.utils.doctree b/.doctrees/transactron.utils.doctree
diff --git a/api.html b/api.html
@@ -168,7 +168,7 @@ <h2>transactron<a class="headerlink" href="#transactron" title="Permalink to thi
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/development-environment.html b/development-environment.html
@@ -181,7 +181,7 @@ <h3>tprof.py<a class="headerlink" href="#tprof-py" title="Permalink to this head
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/genindex.html b/genindex.html
@@ -703,10 +703,10 @@ <h2 id="G">G</h2>
       </ul></li>
       <li><a href="transactron.testing.html#transactron.testing.testbenchio.TestbenchIO.get_call_result">get_call_result() (transactron.testing.testbenchio.TestbenchIO method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="transactron.utils.html#transactron.utils.transactron_helpers.get_caller_class_name">get_caller_class_name() (in module transactron.utils.transactron_helpers)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="transactron.lib.html#transactron.lib.dependencies.DependencyManager.get_dependency">get_dependency() (transactron.lib.dependencies.DependencyManager method)</a>
 
       <ul>
@@ -723,6 +723,12 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="transactron.html#transactron.graph.OwnershipGraph.get_name">get_name() (transactron.graph.OwnershipGraph method)</a>
 </li>
+      <li><a href="transactron.lib.html#transactron.lib.dependencies.DependencyManager.get_optional_dependency">get_optional_dependency() (transactron.lib.dependencies.DependencyManager method)</a>
+
+      <ul>
+        <li><a href="transactron.utils.html#transactron.utils.dependencies.DependencyManager.get_optional_dependency">(transactron.utils.dependencies.DependencyManager method)</a>
+</li>
+      </ul></li>
       <li><a href="transactron.testing.html#transactron.testing.testbenchio.TestbenchIO.get_outputs">get_outputs() (transactron.testing.testbenchio.TestbenchIO method)</a>
 </li>
       <li><a href="transactron.lib.html#transactron.lib.metrics.HardwareMetricsManager.get_register_value">get_register_value() (transactron.lib.metrics.HardwareMetricsManager method)</a>
@@ -1783,7 +1789,7 @@ <h2 id="W">W</h2>
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/index.html b/index.html
@@ -129,7 +129,7 @@ <h1>Transactron<a class="headerlink" href="#transactron" title="Permalink to thi
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/modules.html b/modules.html
@@ -154,7 +154,7 @@ <h1>transactron<a class="headerlink" href="#transactron" title="Permalink to thi
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/objects.inv b/objects.inv
diff --git a/py-modindex.html b/py-modindex.html
@@ -333,7 +333,7 @@ <h1>Python Module Index</h1>
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/search.html b/search.html
@@ -91,7 +91,7 @@
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/transactions.html b/transactions.html
@@ -400,7 +400,7 @@ <h3>Transaction and method nesting<a class="headerlink" href="#transaction-and-m
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/transactron.core.html b/transactron.core.html
@@ -954,7 +954,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/transactron.html b/transactron.html
@@ -745,7 +745,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/transactron.lib.html b/transactron.lib.html
@@ -611,6 +611,14 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>The way dependencies are interpreted is dependent on the key type.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="transactron.lib.dependencies.DependencyManager.get_optional_dependency">
+<span class="sig-name descname"><span class="pre">get_optional_dependency</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.utils.html#transactron.utils.dependencies.DependencyKey" title="transactron.utils.dependencies.DependencyKey"><span class="pre">DependencyKey</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">U</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><span class="pre">U</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#transactron.lib.dependencies.DependencyManager.get_optional_dependency" title="Permalink to this definition"></a></dt>
+<dd><p>Gets the dependency for a key, if it exists.</p>
+<p>If the dependency is gettable, the return value is the same as in
+<cite>get_dependency</cite>. Otherwise, <cite>None</cite> is returned.</p>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">
@@ -2252,7 +2260,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/transactron.testing.html b/transactron.testing.html
@@ -473,7 +473,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/transactron.utils.amaranth_ext.html b/transactron.utils.amaranth_ext.html
@@ -633,7 +633,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>
 

diff --git a/transactron.utils.html b/transactron.utils.html
@@ -468,6 +468,14 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>The way dependencies are interpreted is dependent on the key type.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="transactron.utils.dependencies.DependencyManager.get_optional_dependency">
+<span class="sig-name descname"><span class="pre">get_optional_dependency</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#transactron.utils.dependencies.DependencyKey" title="transactron.utils.dependencies.DependencyKey"><span class="pre">DependencyKey</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">U</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><span class="pre">U</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#transactron.utils.dependencies.DependencyManager.get_optional_dependency" title="Permalink to this definition"></a></dt>
+<dd><p>Gets the dependency for a key, if it exists.</p>
+<p>If the dependency is gettable, the return value is the same as in
+<cite>get_dependency</cite>. Otherwise, <cite>None</cite> is returned.</p>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class">
@@ -820,7 +828,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2024.
-      <span class="lastupdated">Last updated on 20:38 2024-11-19.
+      <span class="lastupdated">Last updated on 10:52 2024-11-20.
       </span></p>
   </div>