bump (#80)
* bump Signed-off-by: Jess Frazelle <github@jessfraz.com> * some fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * YOYO NEW API SPEC! * reformat Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * for now force true Signed-off-by: Jess Frazelle <github@jessfraz.com> * run the tests on generations Signed-off-by: Jess Frazelle <github@jessfraz.com> * add tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * update Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix some types Signed-off-by: Jess Frazelle <github@jessfraz.com> * float to top Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix mypy Signed-off-by: Jess Frazelle <github@jessfraz.com> * more noqa Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * ruff pass Signed-off-by: Jess Frazelle <github@jessfraz.com> * add docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * even less mypy errors Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * add test Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixups Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * new path Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes for mypy Signed-off-by: Jess Frazelle <github@jessfraz.com> * skip tests Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Jess Frazelle
GitHub
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_acceleration_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_acceleration_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_acceleration_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_acceleration_conversion</span> <span class="kn">import</span> <span class="n">UnitAccelerationConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_acceleration_format</span> <span class="kn">import</span> <span class="n">UnitAccelerationFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_acceleration_unit_conversion.html#kittycad.api.unit.get_acceleration_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/acceleration/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_acceleration_unit_conversion.html#kittycad.api.unit.get_acceleration_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAccelerationConversion</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">UnitAccelerationConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_acceleration_unit_conversion.html#kittycad.api.unit.get_acceleration_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAccelerationConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_acceleration_unit_conversion.sync_detailed.html#kittycad.api.unit.get_acceleration_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAccelerationConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_acceleration_unit_conversion.sync.html#kittycad.api.unit.get_acceleration_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAccelerationConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an acceleration unit value to another acceleration unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_acceleration_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_acceleration_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAccelerationConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_acceleration_unit_conversion.asyncio.html#kittycad.api.unit.get_acceleration_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAccelerationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAccelerationConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an acceleration unit value to another acceleration unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_angle_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_angle_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_angle_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_angle_conversion</span> <span class="kn">import</span> <span class="n">UnitAngleConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_angle_format</span> <span class="kn">import</span> <span class="n">UnitAngleFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angle_unit_conversion.html#kittycad.api.unit.get_angle_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/angle/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angle_unit_conversion.html#kittycad.api.unit.get_angle_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngleConversion</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">UnitAngleConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angle_unit_conversion.html#kittycad.api.unit.get_angle_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngleConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_angle_unit_conversion.sync_detailed.html#kittycad.api.unit.get_angle_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngleConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_angle_unit_conversion.sync.html#kittycad.api.unit.get_angle_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngleConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an angle unit value to another angle unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_angle_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_angle_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngleConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angle_unit_conversion.asyncio.html#kittycad.api.unit.get_angle_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngleConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an angle unit value to another angle unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_angular_velocity_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_angular_velocity_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_angular_velocity_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_angular_velocity_conversion</span> <span class="kn">import</span> <span class="n">UnitAngularVelocityConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_angular_velocity_format</span> <span class="kn">import</span> <span class="n">UnitAngularVelocityFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angular_velocity_unit_conversion.html#kittycad.api.unit.get_angular_velocity_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/angular-velocity/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angular_velocity_unit_conversion.html#kittycad.api.unit.get_angular_velocity_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngularVelocityConversion</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">UnitAngularVelocityConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angular_velocity_unit_conversion.html#kittycad.api.unit.get_angular_velocity_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngularVelocityConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_angular_velocity_unit_conversion.sync_detailed.html#kittycad.api.unit.get_angular_velocity_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngularVelocityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_angular_velocity_unit_conversion.sync.html#kittycad.api.unit.get_angular_velocity_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngularVelocityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an angular velocity unit value to another angular velocity unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_angular_velocity_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_angular_velocity_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngularVelocityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_angular_velocity_unit_conversion.asyncio.html#kittycad.api.unit.get_angular_velocity_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAngularVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAngularVelocityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an angular velocity unit value to another angular velocity unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_area_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_area_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_area_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_area_conversion</span> <span class="kn">import</span> <span class="n">UnitAreaConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_area_format</span> <span class="kn">import</span> <span class="n">UnitAreaFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_area_unit_conversion.html#kittycad.api.unit.get_area_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/area/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_area_unit_conversion.html#kittycad.api.unit.get_area_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAreaConversion</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">UnitAreaConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_area_unit_conversion.html#kittycad.api.unit.get_area_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAreaConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_area_unit_conversion.sync_detailed.html#kittycad.api.unit.get_area_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAreaConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_area_unit_conversion.sync.html#kittycad.api.unit.get_area_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAreaConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an area unit value to another area unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_area_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_area_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAreaConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_area_unit_conversion.asyncio.html#kittycad.api.unit.get_area_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitAreaFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitAreaConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert an area unit value to another area unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_charge_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_charge_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_charge_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_charge_conversion</span> <span class="kn">import</span> <span class="n">UnitChargeConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_charge_format</span> <span class="kn">import</span> <span class="n">UnitChargeFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_charge_unit_conversion.html#kittycad.api.unit.get_charge_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/charge/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_charge_unit_conversion.html#kittycad.api.unit.get_charge_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitChargeConversion</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">UnitChargeConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_charge_unit_conversion.html#kittycad.api.unit.get_charge_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitChargeConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_charge_unit_conversion.sync_detailed.html#kittycad.api.unit.get_charge_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitChargeConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_charge_unit_conversion.sync.html#kittycad.api.unit.get_charge_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitChargeConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a charge unit value to another charge unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_charge_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_charge_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitChargeConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_charge_unit_conversion.asyncio.html#kittycad.api.unit.get_charge_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitChargeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitChargeConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a charge unit value to another charge unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_concentration_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_concentration_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_concentration_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_concentration_conversion</span> <span class="kn">import</span> <span class="n">UnitConcentrationConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_concentration_format</span> <span class="kn">import</span> <span class="n">UnitConcentrationFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_concentration_unit_conversion.html#kittycad.api.unit.get_concentration_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/concentration/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_concentration_unit_conversion.html#kittycad.api.unit.get_concentration_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitConcentrationConversion</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">UnitConcentrationConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_concentration_unit_conversion.html#kittycad.api.unit.get_concentration_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitConcentrationConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_concentration_unit_conversion.sync_detailed.html#kittycad.api.unit.get_concentration_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitConcentrationConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_concentration_unit_conversion.sync.html#kittycad.api.unit.get_concentration_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitConcentrationConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a concentration unit value to another concentration unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_concentration_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_concentration_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitConcentrationConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_concentration_unit_conversion.asyncio.html#kittycad.api.unit.get_concentration_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitConcentrationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitConcentrationConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a concentration unit value to another concentration unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_data_transfer_rate_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_data_transfer_rate_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_data_transfer_rate_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_data_transfer_rate_conversion</span> <span class="kn">import</span> <span class="n">UnitDataTransferRateConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_data_transfer_rate_format</span> <span class="kn">import</span> <span class="n">UnitDataTransferRateFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_transfer_rate_unit_conversion.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/data-transfer-rate/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_transfer_rate_unit_conversion.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataTransferRateConversion</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">UnitDataTransferRateConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_transfer_rate_unit_conversion.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataTransferRateConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_data_transfer_rate_unit_conversion.sync_detailed.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataTransferRateConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_data_transfer_rate_unit_conversion.sync.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataTransferRateConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a data transfer rate unit value to another data transfer rate unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_data_transfer_rate_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataTransferRateConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_transfer_rate_unit_conversion.asyncio.html#kittycad.api.unit.get_data_transfer_rate_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataTransferRateFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataTransferRateConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a data transfer rate unit value to another data transfer rate unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_data_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_data_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_data_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_data_conversion</span> <span class="kn">import</span> <span class="n">UnitDataConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_data_format</span> <span class="kn">import</span> <span class="n">UnitDataFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_unit_conversion.html#kittycad.api.unit.get_data_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/data/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_unit_conversion.html#kittycad.api.unit.get_data_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataConversion</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">UnitDataConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_unit_conversion.html#kittycad.api.unit.get_data_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_data_unit_conversion.sync_detailed.html#kittycad.api.unit.get_data_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_data_unit_conversion.sync.html#kittycad.api.unit.get_data_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a data unit value to another data unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_data_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_data_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_data_unit_conversion.asyncio.html#kittycad.api.unit.get_data_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDataFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDataConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a data unit value to another data unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_density_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_density_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_density_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_density_conversion</span> <span class="kn">import</span> <span class="n">UnitDensityConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_density_format</span> <span class="kn">import</span> <span class="n">UnitDensityFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_density_unit_conversion.html#kittycad.api.unit.get_density_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/density/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_density_unit_conversion.html#kittycad.api.unit.get_density_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDensityConversion</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">UnitDensityConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_density_unit_conversion.html#kittycad.api.unit.get_density_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDensityConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_density_unit_conversion.sync_detailed.html#kittycad.api.unit.get_density_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDensityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_density_unit_conversion.sync.html#kittycad.api.unit.get_density_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDensityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a density unit value to another density unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_density_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_density_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDensityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_density_unit_conversion.asyncio.html#kittycad.api.unit.get_density_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitDensityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitDensityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a density unit value to another density unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_energy_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_energy_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_energy_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_energy_conversion</span> <span class="kn">import</span> <span class="n">UnitEnergyConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_energy_format</span> <span class="kn">import</span> <span class="n">UnitEnergyFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_energy_unit_conversion.html#kittycad.api.unit.get_energy_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/energy/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_energy_unit_conversion.html#kittycad.api.unit.get_energy_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitEnergyConversion</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">UnitEnergyConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_energy_unit_conversion.html#kittycad.api.unit.get_energy_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitEnergyConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_energy_unit_conversion.sync_detailed.html#kittycad.api.unit.get_energy_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitEnergyConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_energy_unit_conversion.sync.html#kittycad.api.unit.get_energy_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitEnergyConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a energy unit value to another energy unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_energy_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_energy_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitEnergyConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_energy_unit_conversion.asyncio.html#kittycad.api.unit.get_energy_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitEnergyFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitEnergyConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a energy unit value to another energy unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_force_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_force_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_force_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_force_conversion</span> <span class="kn">import</span> <span class="n">UnitForceConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_force_format</span> <span class="kn">import</span> <span class="n">UnitForceFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_force_unit_conversion.html#kittycad.api.unit.get_force_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/force/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_force_unit_conversion.html#kittycad.api.unit.get_force_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitForceConversion</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">UnitForceConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_force_unit_conversion.html#kittycad.api.unit.get_force_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitForceConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_force_unit_conversion.sync_detailed.html#kittycad.api.unit.get_force_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitForceConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_force_unit_conversion.sync.html#kittycad.api.unit.get_force_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitForceConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a force unit value to another force unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_force_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_force_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitForceConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_force_unit_conversion.asyncio.html#kittycad.api.unit.get_force_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitForceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitForceConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a force unit value to another force unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_illuminance_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_illuminance_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_illuminance_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_illuminance_conversion</span> <span class="kn">import</span> <span class="n">UnitIlluminanceConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_illuminance_format</span> <span class="kn">import</span> <span class="n">UnitIlluminanceFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_illuminance_unit_conversion.html#kittycad.api.unit.get_illuminance_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/illuminance/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_illuminance_unit_conversion.html#kittycad.api.unit.get_illuminance_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitIlluminanceConversion</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">UnitIlluminanceConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_illuminance_unit_conversion.html#kittycad.api.unit.get_illuminance_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitIlluminanceConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_illuminance_unit_conversion.sync_detailed.html#kittycad.api.unit.get_illuminance_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitIlluminanceConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_illuminance_unit_conversion.sync.html#kittycad.api.unit.get_illuminance_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitIlluminanceConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a illuminance unit value to another illuminance unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_illuminance_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_illuminance_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitIlluminanceConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_illuminance_unit_conversion.asyncio.html#kittycad.api.unit.get_illuminance_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitIlluminanceFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitIlluminanceConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a illuminance unit value to another illuminance unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_length_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_length_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_length_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_length_conversion</span> <span class="kn">import</span> <span class="n">UnitLengthConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_length_format</span> <span class="kn">import</span> <span class="n">UnitLengthFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_length_unit_conversion.html#kittycad.api.unit.get_length_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/length/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_length_unit_conversion.html#kittycad.api.unit.get_length_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitLengthConversion</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">UnitLengthConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_length_unit_conversion.html#kittycad.api.unit.get_length_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitLengthConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_length_unit_conversion.sync_detailed.html#kittycad.api.unit.get_length_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitLengthConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_length_unit_conversion.sync.html#kittycad.api.unit.get_length_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitLengthConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a length unit value to another length unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_length_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_length_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitLengthConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_length_unit_conversion.asyncio.html#kittycad.api.unit.get_length_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitLengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitLengthConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a length unit value to another length unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,254 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_magnetic_field_strength_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_magnetic_field_strength_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_magnetic_field_strength_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_magnetic_field_strength_conversion</span> <span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">UnitMagneticFieldStrengthConversion</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_magnetic_field_strength_format</span> <span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_field_strength_unit_conversion.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/magnetic-field-strength/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_field_strength_unit_conversion.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFieldStrengthConversion</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">UnitMagneticFieldStrengthConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_field_strength_unit_conversion.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFieldStrengthConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_magnetic_field_strength_unit_conversion.sync_detailed.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFieldStrengthConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_magnetic_field_strength_unit_conversion.sync.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFieldStrengthConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a magnetic field strength unit value to another magnetic field strength unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_magnetic_field_strength_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFieldStrengthConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_field_strength_unit_conversion.asyncio.html#kittycad.api.unit.get_magnetic_field_strength_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFieldStrengthFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFieldStrengthConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a magnetic field strength unit value to another magnetic field strength unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_magnetic_flux_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_magnetic_flux_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_magnetic_flux_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_magnetic_flux_conversion</span> <span class="kn">import</span> <span class="n">UnitMagneticFluxConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_magnetic_flux_format</span> <span class="kn">import</span> <span class="n">UnitMagneticFluxFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_flux_unit_conversion.html#kittycad.api.unit.get_magnetic_flux_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/magnetic-flux/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_flux_unit_conversion.html#kittycad.api.unit.get_magnetic_flux_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFluxConversion</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">UnitMagneticFluxConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_flux_unit_conversion.html#kittycad.api.unit.get_magnetic_flux_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFluxConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_magnetic_flux_unit_conversion.sync_detailed.html#kittycad.api.unit.get_magnetic_flux_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFluxConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_magnetic_flux_unit_conversion.sync.html#kittycad.api.unit.get_magnetic_flux_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFluxConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a magnetic flux unit value to another magnetic flux unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_magnetic_flux_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_magnetic_flux_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFluxConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_magnetic_flux_unit_conversion.asyncio.html#kittycad.api.unit.get_magnetic_flux_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMagneticFluxFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMagneticFluxConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a magnetic flux unit value to another magnetic flux unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_mass_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_mass_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_mass_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_mass_conversion</span> <span class="kn">import</span> <span class="n">UnitMassConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_mass_format</span> <span class="kn">import</span> <span class="n">UnitMassFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_mass_unit_conversion.html#kittycad.api.unit.get_mass_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/mass/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_mass_unit_conversion.html#kittycad.api.unit.get_mass_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMassConversion</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">UnitMassConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_mass_unit_conversion.html#kittycad.api.unit.get_mass_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMassConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_mass_unit_conversion.sync_detailed.html#kittycad.api.unit.get_mass_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMassConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_mass_unit_conversion.sync.html#kittycad.api.unit.get_mass_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMassConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a mass unit value to another mass unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_mass_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_mass_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMassConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_mass_unit_conversion.asyncio.html#kittycad.api.unit.get_mass_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMassFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMassConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a mass unit value to another mass unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_metric_power_cubed_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_metric_power_cubed_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_metric_power_cubed_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_metric_power</span> <span class="kn">import</span> <span class="n">UnitMetricPower</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_metric_power_cubed_conversion</span> <span class="kn">import</span> <span class="n">UnitMetricPowerCubedConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_cubed_unit_conversion.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/metric/cubed/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_cubed_unit_conversion.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerCubedConversion</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">UnitMetricPowerCubedConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_cubed_unit_conversion.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerCubedConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_metric_power_cubed_unit_conversion.sync_detailed.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerCubedConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_metric_power_cubed_unit_conversion.sync.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerCubedConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a metric cubed unit value to another metric cubed unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_metric_power_cubed_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerCubedConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_cubed_unit_conversion.asyncio.html#kittycad.api.unit.get_metric_power_cubed_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerCubedConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a metric cubed unit value to another metric cubed unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,252 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_metric_power_squared_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_metric_power_squared_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_metric_power_squared_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_metric_power</span> <span class="kn">import</span> <span class="n">UnitMetricPower</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_metric_power_squared_conversion</span> <span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">UnitMetricPowerSquaredConversion</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_squared_unit_conversion.html#kittycad.api.unit.get_metric_power_squared_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/metric/squared/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_squared_unit_conversion.html#kittycad.api.unit.get_metric_power_squared_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerSquaredConversion</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">UnitMetricPowerSquaredConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_squared_unit_conversion.html#kittycad.api.unit.get_metric_power_squared_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerSquaredConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_metric_power_squared_unit_conversion.sync_detailed.html#kittycad.api.unit.get_metric_power_squared_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerSquaredConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_metric_power_squared_unit_conversion.sync.html#kittycad.api.unit.get_metric_power_squared_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerSquaredConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a metric squared unit value to another metric squared unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_metric_power_squared_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_metric_power_squared_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerSquaredConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_squared_unit_conversion.asyncio.html#kittycad.api.unit.get_metric_power_squared_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerSquaredConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a metric squared unit value to another metric squared unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_metric_power_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_metric_power_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_metric_power_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_metric_power</span> <span class="kn">import</span> <span class="n">UnitMetricPower</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_metric_power_conversion</span> <span class="kn">import</span> <span class="n">UnitMetricPowerConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_unit_conversion.html#kittycad.api.unit.get_metric_power_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/metric/power/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_unit_conversion.html#kittycad.api.unit.get_metric_power_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerConversion</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">UnitMetricPowerConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_unit_conversion.html#kittycad.api.unit.get_metric_power_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_metric_power_unit_conversion.sync_detailed.html#kittycad.api.unit.get_metric_power_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_metric_power_unit_conversion.sync.html#kittycad.api.unit.get_metric_power_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a metric unit value to another metric unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_metric_power_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_metric_power_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_metric_power_unit_conversion.asyncio.html#kittycad.api.unit.get_metric_power_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitMetricPower</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitMetricPowerConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a metric unit value to another metric unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_power_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_power_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_power_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_power_conversion</span> <span class="kn">import</span> <span class="n">UnitPowerConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_power_format</span> <span class="kn">import</span> <span class="n">UnitPowerFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_power_unit_conversion.html#kittycad.api.unit.get_power_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/power/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_power_unit_conversion.html#kittycad.api.unit.get_power_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPowerConversion</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">UnitPowerConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_power_unit_conversion.html#kittycad.api.unit.get_power_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPowerConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_power_unit_conversion.sync_detailed.html#kittycad.api.unit.get_power_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPowerConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_power_unit_conversion.sync.html#kittycad.api.unit.get_power_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPowerConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a power unit value to another power unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_power_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_power_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPowerConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_power_unit_conversion.asyncio.html#kittycad.api.unit.get_power_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPowerFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPowerConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a power unit value to another power unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_pressure_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_pressure_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_pressure_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_pressure_conversion</span> <span class="kn">import</span> <span class="n">UnitPressureConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_pressure_format</span> <span class="kn">import</span> <span class="n">UnitPressureFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_pressure_unit_conversion.html#kittycad.api.unit.get_pressure_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/pressure/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_pressure_unit_conversion.html#kittycad.api.unit.get_pressure_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPressureConversion</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">UnitPressureConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_pressure_unit_conversion.html#kittycad.api.unit.get_pressure_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPressureConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_pressure_unit_conversion.sync_detailed.html#kittycad.api.unit.get_pressure_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPressureConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_pressure_unit_conversion.sync.html#kittycad.api.unit.get_pressure_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPressureConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a pressure unit value to another pressure unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_pressure_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_pressure_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPressureConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_pressure_unit_conversion.asyncio.html#kittycad.api.unit.get_pressure_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitPressureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitPressureConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a pressure unit value to another pressure unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_radiation_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_radiation_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_radiation_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_radiation_conversion</span> <span class="kn">import</span> <span class="n">UnitRadiationConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_radiation_format</span> <span class="kn">import</span> <span class="n">UnitRadiationFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radiation_unit_conversion.html#kittycad.api.unit.get_radiation_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/radiation/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radiation_unit_conversion.html#kittycad.api.unit.get_radiation_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadiationConversion</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">UnitRadiationConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radiation_unit_conversion.html#kittycad.api.unit.get_radiation_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadiationConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_radiation_unit_conversion.sync_detailed.html#kittycad.api.unit.get_radiation_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadiationConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_radiation_unit_conversion.sync.html#kittycad.api.unit.get_radiation_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadiationConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a radiation unit value to another radiation unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_radiation_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_radiation_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadiationConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radiation_unit_conversion.asyncio.html#kittycad.api.unit.get_radiation_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadiationFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadiationConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a radiation unit value to another radiation unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_radioactivity_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_radioactivity_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_radioactivity_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_radioactivity_conversion</span> <span class="kn">import</span> <span class="n">UnitRadioactivityConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_radioactivity_format</span> <span class="kn">import</span> <span class="n">UnitRadioactivityFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radioactivity_unit_conversion.html#kittycad.api.unit.get_radioactivity_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/radioactivity/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radioactivity_unit_conversion.html#kittycad.api.unit.get_radioactivity_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadioactivityConversion</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">UnitRadioactivityConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radioactivity_unit_conversion.html#kittycad.api.unit.get_radioactivity_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadioactivityConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_radioactivity_unit_conversion.sync_detailed.html#kittycad.api.unit.get_radioactivity_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadioactivityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_radioactivity_unit_conversion.sync.html#kittycad.api.unit.get_radioactivity_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadioactivityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a radioactivity unit value to another radioactivity unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_radioactivity_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_radioactivity_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadioactivityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_radioactivity_unit_conversion.asyncio.html#kittycad.api.unit.get_radioactivity_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitRadioactivityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitRadioactivityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a radioactivity unit value to another radioactivity unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_solid_angle_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_solid_angle_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_solid_angle_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_solid_angle_conversion</span> <span class="kn">import</span> <span class="n">UnitSolidAngleConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_solid_angle_format</span> <span class="kn">import</span> <span class="n">UnitSolidAngleFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_solid_angle_unit_conversion.html#kittycad.api.unit.get_solid_angle_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/solid-angle/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_solid_angle_unit_conversion.html#kittycad.api.unit.get_solid_angle_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitSolidAngleConversion</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">UnitSolidAngleConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_solid_angle_unit_conversion.html#kittycad.api.unit.get_solid_angle_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitSolidAngleConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_solid_angle_unit_conversion.sync_detailed.html#kittycad.api.unit.get_solid_angle_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitSolidAngleConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_solid_angle_unit_conversion.sync.html#kittycad.api.unit.get_solid_angle_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitSolidAngleConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a solid angle unit value to another solid angle unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_solid_angle_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_solid_angle_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitSolidAngleConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_solid_angle_unit_conversion.asyncio.html#kittycad.api.unit.get_solid_angle_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitSolidAngleFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitSolidAngleConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a solid angle unit value to another solid angle unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_temperature_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_temperature_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_temperature_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_temperature_conversion</span> <span class="kn">import</span> <span class="n">UnitTemperatureConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_temperature_format</span> <span class="kn">import</span> <span class="n">UnitTemperatureFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_temperature_unit_conversion.html#kittycad.api.unit.get_temperature_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/temperature/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_temperature_unit_conversion.html#kittycad.api.unit.get_temperature_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTemperatureConversion</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">UnitTemperatureConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_temperature_unit_conversion.html#kittycad.api.unit.get_temperature_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTemperatureConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_temperature_unit_conversion.sync_detailed.html#kittycad.api.unit.get_temperature_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTemperatureConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_temperature_unit_conversion.sync.html#kittycad.api.unit.get_temperature_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTemperatureConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a temperature unit value to another temperature unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_temperature_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_temperature_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTemperatureConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_temperature_unit_conversion.asyncio.html#kittycad.api.unit.get_temperature_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTemperatureFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTemperatureConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a temperature unit value to another temperature unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_time_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_time_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_time_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_time_conversion</span> <span class="kn">import</span> <span class="n">UnitTimeConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_time_format</span> <span class="kn">import</span> <span class="n">UnitTimeFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_time_unit_conversion.html#kittycad.api.unit.get_time_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/time/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_time_unit_conversion.html#kittycad.api.unit.get_time_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTimeConversion</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">UnitTimeConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_time_unit_conversion.html#kittycad.api.unit.get_time_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTimeConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_time_unit_conversion.sync_detailed.html#kittycad.api.unit.get_time_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTimeConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_time_unit_conversion.sync.html#kittycad.api.unit.get_time_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTimeConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a time unit value to another time unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_time_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_time_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTimeConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_time_unit_conversion.asyncio.html#kittycad.api.unit.get_time_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitTimeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitTimeConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a time unit value to another time unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_velocity_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_velocity_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_velocity_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_velocity_conversion</span> <span class="kn">import</span> <span class="n">UnitVelocityConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_velocity_format</span> <span class="kn">import</span> <span class="n">UnitVelocityFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_velocity_unit_conversion.html#kittycad.api.unit.get_velocity_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/velocity/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_velocity_unit_conversion.html#kittycad.api.unit.get_velocity_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVelocityConversion</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">UnitVelocityConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_velocity_unit_conversion.html#kittycad.api.unit.get_velocity_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVelocityConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_velocity_unit_conversion.sync_detailed.html#kittycad.api.unit.get_velocity_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVelocityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_velocity_unit_conversion.sync.html#kittycad.api.unit.get_velocity_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVelocityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a velocity unit value to another velocity unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_velocity_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_velocity_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVelocityConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_velocity_unit_conversion.asyncio.html#kittycad.api.unit.get_velocity_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVelocityFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVelocityConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a velocity unit value to another velocity unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_voltage_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_voltage_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_voltage_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_voltage_conversion</span> <span class="kn">import</span> <span class="n">UnitVoltageConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_voltage_format</span> <span class="kn">import</span> <span class="n">UnitVoltageFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_voltage_unit_conversion.html#kittycad.api.unit.get_voltage_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/voltage/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_voltage_unit_conversion.html#kittycad.api.unit.get_voltage_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVoltageConversion</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">UnitVoltageConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_voltage_unit_conversion.html#kittycad.api.unit.get_voltage_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVoltageConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_voltage_unit_conversion.sync_detailed.html#kittycad.api.unit.get_voltage_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVoltageConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_voltage_unit_conversion.sync.html#kittycad.api.unit.get_voltage_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVoltageConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a voltage unit value to another voltage unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_voltage_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_voltage_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVoltageConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_voltage_unit_conversion.asyncio.html#kittycad.api.unit.get_voltage_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVoltageFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVoltageConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a voltage unit value to another voltage unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -0,0 +1,250 @@
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kittycad.api.unit.get_volume_unit_conversion — kittycad v0.3.8 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" />
|
||||
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<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/doctools.js"></script>
|
||||
<script src="../../../../_static/clipboard.min.js"></script>
|
||||
<script src="../../../../_static/copybutton.js"></script>
|
||||
<script src="../../../../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="../../../../index.html" class="icon icon-home">
|
||||
kittycad
|
||||
</a>
|
||||
<div class="version">
|
||||
v0.3.8
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../../../../index.html">kittycad</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
|
||||
<li class="breadcrumb-item active">kittycad.api.unit.get_volume_unit_conversion</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<h1>Source code for kittycad.api.unit.get_volume_unit_conversion</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">Optional</span><span class="p">,</span> <span class="n">Union</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">httpx</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>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_volume_conversion</span> <span class="kn">import</span> <span class="n">UnitVolumeConversion</span>
|
||||
<span class="kn">from</span> <span class="nn">...models.unit_volume_format</span> <span class="kn">import</span> <span class="n">UnitVolumeFormat</span>
|
||||
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_volume_unit_conversion.html#kittycad.api.unit.get_volume_unit_conversion._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">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">/unit/conversion/volume/</span><span class="si">{src_format}</span><span class="s2">/</span><span class="si">{output_format}</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span> <span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span>
|
||||
<span class="p">)</span> <span class="c1"># noqa: E501</span>
|
||||
<span class="k">if</span> <span class="n">value</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">"&value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<span class="k">else</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">"?value="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
|
||||
<span class="n">headers</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">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
|
||||
<span class="n">cookies</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">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
|
||||
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
|
||||
<span class="s2">"timeout"</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
|
||||
<span class="p">}</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_volume_unit_conversion.html#kittycad.api.unit.get_volume_unit_conversion._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">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVolumeConversion</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">UnitVolumeConversion</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="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="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="k">return</span> <span class="n">response_5XX</span>
|
||||
<span class="k">return</span> <span class="kc">None</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_volume_unit_conversion.html#kittycad.api.unit.get_volume_unit_conversion._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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVolumeConversion</span><span class="p">,</span> <span class="n">Error</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.unit.get_volume_unit_conversion.sync_detailed.html#kittycad.api.unit.get_volume_unit_conversion.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVolumeConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_volume_unit_conversion.sync.html#kittycad.api.unit.get_volume_unit_conversion.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVolumeConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a volume unit value to another volume unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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.unit.get_volume_unit_conversion.asyncio_detailed.html#kittycad.api.unit.get_volume_unit_conversion.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="n">output_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVolumeConversion</span><span class="p">,</span> <span class="n">Error</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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">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="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.unit.get_volume_unit_conversion.asyncio.html#kittycad.api.unit.get_volume_unit_conversion.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
|
||||
<span class="n">output_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="p">:</span> <span class="n">UnitVolumeFormat</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="p">:</span> <span class="nb">float</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">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">UnitVolumeConversion</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
|
||||
<span class="w"> </span><span class="sd">"""Convert a volume unit value to another volume unit value. This is a nice endpoint to use for helper functions."""</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">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
|
||||
<span class="n">src_format</span><span class="o">=</span><span class="n">src_format</span><span class="p">,</span>
|
||||
<span class="n">value</span><span class="o">=</span><span class="n">value</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>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2023, KittyCAD Team Members.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user