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]
2023-05-08 20:06:56 +00:00
parent f933b716f4
commit fa2b411b78
2603 changed files with 36412 additions and 35438 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/html/_autosummary/kittycad.api.file.create_file_conversion.asyncio.html
View File

@ -1,14 +1,19 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta property="og:title" content="kittycad.api.file.create_file_conversion.asyncio" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.api.file.create_file_conversion.asyncio.html" />
<meta property="og:site_name" content="kittycad" />
<meta property="og:image:width" content="1146" />
<meta property="og:image:height" content="600" />
<meta property="og:image" content="/_images/social_previews/summary__autosummary_kittycad.api.file.create_file_conversion.asyncio_cc3d6865.png" />
<meta property="og:image:alt" content="" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:title" content="kittycad.api.file.create_file_conversion.asyncio" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.api.file.create_file_conversion.asyncio.html" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.file.create_file_conversion.asyncio &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.api.file.create_file_conversion.asyncio &mdash; kittycad v0.4.0 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" />
@ -18,10 +23,11 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.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/js/theme.js"></script>
@ -43,7 +49,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@ -70,6 +76,13 @@
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.asyncio_detailed.html">kittycad.api.file.create_file_conversion.asyncio_detailed</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.sync.html">kittycad.api.file.create_file_conversion.sync</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.sync_detailed.html">kittycad.api.file.create_file_conversion.sync_detailed</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion._build_response"><code class="docutils literal notranslate"><span class="pre">_build_response()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion._get_kwargs"><code class="docutils literal notranslate"><span class="pre">_get_kwargs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion._parse_response"><code class="docutils literal notranslate"><span class="pre">_parse_response()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion.asyncio"><code class="docutils literal notranslate"><span class="pre">asyncio()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion.asyncio_detailed"><code class="docutils literal notranslate"><span class="pre">asyncio_detailed()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion.sync"><code class="docutils literal notranslate"><span class="pre">sync()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.file.create_file_conversion.html#kittycad.api.file.create_file_conversion.sync_detailed"><code class="docutils literal notranslate"><span class="pre">sync_detailed()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.file.create_file_conversion_with_base64_helper.html">kittycad.api.file.create_file_conversion_with_base64_helper</a></li>
@ -120,16 +133,16 @@
<div itemprop="articleBody">
<section id="kittycad-api-file-create-file-conversion-asyncio">
<h1>kittycad.api.file.create_file_conversion.asyncio<a class="headerlink" href="#kittycad-api-file-create-file-conversion-asyncio" title="Permalink to this headline"></a></h1>
<h1>kittycad.api.file.create_file_conversion.asyncio<a class="headerlink" href="#kittycad-api-file-create-file-conversion-asyncio" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.file.create_file_conversion.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.file.create_file_conversion.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/file/create_file_conversion.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/file/create_file_conversion.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.file.create_file_conversion.asyncio" title="Permalink to this definition"></a></dt>
<dd><p>Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.
If the conversion is performed synchronously, the contents of the converted file (<a class="reference internal" href="kittycad.models.async_api_call.AsyncApiCall.html#kittycad.models.async_api_call.AsyncApiCall.output" title="kittycad.models.async_api_call.AsyncApiCall.output"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output</span></code></a>) will be returned as a base64 encoded string.
If the operation is performed asynchronously, the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> of the operation will be returned. You can use the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> returned from the request to get status information about the async operation from the <code class="xref any docutils literal notranslate"><span class="pre">/async/operations/{id}</span></code> endpoint.</p>
If the conversion is performed synchronously, the contents of the converted file (<cite>output</cite>) will be returned as a base64 encoded string.
If the operation is performed asynchronously, the <cite>id</cite> of the operation will be returned. You can use the <cite>id</cite> returned from the request to get status information about the async operation from the <cite>/async/operations/{id}</cite> endpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.file_conversion.FileConversion.html#kittycad.models.file_conversion.FileConversion" title="kittycad.models.file_conversion.FileConversion"><code class="xref py py-class docutils literal notranslate"><span class="pre">FileConversion</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
</dd>
</dl>
</dd></dl>