I HAVE GENERATED YOUR NEW DOCS!

This commit is contained in:
github-actions[bot]
2023-08-16 23:39:29 +00:00
parent 8ba29a105d
commit 3cde65018e
1864 changed files with 73893 additions and 24381 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.models.modeling_outcome &mdash; kittycad v0.4.5 documentation</title>
<title>kittycad.models.modeling_outcome &mdash; kittycad v0.4.6 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
@ -13,13 +13,13 @@
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=80626fd4"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../_static/copybutton.js?v=f281be69"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.5
v0.4.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@ -86,23 +86,24 @@
<span class="kn">from</span> <span class="nn">..models.modeling_cmd_id</span> <span class="kn">import</span> <span class="n">ModelingCmdId</span>
<span class="kn">from</span> <span class="nn">..types</span> <span class="kn">import</span> <span class="n">UNSET</span><span class="p">,</span> <span class="n">Unset</span>
<span class="kn">from</span> <span class="nn">.modeling_error</span> <span class="kn">import</span> <span class="n">ModelingError</span>
<span class="kn">from</span> <span class="nn">.ok_modeling_cmd_response</span> <span class="kn">import</span> <span class="n">OkModelingCmdResponse</span>
<span class="n">Success</span> <span class="o">=</span> <span class="n">Any</span>
<span class="n">success</span> <span class="o">=</span> <span class="n">OkModelingCmdResponse</span>
<span class="n">Error</span> <span class="o">=</span> <span class="n">ModelingError</span>
<span class="n">error</span> <span class="o">=</span> <span class="n">ModelingError</span>
<span class="n">CB</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;CB&quot;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s2">&quot;Cancelled&quot;</span><span class="p">)</span>
<span class="n">GN</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;GN&quot;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s2">&quot;cancelled&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="Cancelled"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled">[docs]</a><span class="nd">@attr</span><span class="o">.</span><span class="n">s</span><span class="p">(</span><span class="n">auto_attribs</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Cancelled</span><span class="p">:</span>
<div class="viewcode-block" id="cancelled"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled">[docs]</a><span class="nd">@attr</span><span class="o">.</span><span class="n">s</span><span class="p">(</span><span class="n">auto_attribs</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">cancelled</span><span class="p">:</span>
<span class="n">what_failed</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Unset</span><span class="p">,</span> <span class="n">ModelingCmdId</span><span class="p">]</span> <span class="o">=</span> <span class="n">UNSET</span>
<span class="n">additional_properties</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">attr</span><span class="o">.</span><span class="n">ib</span><span class="p">(</span><span class="n">init</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span>
<div class="viewcode-block" id="Cancelled.to_dict"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled.to_dict">[docs]</a> <span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<div class="viewcode-block" id="cancelled.to_dict"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled.to_dict">[docs]</a> <span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">what_failed</span><span class="p">,</span> <span class="n">Unset</span><span class="p">):</span>
<span class="n">what_failed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">what_failed</span>
@ -114,8 +115,8 @@
<span class="k">return</span> <span class="n">field_dict</span></div>
<div class="viewcode-block" id="Cancelled.from_dict"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled.from_dict">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="bp">cls</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">CB</span><span class="p">],</span> <span class="n">src_dict</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">CB</span><span class="p">:</span>
<div class="viewcode-block" id="cancelled.from_dict"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled.from_dict">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="bp">cls</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">GN</span><span class="p">],</span> <span class="n">src_dict</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">GN</span><span class="p">:</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">src_dict</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">_what_failed</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;what_failed&quot;</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">)</span>
<span class="n">what_failed</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Unset</span><span class="p">,</span> <span class="n">ModelingCmdId</span><span class="p">]</span>
@ -135,20 +136,20 @@
<span class="k">def</span> <span class="nf">additional_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<div class="viewcode-block" id="Cancelled.__getitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled.__getitem__">[docs]</a> <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<div class="viewcode-block" id="cancelled.__getitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled.__getitem__">[docs]</a> <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">[</span><span class="n">key</span><span class="p">]</span></div>
<div class="viewcode-block" id="Cancelled.__setitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled.__setitem__">[docs]</a> <span class="k">def</span> <span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<div class="viewcode-block" id="cancelled.__setitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled.__setitem__">[docs]</a> <span class="k">def</span> <span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span></div>
<div class="viewcode-block" id="Cancelled.__delitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled.__delitem__">[docs]</a> <span class="k">def</span> <span class="fm">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<div class="viewcode-block" id="cancelled.__delitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled.__delitem__">[docs]</a> <span class="k">def</span> <span class="fm">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span><span class="p">[</span><span class="n">key</span><span class="p">]</span></div>
<div class="viewcode-block" id="Cancelled.__contains__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.Cancelled.html#kittycad.models.modeling_outcome.Cancelled.__contains__">[docs]</a> <span class="k">def</span> <span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<div class="viewcode-block" id="cancelled.__contains__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_outcome.cancelled.html#kittycad.models.modeling_outcome.cancelled.__contains__">[docs]</a> <span class="k">def</span> <span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="k">return</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">additional_properties</span></div></div>
<span class="n">ModelingOutcome</span> <span class="o">=</span> <span class="n">Union</span><span class="p">[</span><span class="n">Success</span><span class="p">,</span> <span class="n">Error</span><span class="p">,</span> <span class="n">Cancelled</span><span class="p">]</span>
<span class="n">ModelingOutcome</span> <span class="o">=</span> <span class="n">Union</span><span class="p">[</span><span class="n">success</span><span class="p">,</span> <span class="n">error</span><span class="p">,</span> <span class="n">cancelled</span><span class="p">]</span>
</pre></div>
</div>