I HAVE GENERATED YOUR NEW DOCS!
This commit is contained in:
github-actions[bot]
@ -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 — kittycad v0.4.4 documentation</title>
|
||||
<title>kittycad.api.executor.create_executor_term — kittycad v0.4.5 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" />
|
||||
@ -37,7 +37,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.4.4
|
||||
v0.4.5
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
@ -81,10 +81,11 @@
|
||||
<h1>Source code for kittycad.api.executor.create_executor_term</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="kn">import</span> <span class="nn">httpx</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">...client</span> <span class="kn">import</span> <span class="n">Client</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</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>
|
||||
@ -104,71 +105,43 @@
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.html#kittycad.api.executor.create_executor_term._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="k">return</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.html#kittycad.api.executor.create_executor_term._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_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">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Any</span><span class="p">]:</span>
|
||||
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
|
||||
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
|
||||
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
|
||||
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
|
||||
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
|
||||
<span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.sync_detailed.html#kittycad.api.executor.create_executor_term.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Any</span><span class="p">]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
|
||||
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
|
||||
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.sync.html#kittycad.api.executor.create_executor_term.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">ClientConnection</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Attach to a docker container to create an interactive terminal."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.executor.create_executor_term.asyncio_detailed.html#kittycad.api.executor.create_executor_term.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">Response</span><span class="p">[</span><span class="n">Any</span><span class="p">]:</span>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<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">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</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">"url"</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"https://"</span><span class="p">,</span> <span class="s2">"wss://"</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">"headers"</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="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
|
||||
<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">"An error occurred while connecting to the websocket."</span><span class="p">)</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>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="p">)</span> <span class="o">-></span> <span class="n">WebSocketClientProtocol</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Attach to a docker container to create an interactive terminal."""</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>
|
||||
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
|
||||
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
|
||||
<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">"url"</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"https://"</span><span class="p">,</span> <span class="s2">"wss://"</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">"headers"</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">"An error occurred while connecting to the websocket."</span><span class="p">)</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
||||
@ -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 — kittycad v0.4.4 documentation</title>
|
||||
<title>kittycad.api.executor.create_file_execution — kittycad v0.4.5 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" />
|
||||
@ -37,7 +37,7 @@
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.4.4
|
||||
v0.4.5
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
@ -97,7 +97,11 @@
|
||||
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
|
||||
<span class="n">output</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">-></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="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">/file/execute/</span><span class="si">{lang}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">,</span> <span class="n">lang</span><span class="o">=</span><span class="n">lang</span><span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="n">url</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">/file/execute/</span><span class="si">{lang}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">,</span>
|
||||
<span class="n">lang</span><span class="o">=</span><span class="n">lang</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">output</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="s2">"?"</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
|
||||
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">"&output="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">output</span><span class="p">)</span>
|
||||
|
||||
Reference in New Issue
Block a user