2023-05-04 00:58:06 -07:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2023-12-05 16:25:51 -08:00
< title > kittycad.client — kittycad v0.5.9 documentation< / title >
2023-05-04 00:58:06 -07:00
< 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]-->
2023-08-16 23:39:29 +00:00
< script src = "../../_static/jquery.js?v=5d32c60e" > < / script >
< script src = "../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" > < / script >
2023-12-05 16:25:51 -08:00
< script data-url_root = "../../" id = "documentation_options" src = "../../_static/documentation_options.js?v=19ad864f" > < / script >
2023-08-16 23:39:29 +00:00
< script src = "../../_static/doctools.js?v=888ff710" > < / script >
< script src = "../../_static/sphinx_highlight.js?v=4825356b" > < / script >
< script src = "../../_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "../../_static/copybutton.js?v=f281be69" > < / script >
2023-05-04 00:58:06 -07:00
< 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" >
2023-12-05 16:25:51 -08:00
v0.5.9
2023-05-04 00:58:06 -07:00
< / 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.client< / 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.client< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "kn" > import< / span > < span class = "nn" > os< / span >
< span class = "kn" > import< / span > < span class = "nn" > ssl< / span >
< span class = "kn" > from< / span > < span class = "nn" > typing< / span > < span class = "kn" > import< / 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" > attr< / span >
< div class = "viewcode-block" id = "Client" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client" > [docs]< / a > < span class = "nd" > @attr< / span > < span class = "o" > .< / span > < span class = "n" > s< / span > < span class = "p" > (< / span > < span class = "n" > auto_attribs< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< span class = "k" > class< / span > < span class = "nc" > Client< / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "sd" > " " " A Client which has been authenticated for use on secured endpoints of the KittyCAD API." " " < / span > < span class = "c1" > # noqa: E501< / span >
< span class = "n" > token< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > ib< / span > < span class = "p" > (< / span > < span class = "n" > kw_only< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< span class = "n" > base_url< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > ib< / span > < span class = "p" > (< / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "s2" > " https://api.kittycad.io" < / 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 = "nb" > str< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > ib< / span > < span class = "p" > (< / span > < span class = "n" > factory< / span > < span class = "o" > =< / span > < span class = "nb" > dict< / span > < span class = "p" > ,< / span > < span class = "n" > kw_only< / span > < span class = "o" > =< / span > < span class = "kc" > True< / 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 = "nb" > str< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > ib< / span > < span class = "p" > (< / span > < span class = "n" > factory< / span > < span class = "o" > =< / span > < span class = "nb" > dict< / span > < span class = "p" > ,< / span > < span class = "n" > kw_only< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< span class = "n" > timeout< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > ib< / span > < span class = "p" > (< / span > < span class = "mf" > 50.0< / span > < span class = "p" > ,< / span > < span class = "n" > kw_only< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< span class = "n" > verify_ssl< / span > < span class = "p" > :< / span > < span class = "n" > Union< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ,< / span > < span class = "nb" > bool< / span > < span class = "p" > ,< / span > < span class = "n" > ssl< / span > < span class = "o" > .< / span > < span class = "n" > SSLContext< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > ib< / span > < span class = "p" > (< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span > < span class = "n" > kw_only< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< div class = "viewcode-block" id = "Client.get_headers" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.get_headers" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_headers< / span > < span class = "p" > (< / span > < span class = "bp" > self< / 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 = "nb" > str< / span > < span class = "p" > ]:< / span >
< span class = "w" > < / span > < span class = "sd" > " " " Get headers to be used in all endpoints" " " < / span >
< span class = "k" > return< / span > < span class = "p" > {< / span > < span class = "s2" > " Authorization" < / span > < span class = "p" > :< / span > < span class = "sa" > f< / span > < span class = "s2" > " Bearer < / span > < span class = "si" > {< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > token< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > headers< / span > < span class = "p" > }< / span > < / div >
< div class = "viewcode-block" id = "Client.with_headers" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.with_headers" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_headers< / span > < span class = "p" > (< / span > < span class = "bp" > self< / 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 = "nb" > str< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "s2" > " Client" < / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "sd" > " " " Get a new client matching this one with additional headers" " " < / span >
< span class = "k" > return< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > evolve< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > headers< / span > < span class = "o" > =< / span > < span class = "p" > {< / span > < span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > headers< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > headers< / span > < span class = "p" > })< / span > < / div >
< div class = "viewcode-block" id = "Client.get_cookies" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.get_cookies" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_cookies< / span > < span class = "p" > (< / span > < span class = "bp" > self< / 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 = "nb" > str< / span > < span class = "p" > ]:< / span >
< span class = "k" > return< / span > < span class = "p" > {< / span > < span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > cookies< / span > < span class = "p" > }< / span > < / div >
< div class = "viewcode-block" id = "Client.with_cookies" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.with_cookies" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_cookies< / span > < span class = "p" > (< / span > < span class = "bp" > self< / 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 = "nb" > str< / span > < span class = "p" > ])< / span > < span class = "o" > -> < / span > < span class = "s2" > " Client" < / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "sd" > " " " Get a new client matching this one with additional cookies" " " < / span >
< span class = "k" > return< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > evolve< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > cookies< / span > < span class = "o" > =< / span > < span class = "p" > {< / span > < span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > cookies< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > cookies< / span > < span class = "p" > })< / span > < / div >
< div class = "viewcode-block" id = "Client.get_timeout" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.get_timeout" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_timeout< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "nb" > float< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > timeout< / span > < / div >
< div class = "viewcode-block" id = "Client.with_timeout" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.with_timeout" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_timeout< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > timeout< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Client" < / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "sd" > " " " Get a new client matching this one with a new timeout (in seconds)" " " < / span >
2023-12-05 16:25:51 -08:00
< span class = "k" > return< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > evolve< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > timeout< / span > < span class = "o" > =< / span > < span class = "n" > timeout< / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "Client.with_base_url" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.Client.html#kittycad.client.Client.with_base_url" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > with_base_url< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > )< / span > < span class = "o" > -> < / span > < span class = "s2" > " Client" < / span > < span class = "p" > :< / span >
< span class = "w" > < / span > < span class = "sd" > " " " Get a new client matching this one with a new base url" " " < / span >
< span class = "k" > return< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > evolve< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > base_url< / span > < span class = "o" > =< / span > < span class = "n" > url< / span > < span class = "p" > )< / span > < / div > < / div >
2023-05-04 00:58:06 -07:00
< div class = "viewcode-block" id = "ClientFromEnv" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.ClientFromEnv.html#kittycad.client.ClientFromEnv" > [docs]< / a > < span class = "nd" > @attr< / span > < span class = "o" > .< / span > < span class = "n" > s< / span > < span class = "p" > (< / span > < span class = "n" > auto_attribs< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< span class = "k" > class< / span > < span class = "nc" > ClientFromEnv< / span > < span class = "p" > (< / span > < span class = "n" > Client< / span > < span class = "p" > ):< / span >
< span class = "w" > < / span > < span class = "sd" > " " " A Client which has been authenticated for use on secured endpoints that uses the KITTYCAD_API_TOKEN environment variable for the authentication token." " " < / span > < span class = "c1" > # noqa: E501< / span >
< span class = "n" > token< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > attr< / span > < span class = "o" > .< / span > < span class = "n" > field< / span > < span class = "p" > ()< / span >
< div class = "viewcode-block" id = "ClientFromEnv.set_token" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.ClientFromEnv.html#kittycad.client.ClientFromEnv.set_token" > [docs]< / a > < span class = "nd" > @token< / span > < span class = "o" > .< / span > < span class = "n" > default< / span >
< span class = "k" > def< / span > < span class = "nf" > set_token< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "n" > maybe_token< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > getenv< / span > < span class = "p" > (< / span > < span class = "s2" > " KITTYCAD_API_TOKEN" < / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > maybe_token< / span > < span class = "ow" > is< / span > < span class = "kc" > None< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > ValueError< / span > < span class = "p" > (< / span >
< span class = "s2" > " KITTYCAD_API_TOKEN environment variable must be set to use ClientFromEnv" < / span >
< span class = "p" > )< / span >
< span class = "n" > token< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "o" > =< / span > < span class = "n" > maybe_token< / span >
< span class = "k" > return< / span > < span class = "n" > token< / span > < / div >
< div class = "viewcode-block" id = "ClientFromEnv.get_headers" > < a class = "viewcode-back" href = "../../_autosummary/kittycad.client.ClientFromEnv.html#kittycad.client.ClientFromEnv.get_headers" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_headers< / span > < span class = "p" > (< / span > < span class = "bp" > self< / 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 = "nb" > str< / span > < span class = "p" > ]:< / span >
< span class = "w" > < / span > < span class = "sd" > " " " Get headers to be used in authenticated endpoints" " " < / span >
< span class = "k" > return< / span > < span class = "p" > {< / span > < span class = "s2" > " Authorization" < / span > < span class = "p" > :< / span > < span class = "sa" > f< / span > < span class = "s2" > " Bearer < / span > < span class = "si" > {< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > token< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > headers< / span > < span class = "p" > }< / span > < / div > < / 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 >
