Files
kittycad.py/docs/html/_autosummary/kittycad.models.input_format.html

7381 lines
2.0 MiB
HTML
Raw Normal View History

2023-07-08 02:27:32 +00:00
<!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.input_format" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.models.input_format.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.input_format_eb8f8b68.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" />
2024-08-23 20:56:42 +00:00
<title>kittycad.models.input_format &mdash; kittycad v0.6.20 documentation</title>
2023-07-08 02:27:32 +00:00
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="../_static/autoclasstoc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
2023-08-16 23:39:29 +00:00
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
2024-08-23 20:56:42 +00:00
<script src="../_static/documentation_options.js?v=c0d2930c"></script>
2024-07-28 22:52:47 +00:00
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
2023-08-16 23:39:29 +00:00
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
2023-07-08 02:27:32 +00:00
<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.input_format.fbx" href="kittycad.models.input_format.fbx.html" />
2024-07-28 22:52:47 +00:00
<link rel="prev" title="kittycad.models.imported_geometry.ImportedGeometry" href="kittycad.models.imported_geometry.ImportedGeometry.html" />
2023-07-08 02:27:32 +00:00
</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">
2024-08-23 20:56:42 +00:00
v0.6.20
2023-07-08 02:27:32 +00:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul 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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.add_org_member.html">kittycad.models.add_org_member</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.address_details.html">kittycad.models.address_details</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.angle.html">kittycad.models.angle</a></li>
2023-08-16 23:39:29 +00:00
<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>
2023-07-08 02:27:32 +00:00
<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>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.auth_callback.html">kittycad.models.auth_callback</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.batch_response.html">kittycad.models.batch_response</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.billing_info.html">kittycad.models.billing_info</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.block_reason.html">kittycad.models.block_reason</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.cache_metadata.html">kittycad.models.cache_metadata</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_end.html">kittycad.models.camera_drag_end</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_interaction_type.html">kittycad.models.camera_drag_interaction_type</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_drag_move.html">kittycad.models.camera_drag_move</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.camera_settings.html">kittycad.models.camera_settings</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.close_path.html">kittycad.models.close_path</a></li>
2023-07-08 02:27:32 +00:00
<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>
2023-08-16 23:39:29 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.color.html">kittycad.models.color</a></li>
2023-07-08 02:27:32 +00:00
<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>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.cut_type.html">kittycad.models.cut_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_focus_on.html">kittycad.models.default_camera_focus_on</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_get_settings.html">kittycad.models.default_camera_get_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.default_camera_zoom.html">kittycad.models.default_camera_zoom</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.density.html">kittycad.models.density</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.der_encoded_key_pair.html">kittycad.models.der_encoded_key_pair</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.discount_code.html">kittycad.models.discount_code</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.distance_type.html">kittycad.models.distance_type</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_circular_pattern.html">kittycad.models.entity_circular_pattern</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_distance.html">kittycad.models.entity_get_distance</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_get_sketch_paths.html">kittycad.models.entity_get_sketch_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_linear_pattern.html">kittycad.models.entity_linear_pattern</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_linear_pattern_transform.html">kittycad.models.entity_linear_pattern_transform</a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.entity_type.html">kittycad.models.entity_type</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.event.html">kittycad.models.event</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.export.html">kittycad.models.export</a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.export_file.html">kittycad.models.export_file</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extrusion_face_cap_type.html">kittycad.models.extrusion_face_cap_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.extrusion_face_info.html">kittycad.models.extrusion_face_info</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.face_get_center.html">kittycad.models.face_get_center</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.face_get_gradient.html">kittycad.models.face_get_gradient</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.face_get_position.html">kittycad.models.face_get_position</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.face_is_planar.html">kittycad.models.face_is_planar</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>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.get_num_objects.html">kittycad.models.get_num_objects</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.global_axis.html">kittycad.models.global_axis</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"><a class="reference internal" href="kittycad.models.highlight_set_entity.html">kittycad.models.highlight_set_entity</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ice_server.html">kittycad.models.ice_server</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.idp_metadata_source.html">kittycad.models.idp_metadata_source</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.imported_geometry.html">kittycad.models.imported_geometry</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2 current"><a class="current reference internal" href="#">kittycad.models.input_format</a><ul>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.fbx.html">kittycad.models.input_format.fbx</a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.gltf.html">kittycad.models.input_format.gltf</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.obj.html">kittycad.models.input_format.obj</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.ply.html">kittycad.models.input_format.ply</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.sldprt.html">kittycad.models.input_format.sldprt</a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.step.html">kittycad.models.input_format.step</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.input_format.stl.html">kittycad.models.input_format.stl</a></li>
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.fbx"><code class="docutils literal notranslate"><span class="pre">fbx</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">fbx.__abstractmethods__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__annotations__"><code class="docutils literal notranslate"><span class="pre">fbx.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">fbx.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__class_vars__"><code class="docutils literal notranslate"><span class="pre">fbx.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__copy__"><code class="docutils literal notranslate"><span class="pre">fbx.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">fbx.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__delattr__"><code class="docutils literal notranslate"><span class="pre">fbx.__delattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__dict__"><code class="docutils literal notranslate"><span class="pre">fbx.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__eq__"><code class="docutils literal notranslate"><span class="pre">fbx.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__fields_set__"><code class="docutils literal notranslate"><span class="pre">fbx.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">fbx.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">fbx.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__getattr__"><code class="docutils literal notranslate"><span class="pre">fbx.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__getstate__"><code class="docutils literal notranslate"><span class="pre">fbx.__getstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__hash__"><code class="docutils literal notranslate"><span class="pre">fbx.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__init__"><code class="docutils literal notranslate"><span class="pre">fbx.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__iter__"><code class="docutils literal notranslate"><span class="pre">fbx.__iter__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__module__"><code class="docutils literal notranslate"><span class="pre">fbx.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pretty__"><code class="docutils literal notranslate"><span class="pre">fbx.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">fbx.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">fbx.__pydantic_validator__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__repr__"><code class="docutils literal notranslate"><span class="pre">fbx.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__repr_args__"><code class="docutils literal notranslate"><span class="pre">fbx.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__repr_name__"><code class="docutils literal notranslate"><span class="pre">fbx.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__repr_str__"><code class="docutils literal notranslate"><span class="pre">fbx.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">fbx.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__setattr__"><code class="docutils literal notranslate"><span class="pre">fbx.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__setstate__"><code class="docutils literal notranslate"><span class="pre">fbx.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__signature__"><code class="docutils literal notranslate"><span class="pre">fbx.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__slots__"><code class="docutils literal notranslate"><span class="pre">fbx.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.__str__"><code class="docutils literal notranslate"><span class="pre">fbx.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx._abc_impl"><code class="docutils literal notranslate"><span class="pre">fbx._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx._calculate_keys"><code class="docutils literal notranslate"><span class="pre">fbx._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx._check_frozen"><code class="docutils literal notranslate"><span class="pre">fbx._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">fbx._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx._get_value"><code class="docutils literal notranslate"><span class="pre">fbx._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx._iter"><code class="docutils literal notranslate"><span class="pre">fbx._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.construct"><code class="docutils literal notranslate"><span class="pre">fbx.construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.copy"><code class="docutils literal notranslate"><span class="pre">fbx.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.dict"><code class="docutils literal notranslate"><span class="pre">fbx.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.from_orm"><code class="docutils literal notranslate"><span class="pre">fbx.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.json"><code class="docutils literal notranslate"><span class="pre">fbx.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">fbx.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_config"><code class="docutils literal notranslate"><span class="pre">fbx.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_construct"><code class="docutils literal notranslate"><span class="pre">fbx.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_copy"><code class="docutils literal notranslate"><span class="pre">fbx.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_dump"><code class="docutils literal notranslate"><span class="pre">fbx.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_dump_json"><code class="docutils literal notranslate"><span class="pre">fbx.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_extra"><code class="docutils literal notranslate"><span class="pre">fbx.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_fields"><code class="docutils literal notranslate"><span class="pre">fbx.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_fields_set"><code class="docutils literal notranslate"><span class="pre">fbx.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_json_schema"><code class="docutils literal notranslate"><span class="pre">fbx.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">fbx.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_post_init"><code class="docutils literal notranslate"><span class="pre">fbx.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_rebuild"><code class="docutils literal notranslate"><span class="pre">fbx.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_validate"><code class="docutils literal notranslate"><span class="pre">fbx.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_validate_json"><code class="docutils literal notranslate"><span class="pre">fbx.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">fbx.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.parse_file"><code class="docutils literal notranslate"><span class="pre">fbx.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.parse_obj"><code class="docutils literal notranslate"><span class="pre">fbx.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.parse_raw"><code class="docutils literal notranslate"><span class="pre">fbx.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.schema"><code class="docutils literal notranslate"><span class="pre">fbx.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.schema_json"><code class="docutils literal notranslate"><span class="pre">fbx.schema_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.type"><code class="docutils literal notranslate"><span class="pre">fbx.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">fbx.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.fbx.validate"><code class="docutils literal notranslate"><span class="pre">fbx.validate()</span></code></a></li>
</ul>
</li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.gltf"><code class="docutils literal notranslate"><span class="pre">gltf</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">gltf.__abstractmethods__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__annotations__"><code class="docutils literal notranslate"><span class="pre">gltf.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">gltf.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__class_vars__"><code class="docutils literal notranslate"><span class="pre">gltf.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__copy__"><code class="docutils literal notranslate"><span class="pre">gltf.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">gltf.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__delattr__"><code class="docutils literal notranslate"><span class="pre">gltf.__delattr__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__dict__"><code class="docutils literal notranslate"><span class="pre">gltf.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__eq__"><code class="docutils literal notranslate"><span class="pre">gltf.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__fields_set__"><code class="docutils literal notranslate"><span class="pre">gltf.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">gltf.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">gltf.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__getattr__"><code class="docutils literal notranslate"><span class="pre">gltf.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__getstate__"><code class="docutils literal notranslate"><span class="pre">gltf.__getstate__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__hash__"><code class="docutils literal notranslate"><span class="pre">gltf.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__init__"><code class="docutils literal notranslate"><span class="pre">gltf.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__iter__"><code class="docutils literal notranslate"><span class="pre">gltf.__iter__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__module__"><code class="docutils literal notranslate"><span class="pre">gltf.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pretty__"><code class="docutils literal notranslate"><span class="pre">gltf.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">gltf.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">gltf.__pydantic_validator__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__repr__"><code class="docutils literal notranslate"><span class="pre">gltf.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__repr_args__"><code class="docutils literal notranslate"><span class="pre">gltf.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__repr_name__"><code class="docutils literal notranslate"><span class="pre">gltf.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__repr_str__"><code class="docutils literal notranslate"><span class="pre">gltf.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">gltf.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__setattr__"><code class="docutils literal notranslate"><span class="pre">gltf.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__setstate__"><code class="docutils literal notranslate"><span class="pre">gltf.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__signature__"><code class="docutils literal notranslate"><span class="pre">gltf.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__slots__"><code class="docutils literal notranslate"><span class="pre">gltf.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.__str__"><code class="docutils literal notranslate"><span class="pre">gltf.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf._abc_impl"><code class="docutils literal notranslate"><span class="pre">gltf._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf._calculate_keys"><code class="docutils literal notranslate"><span class="pre">gltf._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf._check_frozen"><code class="docutils literal notranslate"><span class="pre">gltf._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">gltf._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf._get_value"><code class="docutils literal notranslate"><span class="pre">gltf._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf._iter"><code class="docutils literal notranslate"><span class="pre">gltf._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.construct"><code class="docutils literal notranslate"><span class="pre">gltf.construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.copy"><code class="docutils literal notranslate"><span class="pre">gltf.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.dict"><code class="docutils literal notranslate"><span class="pre">gltf.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.from_orm"><code class="docutils literal notranslate"><span class="pre">gltf.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.json"><code class="docutils literal notranslate"><span class="pre">gltf.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">gltf.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_config"><code class="docutils literal notranslate"><span class="pre">gltf.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_construct"><code class="docutils literal notranslate"><span class="pre">gltf.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_copy"><code class="docutils literal notranslate"><span class="pre">gltf.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_dump"><code class="docutils literal notranslate"><span class="pre">gltf.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_dump_json"><code class="docutils literal notranslate"><span class="pre">gltf.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_extra"><code class="docutils literal notranslate"><span class="pre">gltf.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_fields"><code class="docutils literal notranslate"><span class="pre">gltf.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_fields_set"><code class="docutils literal notranslate"><span class="pre">gltf.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_json_schema"><code class="docutils literal notranslate"><span class="pre">gltf.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">gltf.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_post_init"><code class="docutils literal notranslate"><span class="pre">gltf.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_rebuild"><code class="docutils literal notranslate"><span class="pre">gltf.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_validate"><code class="docutils literal notranslate"><span class="pre">gltf.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_validate_json"><code class="docutils literal notranslate"><span class="pre">gltf.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">gltf.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.parse_file"><code class="docutils literal notranslate"><span class="pre">gltf.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.parse_obj"><code class="docutils literal notranslate"><span class="pre">gltf.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.parse_raw"><code class="docutils literal notranslate"><span class="pre">gltf.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.schema"><code class="docutils literal notranslate"><span class="pre">gltf.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.schema_json"><code class="docutils literal notranslate"><span class="pre">gltf.schema_json()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.type"><code class="docutils literal notranslate"><span class="pre">gltf.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">gltf.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.gltf.validate"><code class="docutils literal notranslate"><span class="pre">gltf.validate()</span></code></a></li>
2023-07-08 02:27:32 +00:00
</ul>
</li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.obj"><code class="docutils literal notranslate"><span class="pre">obj</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">obj.__abstractmethods__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__annotations__"><code class="docutils literal notranslate"><span class="pre">obj.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">obj.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__class_vars__"><code class="docutils literal notranslate"><span class="pre">obj.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__copy__"><code class="docutils literal notranslate"><span class="pre">obj.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">obj.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__delattr__"><code class="docutils literal notranslate"><span class="pre">obj.__delattr__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__dict__"><code class="docutils literal notranslate"><span class="pre">obj.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__eq__"><code class="docutils literal notranslate"><span class="pre">obj.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__fields_set__"><code class="docutils literal notranslate"><span class="pre">obj.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">obj.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">obj.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__getattr__"><code class="docutils literal notranslate"><span class="pre">obj.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__getstate__"><code class="docutils literal notranslate"><span class="pre">obj.__getstate__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__hash__"><code class="docutils literal notranslate"><span class="pre">obj.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__init__"><code class="docutils literal notranslate"><span class="pre">obj.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__iter__"><code class="docutils literal notranslate"><span class="pre">obj.__iter__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__module__"><code class="docutils literal notranslate"><span class="pre">obj.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pretty__"><code class="docutils literal notranslate"><span class="pre">obj.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">obj.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">obj.__pydantic_validator__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__repr__"><code class="docutils literal notranslate"><span class="pre">obj.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__repr_args__"><code class="docutils literal notranslate"><span class="pre">obj.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__repr_name__"><code class="docutils literal notranslate"><span class="pre">obj.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__repr_str__"><code class="docutils literal notranslate"><span class="pre">obj.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">obj.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__setattr__"><code class="docutils literal notranslate"><span class="pre">obj.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__setstate__"><code class="docutils literal notranslate"><span class="pre">obj.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__signature__"><code class="docutils literal notranslate"><span class="pre">obj.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__slots__"><code class="docutils literal notranslate"><span class="pre">obj.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.__str__"><code class="docutils literal notranslate"><span class="pre">obj.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj._abc_impl"><code class="docutils literal notranslate"><span class="pre">obj._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj._calculate_keys"><code class="docutils literal notranslate"><span class="pre">obj._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj._check_frozen"><code class="docutils literal notranslate"><span class="pre">obj._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">obj._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj._get_value"><code class="docutils literal notranslate"><span class="pre">obj._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj._iter"><code class="docutils literal notranslate"><span class="pre">obj._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.construct"><code class="docutils literal notranslate"><span class="pre">obj.construct()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.coords"><code class="docutils literal notranslate"><span class="pre">obj.coords</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.copy"><code class="docutils literal notranslate"><span class="pre">obj.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.dict"><code class="docutils literal notranslate"><span class="pre">obj.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.from_orm"><code class="docutils literal notranslate"><span class="pre">obj.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.json"><code class="docutils literal notranslate"><span class="pre">obj.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">obj.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_config"><code class="docutils literal notranslate"><span class="pre">obj.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_construct"><code class="docutils literal notranslate"><span class="pre">obj.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_copy"><code class="docutils literal notranslate"><span class="pre">obj.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_dump"><code class="docutils literal notranslate"><span class="pre">obj.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_dump_json"><code class="docutils literal notranslate"><span class="pre">obj.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_extra"><code class="docutils literal notranslate"><span class="pre">obj.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_fields"><code class="docutils literal notranslate"><span class="pre">obj.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_fields_set"><code class="docutils literal notranslate"><span class="pre">obj.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_json_schema"><code class="docutils literal notranslate"><span class="pre">obj.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">obj.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_post_init"><code class="docutils literal notranslate"><span class="pre">obj.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_rebuild"><code class="docutils literal notranslate"><span class="pre">obj.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_validate"><code class="docutils literal notranslate"><span class="pre">obj.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_validate_json"><code class="docutils literal notranslate"><span class="pre">obj.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">obj.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.parse_file"><code class="docutils literal notranslate"><span class="pre">obj.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.parse_obj"><code class="docutils literal notranslate"><span class="pre">obj.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.parse_raw"><code class="docutils literal notranslate"><span class="pre">obj.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.schema"><code class="docutils literal notranslate"><span class="pre">obj.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.schema_json"><code class="docutils literal notranslate"><span class="pre">obj.schema_json()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.type"><code class="docutils literal notranslate"><span class="pre">obj.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.units"><code class="docutils literal notranslate"><span class="pre">obj.units</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">obj.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.obj.validate"><code class="docutils literal notranslate"><span class="pre">obj.validate()</span></code></a></li>
2023-07-31 19:56:37 +00:00
</ul>
</li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.ply"><code class="docutils literal notranslate"><span class="pre">ply</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">ply.__abstractmethods__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__annotations__"><code class="docutils literal notranslate"><span class="pre">ply.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">ply.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__class_vars__"><code class="docutils literal notranslate"><span class="pre">ply.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__copy__"><code class="docutils literal notranslate"><span class="pre">ply.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">ply.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__delattr__"><code class="docutils literal notranslate"><span class="pre">ply.__delattr__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__dict__"><code class="docutils literal notranslate"><span class="pre">ply.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__eq__"><code class="docutils literal notranslate"><span class="pre">ply.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__fields_set__"><code class="docutils literal notranslate"><span class="pre">ply.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">ply.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">ply.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__getattr__"><code class="docutils literal notranslate"><span class="pre">ply.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__getstate__"><code class="docutils literal notranslate"><span class="pre">ply.__getstate__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__hash__"><code class="docutils literal notranslate"><span class="pre">ply.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__init__"><code class="docutils literal notranslate"><span class="pre">ply.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__iter__"><code class="docutils literal notranslate"><span class="pre">ply.__iter__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__module__"><code class="docutils literal notranslate"><span class="pre">ply.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pretty__"><code class="docutils literal notranslate"><span class="pre">ply.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">ply.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">ply.__pydantic_validator__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__repr__"><code class="docutils literal notranslate"><span class="pre">ply.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__repr_args__"><code class="docutils literal notranslate"><span class="pre">ply.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__repr_name__"><code class="docutils literal notranslate"><span class="pre">ply.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__repr_str__"><code class="docutils literal notranslate"><span class="pre">ply.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">ply.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__setattr__"><code class="docutils literal notranslate"><span class="pre">ply.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__setstate__"><code class="docutils literal notranslate"><span class="pre">ply.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__signature__"><code class="docutils literal notranslate"><span class="pre">ply.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__slots__"><code class="docutils literal notranslate"><span class="pre">ply.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.__str__"><code class="docutils literal notranslate"><span class="pre">ply.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply._abc_impl"><code class="docutils literal notranslate"><span class="pre">ply._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply._calculate_keys"><code class="docutils literal notranslate"><span class="pre">ply._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply._check_frozen"><code class="docutils literal notranslate"><span class="pre">ply._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">ply._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply._get_value"><code class="docutils literal notranslate"><span class="pre">ply._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply._iter"><code class="docutils literal notranslate"><span class="pre">ply._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.construct"><code class="docutils literal notranslate"><span class="pre">ply.construct()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.coords"><code class="docutils literal notranslate"><span class="pre">ply.coords</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.copy"><code class="docutils literal notranslate"><span class="pre">ply.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.dict"><code class="docutils literal notranslate"><span class="pre">ply.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.from_orm"><code class="docutils literal notranslate"><span class="pre">ply.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.json"><code class="docutils literal notranslate"><span class="pre">ply.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">ply.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_config"><code class="docutils literal notranslate"><span class="pre">ply.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_construct"><code class="docutils literal notranslate"><span class="pre">ply.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_copy"><code class="docutils literal notranslate"><span class="pre">ply.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_dump"><code class="docutils literal notranslate"><span class="pre">ply.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_dump_json"><code class="docutils literal notranslate"><span class="pre">ply.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_extra"><code class="docutils literal notranslate"><span class="pre">ply.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_fields"><code class="docutils literal notranslate"><span class="pre">ply.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_fields_set"><code class="docutils literal notranslate"><span class="pre">ply.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_json_schema"><code class="docutils literal notranslate"><span class="pre">ply.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">ply.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_post_init"><code class="docutils literal notranslate"><span class="pre">ply.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_rebuild"><code class="docutils literal notranslate"><span class="pre">ply.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_validate"><code class="docutils literal notranslate"><span class="pre">ply.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_validate_json"><code class="docutils literal notranslate"><span class="pre">ply.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">ply.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.parse_file"><code class="docutils literal notranslate"><span class="pre">ply.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.parse_obj"><code class="docutils literal notranslate"><span class="pre">ply.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.parse_raw"><code class="docutils literal notranslate"><span class="pre">ply.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.schema"><code class="docutils literal notranslate"><span class="pre">ply.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.schema_json"><code class="docutils literal notranslate"><span class="pre">ply.schema_json()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.type"><code class="docutils literal notranslate"><span class="pre">ply.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.units"><code class="docutils literal notranslate"><span class="pre">ply.units</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">ply.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.ply.validate"><code class="docutils literal notranslate"><span class="pre">ply.validate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.sldprt"><code class="docutils literal notranslate"><span class="pre">sldprt</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">sldprt.__abstractmethods__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__annotations__"><code class="docutils literal notranslate"><span class="pre">sldprt.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">sldprt.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__class_vars__"><code class="docutils literal notranslate"><span class="pre">sldprt.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__copy__"><code class="docutils literal notranslate"><span class="pre">sldprt.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">sldprt.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__delattr__"><code class="docutils literal notranslate"><span class="pre">sldprt.__delattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__dict__"><code class="docutils literal notranslate"><span class="pre">sldprt.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__eq__"><code class="docutils literal notranslate"><span class="pre">sldprt.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__fields_set__"><code class="docutils literal notranslate"><span class="pre">sldprt.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">sldprt.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">sldprt.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__getattr__"><code class="docutils literal notranslate"><span class="pre">sldprt.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__getstate__"><code class="docutils literal notranslate"><span class="pre">sldprt.__getstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__hash__"><code class="docutils literal notranslate"><span class="pre">sldprt.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__init__"><code class="docutils literal notranslate"><span class="pre">sldprt.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__iter__"><code class="docutils literal notranslate"><span class="pre">sldprt.__iter__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__module__"><code class="docutils literal notranslate"><span class="pre">sldprt.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pretty__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">sldprt.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">sldprt.__pydantic_validator__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__repr__"><code class="docutils literal notranslate"><span class="pre">sldprt.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__repr_args__"><code class="docutils literal notranslate"><span class="pre">sldprt.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__repr_name__"><code class="docutils literal notranslate"><span class="pre">sldprt.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__repr_str__"><code class="docutils literal notranslate"><span class="pre">sldprt.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">sldprt.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__setattr__"><code class="docutils literal notranslate"><span class="pre">sldprt.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__setstate__"><code class="docutils literal notranslate"><span class="pre">sldprt.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__signature__"><code class="docutils literal notranslate"><span class="pre">sldprt.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__slots__"><code class="docutils literal notranslate"><span class="pre">sldprt.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.__str__"><code class="docutils literal notranslate"><span class="pre">sldprt.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt._abc_impl"><code class="docutils literal notranslate"><span class="pre">sldprt._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt._calculate_keys"><code class="docutils literal notranslate"><span class="pre">sldprt._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt._check_frozen"><code class="docutils literal notranslate"><span class="pre">sldprt._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">sldprt._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt._get_value"><code class="docutils literal notranslate"><span class="pre">sldprt._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt._iter"><code class="docutils literal notranslate"><span class="pre">sldprt._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.construct"><code class="docutils literal notranslate"><span class="pre">sldprt.construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.copy"><code class="docutils literal notranslate"><span class="pre">sldprt.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.dict"><code class="docutils literal notranslate"><span class="pre">sldprt.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.from_orm"><code class="docutils literal notranslate"><span class="pre">sldprt.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.json"><code class="docutils literal notranslate"><span class="pre">sldprt.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">sldprt.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_config"><code class="docutils literal notranslate"><span class="pre">sldprt.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_construct"><code class="docutils literal notranslate"><span class="pre">sldprt.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_copy"><code class="docutils literal notranslate"><span class="pre">sldprt.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_dump"><code class="docutils literal notranslate"><span class="pre">sldprt.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_dump_json"><code class="docutils literal notranslate"><span class="pre">sldprt.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_extra"><code class="docutils literal notranslate"><span class="pre">sldprt.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_fields"><code class="docutils literal notranslate"><span class="pre">sldprt.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_fields_set"><code class="docutils literal notranslate"><span class="pre">sldprt.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_json_schema"><code class="docutils literal notranslate"><span class="pre">sldprt.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">sldprt.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_post_init"><code class="docutils literal notranslate"><span class="pre">sldprt.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_rebuild"><code class="docutils literal notranslate"><span class="pre">sldprt.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_validate"><code class="docutils literal notranslate"><span class="pre">sldprt.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_validate_json"><code class="docutils literal notranslate"><span class="pre">sldprt.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">sldprt.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.parse_file"><code class="docutils literal notranslate"><span class="pre">sldprt.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.parse_obj"><code class="docutils literal notranslate"><span class="pre">sldprt.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.parse_raw"><code class="docutils literal notranslate"><span class="pre">sldprt.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.schema"><code class="docutils literal notranslate"><span class="pre">sldprt.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.schema_json"><code class="docutils literal notranslate"><span class="pre">sldprt.schema_json()</span></code></a></li>
2024-08-09 21:14:56 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.split_closed_faces"><code class="docutils literal notranslate"><span class="pre">sldprt.split_closed_faces</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.type"><code class="docutils literal notranslate"><span class="pre">sldprt.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">sldprt.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.sldprt.validate"><code class="docutils literal notranslate"><span class="pre">sldprt.validate()</span></code></a></li>
2023-07-08 02:27:32 +00:00
</ul>
</li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.step"><code class="docutils literal notranslate"><span class="pre">step</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">step.__abstractmethods__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__annotations__"><code class="docutils literal notranslate"><span class="pre">step.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">step.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__class_vars__"><code class="docutils literal notranslate"><span class="pre">step.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__copy__"><code class="docutils literal notranslate"><span class="pre">step.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">step.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__delattr__"><code class="docutils literal notranslate"><span class="pre">step.__delattr__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__dict__"><code class="docutils literal notranslate"><span class="pre">step.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__eq__"><code class="docutils literal notranslate"><span class="pre">step.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__fields_set__"><code class="docutils literal notranslate"><span class="pre">step.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">step.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">step.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__getattr__"><code class="docutils literal notranslate"><span class="pre">step.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__getstate__"><code class="docutils literal notranslate"><span class="pre">step.__getstate__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__hash__"><code class="docutils literal notranslate"><span class="pre">step.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__init__"><code class="docutils literal notranslate"><span class="pre">step.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__iter__"><code class="docutils literal notranslate"><span class="pre">step.__iter__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__module__"><code class="docutils literal notranslate"><span class="pre">step.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pretty__"><code class="docutils literal notranslate"><span class="pre">step.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">step.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">step.__pydantic_validator__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__repr__"><code class="docutils literal notranslate"><span class="pre">step.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__repr_args__"><code class="docutils literal notranslate"><span class="pre">step.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__repr_name__"><code class="docutils literal notranslate"><span class="pre">step.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__repr_str__"><code class="docutils literal notranslate"><span class="pre">step.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">step.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__setattr__"><code class="docutils literal notranslate"><span class="pre">step.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__setstate__"><code class="docutils literal notranslate"><span class="pre">step.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__signature__"><code class="docutils literal notranslate"><span class="pre">step.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__slots__"><code class="docutils literal notranslate"><span class="pre">step.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.__str__"><code class="docutils literal notranslate"><span class="pre">step.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step._abc_impl"><code class="docutils literal notranslate"><span class="pre">step._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step._calculate_keys"><code class="docutils literal notranslate"><span class="pre">step._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step._check_frozen"><code class="docutils literal notranslate"><span class="pre">step._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">step._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step._get_value"><code class="docutils literal notranslate"><span class="pre">step._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step._iter"><code class="docutils literal notranslate"><span class="pre">step._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.construct"><code class="docutils literal notranslate"><span class="pre">step.construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.copy"><code class="docutils literal notranslate"><span class="pre">step.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.dict"><code class="docutils literal notranslate"><span class="pre">step.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.from_orm"><code class="docutils literal notranslate"><span class="pre">step.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.json"><code class="docutils literal notranslate"><span class="pre">step.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">step.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_config"><code class="docutils literal notranslate"><span class="pre">step.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_construct"><code class="docutils literal notranslate"><span class="pre">step.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_copy"><code class="docutils literal notranslate"><span class="pre">step.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_dump"><code class="docutils literal notranslate"><span class="pre">step.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_dump_json"><code class="docutils literal notranslate"><span class="pre">step.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_extra"><code class="docutils literal notranslate"><span class="pre">step.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_fields"><code class="docutils literal notranslate"><span class="pre">step.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_fields_set"><code class="docutils literal notranslate"><span class="pre">step.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_json_schema"><code class="docutils literal notranslate"><span class="pre">step.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">step.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_post_init"><code class="docutils literal notranslate"><span class="pre">step.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_rebuild"><code class="docutils literal notranslate"><span class="pre">step.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_validate"><code class="docutils literal notranslate"><span class="pre">step.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_validate_json"><code class="docutils literal notranslate"><span class="pre">step.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">step.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.parse_file"><code class="docutils literal notranslate"><span class="pre">step.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.parse_obj"><code class="docutils literal notranslate"><span class="pre">step.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.parse_raw"><code class="docutils literal notranslate"><span class="pre">step.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.schema"><code class="docutils literal notranslate"><span class="pre">step.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.schema_json"><code class="docutils literal notranslate"><span class="pre">step.schema_json()</span></code></a></li>
2024-08-09 21:14:56 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.split_closed_faces"><code class="docutils literal notranslate"><span class="pre">step.split_closed_faces</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.type"><code class="docutils literal notranslate"><span class="pre">step.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">step.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.step.validate"><code class="docutils literal notranslate"><span class="pre">step.validate()</span></code></a></li>
2023-07-08 02:27:32 +00:00
</ul>
</li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l3"><a class="reference internal" href="#kittycad.models.input_format.stl"><code class="docutils literal notranslate"><span class="pre">stl</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__abstractmethods__"><code class="docutils literal notranslate"><span class="pre">stl.__abstractmethods__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__annotations__"><code class="docutils literal notranslate"><span class="pre">stl.__annotations__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__class_getitem__"><code class="docutils literal notranslate"><span class="pre">stl.__class_getitem__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__class_vars__"><code class="docutils literal notranslate"><span class="pre">stl.__class_vars__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__copy__"><code class="docutils literal notranslate"><span class="pre">stl.__copy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__deepcopy__"><code class="docutils literal notranslate"><span class="pre">stl.__deepcopy__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__delattr__"><code class="docutils literal notranslate"><span class="pre">stl.__delattr__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__dict__"><code class="docutils literal notranslate"><span class="pre">stl.__dict__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__eq__"><code class="docutils literal notranslate"><span class="pre">stl.__eq__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__fields_set__"><code class="docutils literal notranslate"><span class="pre">stl.__fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__get_pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">stl.__get_pydantic_core_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__get_pydantic_json_schema__"><code class="docutils literal notranslate"><span class="pre">stl.__get_pydantic_json_schema__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__getattr__"><code class="docutils literal notranslate"><span class="pre">stl.__getattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__getstate__"><code class="docutils literal notranslate"><span class="pre">stl.__getstate__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__hash__"><code class="docutils literal notranslate"><span class="pre">stl.__hash__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__init__"><code class="docutils literal notranslate"><span class="pre">stl.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__iter__"><code class="docutils literal notranslate"><span class="pre">stl.__iter__()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__module__"><code class="docutils literal notranslate"><span class="pre">stl.__module__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pretty__"><code class="docutils literal notranslate"><span class="pre">stl.__pretty__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">stl.__private_attributes__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_complete__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_core_schema__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_custom_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_decorators__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_extra__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_fields_set__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_generic_metadata__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_init_subclass__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_init_subclass__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_parent_namespace__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_post_init__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_private__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_root_model__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_root_model__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_serializer__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">stl.__pydantic_validator__</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__repr__"><code class="docutils literal notranslate"><span class="pre">stl.__repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__repr_args__"><code class="docutils literal notranslate"><span class="pre">stl.__repr_args__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__repr_name__"><code class="docutils literal notranslate"><span class="pre">stl.__repr_name__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__repr_str__"><code class="docutils literal notranslate"><span class="pre">stl.__repr_str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__rich_repr__"><code class="docutils literal notranslate"><span class="pre">stl.__rich_repr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__setattr__"><code class="docutils literal notranslate"><span class="pre">stl.__setattr__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__setstate__"><code class="docutils literal notranslate"><span class="pre">stl.__setstate__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__signature__"><code class="docutils literal notranslate"><span class="pre">stl.__signature__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__slots__"><code class="docutils literal notranslate"><span class="pre">stl.__slots__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.__str__"><code class="docutils literal notranslate"><span class="pre">stl.__str__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl._abc_impl"><code class="docutils literal notranslate"><span class="pre">stl._abc_impl</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl._calculate_keys"><code class="docutils literal notranslate"><span class="pre">stl._calculate_keys()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl._check_frozen"><code class="docutils literal notranslate"><span class="pre">stl._check_frozen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl._copy_and_set_values"><code class="docutils literal notranslate"><span class="pre">stl._copy_and_set_values()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl._get_value"><code class="docutils literal notranslate"><span class="pre">stl._get_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl._iter"><code class="docutils literal notranslate"><span class="pre">stl._iter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.construct"><code class="docutils literal notranslate"><span class="pre">stl.construct()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.coords"><code class="docutils literal notranslate"><span class="pre">stl.coords</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.copy"><code class="docutils literal notranslate"><span class="pre">stl.copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.dict"><code class="docutils literal notranslate"><span class="pre">stl.dict()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.from_orm"><code class="docutils literal notranslate"><span class="pre">stl.from_orm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.json"><code class="docutils literal notranslate"><span class="pre">stl.json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">stl.model_computed_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_config"><code class="docutils literal notranslate"><span class="pre">stl.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_construct"><code class="docutils literal notranslate"><span class="pre">stl.model_construct()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_copy"><code class="docutils literal notranslate"><span class="pre">stl.model_copy()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_dump"><code class="docutils literal notranslate"><span class="pre">stl.model_dump()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_dump_json"><code class="docutils literal notranslate"><span class="pre">stl.model_dump_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_extra"><code class="docutils literal notranslate"><span class="pre">stl.model_extra</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_fields"><code class="docutils literal notranslate"><span class="pre">stl.model_fields</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_fields_set"><code class="docutils literal notranslate"><span class="pre">stl.model_fields_set</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_json_schema"><code class="docutils literal notranslate"><span class="pre">stl.model_json_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_parametrized_name"><code class="docutils literal notranslate"><span class="pre">stl.model_parametrized_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_post_init"><code class="docutils literal notranslate"><span class="pre">stl.model_post_init()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_rebuild"><code class="docutils literal notranslate"><span class="pre">stl.model_rebuild()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_validate"><code class="docutils literal notranslate"><span class="pre">stl.model_validate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_validate_json"><code class="docutils literal notranslate"><span class="pre">stl.model_validate_json()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.model_validate_strings"><code class="docutils literal notranslate"><span class="pre">stl.model_validate_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.parse_file"><code class="docutils literal notranslate"><span class="pre">stl.parse_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.parse_obj"><code class="docutils literal notranslate"><span class="pre">stl.parse_obj()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.parse_raw"><code class="docutils literal notranslate"><span class="pre">stl.parse_raw()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.schema"><code class="docutils literal notranslate"><span class="pre">stl.schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.schema_json"><code class="docutils literal notranslate"><span class="pre">stl.schema_json()</span></code></a></li>
2023-08-16 23:39:29 +00:00
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.type"><code class="docutils literal notranslate"><span class="pre">stl.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.units"><code class="docutils literal notranslate"><span class="pre">stl.units</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.update_forward_refs"><code class="docutils literal notranslate"><span class="pre">stl.update_forward_refs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.input_format.stl.validate"><code class="docutils literal notranslate"><span class="pre">stl.validate()</span></code></a></li>
2023-07-08 02:27:32 +00:00
</ul>
</li>
</ul>
</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ip_addr_info.html">kittycad.models.ip_addr_info</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.kcl_code_completion_params.html">kittycad.models.kcl_code_completion_params</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.kcl_code_completion_request.html">kittycad.models.kcl_code_completion_request</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.kcl_code_completion_response.html">kittycad.models.kcl_code_completion_response</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.leaf_node.html">kittycad.models.leaf_node</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.length_unit.html">kittycad.models.length_unit</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.linear_transform.html">kittycad.models.linear_transform</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.mass.html">kittycad.models.mass</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-08-22 21:44:40 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ml_feedback.html">kittycad.models.ml_feedback</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ml_prompt.html">kittycad.models.ml_prompt</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ml_prompt_metadata.html">kittycad.models.ml_prompt_metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ml_prompt_results_page.html">kittycad.models.ml_prompt_results_page</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.ml_prompt_type.html">kittycad.models.ml_prompt_type</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_app_event_type.html">kittycad.models.modeling_app_event_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_app_individual_subscription_tier.html">kittycad.models.modeling_app_individual_subscription_tier</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_app_organization_subscription_tier.html">kittycad.models.modeling_app_organization_subscription_tier</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_app_subscription_tier.html">kittycad.models.modeling_app_subscription_tier</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_app_subscription_tier_name.html">kittycad.models.modeling_app_subscription_tier_name</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-08-23 20:56:42 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.modeling_session_data.html">kittycad.models.modeling_session_data</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.mouse_click.html">kittycad.models.mouse_click</a></li>
2023-07-08 02:27:32 +00:00
<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>
2023-08-16 23:39:29 +00:00
<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>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.onboarding.html">kittycad.models.onboarding</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.org.html">kittycad.models.org</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.org_details.html">kittycad.models.org_details</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.org_member.html">kittycad.models.org_member</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.org_member_results_page.html">kittycad.models.org_member_results_page</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.org_results_page.html">kittycad.models.org_results_page</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.org_role.html">kittycad.models.org_role</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_get_curve_uuid.html">kittycad.models.path_get_curve_uuid</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.path_get_sketch_target_uuid.html">kittycad.models.path_get_sketch_target_uuid</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>
2023-07-08 02:27:32 +00:00
<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>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.perspective_camera_parameters.html">kittycad.models.perspective_camera_parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.plan_interval.html">kittycad.models.plan_interval</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>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.point4d.html">kittycad.models.point4d</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.pong.html">kittycad.models.pong</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.post_effect_type.html">kittycad.models.post_effect_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.privacy_settings.html">kittycad.models.privacy_settings</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.saml_identity_provider.html">kittycad.models.saml_identity_provider</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.saml_identity_provider_create.html">kittycad.models.saml_identity_provider_create</a></li>
2023-08-16 23:39:29 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.service_account.html">kittycad.models.service_account</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.service_account_results_page.html">kittycad.models.service_account_results_page</a></li>
2023-07-08 02:27:32 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.session.html">kittycad.models.session</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.session_token_uuid.html">kittycad.models.session_token_uuid</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.solid3d_get_extrusion_face_info.html">kittycad.models.solid3d_get_extrusion_face_info</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>
2024-08-22 21:44:40 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.source_position.html">kittycad.models.source_position</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.source_range.html">kittycad.models.source_range</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.source_range_prompt.html">kittycad.models.source_range_prompt</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.stl_storage.html">kittycad.models.stl_storage</a></li>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.store_coupon_params.html">kittycad.models.store_coupon_params</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.string_uuid.html">kittycad.models.string_uuid</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.subscription_tier_feature.html">kittycad.models.subscription_tier_feature</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.subscription_tier_price.html">kittycad.models.subscription_tier_price</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.subscription_tier_type.html">kittycad.models.subscription_tier_type</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.subscription_training_data_behavior.html">kittycad.models.subscription_training_data_behavior</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.support_tier.html">kittycad.models.support_tier</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.surface_area.html">kittycad.models.surface_area</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-08-22 21:44:40 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_iteration.html">kittycad.models.text_to_cad_iteration</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_iteration_body.html">kittycad.models.text_to_cad_iteration_body</a></li>
2024-08-10 00:46:56 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.text_to_cad_model.html">kittycad.models.text_to_cad_model</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>
2023-07-08 02:27:32 +00:00
<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>
2023-07-31 19:56:37 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_density.html">kittycad.models.unit_density</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.update_member_to_org_body.html">kittycad.models.update_member_to_org_body</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.update_payment_balance.html">kittycad.models.update_payment_balance</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user_org_info.html">kittycad.models.user_org_info</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.user_org_role.html">kittycad.models.user_org_role</a></li>
2023-07-08 02:27:32 +00:00
<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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.verification_token_response.html">kittycad.models.verification_token_response</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.view_isometric.html">kittycad.models.view_isometric</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>
2024-07-28 22:52:47 +00:00
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.zoo_product_subscription.html">kittycad.models.zoo_product_subscription</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.zoo_product_subscriptions.html">kittycad.models.zoo_product_subscriptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.zoo_product_subscriptions_org_request.html">kittycad.models.zoo_product_subscriptions_org_request</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.zoo_product_subscriptions_user_request.html">kittycad.models.zoo_product_subscriptions_user_request</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.zoo_tool.html">kittycad.models.zoo_tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.zoom_to_fit.html">kittycad.models.zoom_to_fit</a></li>
2023-07-08 02:27:32 +00:00
</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.input_format</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.input_format">
2024-07-28 22:52:47 +00:00
<span id="kittycad-models-input-format"></span><h1>kittycad.models.input_format<a class="headerlink" href="#module-kittycad.models.input_format" title="Link to this heading"></a></h1>
2023-07-08 02:27:32 +00:00
<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.input_format.fbx.html#kittycad.models.input_format.fbx" title="kittycad.models.input_format.fbx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fbx</span></code></a>(**data)</p></td>
<td><p>Autodesk Filmbox (FBX) format.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf" title="kittycad.models.input_format.gltf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gltf</span></code></a>(**data)</p></td>
2023-07-08 02:27:32 +00:00
<td><p>Binary glTF 2.0.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj" title="kittycad.models.input_format.obj"><code class="xref py py-obj docutils literal notranslate"><span class="pre">obj</span></code></a>(**data)</p></td>
2023-07-08 02:27:32 +00:00
<td><p>Wavefront OBJ format.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply" title="kittycad.models.input_format.ply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ply</span></code></a>(**data)</p></td>
2023-07-31 19:56:37 +00:00
<td><p>The PLY Polygon File Format.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt" title="kittycad.models.input_format.sldprt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sldprt</span></code></a>(**data)</p></td>
<td><p>SolidWorks part (SLDPRT) format.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step" title="kittycad.models.input_format.step"><code class="xref py py-obj docutils literal notranslate"><span class="pre">step</span></code></a>(**data)</p></td>
2023-07-08 02:27:32 +00:00
<td><p>ISO 10303-21 (STEP) format.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl" title="kittycad.models.input_format.stl"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stl</span></code></a>(**data)</p></td>
2023-07-08 02:27:32 +00:00
<td><p><a href="#id1"><span class="problematic" id="id2">*</span></a>ST**ereo**L**ithography format.</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">fbx</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#fbx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx" title="Link to this definition"></a></dt>
<dd><p>Autodesk Filmbox (FBX) format.</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
2023-07-08 02:27:32 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__abstractmethods__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__annotations__">
2024-07-28 22:52:47 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'type':</span> <span class="pre">typing.Literal['fbx']}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__annotations__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.type" title="kittycad.models.input_format.fbx.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__copy__" title="Link to this definition"></a></dt>
<dd><p>Returns a shallow copy of the model.</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__deepcopy__" title="Link to this definition"></a></dt>
<dd><p>Returns a deep copy of the model.</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__delattr__" title="Link to this definition"></a></dt>
<dd><p>Implement delattr(self, name).</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__dict__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__fields_set__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.type" title="kittycad.models.input_format.fbx.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__getattr__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.dict" title="kittycad.models.input_format.fbx.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>]</span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__hash__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__module__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pretty__" title="Link 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">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__private_attributes__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_complete__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">&lt;class</span> <span class="pre">'kittycad.models.input_format.fbx'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'fbx'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.input_format.fbx'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.input_format.fbx'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.fbx:94724403716080',</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">{'type':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</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">'fbx',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['fbx'],</span> <span class="pre">'type':</span> <span class="pre">'literal'},</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">'model_name':</span> <span class="pre">'fbx',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_core_schema__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_extra__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_fields_set__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.model_fields" title="kittycad.models.input_format.fbx.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
2023-07-08 02:27:32 +00:00
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
2023-07-31 19:56:37 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_post_init__" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
2023-07-31 19:56:37 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__pydantic_root_model__" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be6f5ff0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583da58,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefault(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">default:</span> <span class="pre">Default(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba303ecd0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
2023-07-31 19:56:37 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;fbx&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;type&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;type&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba3040720,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;
<dd></dd></dl>
2023-07-31 19:56:37 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__repr__" title="Link to this definition"></a></dt>
<dd><p>Return repr(self).</p>
<dl class="field-list simple">
2023-07-31 19:56:37 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
2023-07-31 19:56:37 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
2023-07-31 19:56:37 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
2023-07-31 19:56:37 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__repr_str__" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
2023-07-31 19:56:37 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
2023-07-31 19:56:37 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__setattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
2023-07-31 19:56:37 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__setstate__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
2023-07-31 19:56:37 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__signature__">
2024-07-28 22:52:47 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">type:</span> <span class="pre">Literal['fbx']</span> <span class="pre">=</span> <span class="pre">'fbx')</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__signature__" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__slots__" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
2023-07-31 19:56:37 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx._abc_impl" title="Link to this definition"></a></dt>
<dd></dd></dl>
2023-07-31 19:56:37 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx._calculate_keys" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-31 19:56:37 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx._check_frozen" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-31 19:56:37 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx._copy_and_set_values" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-31 19:56:37 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx._get_value" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx._iter" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.construct" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.model_copy" title="kittycad.models.input_format.fbx.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A copy of the model with included, excluded and updated fields as specified.</p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.from_orm" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.__dict__" title="kittycad.models.input_format.fbx.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.__pydantic_fields_set__" title="kittycad.models.input_format.fbx.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.model_construct" title="kittycad.models.input_format.fbx.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.__dict__" title="kittycad.models.input_format.fbx.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.__pydantic_extra__" title="kittycad.models.input_format.fbx.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.model_construct" title="kittycad.models.input_format.fbx.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.dict" title="kittycad.models.input_format.fbx.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.fbx.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.dict" title="kittycad.models.input_format.fbx.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.fbx.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.fbx.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_fields">
2024-07-28 22:52:47 +00:00
<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">{'type':</span> <span class="pre">FieldInfo(annotation=Literal['fbx'],</span> <span class="pre">required=False,</span> <span class="pre">default='fbx')}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_fields_set" title="Link 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.input_format.fbx.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.type" title="kittycad.models.input_format.fbx.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.dict" title="kittycad.models.input_format.fbx.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>]</span></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.input_format.fbx.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.type" title="kittycad.models.input_format.fbx.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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.input_format.fbx.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.fbx.html#id0" title="kittycad.models.input_format.fbx.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.model_construct" title="kittycad.models.input_format.fbx.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.fbx.html#kittycad.models.input_format.fbx.dict" title="kittycad.models.input_format.fbx.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.fbx.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.fbx.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.schema" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.schema_json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'fbx'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.fbx.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.fbx.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">gltf</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#gltf"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf" title="Link to this definition"></a></dt>
<dd><p>Binary glTF 2.0. We refer to this as glTF since that is how our customers refer to it, but this can also import binary glTF (glb).</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__abstractmethods__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__annotations__">
2024-07-28 22:52:47 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'type':</span> <span class="pre">typing.Literal['gltf']}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__annotations__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.type" title="kittycad.models.input_format.gltf.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__copy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__deepcopy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__delattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__dict__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.type" title="kittycad.models.input_format.gltf.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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.input_format.gltf.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__getattr__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.dict" title="kittycad.models.input_format.gltf.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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__hash__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__module__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pretty__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__private_attributes__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_complete__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">&lt;class</span> <span class="pre">'kittycad.models.input_format.gltf'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'gltf'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.input_format.gltf'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.input_format.gltf'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.gltf:94724403720448',</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">{'type':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</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">'gltf',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['gltf'],</span> <span class="pre">'type':</span> <span class="pre">'literal'},</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">'model_name':</span> <span class="pre">'gltf',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_extra__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.model_fields" title="kittycad.models.input_format.gltf.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__pydantic_root_model__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be6f7100,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583da58,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefault(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">default:</span> <span class="pre">Default(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba303f1e0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;gltf&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;type&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;type&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba3040ea0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__repr_str__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__setattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__setstate__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__signature__">
2024-07-28 22:52:47 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">type:</span> <span class="pre">Literal['gltf']</span> <span class="pre">=</span> <span class="pre">'gltf')</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__signature__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__slots__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf._abc_impl" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf._calculate_keys" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf._check_frozen" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf._copy_and_set_values" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf._get_value" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf._iter" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.construct" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.model_copy" title="kittycad.models.input_format.gltf.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><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.input_format.gltf.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.from_orm" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.__dict__" title="kittycad.models.input_format.gltf.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.__pydantic_fields_set__" title="kittycad.models.input_format.gltf.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.model_construct" title="kittycad.models.input_format.gltf.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.__dict__" title="kittycad.models.input_format.gltf.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.__pydantic_extra__" title="kittycad.models.input_format.gltf.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.model_construct" title="kittycad.models.input_format.gltf.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.dict" title="kittycad.models.input_format.gltf.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.gltf.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.dict" title="kittycad.models.input_format.gltf.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.gltf.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.gltf.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_fields">
2024-07-28 22:52:47 +00:00
<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">{'type':</span> <span class="pre">FieldInfo(annotation=Literal['gltf'],</span> <span class="pre">required=False,</span> <span class="pre">default='gltf')}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_fields_set" title="Link 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.input_format.gltf.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.type" title="kittycad.models.input_format.gltf.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.dict" title="kittycad.models.input_format.gltf.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>]</span></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.input_format.gltf.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.type" title="kittycad.models.input_format.gltf.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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.input_format.gltf.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.gltf.html#id0" title="kittycad.models.input_format.gltf.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.model_construct" title="kittycad.models.input_format.gltf.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.gltf.html#kittycad.models.input_format.gltf.dict" title="kittycad.models.input_format.gltf.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.gltf.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.gltf.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.schema" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.schema_json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'gltf'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.gltf.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.gltf.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">obj</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#obj"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj" title="Link to this definition"></a></dt>
<dd><p>Wavefront OBJ format.</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__abstractmethods__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__annotations__">
2024-07-28 22:52:47 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'coords':</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.system.System'&gt;,</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'type':</span> <span class="pre">typing.Literal['obj'],</span> <span class="pre">'units':</span> <span class="pre">&lt;enum</span> <span class="pre">'UnitLength'&gt;}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__annotations__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.type" title="kittycad.models.input_format.obj.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__copy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__deepcopy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__delattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__dict__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.type" title="kittycad.models.input_format.obj.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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.input_format.obj.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__getattr__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.dict" title="kittycad.models.input_format.obj.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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__hash__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__module__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pretty__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__private_attributes__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_complete__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">{'definitions':</span> <span class="pre">[{'cls':</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'AxisDirectionPair'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94724393856400',</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">{'axis':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis.Axis:94724401100208',</span> <span class="pre">'type':</span> <span class="pre">'definition-ref'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'direction':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.direction.Direction:94724393853840',</span> <span class="pre">'type':</span> <span class="pre">'definition-ref'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'AxisDirectionPair',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'},</span> <span class="pre">{'cls':</span> <span class="pre">&lt;enum</span> <span class="pre">'Axis'&gt;,</span> <span class="pre">'members':</span> <span class="pre">[Axis.Y,</span> <span class="pre">Axis.Z],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_enum_core_schema.&lt;locals&gt;.get_json_schema&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis.Axis:94724401100208',</span> <span class="pre">'sub_type':</span> <span class="pre">'str',</span> <span class="pre">'type':</span> <span class="pre">'enum'},</span> <span class="pre">{'cls':</span> <span class="pre">&lt;enum</span> <span class="pre">'
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_extra__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.model_fields" title="kittycad.models.input_format.obj.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__pydantic_root_model__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be6f89f0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583da58,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefault(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">default:</span> <span class="pre">Default(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583bb88,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;obj&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba3041890,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__repr_str__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__setattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__setstate__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__signature__">
2024-07-28 22:52:47 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">coords:</span> <span class="pre">kittycad.models.system.System,</span> <span class="pre">type:</span> <span class="pre">Literal['obj']</span> <span class="pre">=</span> <span class="pre">'obj',</span> <span class="pre">units:</span> <span class="pre">kittycad.models.unit_length.UnitLength)</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__signature__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__slots__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj._abc_impl" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj._calculate_keys" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj._check_frozen" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj._copy_and_set_values" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj._get_value" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj._iter" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.construct" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.coords">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">coords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="kittycad.models.system.System.html#kittycad.models.system.System" title="kittycad.models.system.System"><code class="xref py py-class docutils literal notranslate"><span class="pre">System</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.coords" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.model_copy" title="kittycad.models.input_format.obj.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><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.input_format.obj.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.from_orm" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.__dict__" title="kittycad.models.input_format.obj.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.__pydantic_fields_set__" title="kittycad.models.input_format.obj.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.model_construct" title="kittycad.models.input_format.obj.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.__dict__" title="kittycad.models.input_format.obj.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.__pydantic_extra__" title="kittycad.models.input_format.obj.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.model_construct" title="kittycad.models.input_format.obj.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.dict" title="kittycad.models.input_format.obj.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.obj.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.dict" title="kittycad.models.input_format.obj.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.obj.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.obj.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_fields">
2024-07-28 22:52:47 +00:00
<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">{'coords':</span> <span class="pre">FieldInfo(annotation=System,</span> <span class="pre">required=True),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=Literal['obj'],</span> <span class="pre">required=False,</span> <span class="pre">default='obj'),</span> <span class="pre">'units':</span> <span class="pre">FieldInfo(annotation=UnitLength,</span> <span class="pre">required=True)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_fields_set" title="Link 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.input_format.obj.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.type" title="kittycad.models.input_format.obj.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.dict" title="kittycad.models.input_format.obj.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>]</span></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.input_format.obj.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.type" title="kittycad.models.input_format.obj.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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.input_format.obj.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.obj.html#id0" title="kittycad.models.input_format.obj.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.model_construct" title="kittycad.models.input_format.obj.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.obj.html#kittycad.models.input_format.obj.dict" title="kittycad.models.input_format.obj.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.obj.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.obj.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.schema" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.schema_json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'obj'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.units">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">units</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="kittycad.models.unit_length.UnitLength.html#kittycad.models.unit_length.UnitLength" title="kittycad.models.unit_length.UnitLength"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnitLength</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.units" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.obj.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.obj.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">ply</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#ply"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply" title="Link to this definition"></a></dt>
<dd><p>The PLY Polygon File Format.</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__abstractmethods__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__annotations__">
2024-07-28 22:52:47 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'coords':</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.system.System'&gt;,</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'type':</span> <span class="pre">typing.Literal['ply'],</span> <span class="pre">'units':</span> <span class="pre">&lt;enum</span> <span class="pre">'UnitLength'&gt;}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__annotations__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.type" title="kittycad.models.input_format.ply.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__copy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__deepcopy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__delattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__dict__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.type" title="kittycad.models.input_format.ply.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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.input_format.ply.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__getattr__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.dict" title="kittycad.models.input_format.ply.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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__hash__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__module__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pretty__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__private_attributes__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_complete__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">{'definitions':</span> <span class="pre">[{'cls':</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'AxisDirectionPair'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94724393856400',</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">{'axis':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis.Axis:94724401100208',</span> <span class="pre">'type':</span> <span class="pre">'definition-ref'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'direction':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.direction.Direction:94724393853840',</span> <span class="pre">'type':</span> <span class="pre">'definition-ref'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'AxisDirectionPair',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'},</span> <span class="pre">{'cls':</span> <span class="pre">&lt;enum</span> <span class="pre">'Axis'&gt;,</span> <span class="pre">'members':</span> <span class="pre">[Axis.Y,</span> <span class="pre">Axis.Z],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_enum_core_schema.&lt;locals&gt;.get_json_schema&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis.Axis:94724401100208',</span> <span class="pre">'sub_type':</span> <span class="pre">'str',</span> <span class="pre">'type':</span> <span class="pre">'enum'},</span> <span class="pre">{'cls':</span> <span class="pre">&lt;enum</span> <span class="pre">'
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_extra__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.model_fields" title="kittycad.models.input_format.ply.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__pydantic_root_model__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be6f26e0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583da58,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefault(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">default:</span> <span class="pre">Default(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba303f390,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;ply&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba3041e90,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__repr_str__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__setattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__setstate__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__signature__">
2024-07-28 22:52:47 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">coords:</span> <span class="pre">kittycad.models.system.System,</span> <span class="pre">type:</span> <span class="pre">Literal['ply']</span> <span class="pre">=</span> <span class="pre">'ply',</span> <span class="pre">units:</span> <span class="pre">kittycad.models.unit_length.UnitLength)</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__signature__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__slots__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply._abc_impl" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply._calculate_keys" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply._check_frozen" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply._copy_and_set_values" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply._get_value" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply._iter" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.construct" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.coords">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">coords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="kittycad.models.system.System.html#kittycad.models.system.System" title="kittycad.models.system.System"><code class="xref py py-class docutils literal notranslate"><span class="pre">System</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.coords" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.model_copy" title="kittycad.models.input_format.ply.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><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.input_format.ply.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.from_orm" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.__dict__" title="kittycad.models.input_format.ply.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.__pydantic_fields_set__" title="kittycad.models.input_format.ply.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.model_construct" title="kittycad.models.input_format.ply.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.__dict__" title="kittycad.models.input_format.ply.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.__pydantic_extra__" title="kittycad.models.input_format.ply.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.model_construct" title="kittycad.models.input_format.ply.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.dict" title="kittycad.models.input_format.ply.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.ply.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.dict" title="kittycad.models.input_format.ply.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.ply.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.ply.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_fields">
2024-07-28 22:52:47 +00:00
<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">{'coords':</span> <span class="pre">FieldInfo(annotation=System,</span> <span class="pre">required=True),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=Literal['ply'],</span> <span class="pre">required=False,</span> <span class="pre">default='ply'),</span> <span class="pre">'units':</span> <span class="pre">FieldInfo(annotation=UnitLength,</span> <span class="pre">required=True)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_fields_set" title="Link 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.input_format.ply.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.type" title="kittycad.models.input_format.ply.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.dict" title="kittycad.models.input_format.ply.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>]</span></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.input_format.ply.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.type" title="kittycad.models.input_format.ply.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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.input_format.ply.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.ply.html#id0" title="kittycad.models.input_format.ply.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.model_construct" title="kittycad.models.input_format.ply.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.ply.html#kittycad.models.input_format.ply.dict" title="kittycad.models.input_format.ply.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.ply.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.ply.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.schema" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.schema_json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'ply'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.units">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">units</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="kittycad.models.unit_length.UnitLength.html#kittycad.models.unit_length.UnitLength" title="kittycad.models.unit_length.UnitLength"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnitLength</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.units" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.ply.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.ply.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">sldprt</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#sldprt"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt" title="Link to this definition"></a></dt>
<dd><p>SolidWorks part (SLDPRT) format.</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__abstractmethods__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__annotations__">
2024-08-20 17:43:56 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'split_closed_faces':</span> <span class="pre">&lt;class</span> <span class="pre">'bool'&gt;,</span> <span class="pre">'type':</span> <span class="pre">typing.Literal['sldprt']}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__annotations__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.type" title="kittycad.models.input_format.sldprt.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__copy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__deepcopy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__delattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__dict__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.type" title="kittycad.models.input_format.sldprt.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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.input_format.sldprt.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__getattr__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.dict" title="kittycad.models.input_format.sldprt.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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__hash__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__module__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pretty__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__private_attributes__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_complete__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">&lt;class</span> <span class="pre">'kittycad.models.input_format.sldprt'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'sldprt'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.input_format.sldprt'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.input_format.sldprt'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.sldprt:94724403746448',</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">{'split_closed_faces':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</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">False,</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'bool'},</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">'type':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</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">'sldprt',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['sldprt'],</span> <span class="pre">'type':</span> <span class="pre">'literal'},</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">'model_name':</span> <span class="pre">'sldprt',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_extra__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.model_fields" title="kittycad.models.input_format.sldprt.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__pydantic_root_model__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be6fd690,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583da58,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefault(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">default:</span> <span class="pre">Default(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba303f510,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;sldprt&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;split_closed_faces&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;split_closed_faces&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba2dc1870,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;split_closed_faces&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__repr_str__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__setattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__setstate__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__signature__">
2024-08-20 17:43:56 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">split_closed_faces:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False,</span> <span class="pre">type:</span> <span class="pre">Literal['sldprt']</span> <span class="pre">=</span> <span class="pre">'sldprt')</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__signature__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__slots__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt._abc_impl" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt._calculate_keys" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt._check_frozen" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt._copy_and_set_values" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt._get_value" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt._iter" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.construct" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.model_copy" title="kittycad.models.input_format.sldprt.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><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.input_format.sldprt.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.from_orm" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.__dict__" title="kittycad.models.input_format.sldprt.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.__pydantic_fields_set__" title="kittycad.models.input_format.sldprt.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.model_construct" title="kittycad.models.input_format.sldprt.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.__dict__" title="kittycad.models.input_format.sldprt.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.__pydantic_extra__" title="kittycad.models.input_format.sldprt.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.model_construct" title="kittycad.models.input_format.sldprt.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.dict" title="kittycad.models.input_format.sldprt.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.sldprt.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.dict" title="kittycad.models.input_format.sldprt.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.sldprt.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.sldprt.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_fields">
2024-08-20 17:43:56 +00:00
<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">{'split_closed_faces':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=Literal['sldprt'],</span> <span class="pre">required=False,</span> <span class="pre">default='sldprt')}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_fields_set" title="Link 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.input_format.sldprt.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.type" title="kittycad.models.input_format.sldprt.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.dict" title="kittycad.models.input_format.sldprt.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>]</span></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.input_format.sldprt.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.type" title="kittycad.models.input_format.sldprt.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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.input_format.sldprt.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.sldprt.html#id0" title="kittycad.models.input_format.sldprt.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.model_construct" title="kittycad.models.input_format.sldprt.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.sldprt.html#kittycad.models.input_format.sldprt.dict" title="kittycad.models.input_format.sldprt.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.sldprt.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.sldprt.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.schema" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.schema_json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-08-09 21:14:56 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.split_closed_faces">
2024-08-20 17:43:56 +00:00
<span class="sig-name descname"><span class="pre">split_closed_faces</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/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.split_closed_faces" title="Link to this definition"></a></dt>
2024-08-09 21:14:56 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'sldprt'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.sldprt.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.sldprt.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.step">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">step</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#step"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step" title="Link to this definition"></a></dt>
<dd><p>ISO 10303-21 (STEP) format.</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__abstractmethods__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__annotations__">
2024-08-20 17:43:56 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'split_closed_faces':</span> <span class="pre">&lt;class</span> <span class="pre">'bool'&gt;,</span> <span class="pre">'type':</span> <span class="pre">typing.Literal['step']}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__annotations__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.type" title="kittycad.models.input_format.step.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__copy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__deepcopy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__delattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__dict__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.type" title="kittycad.models.input_format.step.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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.input_format.step.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__getattr__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.dict" title="kittycad.models.input_format.step.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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__hash__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__module__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pretty__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__private_attributes__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_complete__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">&lt;class</span> <span class="pre">'kittycad.models.input_format.step'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'step'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.input_format.step'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.input_format.step'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.input_format.step:94724403754896',</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">{'split_closed_faces':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</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">False,</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'bool'},</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">'type':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</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">'step',</span> <span class="pre">'schema':</span> <span class="pre">{'expected':</span> <span class="pre">['step'],</span> <span class="pre">'type':</span> <span class="pre">'literal'},</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">'model_name':</span> <span class="pre">'step',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_extra__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.model_fields" title="kittycad.models.input_format.step.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__pydantic_root_model__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be6ff790,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;type&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583da58,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefault(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">default:</span> <span class="pre">Default(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb583d2c8,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;step&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;split_closed_faces&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;split_closed_faces&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba2ef8270,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;split_closed_faces&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__repr_str__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__setattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__setstate__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__signature__">
2024-08-20 17:43:56 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">split_closed_faces:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False,</span> <span class="pre">type:</span> <span class="pre">Literal['step']</span> <span class="pre">=</span> <span class="pre">'step')</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__signature__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__slots__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step._abc_impl" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step._calculate_keys" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step._check_frozen" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step._copy_and_set_values" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step._get_value" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step._iter" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.construct" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.model_copy" title="kittycad.models.input_format.step.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><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.input_format.step.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.from_orm" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.__dict__" title="kittycad.models.input_format.step.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.__pydantic_fields_set__" title="kittycad.models.input_format.step.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.model_construct" title="kittycad.models.input_format.step.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.__dict__" title="kittycad.models.input_format.step.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.__pydantic_extra__" title="kittycad.models.input_format.step.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.model_construct" title="kittycad.models.input_format.step.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.dict" title="kittycad.models.input_format.step.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.step.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.dict" title="kittycad.models.input_format.step.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.step.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><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.input_format.step.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_fields">
2024-08-20 17:43:56 +00:00
<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">{'split_closed_faces':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=Literal['step'],</span> <span class="pre">required=False,</span> <span class="pre">default='step')}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_fields_set" title="Link 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.input_format.step.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.type" title="kittycad.models.input_format.step.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.dict" title="kittycad.models.input_format.step.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>]</span></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.input_format.step.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.type" title="kittycad.models.input_format.step.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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.input_format.step.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.step.html#id0" title="kittycad.models.input_format.step.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.model_construct" title="kittycad.models.input_format.step.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.step.html#kittycad.models.input_format.step.dict" title="kittycad.models.input_format.step.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.step.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.step.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.schema" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.schema_json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-08-09 21:14:56 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.split_closed_faces">
2024-08-20 17:43:56 +00:00
<span class="sig-name descname"><span class="pre">split_closed_faces</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/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.split_closed_faces" title="Link to this definition"></a></dt>
2024-08-09 21:14:56 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'step'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.step.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.step.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl">
2024-07-28 22:52:47 +00:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.input_format.</span></span><span class="sig-name descname"><span class="pre">stl</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/input_format.html#stl"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl" title="Link to this definition"></a></dt>
<dd><p><a href="#id3"><span class="problematic" id="id4">*</span></a>ST**ereo**L**ithography format.</p>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__abstractmethods__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__abstractmethods__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__annotations__">
2024-07-28 22:52:47 +00:00
<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">&quot;ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]&quot;,</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">|</span> <span class="pre">PluggableSchemaValidator]',</span> <span class="pre">'__signature__':</span> <span class="pre">'ClassVar[Signature]',</span> <span class="pre">'coords':</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.system.System'&gt;,</span> <span class="pre">'model_computed_fields':</span> <span class="pre">'ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]',</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">'type':</span> <span class="pre">typing.Literal['stl'],</span> <span class="pre">'units':</span> <span class="pre">&lt;enum</span> <span class="pre">'UnitLength'&gt;}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__annotations__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__class_getitem__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__class_getitem__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.type" title="kittycad.models.input_format.stl.type"><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">BaseModel</span></code>] | <code class="xref py py-class docutils literal notranslate"><span class="pre">PydanticRecursiveRef</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__class_vars__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__class_vars__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__copy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__copy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__deepcopy__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__deepcopy__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__delattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__delattr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__dict__">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">__dict__</span></span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__dict__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__eq__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__eq__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__get_pydantic_core_schema__">
2024-07-28 22:52:47 +00:00
<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">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__get_pydantic_core_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models CoreSchema.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>source</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.type" title="kittycad.models.input_format.stl.type"><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">BaseModel</span></code>]</span>) The class we are generating a schema for.
This will generally be the same as the <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> argument if this is a classmethod.</p></li>
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetCoreSchemaHandler</span></code></span>) A callable that calls into Pydantics internal CoreSchema generation logic.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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 c
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A <code class="xref any docutils literal notranslate"><span class="pre">pydantic-core</span></code> <code class="xref any docutils literal notranslate"><span class="pre">CoreSchema</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__get_pydantic_json_schema__">
2024-07-28 22:52:47 +00:00
<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">core_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__get_pydantic_json_schema__" title="Link to this definition"></a></dt>
<dd><p>Hook into generating the models 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>core_schema</strong> (<span class="sphinx_autodoc_typehints-type"><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">EnumSchema</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">TupleSchema</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></cod
You can ignore this argument and call the handler with a new CoreSchema,
2024-07-28 22:52:47 +00:00
wrap this CoreSchema (<code class="xref any docutils literal notranslate"><span class="pre">{'type':</span> <span class="pre">'nullable',</span> <span class="pre">'schema':</span> <span class="pre">current_schema}</span></code>),
or just call the handler with the original schema.</p></li>
2024-07-28 22:52:47 +00:00
<li><p><strong>handler</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">GetJsonSchemaHandler</span></code></span>) Call into Pydantics internal JSON schema generation.
This will raise a <code class="xref any docutils literal notranslate"><span class="pre">pydantic.errors.PydanticInvalidForJsonSchema</span></code> if JSON schema
generation fails.
2024-07-28 22:52:47 +00:00
Since this gets called by <code class="xref any docutils literal notranslate"><span class="pre">BaseModel.model_json_schema</span></code> you can override the
<code class="xref any docutils literal notranslate"><span class="pre">schema_generator</span></code> 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>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></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.input_format.stl.__getattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__getattr__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__getstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__getstate__" title="Link to this definition"></a></dt>
<dd><p>Helper for pickle.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.dict" title="kittycad.models.input_format.stl.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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__hash__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__hash__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__init__" title="Link to this definition"></a></dt>
<dd><p>Create a new model by parsing and validating input data from keyword arguments.</p>
2024-07-28 22:52:47 +00:00
<p>Raises [<code class="xref any docutils literal notranslate"><span class="pre">ValidationError</span></code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
2024-07-28 22:52:47 +00:00
<p><code class="xref any docutils literal notranslate"><span class="pre">self</span></code> is explicitly positional-only to allow <code class="xref any docutils literal notranslate"><span class="pre">self</span></code> as a field name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__iter__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__iter__" title="Link to this definition"></a></dt>
<dd><p>So <code class="xref any docutils literal notranslate"><span class="pre">dict(model)</span></code> works.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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.Tuple" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</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>], <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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__module__">
2024-07-28 22:52:47 +00:00
<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.input_format'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__module__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pretty__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pretty__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__private_attributes__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__private_attributes__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_complete__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_complete__" title="Link to this definition"></a></dt>
<dd></dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_core_schema__">
2024-08-23 20:56:42 +00:00
<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">{'definitions':</span> <span class="pre">[{'cls':</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'AxisDirectionPair'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</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(&lt;function</span> <span class="pre">modify_model_json_schema&gt;,</span> <span class="pre">cls=&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;,</span> <span class="pre">title=None),</span> <span class="pre">&lt;bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre">&lt;class</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair'&gt;&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis_direction_pair.AxisDirectionPair:94724393856400',</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">{'axis':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.axis.Axis:94724401100208',</span> <span class="pre">'type':</span> <span class="pre">'definition-ref'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'direction':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_json_schema_update_func.&lt;locals&gt;.json_schema_update_func&gt;],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'schema_ref':</span> <span class="pre">'kittycad.models.direction.Direction:94724393853840',</span> <span class="pre">'type':</span> <span class="pre">'definition-ref'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'AxisDirectionPair',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'},</span> <span class="pre">{'cls':</span> <span class="pre">&lt;enum</span> <span class="pre">'Axis'&gt;,</span> <span class="pre">'members':</span> <span class="pre">[Axis.Y,</span> <span class="pre">Axis.Z],</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[&lt;function</span> <span class="pre">get_enum_core_schema.&lt;locals&gt;.get_json_schema&gt;]},</span> <span class="pre">'ref':</span> <span class="pre">'kittycad.models.axis.Axis:94724401100208',</span> <span class="pre">'sub_type':</span> <span class="pre">'str',</span> <span class="pre">'type':</span> <span class="pre">'enum'},</span> <span class="pre">{'cls':</span> <span class="pre">&lt;enum</span> <span class="pre">'
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_custom_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_custom_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_decorators__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_decorators__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_extra__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_extra__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_fields_set__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_fields_set__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_generic_metadata__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_generic_metadata__" title="Link to this definition"></a></dt>
<dd></dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_init_subclass__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_init_subclass__" title="Link to this definition"></a></dt>
<dd><p>This is intended to behave just like <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, but is called by <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code>
only after the class is actually fully initialized. In particular, attributes like <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.model_fields" title="kittycad.models.input_format.stl.model_fields"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">model_fields</span></code></a> will
be present when this is called.</p>
2024-07-28 22:52:47 +00:00
<p>This is necessary because <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a> will always be called by <code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code>,
and it would require a prohibitively large refactor to the <code class="xref any docutils literal notranslate"><span class="pre">ModelMetaclass</span></code> to ensure that
<code class="xref any docutils literal notranslate"><span class="pre">type.__new__</span></code> was called in such a manner that the class would already be sufficiently initialized.</p>
<p>This will receive the same <code class="xref any docutils literal notranslate"><span class="pre">kwargs</span></code> that would be passed to the standard <a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response.__init_subclass__" title="kittycad.types.Response.__init_subclass__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init_subclass__</span></code></a>, namely,
any kwargs passed to the class definition that arent used internally by pydantic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>**kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Any keyword arguments passed to the class definition that arent used internally
by pydantic.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_parent_namespace__">
2024-08-20 17:43:56 +00:00
<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">{'Annotated':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'BaseModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'ConfigDict':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Field':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Literal':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'RootModel':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'System':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'Union':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'UnitLength':</span> <span class="pre">&lt;pydantic._internal._model_construction._PydanticWeakRef</span> <span class="pre">object&gt;,</span> <span class="pre">'__builtins__':</span> <span class="pre">{'ArithmeticError':</span> <span class="pre">&lt;class</span> <span class="pre">'ArithmeticError'&gt;,</span> <span class="pre">'AssertionError':</span> <span class="pre">&lt;class</span> <span class="pre">'AssertionError'&gt;,</span> <span class="pre">'AttributeError':</span> <span class="pre">&lt;class</span> <span class="pre">'AttributeError'&gt;,</span> <span class="pre">'BaseException':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseException'&gt;,</span> <span class="pre">'BaseExceptionGroup':</span> <span class="pre">&lt;class</span> <span class="pre">'BaseExceptionGroup'&gt;,</span> <span class="pre">'BlockingIOError':</span> <span class="pre">&lt;class</span> <span class="pre">'BlockingIOError'&gt;,</span> <span class="pre">'BrokenPipeError':</span> <span class="pre">&lt;class</span> <span class="pre">'BrokenPipeError'&gt;,</span> <span class="pre">'BufferError':</span> <span class="pre">&lt;class</span> <span class="pre">'BufferError'&gt;,</span> <span class="pre">'BytesWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'BytesWarning'&gt;,</span> <span class="pre">'ChildProcessError':</span> <span class="pre">&lt;class</span> <span class="pre">'ChildProcessError'&gt;,</span> <span class="pre">'ConnectionAbortedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionAbortedError'&gt;,</span> <span class="pre">'ConnectionError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionError'&gt;,</span> <span class="pre">'ConnectionRefusedError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionRefusedError'&gt;,</span> <span class="pre">'ConnectionResetError':</span> <span class="pre">&lt;class</span> <span class="pre">'ConnectionResetError'&gt;,</span> <span class="pre">'DeprecationWarning':</span> <span class="pre">&lt;class</span> <span class="pre">'DeprecationWarning'&gt;,</span> <span class="pre">'EOFError':</span> <span class="pre">&lt;class</span> <span class="pre">'EOFError'&gt;,</span> <span class="pre">'Ellipsis':</span> <span class="pre">Ellipsis,</span> <span class="pre">'EncodingWarning':</span> <span class="pre
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_post_init__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_private__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_private__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_root_model__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__pydantic_root_model__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_serializer__">
2024-08-23 20:56:42 +00:00
<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>&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626be701bc0,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Fields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;coords&quot;:</span> <span class="pre">SerField</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key_py:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3bb3f75560,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">alias_py:</span> <span class="pre">None,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">serializer:</span> <span class="pre">Some(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Model(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelSerializer</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">class:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00005626bdd91700,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#1
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__pydantic_validator__">
2024-08-23 20:56:42 +00:00
<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> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</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=&quot;stl&quot;,</span> <span class="pre">validator=Model(</span>&#160;&#160;&#160;&#160; <span class="pre">ModelValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">revalidate:</span> <span class="pre">Never,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">validator:</span> <span class="pre">ModelFields(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">fields:</span> <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Field</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">key:</span> <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">py_key:</span> <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">0x00007f3ba2f48d20,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">),</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">path:</span> <span class="pre">LookupPath(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">S(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">&quot;coords&quot;,</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Py(</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__repr_args__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__repr_args__" title="Link 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><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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/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>[<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>]]</span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__repr_name__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__repr_name__" title="Link to this definition"></a></dt>
<dd><p>Name of the instances class, used in __repr__.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__repr_str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__repr_str__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__rich_repr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__rich_repr__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</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/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/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/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/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>] | <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/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>, <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>]]</span></p>
</dd>
</dl>
</dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__setattr__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__setattr__" title="Link to this definition"></a></dt>
<dd><p>Implement setattr(self, name, value).</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__setstate__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__setstate__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__signature__">
2024-07-28 22:52:47 +00:00
<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">&lt;Signature</span> <span class="pre">(*,</span> <span class="pre">coords:</span> <span class="pre">kittycad.models.system.System,</span> <span class="pre">type:</span> <span class="pre">Literal['stl']</span> <span class="pre">=</span> <span class="pre">'stl',</span> <span class="pre">units:</span> <span class="pre">kittycad.models.unit_length.UnitLength)</span> <span class="pre">-&gt;</span> <span class="pre">None&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__signature__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__slots__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__slots__" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.__str__">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.__str__" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl._abc_impl">
2024-07-28 22:52:47 +00:00
<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">&lt;_abc._abc_data</span> <span class="pre">object&gt;</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl._abc_impl" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl._calculate_keys">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl._calculate_keys" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl._check_frozen">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl._check_frozen" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl._copy_and_set_values">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl._copy_and_set_values" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl._get_value">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl._get_value" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl._iter">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl._iter" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.construct">
2024-07-28 22:52:47 +00:00
<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">_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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.construct" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.coords">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">coords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="kittycad.models.system.System.html#kittycad.models.system.System" title="kittycad.models.system.System"><code class="xref py py-class docutils literal notranslate"><span class="pre">System</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.coords" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the model.</p>
<dl class="simple">
2024-07-28 22:52:47 +00:00
<dt>!!! warning “Deprecated”</dt><dd><p>This method is now deprecated; use <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.model_copy" title="kittycad.models.input_format.stl.model_copy"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_copy</span></code></a> instead.</p>
</dd>
</dl>
2024-07-28 22:52:47 +00:00
<p>If you need <code class="xref any docutils literal notranslate"><span class="pre">include</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">exclude</span></code>, 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>include</strong> Optional set or mapping specifying which fields to include in the copied model.</p></li>
<li><p><strong>exclude</strong> Optional set or mapping specifying which fields to exclude in the copied model.</p></li>
<li><p><strong>update</strong> Optional dictionary of field-value pairs to override field values in the copied model.</p></li>
<li><p><strong>deep</strong> If True, the values of fields that are Pydantic models will be deep-copied.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A copy of the model with included, excluded and updated fields as specified.</p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.dict">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.dict" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.from_orm">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.from_orm" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.json" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
</dl>
</dd></dl>
2024-07-28 22:52:47 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_computed_fields">
2024-07-28 22:52:47 +00:00
<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><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_computed_fields" title="Link to this definition"></a></dt>
<dd><p>A dictionary of computed field names and their corresponding <code class="xref any docutils literal notranslate"><span class="pre">ComputedFieldInfo</span></code> objects.</p>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_config">
2024-07-28 22:52:47 +00:00
<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">{'protected_namespaces':</span> <span class="pre">()}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<code class="xref any docutils literal notranslate"><span class="pre">ConfigDict</span></code>][pydantic.config.ConfigDict].</p>
</dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_construct">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_construct" title="Link to this definition"></a></dt>
<dd><p>Creates a new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
<p>Creates a new model setting <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.__dict__" title="kittycad.models.input_format.stl.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.__pydantic_fields_set__" title="kittycad.models.input_format.stl.__pydantic_fields_set__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_fields_set__</span></code></a> from trusted or pre-validated data.
Default values are respected, but no other validation is performed.</p>
<dl class="simple">
<dt>!!! note</dt><dd><p><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.model_construct" title="kittycad.models.input_format.stl.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a> generally respects the <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span></code> setting on the provided model.
That is, if <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'allow'</span></code>, then all extra passed values are added to the model instances <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.__dict__" title="kittycad.models.input_format.stl.__dict__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__dict__</span></code></a>
and <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.__pydantic_extra__" title="kittycad.models.input_format.stl.__pydantic_extra__"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">__pydantic_extra__</span></code></a> fields. If <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'ignore'</span></code> (the default), then all extra passed values are ignored.
Because no validation is performed with a call to <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.model_construct" title="kittycad.models.input_format.stl.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct()</span></code></a>, having <code class="xref any docutils literal notranslate"><span class="pre">model_config.extra</span> <span class="pre">==</span> <span class="pre">'forbid'</span></code> does not result in
an error if extra values are passed, but they will be ignored.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>_fields_set</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">set</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>]]</span>) The set of field names accepted for the Model instance.</p></li>
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Trusted or pre-validated data dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A new instance of the <code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> class with validated data.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_copy">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_copy" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#model_copy">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>update</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.dict" title="kittycad.models.input_format.stl.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>]]</span>) 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>
2024-07-28 22:52:47 +00:00
<li><p><strong>deep</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> to make a deep copy of the model.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>New model instance.</p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_dump">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_dump" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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">'json'</span></code>, <code class="docutils literal notranslate"><span class="pre">'python'</span></code>], <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>) The mode in which <code class="xref any docutils literal notranslate"><span class="pre">to_python</span></code> should run.
If mode is json, the output will only contain JSON serializable types.
If mode is python, the output may contain non-JSON-serializable Python objects.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to include in the output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) A set of fields to exclude from the output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use the fields alias in the dictionary key if defined.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.dict" title="kittycad.models.input_format.stl.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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A dictionary representation of the model.</p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_dump_json">
2024-07-28 22:52:47 +00:00
<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">context</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>, <em class="sig-param"><span class="n"><span class="pre">serialize_as_any</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_dump_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json">https://docs.pydantic.dev/2.8/concepts/serialization/#modelmodel_dump_json</a></p>
<p>Generates a JSON representation of the model using Pydantics <code class="xref any docutils literal notranslate"><span class="pre">to_json</span></code> method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
2024-07-28 22:52:47 +00:00
<li><p><strong>indent</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>) Indentation to use in the JSON output. If None is passed, the output will be compact.</p></li>
<li><p><strong>include</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to include in the JSON output.</p></li>
<li><p><strong>exclude</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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.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/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</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.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>], <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>]</span>) Field(s) to exclude from the JSON output.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Additional context to pass to the serializer.</p></li>
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize using field aliases.</p></li>
<li><p><strong>exclude_unset</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have not been explicitly set.</p></li>
<li><p><strong>exclude_defaults</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that are set to their default value.</p></li>
<li><p><strong>exclude_none</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to exclude fields that have a value of <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
<li><p><strong>round_trip</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) If True, dumped values should be valid as input for non-idempotent types such as Json[T].</p></li>
<li><p><strong>warnings</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>, <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">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'warn'</span></code>, <code class="docutils literal notranslate"><span class="pre">'error'</span></code>]]</span>) How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,
“error” raises a [<code class="xref any docutils literal notranslate"><span class="pre">PydanticSerializationError</span></code>][pydantic_core.PydanticSerializationError].</p></li>
<li><p><strong>serialize_as_any</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to serialize fields with duck-typing serialization behavior.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A JSON string representation of the model.</p>
</dd>
</dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_extra">
2024-07-28 22:52:47 +00:00
<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><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><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_extra" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>A dictionary of extra fields, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if <code class="xref any docutils literal notranslate"><span class="pre">config.extra</span></code> is not set to <code class="xref any docutils literal notranslate"><span class="pre">&quot;allow&quot;</span></code>.</p>
</dd>
</dl>
</dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_fields">
2024-07-28 22:52:47 +00:00
<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">{'coords':</span> <span class="pre">FieldInfo(annotation=System,</span> <span class="pre">required=True),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=Literal['stl'],</span> <span class="pre">required=False,</span> <span class="pre">default='stl'),</span> <span class="pre">'units':</span> <span class="pre">FieldInfo(annotation=UnitLength,</span> <span class="pre">required=True)}</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
2024-07-28 22:52:47 +00:00
mapping of field names to [<code class="xref any docutils literal notranslate"><span class="pre">FieldInfo</span></code>][pydantic.fields.FieldInfo].</p>
<p>This replaces <code class="xref any docutils literal notranslate"><span class="pre">Model.__fields__</span></code> from Pydantic V1.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_fields_set">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_fields_set" title="Link 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>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_json_schema">
2024-07-28 22:52:47 +00:00
<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=&lt;class</span> <span class="pre">'pydantic.json_schema.GenerateJsonSchema'&gt;</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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_json_schema" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>by_alias</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to use attribute aliases or not.</p></li>
<li><p><strong>ref_template</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The reference template.</p></li>
<li><p><strong>schema_generator</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.type" title="kittycad.models.input_format.stl.type"><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>]</span>) To override the logic used to generate the JSON schema, as a subclass of
<code class="xref any docutils literal notranslate"><span class="pre">GenerateJsonSchema</span></code> with your desired modifications</p></li>
<li><p><strong>mode</strong> (<span class="sphinx_autodoc_typehints-type"><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>]</span>) The mode in which to generate the schema.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.dict" title="kittycad.models.input_format.stl.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>]</span></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>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_parametrized_name">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_parametrized_name" title="Link 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><strong>params</strong> (<span class="sphinx_autodoc_typehints-type"><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 internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.type" title="kittycad.models.input_format.stl.type"><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>]</span>) Tuple of types of the class. Given a generic class
<code class="xref any docutils literal notranslate"><span class="pre">Model</span></code> with 2 type variables and a concrete model <code class="xref any docutils literal notranslate"><span class="pre">Model[str,</span> <span class="pre">int]</span></code>,
the value <code class="xref any docutils literal notranslate"><span class="pre">(str,</span> <span class="pre">int)</span></code> would be passed to <code class="xref any docutils literal notranslate"><span class="pre">params</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p>String representing the new class where <code class="xref any docutils literal notranslate"><span class="pre">params</span></code> are passed to <code class="xref any docutils literal notranslate"><span class="pre">cls</span></code> 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>
2023-07-08 02:27:32 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_post_init">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_post_init" title="Link to this definition"></a></dt>
<dd><p>Override this method to perform additional initialization after <a class="reference internal" href="kittycad.models.input_format.stl.html#id0" title="kittycad.models.input_format.stl.__init__"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">__init__</span></code></a> and <a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.model_construct" title="kittycad.models.input_format.stl.model_construct"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">model_construct</span></code></a>.
This is useful if you want to do some validation that requires the entire model to be initialized.</p>
<dl class="field-list simple">
2023-07-08 02:27:32 +00:00
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_rebuild">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_rebuild" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>force</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to force the rebuilding of the model schema, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p></li>
<li><p><strong>raise_errors</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) Whether to raise errors, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a>.</p></li>
<li><p><strong>_parent_namespace_depth</strong> (<span class="sphinx_autodoc_typehints-type"><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>) The depth level of the parent namespace, defaults to 2.</p></li>
<li><p><strong>_types_namespace</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<a class="reference internal" href="kittycad.models.input_format.stl.html#kittycad.models.input_format.stl.dict" title="kittycad.models.input_format.stl.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>]]</span>) The types namespace, defaults to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a>.</p></li>
</ul>
</dd>
2024-07-28 22:52:47 +00:00
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><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>[<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>]</span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">None</span></code></a> if the schema is already “complete” and rebuilding was not required.
If rebuilding _was_ required, returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if rebuilding was successful, otherwise <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref any docutils literal notranslate"><span class="pre">False</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_validate">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_validate" title="Link 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>from_attributes</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to extract data from object attributes.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) 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>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_validate_json">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_validate_json" title="Link to this definition"></a></dt>
<dd><p>Usage docs: <a class="reference external" href="https://docs.pydantic.dev/2.8/concepts/json/#json-parsing">https://docs.pydantic.dev/2.8/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">
2024-07-28 22:52:47 +00:00
<li><p><strong>json_data</strong> (<span class="sphinx_autodoc_typehints-type"><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/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytearray" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code></a></span>) The JSON data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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>
2024-07-28 22:52:47 +00:00
<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 <code class="xref any docutils literal notranslate"><span class="pre">json_data</span></code> is not a JSON string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.model_validate_strings">
2024-07-28 22:52:47 +00:00
<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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.model_validate_strings" title="Link to this definition"></a></dt>
<dd><p>Validate the given object with 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">
2024-07-28 22:52:47 +00:00
<li><p><strong>obj</strong> (<span class="sphinx_autodoc_typehints-type"><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></span>) The object containing string data to validate.</p></li>
<li><p><strong>strict</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Whether to enforce types strictly.</p></li>
<li><p><strong>context</strong> (<span class="sphinx_autodoc_typehints-type"><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>[<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>]</span>) Extra variables to pass to the validator.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></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.input_format.stl.parse_file">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.parse_file" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.parse_obj">
2024-07-28 22:52:47 +00:00
<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">obj</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.parse_obj" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.parse_raw">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.parse_raw" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
2023-07-08 02:27:32 +00:00
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.schema">
2024-07-28 22:52:47 +00:00
<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">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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.schema" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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>]</span></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.schema_json">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.schema_json" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></p>
2023-07-08 02:27:32 +00:00
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
2023-08-16 23:39:29 +00:00
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.type">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">type</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.Literal" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code></a><span class="pre">[</span><code class="docutils literal notranslate"><span class="pre">'stl'</span></code><span class="pre">]</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.type" title="Link to this definition"></a></dt>
2023-07-08 02:27:32 +00:00
<dd></dd></dl>
2023-07-31 19:56:37 +00:00
<dl class="py attribute">
2023-08-16 23:39:29 +00:00
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.units">
2024-07-28 22:52:47 +00:00
<span class="sig-name descname"><span class="pre">units</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="kittycad.models.unit_length.UnitLength.html#kittycad.models.unit_length.UnitLength" title="kittycad.models.unit_length.UnitLength"><code class="xref py py-class docutils literal notranslate"><span class="pre">UnitLength</span></code></a></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.units" title="Link to this definition"></a></dt>
2023-07-31 19:56:37 +00:00
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.update_forward_refs">
2024-07-28 22:52:47 +00:00
<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="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/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.update_forward_refs" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><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></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.input_format.stl.validate">
2024-07-28 22:52:47 +00:00
<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">value</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/input_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.input_format.stl.validate" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
2024-07-28 22:52:47 +00:00
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></span></p>
</dd>
</dl>
</dd></dl>
2023-07-08 02:27:32 +00:00
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
2024-07-28 22:52:47 +00:00
<a href="kittycad.models.imported_geometry.ImportedGeometry.html" class="btn btn-neutral float-left" title="kittycad.models.imported_geometry.ImportedGeometry" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="kittycad.models.input_format.fbx.html" class="btn btn-neutral float-right" title="kittycad.models.input_format.fbx" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
2023-07-08 02:27:32 +00:00
</div>
<hr/>
<div role="contentinfo">
2024-07-28 22:52:47 +00:00
<p>&#169; Copyright 2024, KittyCAD Team Members.</p>
2023-07-08 02:27:32 +00:00
</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>