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

I HAVE GENERATED YOUR NEW DOCS!

Browse Source
This commit is contained in:
github-actions[bot]
2024-11-26 19:30:22 +00:00
parent 779a1c3458
commit 9d1e3b5490
1696 changed files with 71558 additions and 30838 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/html/_modules/kittycad/api/modeling/modeling_commands_ws.html
View File

@ -80,8 +80,14 @@
<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">Iterator</span><span class="p">,</span> <span class="n">Optional</span>
<span class="kn">import</span> <span class="nn">bson</span>
<span class="kn">from</span> <span class="nn">websockets.client</span> <span class="kn">import</span> <span class="n">WebSocketClientProtocol</span><span class="p">,</span> <span class="n">connect</span> <span class="k">as</span> <span class="n">ws_connect_async</span>
<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">websockets.asyncio.client</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">ClientConnection</span> <span class="k">as</span> <span class="n">ClientConnectionAsync</span><span class="p">,</span>
<span class="n">connect</span> <span class="k">as</span> <span class="n">ws_connect_async</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">websockets.sync.client</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">ClientConnection</span> <span class="k">as</span> <span class="n">ClientConnectionSync</span><span class="p">,</span>
<span class="n">connect</span> <span class="k">as</span> <span class="n">ws_connect</span><span class="p">,</span>
<span class="p">)</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.post_effect_type</span> <span class="kn">import</span> <span class="n">PostEffectType</span>
@ -186,7 +192,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="n">pool</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">replay</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ClientConnection</span><span class="p">:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ClientConnectionSync</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Pass those commands to the engine via websocket, and pass responses back to the client. Basically, this is a websocket proxy between the frontend/client and the engine.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
@ -225,7 +231,7 @@
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="n">pool</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">replay</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">WebSocketClientProtocol</span><span class="p">:</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ClientConnectionAsync</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Pass those commands to the engine via websocket, and pass responses back to the client. Basically, this is a websocket proxy between the frontend/client and the engine.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
@ -255,7 +261,7 @@
<span class="k">class</span> <span class="nc">WebSocket</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A websocket connection to the API endpoint.&quot;&quot;&quot;</span>
<span class="n">ws</span><span class="p">:</span> <span class="n">ClientConnection</span>
<span class="n">ws</span><span class="p">:</span> <span class="n">ClientConnectionSync</span>
<div class="viewcode-block" id="WebSocket.__init__">
<a class="viewcode-back" href="../../../../_autosummary/kittycad.api.modeling.modeling_commands_ws.WebSocket.html#kittycad.api.modeling.modeling_commands_ws.WebSocket.__init__">[docs]</a>