1312 lines
247 KiB
HTML
1312 lines
247 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
|||
|
|
<meta property="og:title" content="kittycad.models.highlight_set_entity" />
|
|||
|
|
<meta property="og:type" content="website" />
|
|||
|
|
<meta property="og:url" content="_autosummary/kittycad.models.highlight_set_entity.html" />
|
|||
|
|
<meta property="og:site_name" content="kittycad" />
|
|||
|
|
<meta property="og:description" content="Classes" />
|
|||
|
|
<meta property="og:image:width" content="1146" />
|
|||
|
|
<meta property="og:image:height" content="600" />
|
|||
|
|
<meta property="og:image" content="/_images/social_previews/summary__autosummary_kittycad.models.highlight_set_entity_c86920ae.png" />
|
|||
|
|
<meta property="og:image:alt" content="Classes" />
|
|||
|
|
<meta name="description" content="Classes" />
|
|||
|
|
<meta name="twitter:card" content="summary_large_image" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
<title>kittycad.models.highlight_set_entity — kittycad v0.5.9 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 src="../_static/jquery.js?v=5d32c60e"></script>
|
|||
|
|
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|||
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=19ad864f"></script>
|
|||
|
|
<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>
|
|||
|
|
<script src="../_static/js/theme.js"></script>
|
|||
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../search.html" />
|
|||
|
|
<link rel="next" title="kittycad.models.highlight_set_entity.HighlightSetEntity" href="kittycad.models.highlight_set_entity.HighlightSetEntity.html" />
|
|||
|
|
<link rel="prev" title="kittycad.models.gltf_storage.GltfStorage" href="kittycad.models.gltf_storage.GltfStorage.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.5.9
|
|||
|
|
</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 class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.api.html">kittycad.api</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="kittycad.models.html">kittycad.models</a><ul class="current">
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.account_provider.html">kittycad.models.account_provider</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_feedback.html">kittycad.models.ai_feedback</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_plugin_api.html">kittycad.models.ai_plugin_api</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_plugin_api_type.html">kittycad.models.ai_plugin_api_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_plugin_auth.html">kittycad.models.ai_plugin_auth</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_plugin_auth_type.html">kittycad.models.ai_plugin_auth_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_plugin_http_auth_type.html">kittycad.models.ai_plugin_http_auth_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_plugin_manifest.html">kittycad.models.ai_plugin_manifest</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_prompt.html">kittycad.models.ai_prompt</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_prompt_results_page.html">kittycad.models.ai_prompt_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ai_prompt_type.html">kittycad.models.ai_prompt_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.angle.html">kittycad.models.angle</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_line_end.html">kittycad.models.annotation_line_end</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_line_end_options.html">kittycad.models.annotation_line_end_options</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_options.html">kittycad.models.annotation_options</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_text_alignment_x.html">kittycad.models.annotation_text_alignment_x</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_text_alignment_y.html">kittycad.models.annotation_text_alignment_y</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_text_options.html">kittycad.models.annotation_text_options</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.annotation_type.html">kittycad.models.annotation_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_query_group.html">kittycad.models.api_call_query_group</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_query_group_by.html">kittycad.models.api_call_query_group_by</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_status.html">kittycad.models.api_call_status</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_with_price.html">kittycad.models.api_call_with_price</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_call_with_price_results_page.html">kittycad.models.api_call_with_price_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_error.html">kittycad.models.api_error</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_token.html">kittycad.models.api_token</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.api_token_results_page.html">kittycad.models.api_token_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.app_client_info.html">kittycad.models.app_client_info</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call.html">kittycad.models.async_api_call</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call_output.html">kittycad.models.async_api_call_output</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call_results_page.html">kittycad.models.async_api_call_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.async_api_call_type.html">kittycad.models.async_api_call_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.axis.html">kittycad.models.axis</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.axis_direction_pair.html">kittycad.models.axis_direction_pair</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.base64data.html">kittycad.models.base64data</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.billing_info.html">kittycad.models.billing_info</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.cache_metadata.html">kittycad.models.cache_metadata</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_interaction_type.html">kittycad.models.camera_drag_interaction_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.card_details.html">kittycad.models.card_details</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.center_of_mass.html">kittycad.models.center_of_mass</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.client_metrics.html">kittycad.models.client_metrics</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.cluster.html">kittycad.models.cluster</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.code_language.html">kittycad.models.code_language</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.code_output.html">kittycad.models.code_output</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.color.html">kittycad.models.color</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.connection.html">kittycad.models.connection</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.country_code.html">kittycad.models.country_code</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.coupon.html">kittycad.models.coupon</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.created_at_sort_mode.html">kittycad.models.created_at_sort_mode</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.currency.html">kittycad.models.currency</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_get_control_points.html">kittycad.models.curve_get_control_points</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_get_end_points.html">kittycad.models.curve_get_end_points</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_get_type.html">kittycad.models.curve_get_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.curve_type.html">kittycad.models.curve_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.customer.html">kittycad.models.customer</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.customer_balance.html">kittycad.models.customer_balance</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.density.html">kittycad.models.density</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_access_token_request_form.html">kittycad.models.device_access_token_request_form</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_auth_request_form.html">kittycad.models.device_auth_request_form</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.device_auth_verify_params.html">kittycad.models.device_auth_verify_params</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.direction.html">kittycad.models.direction</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.discount.html">kittycad.models.discount</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.email_authentication_form.html">kittycad.models.email_authentication_form</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.empty.html">kittycad.models.empty</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_all_child_uuids.html">kittycad.models.entity_get_all_child_uuids</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_child_uuid.html">kittycad.models.entity_get_child_uuid</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_num_children.html">kittycad.models.entity_get_num_children</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_parent_id.html">kittycad.models.entity_get_parent_id</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_type.html">kittycad.models.entity_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.environment.html">kittycad.models.environment</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.error.html">kittycad.models.error</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.error_code.html">kittycad.models.error_code</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.export.html">kittycad.models.export</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.export_file.html">kittycad.models.export_file</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extended_user.html">kittycad.models.extended_user</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extended_user_results_page.html">kittycad.models.extended_user_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.failure_web_socket_response.html">kittycad.models.failure_web_socket_response</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.fbx_storage.html">kittycad.models.fbx_storage</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_center_of_mass.html">kittycad.models.file_center_of_mass</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_conversion.html">kittycad.models.file_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_density.html">kittycad.models.file_density</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_export_format.html">kittycad.models.file_export_format</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_import_format.html">kittycad.models.file_import_format</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_mass.html">kittycad.models.file_mass</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_surface_area.html">kittycad.models.file_surface_area</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_system_metadata.html">kittycad.models.file_system_metadata</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.file_volume.html">kittycad.models.file_volume</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.gateway.html">kittycad.models.gateway</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.get_entity_type.html">kittycad.models.get_entity_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.get_sketch_mode_plane.html">kittycad.models.get_sketch_mode_plane</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.gltf_presentation.html">kittycad.models.gltf_presentation</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.gltf_storage.html">kittycad.models.gltf_storage</a></li>
|
|||
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">kittycad.models.highlight_set_entity</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.highlight_set_entity.HighlightSetEntity.html">kittycad.models.highlight_set_entity.HighlightSetEntity</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity</span></code></a><ul>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__abstractmethods__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__annotations__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__annotations__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__class_getitem__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__class_vars__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__class_vars__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__copy__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__copy__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__deepcopy__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__delattr__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__delattr__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__dict__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__dict__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__eq__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__eq__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__fields__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__fields__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__fields_set__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__fields_set__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__get_pydantic_core_schema__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__get_pydantic_json_schema__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__getattr__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__getattr__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__getstate__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__getstate__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__hash__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__hash__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__init__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__init__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__iter__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__iter__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__module__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__module__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pretty__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pretty__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__private_attributes__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_complete__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_core_schema__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_custom_init__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_decorators__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_extra__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_fields_set__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_generic_metadata__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_init_subclass__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_parent_namespace__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_post_init__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_private__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_root_model__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_serializer__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__pydantic_validator__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__repr__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_args__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__repr_args__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_name__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__repr_name__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_str__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__repr_str__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__rich_repr__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__setattr__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__setattr__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__setstate__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__setstate__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__signature__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__signature__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__slots__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__slots__</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__str__"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.__str__()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._abc_impl"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity._abc_impl</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._calculate_keys"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity._calculate_keys()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._check_frozen"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity._check_frozen()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity._copy_and_set_values()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._get_value"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity._get_value()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._iter"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity._iter()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.construct"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.construct()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.copy"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.copy()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.dict"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.dict()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.entity_id"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.entity_id</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.from_orm"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.from_orm()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.json"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.json()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_computed_fields</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_config"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_config</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_construct"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_construct()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_copy"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_copy()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_dump"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_dump()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_dump_json"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_dump_json()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_extra"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_extra</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_fields"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_fields</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_fields_set"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_fields_set</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_json_schema"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_json_schema()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_parametrized_name()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_post_init"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_post_init()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_rebuild"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_rebuild()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_validate()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate_json"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_validate_json()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.model_validate_strings()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.parse_file"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.parse_file()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.parse_obj"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.parse_obj()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.parse_raw"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.parse_raw()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.schema"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.schema()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.schema_json"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.schema_json()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.sequence"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.sequence</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.update_forward_refs()</span></code></a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.validate"><code class="docutils literal notranslate"><span class="pre">HighlightSetEntity.validate()</span></code></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ice_server.html">kittycad.models.ice_server</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.image_format.html">kittycad.models.image_format</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.import_file.html">kittycad.models.import_file</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.import_files.html">kittycad.models.import_files</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.input_format.html">kittycad.models.input_format</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.invoice.html">kittycad.models.invoice</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.invoice_line_item.html">kittycad.models.invoice_line_item</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.invoice_status.html">kittycad.models.invoice_status</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream.html">kittycad.models.jetstream</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream_api_stats.html">kittycad.models.jetstream_api_stats</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream_config.html">kittycad.models.jetstream_config</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.jetstream_stats.html">kittycad.models.jetstream_stats</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.leaf_node.html">kittycad.models.leaf_node</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.mass.html">kittycad.models.mass</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.meta_cluster_info.html">kittycad.models.meta_cluster_info</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.metadata.html">kittycad.models.metadata</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.method.html">kittycad.models.method</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_cmd.html">kittycad.models.modeling_cmd</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_cmd_id.html">kittycad.models.modeling_cmd_id</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_cmd_req.html">kittycad.models.modeling_cmd_req</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.mouse_click.html">kittycad.models.mouse_click</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.new_address.html">kittycad.models.new_address</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.o_auth2_client_info.html">kittycad.models.o_auth2_client_info</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.o_auth2_grant_type.html">kittycad.models.o_auth2_grant_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ok_modeling_cmd_response.html">kittycad.models.ok_modeling_cmd_response</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ok_web_socket_response_data.html">kittycad.models.ok_web_socket_response_data</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.onboarding.html">kittycad.models.onboarding</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.output_file.html">kittycad.models.output_file</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.output_format.html">kittycad.models.output_format</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_command.html">kittycad.models.path_command</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_component_constraint_bound.html">kittycad.models.path_component_constraint_bound</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_component_constraint_type.html">kittycad.models.path_component_constraint_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_get_curve_uuids_for_vertices.html">kittycad.models.path_get_curve_uuids_for_vertices</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_get_info.html">kittycad.models.path_get_info</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_get_vertex_uuids.html">kittycad.models.path_get_vertex_uuids</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_segment.html">kittycad.models.path_segment</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_segment_info.html">kittycad.models.path_segment_info</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_intent.html">kittycad.models.payment_intent</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_method.html">kittycad.models.payment_method</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_method_card_checks.html">kittycad.models.payment_method_card_checks</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.payment_method_type.html">kittycad.models.payment_method_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.plane_intersect_and_project.html">kittycad.models.plane_intersect_and_project</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ply_storage.html">kittycad.models.ply_storage</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.point2d.html">kittycad.models.point2d</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.point3d.html">kittycad.models.point3d</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.pong.html">kittycad.models.pong</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.raw_file.html">kittycad.models.raw_file</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rtc_ice_candidate_init.html">kittycad.models.rtc_ice_candidate_init</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rtc_sdp_type.html">kittycad.models.rtc_sdp_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.rtc_session_description.html">kittycad.models.rtc_session_description</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.scene_selection_type.html">kittycad.models.scene_selection_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.scene_tool_type.html">kittycad.models.scene_tool_type</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.select_get.html">kittycad.models.select_get</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.select_with_point.html">kittycad.models.select_with_point</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.selection.html">kittycad.models.selection</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.session.html">kittycad.models.session</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_all_edge_faces.html">kittycad.models.solid3d_get_all_edge_faces</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_all_opposite_edges.html">kittycad.models.solid3d_get_all_opposite_edges</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_next_adjacent_edge.html">kittycad.models.solid3d_get_next_adjacent_edge</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_opposite_edge.html">kittycad.models.solid3d_get_opposite_edge</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_prev_adjacent_edge.html">kittycad.models.solid3d_get_prev_adjacent_edge</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.stl_storage.html">kittycad.models.stl_storage</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.success_web_socket_response.html">kittycad.models.success_web_socket_response</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.surface_area.html">kittycad.models.surface_area</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.system.html">kittycad.models.system</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.take_snapshot.html">kittycad.models.take_snapshot</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad.html">kittycad.models.text_to_cad</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_create_body.html">kittycad.models.text_to_cad_create_body</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_results_page.html">kittycad.models.text_to_cad_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_angle.html">kittycad.models.unit_angle</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_angle_conversion.html">kittycad.models.unit_angle_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_area.html">kittycad.models.unit_area</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_area_conversion.html">kittycad.models.unit_area_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_current.html">kittycad.models.unit_current</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_current_conversion.html">kittycad.models.unit_current_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_density.html">kittycad.models.unit_density</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_energy.html">kittycad.models.unit_energy</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_energy_conversion.html">kittycad.models.unit_energy_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_force.html">kittycad.models.unit_force</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_force_conversion.html">kittycad.models.unit_force_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_frequency.html">kittycad.models.unit_frequency</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_frequency_conversion.html">kittycad.models.unit_frequency_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_length.html">kittycad.models.unit_length</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_length_conversion.html">kittycad.models.unit_length_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_mass.html">kittycad.models.unit_mass</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_mass_conversion.html">kittycad.models.unit_mass_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_power.html">kittycad.models.unit_power</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_power_conversion.html">kittycad.models.unit_power_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_pressure.html">kittycad.models.unit_pressure</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_pressure_conversion.html">kittycad.models.unit_pressure_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_temperature.html">kittycad.models.unit_temperature</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_temperature_conversion.html">kittycad.models.unit_temperature_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_torque.html">kittycad.models.unit_torque</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_torque_conversion.html">kittycad.models.unit_torque_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_volume.html">kittycad.models.unit_volume</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_volume_conversion.html">kittycad.models.unit_volume_conversion</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.update_user.html">kittycad.models.update_user</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user.html">kittycad.models.user</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user_results_page.html">kittycad.models.user_results_page</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.uuid.html">kittycad.models.uuid</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.verification_token.html">kittycad.models.verification_token</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.volume.html">kittycad.models.volume</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.web_socket_request.html">kittycad.models.web_socket_request</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.web_socket_response.html">kittycad.models.web_socket_response</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="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="kittycad.models.html">kittycad.models</a></li>
|
|||
|
|
<li class="breadcrumb-item active">kittycad.models.highlight_set_entity</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">
|
|||
|
|
|
|||
|
|
<section id="module-kittycad.models.highlight_set_entity">
|
|||
|
|
<span id="kittycad-models-highlight-set-entity"></span><h1>kittycad.models.highlight_set_entity<a class="headerlink" href="#module-kittycad.models.highlight_set_entity" title="Permalink to this heading"></a></h1>
|
|||
|
|
<p class="rubric">Classes</p>
|
|||
|
|
<table class="autosummary longtable docutils align-default">
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.models.highlight_set_entity.HighlightSetEntity.html#kittycad.models.highlight_set_entity.HighlightSetEntity" title="kittycad.models.highlight_set_entity.HighlightSetEntity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HighlightSetEntity</span></code></a>(**data)</p></td>
|
|||
|
|
<td><p>The response from the <cite>HighlightSetEntity</cite> command.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.highlight_set_entity.</span></span><span class="sig-name descname"><span class="pre">HighlightSetEntity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/highlight_set_entity.html#HighlightSetEntity"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The response from the <cite>HighlightSetEntity</cite> command.</p>
|
|||
|
|
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
|||
|
|
<p>Raises [<cite>ValidationError</cite>][pydantic_core.ValidationError] if the input data cannot be
|
|||
|
|
validated to form a valid model.</p>
|
|||
|
|
<p><cite>__init__</cite> uses <cite>__pydantic_self__</cite> instead of the more common <cite>self</cite> for the first arg to
|
|||
|
|
allow <cite>self</cite> as a field name.</p>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__abstractmethods__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__abstractmethods__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">frozenset({})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__abstractmethods__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__annotations__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__annotations__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'__class_vars__':</span> <span class="pre">'ClassVar[set[str]]',</span> <span class="pre">'__private_attributes__':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ModelPrivateAttr]]',</span> <span class="pre">'__pydantic_complete__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_core_schema__':</span> <span class="pre">'ClassVar[CoreSchema]',</span> <span class="pre">'__pydantic_custom_init__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_decorators__':</span> <span class="pre">'ClassVar[_decorators.DecoratorInfos]',</span> <span class="pre">'__pydantic_extra__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_fields_set__':</span> <span class="pre">'set[str]',</span> <span class="pre">'__pydantic_generic_metadata__':</span> <span class="pre">'ClassVar[_generics.PydanticGenericMetadata]',</span> <span class="pre">'__pydantic_parent_namespace__':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]',</span> <span class="pre">'__pydantic_post_init__':</span> <span class="pre">"ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]",</span> <span class="pre">'__pydantic_private__':</span> <span class="pre">'dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None',</span> <span class="pre">'__pydantic_root_model__':</span> <span class="pre">'ClassVar[bool]',</span> <span class="pre">'__pydantic_serializer__':</span> <span class="pre">'ClassVar[SchemaSerializer]',</span> <span class="pre">'__pydantic_validator__':</span> <span class="pre">'ClassVar[SchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'entity_id':</span> <span class="pre">typing.Optional[str],</span> <span class="pre">'model_config':</span> <span class="pre">'ClassVar[ConfigDict]',</span> <span class="pre">'model_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">FieldInfo]]',</span> <span class="pre">'sequence':</span> <span class="pre">typing.Optional[int]}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__annotations__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__class_getitem__">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__class_getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">typevar_values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__class_getitem__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__class_vars__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__class_vars__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__copy__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__copy__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__copy__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Returns a shallow copy of the model.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__deepcopy__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__deepcopy__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__deepcopy__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Returns a deep copy of the model.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__delattr__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__delattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__delattr__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Implement delattr(self, name).</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__dict__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__dict__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__eq__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__eq__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__eq__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Return self==value.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__fields__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__fields__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'entity_id':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'sequence':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__fields__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py property">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__fields_set__">
|
|||
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__fields_set__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__get_pydantic_core_schema__">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_core_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_BaseModel__handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__get_pydantic_core_schema__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Hook into generating the model’s CoreSchema.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>__source</strong> – The class we are generating a schema for.
|
|||
|
|
This will generally be the same as the <cite>cls</cite> argument if this is a classmethod.</p></li>
|
|||
|
|
<li><p><strong>__handler</strong> – Call into Pydantic’s internal JSON schema generation.
|
|||
|
|
A callable that calls into Pydantic’s internal CoreSchema generation logic.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">AnySchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">NoneSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">BoolSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">IntSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">FloatSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DecimalSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">StringSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">BytesSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DateSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DatetimeSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TimedeltaSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">LiteralSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">IsInstanceSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">IsSubclassSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CallableSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ListSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TuplePositionalSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TupleVariableSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">SetSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">FrozenSetSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">GeneratorSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DictSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">AfterValidatorFunctionSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">BeforeValidatorFunctionSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">WrapValidatorFunctionSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">PlainValidatorFunctionSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">WithDefaultSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">NullableSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UnionSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TaggedUnionSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ChainSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">LaxOrStrictSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">JsonOrPythonSchema</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">TypedDictSchema</span></code>, <code class="xref py py-class do
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A <cite>pydantic-core</cite> <cite>CoreSchema</cite>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__get_pydantic_json_schema__">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__get_pydantic_json_schema__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_BaseModel__handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__get_pydantic_json_schema__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Hook into generating the model’s JSON schema.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>__core_schema</strong> – A <cite>pydantic-core</cite> CoreSchema.
|
|||
|
|
You can ignore this argument and call the handler with a new CoreSchema,
|
|||
|
|
wrap this CoreSchema (<cite>{‘type’: ‘nullable’, ‘schema’: current_schema}</cite>),
|
|||
|
|
or just call the handler with the original schema.</p></li>
|
|||
|
|
<li><p><strong>__handler</strong> – Call into Pydantic’s internal JSON schema generation.
|
|||
|
|
This will raise a <cite>pydantic.errors.PydanticInvalidForJsonSchema</cite> if JSON schema
|
|||
|
|
generation fails.
|
|||
|
|
Since this gets called by <cite>BaseModel.model_json_schema</cite> you can override the
|
|||
|
|
<cite>schema_generator</cite> argument to that function to change JSON schema generation globally
|
|||
|
|
for a type.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A JSON schema, as a Python object.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__getattr__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__getattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__getattr__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__getstate__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__getstate__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__getstate__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="kittycad.models.highlight_set_entity.HighlightSetEntity.html#kittycad.models.highlight_set_entity.HighlightSetEntity.dict" title="kittycad.models.highlight_set_entity.HighlightSetEntity.dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__hash__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__hash__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__hash__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__init__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__init__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
|
|||
|
|
<p>Raises [<cite>ValidationError</cite>][pydantic_core.ValidationError] if the input data cannot be
|
|||
|
|
validated to form a valid model.</p>
|
|||
|
|
<p><cite>__init__</cite> uses <cite>__pydantic_self__</cite> instead of the more common <cite>self</cite> for the first arg to
|
|||
|
|
allow <cite>self</cite> as a field name.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__iter__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__iter__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>So <cite>dict(model)</cite> works.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>TupleGenerator</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__module__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kittycad.models.highlight_set_entity'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__module__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pretty__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pretty__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pretty__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Used by devtools (<a class="reference external" href="https://python-devtools.helpmanual.io/">https://python-devtools.helpmanual.io/</a>) to pretty print objects.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generator" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generator</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__private_attributes__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__private_attributes__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">ModelPrivateAttr]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__private_attributes__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_complete__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_complete__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_core_schema__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.highlight_set_entity.HighlightSetEntity'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'HighlightSetEntity'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic.internal.needs_apply_discriminated_union':</span> <span class="pre">False,</span> <span class="pre">'pydantic_js_annotation_functions':</span> <span class="pre">[],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[functools.partial(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'kittycad.models.highlight_set_entity.HighlightSetEntity'>),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'kittycad.models.highlight_set_entity.HighlightSetEntity'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.highlight_set_entity.HighlightSetEntity:93825018048688',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'entity_id':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'schema':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic.internal.needs_apply_discriminated_union':</span> <span class="pre">False},</span> <span class="pre">'schema':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic.internal.needs_apply_discriminated_union':</span> <span class="pre">False},</span> <span class="pre">'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'nullable'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'sequence':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">None,</span> <span class="pre">'schema':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic.internal.needs_apply_discriminated_union':</span> <span class="pre">False},</span> <span class="pre">'schema':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic.internal.needs_apply_discriminated_union':</span> <span class="pre">False},</span> <span class="pre">'type':</span> <span class="pre">'int'},</span> <span class="pre">'type':</span> <span class="pre">'nullable'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_custom_init__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_custom_init__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_decorators__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_decorators__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_extra__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_extra__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_fields_set__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_fields_set__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_generic_metadata__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_generic_metadata__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_init_subclass__">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">__pydantic_init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_init_subclass__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This is intended to behave just like <cite>__init_subclass__</cite>, but is called by <cite>ModelMetaclass</cite>
|
|||
|
|
only after the class is actually fully initialized. In particular, attributes like <cite>model_fields</cite> will
|
|||
|
|
be present when this is called.</p>
|
|||
|
|
<p>This is necessary because <cite>__init_subclass__</cite> will always be called by <cite>type.__new__</cite>,
|
|||
|
|
and it would require a prohibitively large refactor to the <cite>ModelMetaclass</cite> to ensure that
|
|||
|
|
<cite>type.__new__</cite> was called in such a manner that the class would already be sufficiently initialized.</p>
|
|||
|
|
<p>This will receive the same <cite>kwargs</cite> that would be passed to the standard <cite>__init_subclass__</cite>, namely,
|
|||
|
|
any kwargs passed to the class definition that aren’t used internally by pydantic.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><strong>**kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>) – Any keyword arguments passed to the class definition that aren’t used internally
|
|||
|
|
by pydantic.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_parent_namespace__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'BaseModel':</span> <span class="pre"><pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object>,</span> <span class="pre">'Optional':</span> <span class="pre"><pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object>,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre"><class</span> <span class="pre">'ArithmeticError'>,</span> <span class="pre">'AssertionError':</span> <span class="pre"><class</span> <span class="pre">'AssertionError'>,</span> <span class="pre">'AttributeError':</span> <span class="pre"><class</span> <span class="pre">'AttributeError'>,</span> <span class="pre">'BaseException':</span> <span class="pre"><class</span> <span class="pre">'BaseException'>,</span> <span class="pre">'BlockingIOError':</span> <span class="pre"><class</span> <span class="pre">'BlockingIOError'>,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre"><class</span> <span class="pre">'BrokenPipeError'>,</span> <span class="pre">'BufferError':</span> <span class="pre"><class</span> <span class="pre">'BufferError'>,</span> <span class="pre">'BytesWarning':</span> <span class="pre"><class</span> <span class="pre">'BytesWarning'>,</span> <span class="pre">'ChildProcessError':</span> <span class="pre"><class</span> <span class="pre">'ChildProcessError'>,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre"><class</span> <span class="pre">'ConnectionAbortedError'>,</span> <span class="pre">'ConnectionError':</span> <span class="pre"><class</span> <span class="pre">'ConnectionError'>,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre"><class</span> <span class="pre">'ConnectionRefusedError'>,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre"><class</span> <span class="pre">'ConnectionResetError'>,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre"><class</span> <span class="pre">'DeprecationWarning'>,</span> <span class="pre">'EOFError':</span> <span class="pre"><class</span> <span class="pre">'EOFError'>,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EnvironmentError':</span> <span class="pre"><class</span> <span class="pre">'OSError'>,</span> <span class="pre">'Exception':</span> <span class="pre"><class</span> <span class="pre">'Exception'>,</span> <span class="pre">'False':</span> <span class="pre">False,</span> <span class="pre">'FileExistsError':</span> <span class="pre"><class</span> <span class="pre">'FileExistsError'>,</span> <span class="pre">'FileNotFoundError':</span> <span class="pre"><class</span> <span class="pre">'FileNotFoundError'>,</span> <span class="pre">'FloatingPointError':</span> <span class="pre"><class</span> <span class="pre">'FloatingPointError'>,</span> <span class="pre">'FutureWarning':</span> <span class="pre"><class</span> <span class="pre">'FutureWarning'>,</span> <span class="pre">'GeneratorExit':</span> <span class="pre"><class</span> <span class="pre">'GeneratorExit'>,</span> <span class="pre">'IOError':</span> <span class="pre"><class</span> <span class="pre">'OSError'>,</span> <span class="pre">'ImportError':</span> <span class="pre"><class</span> <span class="pre">'ImportError'>,</span> <span class="pre">'ImportWarning':</span> <span class="pre"><class</span> <span class="pre">'ImportWarning'>,</span> <span class=
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_post_init__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_post_init__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_private__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_private__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_root_model__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_root_model__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_root_model__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_serializer__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000555556df30b0,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"sequence":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fffff11ecf0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007ffffff85420,</span>              
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__pydantic_validator__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="HighlightSetEntity",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"entity_id",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"entity_id",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fffe1186df0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"entity_id",</span>                                         <span class="pre">Py(</span>                               
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__repr__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Return repr(self).</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_args__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__repr_args__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_args__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_name__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__repr_name__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_name__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Name of the instance’s class, used in __repr__.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_str__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__repr_str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">join_str</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__repr_str__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__rich_repr__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__rich_repr__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__rich_repr__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Used by Rich (<a class="reference external" href="https://rich.readthedocs.io/en/stable/pretty.html">https://rich.readthedocs.io/en/stable/pretty.html</a>) to pretty print objects.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__setattr__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__setattr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__setattr__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Implement setattr(self, name, value).</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__setstate__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__setstate__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__setstate__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__signature__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">entity_id:</span> <span class="pre">Optional[str]</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">sequence:</span> <span class="pre">Optional[int]</span> <span class="pre">=</span> <span class="pre">None)</span> <span class="pre">-></span> <span class="pre">None></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__signature__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__slots__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__slots__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('__dict__',</span> <span class="pre">'__pydantic_fields_set__',</span> <span class="pre">'__pydantic_extra__',</span> <span class="pre">'__pydantic_private__')</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__slots__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.__str__">
|
|||
|
|
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.__str__" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Return str(self).</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity._abc_impl">
|
|||
|
|
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc._abc_data</span> <span class="pre">object></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._abc_impl" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity._calculate_keys">
|
|||
|
|
<span class="sig-name descname"><span class="pre">_calculate_keys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._calculate_keys" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity._check_frozen">
|
|||
|
|
<span class="sig-name descname"><span class="pre">_check_frozen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._check_frozen" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity._copy_and_set_values">
|
|||
|
|
<span class="sig-name descname"><span class="pre">_copy_and_set_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._copy_and_set_values" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity._get_value">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">_get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._get_value" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity._iter">
|
|||
|
|
<span class="sig-name descname"><span class="pre">_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity._iter" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.construct">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.construct" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.copy">
|
|||
|
|
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.copy" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Returns a copy of the model.</p>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <cite>model_copy</cite> instead.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p>If you need <cite>include</cite> or <cite>exclude</cite>, use:</p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">`py</span>
|
|||
|
|
<span class="pre">data</span> <span class="pre">=</span> <span class="pre">self.model_dump(include=include,</span> <span class="pre">exclude=exclude,</span> <span class="pre">round_trip=True)</span>
|
|||
|
|
<span class="pre">data</span> <span class="pre">=</span> <span class="pre">{**data,</span> <span class="pre">**(update</span> <span class="pre">or</span> <span class="pre">{})}</span>
|
|||
|
|
<span class="pre">copied</span> <span class="pre">=</span> <span class="pre">self.model_validate(data)</span>
|
|||
|
|
<span class="pre">`</span></code></p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>include</strong> (<em>AbstractSetIntStr</em><em> | </em><em>MappingIntStrAny</em><em> | </em><em>None</em>) – Optional set or mapping
|
|||
|
|
specifying which fields to include in the copied model.</p></li>
|
|||
|
|
<li><p><strong>exclude</strong> (<em>AbstractSetIntStr</em><em> | </em><em>MappingIntStrAny</em><em> | </em><em>None</em>) – Optional set or mapping
|
|||
|
|
specifying which fields to exclude in the copied model.</p></li>
|
|||
|
|
<li><p><strong>update</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><em>Dict</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em>) – Optional dictionary of field-value pairs to override field values
|
|||
|
|
in the copied model.</p></li>
|
|||
|
|
<li><p><strong>deep</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True, the values of fields that are Pydantic models will be deep copied.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A copy of the model with included, excluded and updated fields as specified.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.dict">
|
|||
|
|
<span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.dict" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><em>Dict</em></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>, Any]</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.entity_id">
|
|||
|
|
<span class="sig-name descname"><span class="pre">entity_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.entity_id" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.from_orm">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_orm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.from_orm" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.json">
|
|||
|
|
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">models_as_dict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PydanticUndefined</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.json" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py property">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_computed_fields">
|
|||
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ComputedFieldInfo</span><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_computed_fields" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Get the computed fields of this model instance.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_config">
|
|||
|
|
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_config" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_construct">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_construct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_fields_set</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_construct" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Creates a new instance of the <cite>Model</cite> class with validated data.</p>
|
|||
|
|
<p>Creates a new model setting <cite>__dict__</cite> and <cite>__pydantic_fields_set__</cite> from trusted or pre-validated data.
|
|||
|
|
Default values are respected, but no other validation is performed.
|
|||
|
|
Behaves as if <cite>Config.extra = ‘allow’</cite> was set since it adds all passed values</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>_fields_set</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><em>set</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>] </em><em>| </em><em>None</em>) – The set of field names accepted for the Model instance.</p></li>
|
|||
|
|
<li><p><strong>values</strong> (<em>Any</em>) – Trusted or pre-validated data dictionary.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A new instance of the <cite>Model</cite> class with validated data.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_copy">
|
|||
|
|
<span class="sig-name descname"><span class="pre">model_copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_copy" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.5/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.5/concepts/serialization/#model_copy</a></p>
|
|||
|
|
<p>Returns a copy of the model.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>update</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em>) – Values to change/add in the new model. Note: the data is not validated
|
|||
|
|
before creating the new model. You should trust this data.</p></li>
|
|||
|
|
<li><p><strong>deep</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Set to <cite>True</cite> to make a deep copy of the model.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>New model instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_dump">
|
|||
|
|
<span class="sig-name descname"><span class="pre">model_dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'python'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">round_trip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_dump" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.5/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.5/concepts/serialization/#modelmodel_dump</a></p>
|
|||
|
|
<p>Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>mode</strong> – The mode in which <cite>to_python</cite> should run.
|
|||
|
|
If mode is ‘json’, the dictionary will only contain JSON serializable types.
|
|||
|
|
If mode is ‘python’, the dictionary may contain any Python objects.</p></li>
|
|||
|
|
<li><p><strong>include</strong> – A list of fields to include in the output.</p></li>
|
|||
|
|
<li><p><strong>exclude</strong> – A list of fields to exclude from the output.</p></li>
|
|||
|
|
<li><p><strong>by_alias</strong> – Whether to use the field’s alias in the dictionary key if defined.</p></li>
|
|||
|
|
<li><p><strong>exclude_unset</strong> – Whether to exclude fields that have not been explicitly set.</p></li>
|
|||
|
|
<li><p><strong>exclude_defaults</strong> – Whether to exclude fields that are set to their default value from the output.</p></li>
|
|||
|
|
<li><p><strong>exclude_none</strong> – Whether to exclude fields that have a value of <cite>None</cite> from the output.</p></li>
|
|||
|
|
<li><p><strong>round_trip</strong> – Whether to enable serialization and deserialization round-trip support.</p></li>
|
|||
|
|
<li><p><strong>warnings</strong> – Whether to log warnings when invalid fields are encountered.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>A dictionary representation of the model.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_dump_json">
|
|||
|
|
<span class="sig-name descname"><span class="pre">model_dump_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_unset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_defaults</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">round_trip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_dump_json" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.5/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.5/concepts/serialization/#modelmodel_dump_json</a></p>
|
|||
|
|
<p>Generates a JSON representation of the model using Pydantic’s <cite>to_json</cite> method.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>indent</strong> – Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
|
|||
|
|
<li><p><strong>include</strong> – Field(s) to include in the JSON output. Can take either a string or set of strings.</p></li>
|
|||
|
|
<li><p><strong>exclude</strong> – Field(s) to exclude from the JSON output. Can take either a string or set of strings.</p></li>
|
|||
|
|
<li><p><strong>by_alias</strong> – Whether to serialize using field aliases.</p></li>
|
|||
|
|
<li><p><strong>exclude_unset</strong> – Whether to exclude fields that have not been explicitly set.</p></li>
|
|||
|
|
<li><p><strong>exclude_defaults</strong> – Whether to exclude fields that have the default value.</p></li>
|
|||
|
|
<li><p><strong>exclude_none</strong> – Whether to exclude fields that have a value of <cite>None</cite>.</p></li>
|
|||
|
|
<li><p><strong>round_trip</strong> – Whether to use serialization/deserialization between JSON and class instance.</p></li>
|
|||
|
|
<li><p><strong>warnings</strong> – Whether to show any warnings that occurred during serialization.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>A JSON string representation of the model.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py property">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_extra">
|
|||
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_extra</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_extra" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Get extra fields set during validation.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>A dictionary of extra fields, or <cite>None</cite> if <cite>config.extra</cite> is not set to <cite>“allow”</cite>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_fields">
|
|||
|
|
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'entity_id':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'sequence':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_fields" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Metadata about the fields defined on the model,
|
|||
|
|
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
|
|||
|
|
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py property">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_fields_set">
|
|||
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_fields_set</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_fields_set" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Returns the set of fields that have been explicitly set on this model instance.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><dl class="simple">
|
|||
|
|
<dt>A set of strings representing the fields that have been set,</dt><dd><p>i.e. that were not filled from defaults.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_json_schema">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_json_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by_alias=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template='#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_generator=<class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode='validation'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_json_schema" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Generates a JSON schema for a model class.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>by_alias</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Whether to use attribute aliases or not.</p></li>
|
|||
|
|
<li><p><strong>ref_template</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The reference template.</p></li>
|
|||
|
|
<li><p><strong>schema_generator</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code>]) – To override the logic used to generate the JSON schema, as a subclass of
|
|||
|
|
<cite>GenerateJsonSchema</cite> with your desired modifications</p></li>
|
|||
|
|
<li><p><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a>[<code class="docutils literal notranslate"><span class="pre">'validation'</span></code>, <code class="docutils literal notranslate"><span class="pre">'serialization'</span></code>]) – The mode in which to generate the schema.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="kittycad.models.highlight_set_entity.HighlightSetEntity.html#kittycad.models.highlight_set_entity.HighlightSetEntity.dict" title="kittycad.models.highlight_set_entity.HighlightSetEntity.dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>The JSON schema for the given model class.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_parametrized_name">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_parametrized_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_parametrized_name" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Compute the class name for parametrizations of generic classes.</p>
|
|||
|
|
<p>This method can be overridden to achieve a custom naming scheme for generic BaseModels.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><strong>params</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#Ellipsis" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code></a>]) – Tuple of types of the class. Given a generic class
|
|||
|
|
<cite>Model</cite> with 2 type variables and a concrete model <cite>Model[str, int]</cite>,
|
|||
|
|
the value <cite>(str, int)</cite> would be passed to <cite>params</cite>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>String representing the new class where <cite>params</cite> are passed to <cite>cls</cite> as type variables.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.12)"><strong>TypeError</strong></a> – Raised when trying to generate concrete names for non-generic models.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_post_init">
|
|||
|
|
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_BaseModel__context</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_post_init" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Override this method to perform additional initialization after <cite>__init__</cite> and <cite>model_construct</cite>.
|
|||
|
|
This is useful if you want to do some validation that requires the entire model to be initialized.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_rebuild">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_rebuild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_parent_namespace_depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_types_namespace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_rebuild" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Try to rebuild the pydantic-core schema for the model.</p>
|
|||
|
|
<p>This may be necessary when one of the annotations is a ForwardRef which could not be resolved during
|
|||
|
|
the initial attempt to build the schema, and automatic rebuilding fails.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>force</strong> – Whether to force the rebuilding of the model schema, defaults to <cite>False</cite>.</p></li>
|
|||
|
|
<li><p><strong>raise_errors</strong> – Whether to raise errors, defaults to <cite>True</cite>.</p></li>
|
|||
|
|
<li><p><strong>_parent_namespace_depth</strong> – The depth level of the parent namespace, defaults to 2.</p></li>
|
|||
|
|
<li><p><strong>_types_namespace</strong> – The types namespace, defaults to <cite>None</cite>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Returns <cite>None</cite> if the schema is already “complete” and rebuilding was not required.
|
|||
|
|
If rebuilding _was_ required, returns <cite>True</cite> if rebuilding was successful, otherwise <cite>False</cite>.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Validate a pydantic model instance.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>obj</strong> (<em>Any</em>) – The object to validate.</p></li>
|
|||
|
|
<li><p><strong>strict</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> | </em><em>None</em>) – Whether to raise an exception on invalid fields.</p></li>
|
|||
|
|
<li><p><strong>from_attributes</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> | </em><em>None</em>) – Whether to extract data from object attributes.</p></li>
|
|||
|
|
<li><p><strong>context</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em>) – Additional context to pass to the validator.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><strong>ValidationError</strong> – If the object could not be validated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>The validated model instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate_json">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate_json" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.5/concepts/json/#json-parsing">https://docs.pydantic.dev/2.5/concepts/json/#json-parsing</a></p>
|
|||
|
|
<p>Validate the given JSON data against the Pydantic model.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>json_data</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><em>bytes</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><em>bytearray</em></a>) – The JSON data to validate.</p></li>
|
|||
|
|
<li><p><strong>strict</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> | </em><em>None</em>) – Whether to enforce types strictly.</p></li>
|
|||
|
|
<li><p><strong>context</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em>) – Extra variables to pass to the validator.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>The validated Pydantic model.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – If <cite>json_data</cite> is not a JSON string.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate_strings">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model_validate_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.model_validate_strings" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Validate the given object contains string data against the Pydantic model.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>obj</strong> (<em>Any</em>) – The object contains string data to validate.</p></li>
|
|||
|
|
<li><p><strong>strict</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> | </em><em>None</em>) – Whether to enforce types strictly.</p></li>
|
|||
|
|
<li><p><strong>context</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em>) – Extra variables to pass to the validator.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>The validated Pydantic model.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.parse_file">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proto</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_pickle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.parse_file" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.parse_obj">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_obj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.parse_obj" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.parse_raw">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_raw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proto</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_pickle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.parse_raw" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.schema">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#/$defs/{model}'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.schema" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.schema_json">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">schema_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by_alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'#/$defs/{model}'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">dumps_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.schema_json" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.sequence">
|
|||
|
|
<span class="sig-name descname"><span class="pre">sequence</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a><span class="pre">[</span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.sequence" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd></dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.update_forward_refs">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_forward_refs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">localns</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.update_forward_refs" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="kittycad.models.highlight_set_entity.HighlightSetEntity.validate">
|
|||
|
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/highlight_set_entity.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.highlight_set_entity.HighlightSetEntity.validate" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Model</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
|
<a href="kittycad.models.gltf_storage.GltfStorage.html" class="btn btn-neutral float-left" title="kittycad.models.gltf_storage.GltfStorage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
<a href="kittycad.models.highlight_set_entity.HighlightSetEntity.html" class="btn btn-neutral float-right" title="kittycad.models.highlight_set_entity.HighlightSetEntity" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<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>
|