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

29
docs/html/_modules/kittycad/api/executor/create_executor_term.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.api.executor.create_executor_term &mdash; kittycad v0.4.6 documentation</title>
<title>kittycad.api.executor.create_executor_term &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">
@ -85,7 +85,6 @@
<span class="kn">from</span> <span class="nn">websockets.sync.client</span> <span class="kn">import</span> <span class="n">ClientConnection</span><span class="p">,</span> <span class="n">connect</span> <span class="k">as</span> <span class="n">ws_connect</span>
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.html#kittycad.api.executor.create_executor_term._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
@ -115,14 +114,7 @@
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">with</span> <span class="n">ws_connect</span><span class="p">(</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;https://&quot;</span><span class="p">,</span> <span class="s2">&quot;wss://&quot;</span><span class="p">),</span>
<span class="n">additional_headers</span><span class="o">=</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">],</span>
<span class="p">)</span> <span class="k">as</span> <span class="n">websocket</span><span class="p">:</span>
<span class="k">return</span> <span class="n">websocket</span> <span class="c1"># type: ignore</span>
<span class="c1"># Return an error if we got here.</span>
<span class="k">return</span> <span class="n">Error</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="s2">&quot;An error occurred while connecting to the websocket.&quot;</span><span class="p">)</span></div>
<span class="k">return</span> <span class="n">ws_connect</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;http&quot;</span><span class="p">,</span> <span class="s2">&quot;ws&quot;</span><span class="p">),</span> <span class="n">additional_headers</span><span class="o">=</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">],</span> <span class="n">close_timeout</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span> <span class="n">max_size</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># type: ignore</span></div>
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.asyncio.html#kittycad.api.executor.create_executor_term.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
@ -135,13 +127,12 @@
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">ws_connect_async</span><span class="p">(</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;https://&quot;</span><span class="p">,</span> <span class="s2">&quot;wss://&quot;</span><span class="p">),</span> <span class="n">extra_headers</span><span class="o">=</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">]</span>
<span class="p">)</span> <span class="k">as</span> <span class="n">websocket</span><span class="p">:</span>
<span class="k">return</span> <span class="n">websocket</span>
<span class="c1"># Return an error if we got here.</span>
<span class="k">return</span> <span class="n">Error</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="s2">&quot;An error occurred while connecting to the websocket.&quot;</span><span class="p">)</span></div>
<span class="k">return</span> <span class="k">await</span> <span class="n">ws_connect_async</span><span class="p">(</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;http&quot;</span><span class="p">,</span> <span class="s2">&quot;ws&quot;</span><span class="p">),</span>
<span class="n">extra_headers</span><span class="o">=</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;headers&quot;</span><span class="p">],</span>
<span class="n">close_timeout</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span>
<span class="n">max_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="p">)</span></div>
</pre></div>
</div>

14
docs/html/_modules/kittycad/api/executor/create_file_execution.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.api.executor.create_file_execution &mdash; kittycad v0.4.6 documentation</title>
<title>kittycad.api.executor.create_file_execution &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">
@ -122,15 +122,15 @@
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_file_execution.html#kittycad.api.executor.create_file_execution._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">CodeOutput</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
<span class="n">response_200</span> <span class="o">=</span> <span class="n">CodeOutput</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="n">response_200</span> <span class="o">=</span> <span class="n">CodeOutput</span><span class="p">(</span><span class="o">**</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_200</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="p">(</span><span class="o">**</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_4XX</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="p">(</span><span class="o">**</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<span class="k">return</span> <span class="n">Error</span><span class="p">(</span><span class="o">**</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_file_execution.html#kittycad.api.executor.create_file_execution._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span>