ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source 
Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2023-12-05 16:25:51 -08:00
parent 3467a5d5dd
commit 43cc9d18b6
2585 changed files with 705361 additions and 171748 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
docs/html/_modules/kittycad/models/system.html
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.system &mdash; kittycad v0.4.6 documentation</title>
<title>kittycad.models.system &mdash; kittycad v0.5.9 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" />
@ -15,7 +15,7 @@
<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 data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=19ad864f"></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>
@ -37,7 +37,7 @@
kittycad
</a>
<div class="version">
v0.4.6
v0.5.9
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@ -79,18 +79,13 @@
<div itemprop="articleBody">
<h1>Source code for kittycad.models.system</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Type</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Union</span>
<span class="kn">import</span> <span class="nn">attr</span>
<span></span>
<span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">BaseModel</span>
<span class="kn">from</span> <span class="nn">..models.axis_direction_pair</span> <span class="kn">import</span> <span class="n">AxisDirectionPair</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="n">MT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;MT&quot;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="s2">&quot;System&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="System"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System">[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">System</span><span class="p">:</span>
<div class="viewcode-block" id="System"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System">[docs]</a><span class="k">class</span> <span class="nc">System</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Co-ordinate system definition.</span>
<span class="sd"> The `up` axis must be orthogonal to the `forward` axis.</span>
@ -98,69 +93,11 @@
<span class="sd"> See [cglearn.eu] for background reading.</span>
<span class="sd"> [cglearn.eu](https://cglearn.eu/pub/computer-graphics/introduction-to-geometry#material-coordinate-systems-1)</span>
<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">forward</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">AxisDirectionPair</span><span class="p">]</span> <span class="o">=</span> <span class="n">UNSET</span>
<span class="n">up</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">AxisDirectionPair</span><span class="p">]</span> <span class="o">=</span> <span class="n">UNSET</span>
<span class="n">forward</span><span class="p">:</span> <span class="n">AxisDirectionPair</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="System.to_dict"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System.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">forward</span><span class="p">,</span> <span class="n">Unset</span><span class="p">):</span>
<span class="n">forward</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">forward</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">up</span><span class="p">,</span> <span class="n">Unset</span><span class="p">):</span>
<span class="n">up</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">up</span>
<span class="n">field_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">=</span> <span class="p">{}</span>
<span class="n">field_dict</span><span class="o">.</span><span class="n">update</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">field_dict</span><span class="o">.</span><span class="n">update</span><span class="p">({})</span>
<span class="k">if</span> <span class="n">forward</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">UNSET</span><span class="p">:</span>
<span class="n">field_dict</span><span class="p">[</span><span class="s2">&quot;forward&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">forward</span>
<span class="k">if</span> <span class="n">up</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">UNSET</span><span class="p">:</span>
<span class="n">field_dict</span><span class="p">[</span><span class="s2">&quot;up&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">up</span>
<span class="k">return</span> <span class="n">field_dict</span></div>
<div class="viewcode-block" id="System.from_dict"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System.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">MT</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">MT</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">_forward</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;forward&quot;</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">)</span>
<span class="n">forward</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">AxisDirectionPair</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">_forward</span><span class="p">,</span> <span class="n">Unset</span><span class="p">):</span>
<span class="n">forward</span> <span class="o">=</span> <span class="n">UNSET</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">forward</span> <span class="o">=</span> <span class="n">_forward</span> <span class="c1"># type: ignore[arg-type]</span>
<span class="n">_up</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;up&quot;</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">)</span>
<span class="n">up</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">AxisDirectionPair</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">_up</span><span class="p">,</span> <span class="n">Unset</span><span class="p">):</span>
<span class="n">up</span> <span class="o">=</span> <span class="n">UNSET</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">up</span> <span class="o">=</span> <span class="n">_up</span> <span class="c1"># type: ignore[arg-type]</span>
<span class="n">system</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span>
<span class="n">forward</span><span class="o">=</span><span class="n">forward</span><span class="p">,</span>
<span class="n">up</span><span class="o">=</span><span class="n">up</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">system</span><span class="o">.</span><span class="n">additional_properties</span> <span class="o">=</span> <span class="n">d</span>
<span class="k">return</span> <span class="n">system</span></div>
<span class="nd">@property</span>
<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="System.__getitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System.__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="System.__setitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System.__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="System.__delitem__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System.__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="System.__contains__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.system.System.html#kittycad.models.system.System.__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">up</span><span class="p">:</span> <span class="n">AxisDirectionPair</span></div>
</pre></div>
</div>